Skip to main content

ConstrainedSampler

Struct ConstrainedSampler 

Source
pub struct ConstrainedSampler<S, C> { /* private fields */ }
Expand description

Grammar-aware wrapper around a backend-neutral sampling policy.

Implementations§

Source§

impl<S, C> ConstrainedSampler<S, C>

Source

pub fn new(policy: S, controller: C) -> Self

Wraps a policy with a portable canonical constraint controller.

Source

pub const fn policy(&self) -> &S

Returns the wrapped policy.

Source

pub const fn controller(&self) -> &C

Returns the portable constraint controller.

Source

pub fn controller_mut(&mut self) -> &mut C

Returns the portable constraint controller mutably.

Trait Implementations§

Source§

impl<S: Clone, C: Clone> Clone for ConstrainedSampler<S, C>

Source§

fn clone(&self) -> Self

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<B, S, C> Sampler<B> for ConstrainedSampler<S, C>

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, S, C> SpeculativeSampler<B> for ConstrainedSampler<S, C>

Source§

fn supports_exact_optimistic_promotion(&self) -> bool

Whether optimistic draft work is an exact discardable fork.
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 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 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.
Source§

fn uses_checkpoint_defaults(&self) -> bool

Whether loaded checkpoint defaults should wrap this policy.

Auto Trait Implementations§

§

impl<S, C> Freeze for ConstrainedSampler<S, C>
where S: Freeze, C: Freeze,

§

impl<S, C> RefUnwindSafe for ConstrainedSampler<S, C>

§

impl<S, C> Send for ConstrainedSampler<S, C>
where S: Send, C: Send,

§

impl<S, C> Sync for ConstrainedSampler<S, C>
where S: Sync, C: Sync,

§

impl<S, C> Unpin for ConstrainedSampler<S, C>
where S: Unpin, C: Unpin,

§

impl<S, C> UnsafeUnpin for ConstrainedSampler<S, C>
where S: UnsafeUnpin, C: UnsafeUnpin,

§

impl<S, C> UnwindSafe for ConstrainedSampler<S, C>
where S: UnwindSafe, C: UnwindSafe,

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.