Skip to main content

StopTokens

Struct StopTokens 

Source
pub struct StopTokens { /* private fields */ }
Expand description

The set of token ids a decode loop must stop on, carried as one value so a caller cannot accidentally carry only half of it.

This type exists because Option<usize> was the shape of a real bug: every ferrox-server decode loop threaded a single eos_id from the loader to the sampler, so a Llama-3 or gemma checkpoint served over HTTP ran past <|eot_id|> / <end_of_turn> to max_tokens even after eog_token_ids landed for the CLI. Passing a StopTokens makes “I only have the metadata EOS” an explicit choice (StopTokens::from_eos, for the synthetic-weights and Kimi paths that have no GGUF metadata to read) rather than the default.

Implementations§

Source§

impl StopTokens

Source

pub fn from_gguf(file: &impl TensorSource) -> Self

Everything eog_token_ids finds in this checkpoint: the eos/eot/eom metadata ids plus every vocabulary entry whose text is on llama.cpp’s literal EOG list.

Source

pub fn from_eos(eos: Option<usize>) -> Self

Just the one id. For callers with no GGUF metadata behind them — the synthetic random-weights demo model, and the Kimi checkpoint directory whose tokenizer is a separate file format.

Source

pub fn from_special_tokens<'a>( specials: impl IntoIterator<Item = (&'a str, u32)>, ) -> Self

For checkpoints whose vocabulary is not GGUF metadata — Kimi K3 ships a tokenizer_config.json with a name→id special-token map. Folds in every entry whose text is on llama.cpp’s EOG list, so [EOT] stops a turn there exactly as it does in a GGUF.

Source

pub fn with_id(self, id: Option<usize>) -> Self

Folds one more id in — used to keep a metadata eos_token_id that a vocabulary spells in a way the literal list does not know.

Source

pub fn contains(&self, id: usize) -> bool

Source

pub fn is_empty(&self) -> bool

Source

pub fn len(&self) -> usize

Trait Implementations§

Source§

impl Clone for StopTokens

Source§

fn clone(&self) -> StopTokens

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 StopTokens

Source§

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

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

impl Default for StopTokens

Source§

fn default() -> StopTokens

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

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.