Skip to main content

RuleGuidedBeamSearch

Struct RuleGuidedBeamSearch 

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

High-level composition of a beam-search decoder, a logical constraint and a masking strategy.

Implementations§

Source§

impl RuleGuidedBeamSearch

Source

pub fn new( config: BeamSearchConfig, constraint: RuleConstraint, masker: Arc<dyn LogitMasker>, ) -> Self

Construct a decoder with an explicit beam-search configuration.

Source

pub fn config(&self) -> &BeamSearchConfig

Read-only access to the underlying beam-search configuration.

Source

pub fn constraint(&self) -> &RuleConstraint

Read-only access to the compiled constraint.

Source

pub fn masker_name(&self) -> &'static str

Return the masker’s name ("HardMask" / "SoftPenaltyMask" / …).

Source

pub fn decode<F>( &self, bos_token_id: usize, score_fn: F, ) -> RuleGuidedResult<BeamSearchResult>
where F: Fn(&[&[usize]]) -> Result<Vec<Vec<f64>>, String>,

Run the decoder.

score_fn is the same “raw logits” closure accepted by BeamSearchDecoder::decode. The engine wraps it so that every row of the returned [num_beams][vocab_size] logit matrix is filtered through the configured LogitMasker before being passed on.

Trait Implementations§

Source§

impl Debug for RuleGuidedBeamSearch

Source§

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

Formats the value using the given formatter. 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> 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, 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