Skip to main content

RotaryPositionEncoding

Struct RotaryPositionEncoding 

Source
pub struct RotaryPositionEncoding {
    pub config: PositionEncodingConfig,
}
Expand description

Rotary Position Embedding (RoPE)

Used in models like LLaMA, GPT-NeoX, PaLM. RoPE encodes position by rotating query and key vectors in the complex plane, providing natural relative position information without adding extra parameters.

Reference: “RoFormer: Enhanced Transformer with Rotary Position Embedding” https://arxiv.org/abs/2104.09864

Fields§

§config: PositionEncodingConfig

Configuration

Implementations§

Source§

impl RotaryPositionEncoding

Source

pub fn new(config: PositionEncodingConfig) -> Result<Self>

Create a new rotary position encoding

Source

pub fn build_encoding_graph( &self, graph: &mut EinsumGraph, ) -> Result<Vec<usize>>

Build einsum graph for RoPE

RoPE applies rotation to query and key vectors in attention:

  • Splits d_model into pairs of dimensions
  • Rotates each pair by position-dependent angle
  • Preserves relative position information

Input tensors:

  • 0: x (input) [batch, seq_len, d_model]
  • 1: cos_cached [max_seq_len, d_model/2] (precomputed cosines)
  • 2: sin_cached [max_seq_len, d_model/2] (precomputed sines)

Output tensors:

  • output: [batch, seq_len, d_model] (rotated embeddings)
Source

pub fn base(&self) -> f64

Get the base frequency for RoPE

Source

pub fn scaling_factor(&self) -> f64

Get the scaling factor for long sequences

Trait Implementations§

Source§

impl Clone for RotaryPositionEncoding

Source§

fn clone(&self) -> RotaryPositionEncoding

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RotaryPositionEncoding

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.