Struct TransformerBuilder

pub struct TransformerBuilder {
    pub dimensions: i32,
    pub num_heads: i32,
    pub encoder_layer_count: usize,
    pub decoder_layer_count: usize,
    pub mlp_dimensions: Option<i32>,
    pub dropout: f32,
    pub activation: Option<Box<dyn Activation>>,
    pub norm_first: bool,
}

Builder for the Transformer module

Fields

dimensions: i32

number of expected features in the encoder/decoder

num_heads: i32

number of attention heads

encoder_layer_count: usize

number of layers in the encoder

decoder_layer_count: usize

number of layers in the decoder

mlp_dimensions: Option<i32>

hidden dimensions of the MLP block in each layer. Defaults to 4 * dimensions if not specified

dropout: f32

dropout value for the encode and decoder. Dropout is used after each attention layer and the activation in the MLP layer

activation: Option<Box<dyn Activation>>

the activation layer for the MLP hidden layer

norm_first: bool

if true encode and decoder layers will perform layer normalization before attention and MLP operations, otherwise after

Implementations

impl TransformerBuilder

pub fn new() -> Self

Creates a new TransformerBuilder.

impl TransformerBuilder

pub fn dimensions(self, dimensions: impl Into<i32>) -> Self

Sets the value of [dimensions].

pub fn num_heads(self, num_heads: impl Into<i32>) -> Self

Sets the value of [num_heads].

pub fn encoder_layer_count(self, encoder_layer_count: impl Into<usize>) -> Self

Sets the value of [encoder_layer_count].

pub fn decoder_layer_count(self, decoder_layer_count: impl Into<usize>) -> Self

Sets the value of [decoder_layer_count].

pub fn mlp_dimensions(self, mlp_dimensions: impl Into<Option<i32>>) -> Self

Sets the value of [mlp_dimensions].

pub fn dropout(self, dropout: impl Into<f32>) -> Self

Sets the value of [dropout].

pub fn activation( self, activation: impl Into<Option<Box<dyn Activation>>>, ) -> Self

Sets the value of [activation].

pub fn norm_first(self, norm_first: impl Into<bool>) -> Self

Sets the value of [norm_first].

Trait Implementations

impl Builder<Transformer> for TransformerBuilder

type Error = TransformerBulidError

Error with building

fn build(self) -> Result<Transformer, Self::Error>

Build the type

impl Clone for TransformerBuilder

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TransformerBuilder

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

Formats the value using the given formatter.