Skip to main content

Decoder

Struct Decoder 

Source
pub struct Decoder<'a> { /* private fields */ }
Expand description

A decoding session: the KV caches, the ids that filled them, and the logits for whatever comes next. Built by TransformerLm::decoder.

Implementations§

Source§

impl<'a> Decoder<'a>

Source

pub fn fork(&self) -> Result<Decoder<'a>, NetworkError>

An independent copy of the session, history and caches included. A prefix every request shares, such as a system prompt or a few-shot preamble, is prefilled once and each request continues a fork:

let mut preamble = model.decoder();
preamble.feed(&[1, 2, 3, 4])?;
let mut request = preamble.fork()?;
request.feed(&[5, 6])?;
let id = request.next(&mut sampler)?;

On a device the copy takes as much memory as the original’s caches and shares its packed weights.

Source

pub fn feed(&mut self, ids: &[u32]) -> Result<(), NetworkError>

Appends ids to the session: a prompt, or the next turn of a conversation. Only these tokens are read, not the ones before them.

Source

pub fn next(&mut self, sampler: &mut Sampler) -> Result<u32, NetworkError>

Samples the next token and appends it to the session.

Source

pub fn logits(&mut self) -> Result<&[f32], NetworkError>

The next token’s logits, for choices Sampler does not make: constrained output, a logit bias, log-probabilities. Append the chosen id with push:

let mut decoder = model.decoder();
decoder.feed(&[1, 2, 3])?;
let logits = decoder.logits()?;
let id = *allowed.iter().max_by(|a, b| {
    logits[**a as usize].total_cmp(&logits[**b as usize])
}).unwrap();
decoder.push(id)?;
Source

pub fn push(&mut self, id: u32) -> Result<(), NetworkError>

Appends id as if next had sampled it, deferring its forward pass the same way.

Source

pub fn history(&self) -> &[u32]

Every id the session has seen, prompts and generated tokens alike.

Auto Trait Implementations§

§

impl<'a> Freeze for Decoder<'a>

§

impl<'a> RefUnwindSafe for Decoder<'a>

§

impl<'a> Send for Decoder<'a>

§

impl<'a> Sync for Decoder<'a>

§

impl<'a> Unpin for Decoder<'a>

§

impl<'a> UnsafeUnpin for Decoder<'a>

§

impl<'a> UnwindSafe for Decoder<'a>

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

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V