Skip to main content

EncodeConfig

Struct EncodeConfig 

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

Configuration for encode_with / encode_batch.

Build it fluently:

use tpt_tokenizer_core::encoding::{EncodeConfig, Padding, Truncation};

let cfg = EncodeConfig::new()
    .with_bos(1)
    .with_eos(2)
    .with_pad(0)
    .padding(Padding::Longest)
    .truncation(Truncation::Fixed(128));

Implementations§

Source§

impl EncodeConfig

Source

pub fn new() -> Self

A config that adds no special tokens and applies no padding or truncation — equivalent to a plain Tokenizer::encode, but wrapped in an Encoding with an attention mask.

Source

pub fn with_bos(self, id: TokenId) -> Self

Set the beginning-of-sequence token id to prepend (enables special-token insertion).

Source

pub fn with_eos(self, id: TokenId) -> Self

Set the end-of-sequence token id to append (enables special-token insertion).

Source

pub fn with_pad(self, id: TokenId) -> Self

Set the padding token id. Required for any Padding other than Padding::None.

Source

pub fn add_special_tokens(self, yes: bool) -> Self

Enable or disable BOS/EOS insertion without changing the ids.

Source

pub fn padding(self, padding: Padding) -> Self

Set the padding strategy.

Source

pub fn truncation(self, truncation: Truncation) -> Self

Set the truncation strategy.

Trait Implementations§

Source§

impl Clone for EncodeConfig

Source§

fn clone(&self) -> EncodeConfig

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 Debug for EncodeConfig

Source§

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

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

impl Default for EncodeConfig

Source§

fn default() -> EncodeConfig

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

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