Skip to main content

PenaltyWindow

Struct PenaltyWindow 

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

The tokens the penalties may see: a prompt and the tokens generated after it, in that order.

Borrowed rather than owned because this is built once per sampled token on every decode loop in the workspace; an owning window would clone the whole sequence per token.

The two halves are kept separate rather than concatenated because a decode loop already holds them separately, and concatenating would mean an allocation per token for a value only ever read back as “the last N of the two”.

Implementations§

Source§

impl<'a> PenaltyWindow<'a>

Source

pub fn new(prompt: &'a [usize], generated: &'a [usize]) -> Self

The window over prompt followed by generated.

prompt is the tokens the model was fed before generation started, and it belongs in the window: see the module docs for the llama.cpp lines that put it there.

Source

pub fn len(&self) -> usize

Total tokens in the sequence, before penalty_last_n truncates it.

Source

pub fn is_empty(&self) -> bool

Source

pub fn recent(&self, last_n: usize) -> impl Iterator<Item = usize> + '_

The most recent last_n tokens of prompt ++ generated, oldest first.

This is llama.cpp’s ring buffer expressed as a view: the buffer holds at most penalty_last_n entries and the oldest is dropped on every accept (src/llama-sampler.cpp:2707-2716), so its contents are exactly the tail of the accepted sequence.

Order does not matter to any caller – only the multiset does – but it is the natural one anyway, and a test reads it.

Trait Implementations§

Source§

impl<'a> Clone for PenaltyWindow<'a>

Source§

fn clone(&self) -> PenaltyWindow<'a>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for PenaltyWindow<'a>

Source§

impl<'a> Debug for PenaltyWindow<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for PenaltyWindow<'a>

§

impl<'a> RefUnwindSafe for PenaltyWindow<'a>

§

impl<'a> Send for PenaltyWindow<'a>

§

impl<'a> Sync for PenaltyWindow<'a>

§

impl<'a> Unpin for PenaltyWindow<'a>

§

impl<'a> UnsafeUnpin for PenaltyWindow<'a>

§

impl<'a> UnwindSafe for PenaltyWindow<'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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.