Skip to main content

ReasoningBudget

Struct ReasoningBudget 

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

A sampler that caps how long a model may think.

Reasoning models emit an unbounded <think>…</think> block before their answer, and nothing in the model stops them running to the context limit. This watches for the start tag, counts down, and — when the budget is spent — forces the closing sequence token by token, masking everything else.

It is the piece llama.cpp pairs with a lazy grammar: the grammar leaves reasoning unconstrained by design, so something else has to bound it.

Build one with ReasoningBudget::new and add it to a LlamaSampler::chain, or let CommonSampler assemble it for you via CommonSamplerParams::set_reasoning_budget.

Implementations§

Source§

impl ReasoningBudget

Source

pub fn new( model: &LlamaModel, starts: &[Vec<LlamaToken>], ends: &[Vec<LlamaToken>], forced: &[LlamaToken], budget: i32, ) -> Result<Self, ShimError>

Build a budget sampler.

  • starts — tokenized opening tags; any one arms the countdown.
  • ends — tokenized closing tags; any one disarms it naturally.
  • forced — emitted when the budget runs out, usually a short message followed by a closing tag.
  • budget — tokens allowed inside the block.
§Errors

Returns CommonSamplerError::Failed if llama.cpp returns null.

Source

pub fn with_initial_state( model: &LlamaModel, starts: &[Vec<LlamaToken>], ends: &[Vec<LlamaToken>], forced: &[LlamaToken], budget: i32, initial_state: ReasoningBudgetState, ) -> Result<Self, ShimError>

Self::new with an explicit starting state — use ReasoningBudgetState::Counting when the prompt already opened a reasoning block, which is what a template with thinking_forced_open produces.

§Errors

Returns CommonSamplerError::Failed if llama.cpp returns null.

Source

pub fn state(&self) -> Option<ReasoningBudgetState>

Where the state machine currently is.

Source

pub fn force_end(&mut self) -> bool

Cut the reasoning block short now. Returns false if it was not counting.

Source

pub fn into_sampler(self) -> LlamaSampler

Take the underlying sampler, to add to a chain.

Trait Implementations§

Source§

impl Debug for ReasoningBudget

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

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more