Struct tokenizers::processors::template::TemplateProcessing

pub struct TemplateProcessing { /* private fields */ }

This PostProcessor takes care of processing each input Encoding by applying the corresponding template, before merging them in the final Encoding.

A Template is actually a sequence of Piece that will be concatenated together in the given order. Each Piece represents either one of the input Encoding or a SpecialToken.

Example

let template = TemplateProcessing::builder()
    .try_single("[CLS] $A [SEP]").unwrap()
    .try_pair("[CLS] $A [SEP] $B:1 [SEP]:1").unwrap()
    .special_tokens(vec![("[CLS]", 1), ("[SEP]", 0)])
    .build()
    .unwrap();

Implementations

impl TemplateProcessing

pub fn builder() -> TemplateProcessingBuilder

Trait Implementations

impl Clone for TemplateProcessing

fn clone(&self) -> TemplateProcessing

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TemplateProcessing

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

Formats the value using the given formatter.

impl Default for TemplateProcessing

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TemplateProcessing

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<TemplateProcessing> for PostProcessorWrapper

fn from(from: TemplateProcessing) -> Self

Converts to this type from the input type.

impl PartialEq for TemplateProcessing

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PostProcessor for TemplateProcessing

fn added_tokens(&self, is_pair: bool) -> usize

Returns the number of tokens that will be added during the processing step

fn process_encodings( &self, encodings: Vec<Encoding>, add_special_tokens: bool ) -> Result<Vec<Encoding>>

Process any amount of encodings and returns a series of encoding (might merge them)

fn process( &self, encoding: Encoding, pair_encoding: Option<Encoding>, add_special_tokens: bool ) -> Result<Encoding>

Process both encodings and returns a new merged one

impl Serialize for TemplateProcessing

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for TemplateProcessing

impl StructuralPartialEq for TemplateProcessing