Skip to main content

CommonSamplerType

Enum CommonSamplerType 

Source
#[repr(i32)]
pub enum CommonSamplerType { Dry = 1, TopK = 2, TopP = 3, MinP = 4, TypicalP = 6, Temperature = 7, Xtc = 8, Infill = 9, Penalties = 10, TopNSigma = 11, AdaptiveP = 12, }
Expand description

Which of llama.cpp’s samplers to run, and in what order.

Values match common_sampler_type; the default chain is penalties → DRY → top-n-sigma → top-k → typical-p → top-p → min-p → XTC → temperature.

Variants§

§

Dry = 1

DRY repetition penalty.

§

TopK = 2

Top-k truncation.

§

TopP = 3

Top-p (nucleus) truncation.

§

MinP = 4

Min-p truncation.

§

TypicalP = 6

Typical-p truncation.

§

Temperature = 7

Temperature scaling.

§

Xtc = 8

Exclude Top Choices.

§

Infill = 9

Infill sampler, for fill-in-the-middle.

§

Penalties = 10

Repetition / frequency / presence penalties.

§

TopNSigma = 11

Top-n-sigma truncation.

§

AdaptiveP = 12

Adaptive-p, which targets a probability rather than a cutoff.

Implementations§

Source§

impl CommonSamplerType

Source

pub fn name(self) -> Result<String, ShimError>

llama.cpp’s own name for this sampler, e.g. "top_k".

§Errors

Returns CommonSamplerError::Failed if llama.cpp cannot name it.

Source

pub fn from_names(names: &[&str]) -> Result<Vec<i32>, ShimError>

Parse llama.cpp’s sampler names into an ordering.

Unrecognised names are dropped by llama.cpp rather than rejected, so a shorter result than names means something was not understood.

§Errors

Returns CommonSamplerError::Nul if a name contains an interior NUL.

Trait Implementations§

Source§

impl Clone for CommonSamplerType

Source§

fn clone(&self) -> CommonSamplerType

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for CommonSamplerType

Source§

impl Debug for CommonSamplerType

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Eq for CommonSamplerType

Source§

impl PartialEq for CommonSamplerType

Source§

fn eq(&self, other: &CommonSamplerType) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for CommonSamplerType

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more