Skip to main content

SamplerKind

Enum SamplerKind 

Source
#[non_exhaustive]
pub enum SamplerKind { TopK { top_k: i32, }, TopP { top_p: f32, }, MinP { min_p: f32, }, TopKTopP { top_k: i32, top_p: f32, }, }
Expand description

Which sort-free sampler to run.

Note: only PartialEq is derived (not Eq) because top_p / min_p are f32, and f32 doesn’t satisfy Eq (NaN != NaN).

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

TopK

Keep only the top-K cells (K = top_k).

Fields

§top_k: i32

Cells kept per row. Must be in [1, vocab_size].

§

TopP

Keep the smallest top-prob set whose cumulative mass > top_p.

Fields

§top_p: f32

Cumulative-mass cutoff in (0, 1].

§

MinP

Keep cells prob >= min_p * row_max.

Fields

§min_p: f32

Multiplier of the per-row max prob in (0, 1].

§

TopKTopP

Combined top-K then top-P filter. Canonical decode sampler.

Fields

§top_k: i32

Cells kept per row. Must be in [1, vocab_size].

§top_p: f32

Cumulative-mass cutoff in (0, 1].

Trait Implementations§

Source§

impl Clone for SamplerKind

Source§

fn clone(&self) -> SamplerKind

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 SamplerKind

Source§

impl Debug for SamplerKind

Source§

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

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

impl PartialEq for SamplerKind

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for SamplerKind

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, 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.