Struct RotaryEncoding 

pub struct RotaryEncoding {
    pub freq_complex: Tensor<3>,
    pub theta: Tensor<1>,
    /* private fields */
}

A module that applies rotary positional encoding to a tensor. Rotary Position Encoding or Embedding (RoPE), is a type of position embedding which encodes absolute positional information with rotation matrix and naturally incorporates explicit relative position dependency in self-attention formulation.

Introduced in the paper: RoFormer: Enhanced Transformer with Rotary Position Embedding

Should be created using RotaryEncodingConfig.

Fields

freq_complex: Tensor<3>

Complex frequency tensor of shape (max_sequence_length, d_model, 2) with real and imaginary components

theta: Tensor<1>

Frequency vector used to compute/apply the complex rotations.

Implementations

impl RotaryEncoding

pub fn forward<const D: usize>(&self, x: Tensor<D>) -> Tensor<D>

Applies rotary positional encoding to a tensor of dimensions (…, seq_len, d_model)

Arguments:

• x - Input tensor of shape (…, seq_len, d_model). Accommodate both 3D and 4D tensors for (batch size, seq_len, hidden_dim) or (batch size, num_heads, seq_len, hidden_dim) respectively.

Returns:

Output tensor with the same shape as input tensor after applying rotary encoding.

Panics

If the input has fewer than 2 dimensions or its last axis is not d_model.

pub fn apply<const D: usize>(&self, x: Tensor<D>, start: usize) -> Tensor<D>

Applies rotary positional encoding to a tensor of dimensions (…, seq_len, d_model)

Arguments:

• x - Input tensor of shape (…, seq_len, d_model). Accommodate both 3D and 4D tensors for (batch size, seq_len, hidden_dim) or (batch size, num_heads, seq_len, hidden_dim) respectively.
• start - Sequence start position index.

Returns:

Output tensor with the same shape as input tensor after applying rotary encoding.

Panics

If the input has fewer than 2 dimensions or its last axis is not d_model.

pub fn shift(&mut self, start: usize)

Shifts the pre-computed rotary frequency to cover a new range of positions.

This method updates the internal frequency tensor freq_complex to store the rotary positional encodings for a new window of positions starting at start.

pub fn reset(&mut self)

Resets the pre-computed rotary frequency window to start at position 0.

Trait Implementations

impl Clone for RotaryEncoding

fn clone(&self) -> RotaryEncoding

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RotaryEncoding

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

Formats the value using the given formatter.

impl Display for RotaryEncoding

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

Formats the value using the given formatter.

impl Module for RotaryEncoding

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) -> RotaryEncoding

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) -> RotaryEncoding

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

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

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

fn valid(&self) -> RotaryEncoding

Returns a validation snapshot without autodiff or active training flags.

fn train(self) -> RotaryEncoding

Enables autodiff and restores configured training state throughout the module.

fn materialize(self) -> RotaryEncoding

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 RotaryEncoding

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 RotaryEncoding

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.