Struct TransformerEncoder 

pub struct TransformerEncoder {
    pub layers: Vec<TransformerEncoderLayer>,
    pub d_model: usize,
    pub d_ff: usize,
    pub n_heads: usize,
    pub n_layers: usize,
    pub dropout: f64,
    pub norm_first: bool,
    pub quiet_softmax: bool,
}

The transformer encoder module as describe in the paper Attention Is All You Need.

Params

• layers: transformer encoder layers with d_model input and output features.

Should be created using TransformerEncoderConfig

Fields

layers: Vec<TransformerEncoderLayer>

The transformer encoder layers.

d_model: usize

The size of the model.

d_ff: usize

The size of the position-wise feed-forward network.

n_heads: usize

The number of attention heads.

n_layers: usize

The number of layers.

dropout: f64

The dropout rate. Default: 0.1

norm_first: bool

Layer norm will be applied first instead of after the other modules.

quiet_softmax: bool

Use “quiet softmax” instead of regular softmax.

Implementations

impl TransformerEncoder

pub fn forward(&self, input: TransformerEncoderInput) -> Tensor<3>

Applies the forward pass on the input tensor.

Shapes

• tensor: [batch_size, seq_length, d_model]
• output: [batch_size, seq_length, d_model]

pub fn forward_autoregressive_inference( &self, input: TransformerEncoderInput, cache: &mut TransformerEncoderAutoregressiveCache, ) -> Tensor<3>

Applies the forward pass on the input tensor using autoregressive cache.

Shapes

• tensor: [batch_size, seq_length, d_model]
• output: [batch_size, seq_length, d_model]

pub fn new_autoregressive_cache(&self) -> TransformerEncoderAutoregressiveCache

Create an empty autoregressive cache.

Trait Implementations

impl Clone for TransformerEncoder

fn clone(&self) -> TransformerEncoder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TransformerEncoder

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

Formats the value using the given formatter.

impl Display for TransformerEncoder

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

Formats the value using the given formatter.

impl Module for TransformerEncoder

fn num_params(&self) -> usize

Get the number of parameters the module has, including all of its sub-modules, without initializing the ones not initialized yet.

fn visit<Visitor>(&self, visitor: &mut Visitor)

where Visitor: ModuleVisitor,

Visit each parameter and module-owned control value with a visitor.

fn map<Mapper>(self, mapper: &mut Mapper) -> TransformerEncoder

where Mapper: ModuleMapper,

Map each parameter and module-owned control value with a mapper.

fn collect_devices(&self, devices: Vec<Device>) -> Vec<Device>

Return all the devices found in the underneath module tree added to the given vector without duplicates.

fn to_device(self, device: &Device) -> TransformerEncoder

Move the module and all of its sub-modules to the given device.

fn fork(self, device: &Device) -> TransformerEncoder

Fork the module and all of its sub-modules to the given device.

fn valid(&self) -> TransformerEncoder

Returns a validation snapshot without autodiff or active training flags.

fn train(self) -> TransformerEncoder

Enables autodiff and restores configured training state throughout the module.

fn materialize(self) -> TransformerEncoder

Fold parameter reparameterizations into their effective values and remove them.

fn devices(&self) -> Vec<Device>

Return all the devices found in the underneath module tree without duplicates.

fn set_require_grad(self, require_grad: bool) -> Self

Set whether every floating-point tensor parameter in the module tree requires gradients.

fn set_require_grad_group(self, group: ParamGroup, require_grad: bool) -> Self

Set whether matched floating-point tensor parameters require gradients.

fn no_grad(self) -> Self

Disable gradients for every floating-point tensor parameter in the module tree.

fn freeze(self) -> Self

Freeze the whole module tree.

fn unfreeze(self) -> Self

Unfreeze the whole module tree.

fn freeze_group(self, group: ParamGroup) -> Self

Freeze every module-owned value in the given group, leaving the rest of the module untouched.

fn unfreeze_group(self, group: ParamGroup) -> Self

Unfreeze every module-owned value in the given group, leaving the rest of the module untouched.

fn quantize_weights(self, quantizer: &mut Quantizer) -> Self

Quantize the weights of the module.

fn quantize_weights_group( self, quantizer: &mut Quantizer, group: ParamGroup, ) -> Self

Quantize the weights of the given parameter group.

fn apply_reparameterization<R>(self, reparameterizer: R) -> Self

where Self: Sized, R: Reparameterizer,

Attach reparameterizations using the given Reparameterizer.

fn apply_lora(self, lora: Lora) -> Self

where Self: Sized,

Attach LoRA adapters to the module’s 2-D weights, freezing all base tensor parameters.

fn apply_qlora(self, qlora: QLora) -> Self

where Self: Sized,

Apply QLoRA to the module: quantize the (frozen) base tensor parameters and attach trainable LoRA adapters to 2-D weights.

fn into_record(self) -> ModuleRecord

where Self: Sized,

Collect this module’s tensor parameters into a ModuleRecord.

fn into_record_group(self, group: ParamGroup) -> ModuleRecord

where Self: Sized,

Collect the tensor parameters group names into a ModuleRecord.

fn try_load_record(self, record: ModuleRecord) -> Result<Self, RecordError>

where Self: Sized,

Apply a ModuleRecord to this module, returning the loaded module.

fn load_record(self, record: ModuleRecord) -> Self

where Self: Sized,

Apply a ModuleRecord to this module, consuming and returning it.

fn save_file<P>(self, path: P) -> Result<(), RecordError>

where P: AsRef<Path>, Self: Sized,

Save this module’s parameters to a burnpack file on disk.

fn load_file<P>(self, path: P) -> Self

where P: AsRef<Path>, Self: Sized,

Load this module’s parameters from a burnpack file on disk, returning the loaded module.

fn try_load_file<P>(self, path: P) -> Result<Self, RecordError>

where P: AsRef<Path>, Self: Sized,

Fallible variant of load_file.

impl ModuleDisplay for TransformerEncoder

fn custom_settings(&self) -> Option<DisplaySettings>

Custom display settings for the module.

fn custom_content(&self, content: Content) -> Option<Content>

Custom attributes for the module.

fn format(&self, passed_settings: DisplaySettings) -> String

Formats the module with provided display settings.

impl ModuleDisplayDefault for TransformerEncoder

fn content(&self, content: Content) -> Option<Content>

Attributes of the module used for display purposes.

fn num_params(&self) -> usize

Gets the number of the parameters of the module.