Skip to main content

NgramMap

Struct NgramMap 

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

An adaptive in-context n-gram drafter.

Like NgramCache it indexes repeated n-grams, but it also records how many tokens each of its own drafts got accepted and uses that to decide whether to draft again — so a context where lookup is not paying off stops costing anything. Feed results back with Self::accept.

State lives only in memory and only for this generation; call Self::begin when starting a new one.

Wraps common_ngram_map.

Implementations§

Source§

impl NgramMap

Source

pub fn new( size_key: u16, size_value: u16, key_only: bool, min_hits: u16, ) -> Result<Self, NgramError>

Build a map.

  • size_key — length of the n-grams used as lookup keys.
  • size_value — length of the continuations drafted.
  • key_only — index keys without tracking continuations, which is cheaper but drafts nothing on its own.
  • min_hits — how many times a key must recur before it is trusted.
§Errors

Returns NgramError::Failed if llama.cpp cannot allocate the map — it reserves a 2^18-entry hash table up front.

Source

pub fn begin(&mut self, tokens: &[LlamaToken]) -> Result<(), NgramError>

Start a generation over tokens (the prompt).

§Errors

Returns NgramError::Failed if llama.cpp throws.

Source

pub fn draft( &mut self, tokens: &[LlamaToken], sampled: LlamaToken, ) -> Result<Vec<LlamaToken>, NgramError>

Draft a continuation, given everything generated so far and the token just sampled.

Returns an empty draft when the map decides lookup is not worth it here.

§Errors

Returns NgramError::Failed if llama.cpp throws.

Source

pub fn accept(&mut self, n_accepted: u16)

Report how many of the last draft’s tokens the target model accepted.

This is what makes the map adaptive; skipping it leaves it drafting blind.

Trait Implementations§

Source§

impl Debug for NgramMap

Source§

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

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

impl Drop for NgramMap

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more
Source§

impl Send for NgramMap

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