Skip to main content

GenerationSampler

Struct GenerationSampler 

Source
pub struct GenerationSampler {
    pub top_k: i32,
    pub top_p: f32,
    pub min_p: f32,
    pub repeat_penalty: f32,
    pub repeat_last_n: i32,
    pub frequency_penalty: f32,
    pub presence_penalty: f32,
    /* private fields */
}
Expand description

Configurable backend-neutral text sampler.

Fields§

§top_k: i32

Keep only the top_k highest-logit tokens when positive.

§top_p: f32

Nucleus probability mass.

§min_p: f32

Minimum probability relative to the most probable token.

§repeat_penalty: f32

Repetition multiplier.

§repeat_last_n: i32

Number of recent tokens considered by penalties.

§frequency_penalty: f32

Per-occurrence penalty.

§presence_penalty: f32

One-time presence penalty.

Implementations§

Source§

impl GenerationSampler

Source

pub fn new() -> Self

Creates a sampler with default controls.

Source

pub fn from_resolved(config: ResolvedGenerationConfig) -> Self

Creates a sampler from a resolved portable generation configuration.

Source

pub fn with_generated_tokens( self, tokens: impl IntoIterator<Item = u32>, ) -> Self

Seeds accepted-token history.

Source

pub fn top_k(self, value: i32) -> Self

Sets top-k filtering.

Source

pub fn top_p(self, value: f32) -> Self

Sets nucleus filtering.

Source

pub fn min_p(self, value: f32) -> Self

Sets minimum-relative-probability filtering.

Source

pub fn penalties( self, repeat_penalty: f32, repeat_last_n: i32, frequency_penalty: f32, presence_penalty: f32, ) -> Self

Sets repetition, frequency, and presence penalties.

Source

pub fn generated_tokens(&self) -> &[u32]

Returns accepted-token history.

Source

pub fn set_generated_tokens(&mut self, tokens: impl IntoIterator<Item = u32>)

Replaces accepted-token history.

Source

pub fn accept_token(&mut self, token: u32)

Records a token accepted outside this sampler.

Source

pub fn clear_generated_tokens(&mut self)

Clears accepted-token history.

Source

pub const fn penalty_config(&self) -> PenaltyConfig

Returns the portable penalty controls.

Trait Implementations§

Source§

impl Clone for GenerationSampler

Source§

fn clone(&self) -> GenerationSampler

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 Debug for GenerationSampler

Source§

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

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

impl Default for GenerationSampler

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<B: SamplingBackend> Sampler<B> for GenerationSampler

Source§

fn sample( &mut self, logits: &B::Logits, temperature: f32, random: Option<&mut B::RandomState>, context: &B::Context, ) -> Result<B::Token, B::Error>

Selects one token from raw model logits.
Source§

fn uses_checkpoint_defaults(&self) -> bool

Whether loaded checkpoint defaults should wrap this policy.
Source§

impl<B: SamplingBackend> SpeculativeSampler<B> for GenerationSampler

Source§

fn supports_exact_optimistic_promotion(&self) -> bool

Whether optimistic draft work is an exact discardable fork.
Source§

fn process_logits( &mut self, logits: &B::Logits, temperature: f32, history: &[u32], context: &B::Context, ) -> Result<B::Logits, B::Error>

Applies penalties, filters, and temperature.
Source§

fn uses_checkpoint_defaults(&self) -> bool

Whether loaded checkpoint defaults should wrap this policy.
Source§

fn grammar_is_complete(&mut self) -> Result<bool, B::Error>

Whether the committed generation grammar is complete.
Source§

fn prefix_is_complete(&self, _history: &[u32]) -> Result<bool, B::Error>

Whether an uncommitted logical prefix completes the grammar.
Source§

fn sample_processed( &self, logits: &B::Logits, temperature: f32, random: Option<&mut B::RandomState>, context: &B::Context, ) -> Result<B::Token, B::Error>

Selects from already processed logits.
Source§

fn commit_token( &mut self, _processed_logits: &B::Logits, _token: u32, _context: &B::Context, ) -> Result<(), B::Error>

Commits a token selected from a processed target distribution.

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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, <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.