Struct SinusoidalPositionalEncoding

pub struct SinusoidalPositionalEncoding {
    pub scale: f32,
    pub cosine_first: bool,
    /* private fields */
}

Implements sinusoidal positional encoding.

For more details see the paper “Attention Is All You Need” https://arxiv.org/abs/1706.03762.

Fields

scale: f32

multiplicative scale for the embeddings. Default is sqrt(2/dimensions)

cosine_first: bool

if true embed using [cos(x), sin(x)] instead of the reverse

Implementations

impl SinusoidalPositionalEncoding

pub const DEFAULT_COSINE_FIRST: bool = false

Default value for cosine_first field.

pub const DEFAULT_MIN_FREQUENCY: f32 = 9.99999974E-5f32

Default value for min frequency.

pub const DEFAULT_MAX_FREQUENCY: f32 = 1f32

Default value for max frequency.

pub const DEFAULT_FULL_TURNS: bool = false

Default value for full turns.

impl SinusoidalPositionalEncoding

pub fn new( dimensions: impl Into<i32>, ) -> Result<Self, <<Self as Buildable>::Builder as Builder<Self>>::Error>

Creates a new instance of SinusoidalPositionalEncoding.

Trait Implementations

impl Buildable for SinusoidalPositionalEncoding

type Builder = SinusoidalPositionalEncodingBuilder

The builder type for this buildable type

impl Builder<SinusoidalPositionalEncoding> for SinusoidalPositionalEncodingBuilder

type Error = Exception

Error with building

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

Build the type

impl Clone for SinusoidalPositionalEncoding

fn clone(&self) -> SinusoidalPositionalEncoding

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SinusoidalPositionalEncoding

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

Formats the value using the given formatter.

impl ModuleParameters for SinusoidalPositionalEncoding

fn freeze_parameters(&mut self, recursive: bool)

Freeze all parameters in the module.

fn unfreeze_parameters(&mut self, recursive: bool)

Unfreeze all parameters in the module.

fn parameters(&self) -> ModuleParamRef<'_>

Get references to the module parameters.

fn parameters_mut(&mut self) -> ModuleParamMut<'_>

Get mutable references to the module parameters.

fn trainable_parameters(&self) -> ModuleParamRef<'_>

Get references to the trainable parameters. A parameter is trainable if it is NOT frozen.

fn all_frozen(&self) -> Option<bool>

Check if all parameters in the module are frozen. Returns None if there are no parameters.

fn any_frozen(&self) -> Option<bool>

Check if any parameter in the module is frozen. Returns None if there are no parameters.

fn update(&mut self, parameters: ModuleParam)

Update the module parameters.

fn update_flattened(&mut self, flattened_parameters: FlattenedModuleParam)

Update the module parameters from a flattened representation.