Skip to main content

RegexGuidedProcessor

Struct RegexGuidedProcessor 

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

Hard-mask regex constraint processor.

Build with RegexGuidedProcessor::new(pattern, tokenizer, eos_token); use by adding as a high-priority logits processor before temperature / top-k / top-p.

Implementations§

Source§

impl RegexGuidedProcessor

Source

pub fn new( pattern: &str, tokenizer: Arc<dyn Tokenizer + Send + Sync>, eos_token: Option<TokenId>, ) -> Result<Self>

Build a guided-decoding processor for pattern. tokenizer is used to map each vocab entry to its byte representation.

Source

pub fn reset(&self) -> Result<()>

Reset for a new generation.

Source

pub fn can_accept(&self) -> bool

Check if the pattern can currently accept (i.e. EOS is valid here).

Source

pub fn mask_logits(&self, logits: &mut [f32])

Apply the hard mask to logits given the current DFA state.

Source

pub fn advance_with_tokens_public(&self, tokens: &[TokenId])

Public wrapper around advance_with_tokens for direct callers (the engine applies the mask inline rather than via LogitsProcessor::process).

Trait Implementations§

Source§

impl Debug for RegexGuidedProcessor

Source§

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

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

impl LogitsProcessor for RegexGuidedProcessor

Source§

fn process(&self, ctx: &mut SamplingContext<'_>) -> Result<()>

Process logits in-place
Source§

fn name(&self) -> &str

Get processor name for debugging/logging
Source§

fn priority(&self) -> ProcessorPriority

Whether this processor should be applied before others

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> 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, 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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V