Skip to main content

RotaryPositionalEncoding

Struct RotaryPositionalEncoding 

Source
pub struct RotaryPositionalEncoding<F: Float + Debug + NumAssign> { /* private fields */ }
Expand description

Rotary Positional Encoding (RoPE)

Implements rotary position embeddings as described in “RoFormer: Enhanced Transformer with Rotary Position Embedding”. RoPE encodes position information by rotating the query and key vectors, which has several advantages:

  • Relative position information is naturally encoded
  • Better length extrapolation than absolute position encodings
  • Used in modern LLMs like LLaMA, GPT-NeoX, etc.

Implementations§

Source§

impl<F: Float + Debug + NumAssign> RotaryPositionalEncoding<F>

Source

pub fn new(d_model: usize, max_len: usize, base: f64) -> Self

Create a new RoPE encoding

§Arguments
  • d_model - Model dimension (must be even)
  • max_len - Maximum sequence length
  • base - Base for frequency computation (default: 10000.0)
Source

pub fn default_base(d_model: usize, max_len: usize) -> Self

Create with default base (10000.0)

Source

pub fn rotate(&self, x: &Array3<F>, offset: usize) -> Result<Array3<F>>

Apply rotary embedding to query or key tensor

§Arguments
  • x - Input tensor of shape [batch, seq_len, d_model]
  • offset - Position offset (for KV cache during inference)
§Returns

Rotated tensor with same shape

Source

pub fn sin_cache(&self) -> &Array2<F>

Get sin cache

Source

pub fn cos_cache(&self) -> &Array2<F>

Get cos cache

Trait Implementations§

Source§

impl<F: Clone + Float + Debug + NumAssign> Clone for RotaryPositionalEncoding<F>

Source§

fn clone(&self) -> RotaryPositionalEncoding<F>

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<F: Debug + Float + Debug + NumAssign> Debug for RotaryPositionalEncoding<F>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<F: Float + Debug + NumAssign> PositionalEncoding<F> for RotaryPositionalEncoding<F>

Source§

fn encode(&self, seq_len: usize) -> Array2<F>

Encode positions for a sequence of given length Read more
Source§

fn apply(&self, input: &Array3<F>) -> Result<Array3<F>>

Apply positional encoding to an input tensor Read more
Source§

fn clone_box(&self) -> Box<dyn PositionalEncoding<F> + Send + Sync>
where F: Send + Sync + 'static,

Clone the positional encoding into a boxed trait object
Source§

fn d_model(&self) -> usize

Get the model dimension
Source§

fn max_len(&self) -> usize

Get the maximum sequence length supported
Source§

fn forward(&self, input: &Array<F, IxDyn>) -> Result<Array<F, IxDyn>>

Forward pass with dynamic array Read more
Source§

fn update(&mut self, _learning_rate: F) -> Result<()>

Update trainable parameters (for learned encodings) 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V