Struct burn::nn::transformer::TransformerEncoder

pub struct TransformerEncoder<B>
where
    B: Backend,
{
    pub layers: Vec<TransformerEncoderLayer<B>>,
    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<B>>

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<B> TransformerEncoder<B>

where B: Backend,

pub fn forward(&self, input: TransformerEncoderInput<B>) -> Tensor<B, 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<B>, cache: &mut TransformerEncoderAutoregressiveCache<B>, ) -> Tensor<B, 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<B>

Create an empty autoregressive cache.

Trait Implementations

impl<B> AutodiffModule<B> for TransformerEncoder<B>

where B: Backend + AutodiffBackend, <B as AutodiffBackend>::InnerBackend: Backend,

type InnerModule = TransformerEncoder<<B as AutodiffBackend>::InnerBackend>

Inner module without auto-differentiation.

fn valid(&self) -> <TransformerEncoder<B> as AutodiffModule<B>>::InnerModule

Get the same module, but on the inner backend without auto-differentiation.

impl<B> Clone for TransformerEncoder<B>

where B: Backend,

fn clone(&self) -> TransformerEncoder<B>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<B> Debug for TransformerEncoder<B>

where B: Debug + Backend,

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

Formats the value using the given formatter.

impl<B> Display for TransformerEncoder<B>

where B: Backend,

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

Formats the value using the given formatter.

impl<B> Module<B> for TransformerEncoder<B>

where B: Backend,

type Record = TransformerEncoderRecord<B>

Type to save and load the module.

fn load_record( self, record: <TransformerEncoder<B> as Module<B>>::Record, ) -> TransformerEncoder<B>

Load the module state from a record.

fn into_record(self) -> <TransformerEncoder<B> as Module<B>>::Record

Convert the module into a record containing the state.

fn num_params(&self) -> usize

Get the number of parameters the module has, including all of its sub-modules.

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

where Visitor: ModuleVisitor<B>,

Visit each tensor parameter in the module with a visitor.

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

where Mapper: ModuleMapper<B>,

Map each tensor parameter in the module with a mapper.

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

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

fn to_device(self, device: &<B as Backend>::Device) -> TransformerEncoder<B>

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

fn fork(self, device: &<B as Backend>::Device) -> TransformerEncoder<B>

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

fn devices(&self) -> Vec<<B as Backend>::Device>

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

fn no_grad(self) -> Self

Each tensor in the module tree will not require grad.

fn save_file<FR, PB>( self, file_path: PB, recorder: &FR, ) -> Result<(), RecorderError>

where FR: FileRecorder<B>, PB: Into<PathBuf>,

Save the module to a file using the provided file recorder.

fn load_file<FR, PB>( self, file_path: PB, recorder: &FR, device: &<B as Backend>::Device, ) -> Result<Self, RecorderError>

where FR: FileRecorder<B>, PB: Into<PathBuf>,

Load the module from a file using the provided file recorder.

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

where C: Calibration,

Quantize the weights of the module.

impl<B> ModuleDisplay for TransformerEncoder<B>

where B: Backend,

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<B> ModuleDisplayDefault for TransformerEncoder<B>

where B: Backend,

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.