Skip to main content

SpeculativeDecoder

Struct SpeculativeDecoder 

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

Async speculative decoder.

Wraps a draft engine (generating spec_k candidates per step) and a target engine (verifying the candidates in a single batched forward pass). The two engines run with overlap via tokio.

§Limitations

  • Both engines must use the same tokenizer and vocabulary.
  • The draft engine must be strictly smaller/faster than the target.
  • The target engine must implement Rewindable (KV-cache based). For SSM targets use SpeculativeDecoder::new_n1 which forces N=1 mode.

§Example

let decoder = SpeculativeDecoder::new(
    draft_engine,
    target_engine,
    AsyncSpecConfig::default(),
);
let stats = decoder.generate("hello", 128, |tok| print!("{tok}")).await?;

Implementations§

Source§

impl SpeculativeDecoder

Source

pub fn new( draft: InferenceEngine, target: InferenceEngine, config: AsyncSpecConfig, ) -> Self

Construct a new async speculative decoder.

Both engines must be loaded (i.e. is_loaded() is true) before generate is called.

Source

pub fn new_n1( draft: InferenceEngine, target: InferenceEngine, config: AsyncSpecConfig, ) -> Self

Construct a decoder that always uses N=1 mode (for SSM targets).

Source

pub fn stats(&self) -> &SpecStats

Return the accumulated statistics from all generate calls.

Source

pub fn reset_stats(&mut self)

Reset statistics counters.

Source

pub fn cancellation_token(&self) -> CancellationToken

Return a reference to the cancellation token for external cancellation.

Source

pub async fn generate<F>( &mut self, prompt: &str, on_token: F, ) -> RuntimeResult<String>
where F: FnMut(&str) + Send + 'static,

Run async speculative generation for prompt, calling on_token for each decoded token.

Returns the full generated text and updates self.stats.

§SSM fallback

If the target engine’s rewind() returns RewindError::NotSupported on the first call, the decoder automatically falls back to N=1 mode for the rest of the generation. SpecStats::n1_fallbacks is incremented.

§Cancellation

The generation loop checks self.cancel after each speculation step. Callers can cancel by calling cancel.cancel() from another task.

§Errors

Returns RuntimeError::ModelNotLoaded if either engine is not loaded. Returns RuntimeError::Cancelled if the cancellation token is triggered before the first token is produced.

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> 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

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