pub struct TokenizerInfo { /* private fields */ }Expand description
Decoded-vocabulary view of a tokenizer for grammar-constrained decoding.
Construct with TokenizerInfo::new from a raw vocabulary, or with
TokenizerInfo::from_huggingface to additionally infer the vocab
type / prefix-space from a tokenizer.json.
Implementations§
Source§impl TokenizerInfo
impl TokenizerInfo
Sourcepub fn new(
encoded_vocab: &[String],
vocab_type: VocabType,
vocab_size: Option<usize>,
stop_token_ids: Option<Vec<i32>>,
add_prefix_space: bool,
) -> Self
pub fn new( encoded_vocab: &[String], vocab_type: VocabType, vocab_size: Option<usize>, stop_token_ids: Option<Vec<i32>>, add_prefix_space: bool, ) -> Self
Build a TokenizerInfo from a raw (encoded) vocabulary.
Mirrors the C++ TokenizerInfo constructor:
encoded_vocab— raw vocabulary strings, indexed by token id.vocab_type— controls token decoding (seeVocabType).vocab_size— total id space;Nonemeansencoded_vocab.len(). When larger, the trailing ids become padding special tokens.stop_token_ids— explicit stop ids;Nonetriggers detection viaDETECTION_STOP_TOKENS.add_prefix_space— recorded for metadata, no decoding effect.
Sourcepub fn from_huggingface(
encoded_vocab: &[String],
tokenizer_json: &str,
vocab_size: Option<usize>,
stop_token_ids: Option<Vec<i32>>,
) -> Result<Self, String>
pub fn from_huggingface( encoded_vocab: &[String], tokenizer_json: &str, vocab_size: Option<usize>, stop_token_ids: Option<Vec<i32>>, ) -> Result<Self, String>
Build a TokenizerInfo from the raw text of a HuggingFace
tokenizer.json, inferring vocab_type and add_prefix_space.
Returns Err when tokenizer_json is not a parseable JSON
object. The caller still supplies the raw vocabulary, optional
vocab_size, and optional stop_token_ids.
Sourcepub fn vocab_type(&self) -> VocabType
pub fn vocab_type(&self) -> VocabType
The vocabulary type.
Sourcepub fn vocab_size(&self) -> usize
pub fn vocab_size(&self) -> usize
The total id space size (raw vocab length, or the override).
Sourcepub fn add_prefix_space(&self) -> bool
pub fn add_prefix_space(&self) -> bool
Whether the tokenizer prepends a space to the first token.
Sourcepub fn decoded_vocab(&self) -> &[Vec<u8>]
pub fn decoded_vocab(&self) -> &[Vec<u8>]
Decoded token bytes, indexed by token id (length vocab_size).
Sourcepub fn stop_token_ids(&self) -> &[i32]
pub fn stop_token_ids(&self) -> &[i32]
Ids accepted as end-of-generation by the grammar matcher.
Sourcepub fn special_token_ids(&self) -> &[i32]
pub fn special_token_ids(&self) -> &[i32]
Ids masked out during grammar-guided generation.
Sourcepub fn sorted_decoded_vocab(&self) -> &[(i32, Vec<u8>)]
pub fn sorted_decoded_vocab(&self) -> &[(i32, Vec<u8>)]
(id, token) pairs sorted lexicographically by token bytes,
excluding stop and special tokens.
Sourcepub fn trie_subtree_nodes_range(&self) -> &[i32]
pub fn trie_subtree_nodes_range(&self) -> &[i32]
Pseudo-trie subtree end-indices over Self::sorted_decoded_vocab.
Sourcepub fn fingerprint(&self) -> u64
pub fn fingerprint(&self) -> u64
A PROCESS-STABLE digest of everything an adaptive token mask depends on: the vocab type / size / prefix-space flag, the sorted decoded vocabulary (ids and bytes, in order), and the stop / special id sets.
#918: the on-disk mask snapshot
(crate::compiler::mask_snapshot) is only valid for the exact
tokenizer it was computed against — a mask is a partition of
Self::sorted_decoded_vocab by index. This is the key that
decides hit vs miss across processes, so it is FNV-1a with a
fixed basis rather than ahash/DefaultHasher, whose seeds are
randomized per process.
Sourcepub fn dump_metadata(&self) -> String
pub fn dump_metadata(&self) -> String
Serialize the metadata to the compact JSON form C++
DumpMetadata emits:
{"vocab_type":N,"vocab_size":N,"add_prefix_space":b,"stop_token_ids":[...]}.
Trait Implementations§
Source§impl Clone for TokenizerInfo
impl Clone for TokenizerInfo
Source§fn clone(&self) -> TokenizerInfo
fn clone(&self) -> TokenizerInfo
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for TokenizerInfo
impl Debug for TokenizerInfo
Source§impl PartialEq for TokenizerInfo
impl PartialEq for TokenizerInfo
impl Eq for TokenizerInfo
impl StructuralPartialEq for TokenizerInfo
Auto Trait Implementations§
impl Freeze for TokenizerInfo
impl RefUnwindSafe for TokenizerInfo
impl Send for TokenizerInfo
impl Sync for TokenizerInfo
impl Unpin for TokenizerInfo
impl UnwindSafe for TokenizerInfo
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Conv for T
impl<T> Conv for T
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self to use its Binary implementation when Debug-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self to use its Display implementation when
Debug-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self to use its LowerExp implementation when
Debug-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self to use its LowerHex implementation when
Debug-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self to use its Octal implementation when Debug-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self to use its Pointer implementation when
Debug-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self to use its UpperExp implementation when
Debug-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self to use its UpperHex implementation when
Debug-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self, then passes self.as_ref() into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self, then passes self.as_mut() into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow() only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut() only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref() only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut() only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.