Struct TokenBias

Source
pub struct TokenBias(/* private fields */);
Expand description

A list of tokens to bias during the process of inferencing.

When a biased token is encountered, the bias will be used instead of the inferred logit during the sampling process.

This can be used to disable the generation of responses with specific tokens by setting their corresponding bias to -1.0.

Implementations§

Source§

impl TokenBias

Source

pub fn new(v: Vec<(TokenId, f32)>) -> Self

Create a TokenBias from an existing Vec.

Source

pub fn get(&self, tid: TokenId) -> Option<f32>

Retrieves the bias for a given token, if available.

Trait Implementations§

Source§

impl Clone for TokenBias

Source§

fn clone(&self) -> TokenBias

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TokenBias

Source§

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

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

impl Default for TokenBias

Source§

fn default() -> TokenBias

Returns the “default value” for a type. Read more
Source§

impl Display for TokenBias

Source§

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

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

impl FromStr for TokenBias

Source§

fn from_str(s: &str) -> Result<Self, Self::Err>

A comma separated list of token biases. The list should be in the format “TID=BIAS,TID=BIAS” where TID is an integer token ID and BIAS is a floating point number. For example, “1=-1.0,2=-1.0” sets the bias for token IDs 1 (start of document) and 2 (end of document) to -1.0 which effectively disables the model from generating responses containing those token IDs.

Source§

type Err = String

The associated error which can be returned from parsing.
Source§

impl PartialEq for TokenBias

Source§

fn eq(&self, other: &TokenBias) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for TokenBias

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> 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> 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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