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>
impl<F: Float + Debug + NumAssign> RotaryPositionalEncoding<F>
Sourcepub fn new(d_model: usize, max_len: usize, base: f64) -> Self
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 lengthbase- Base for frequency computation (default: 10000.0)
Sourcepub fn default_base(d_model: usize, max_len: usize) -> Self
pub fn default_base(d_model: usize, max_len: usize) -> Self
Create with default base (10000.0)
Trait Implementations§
Source§impl<F: Clone + Float + Debug + NumAssign> Clone for RotaryPositionalEncoding<F>
impl<F: Clone + Float + Debug + NumAssign> Clone for RotaryPositionalEncoding<F>
Source§fn clone(&self) -> RotaryPositionalEncoding<F>
fn clone(&self) -> RotaryPositionalEncoding<F>
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl<F: Float + Debug + NumAssign> PositionalEncoding<F> for RotaryPositionalEncoding<F>
impl<F: Float + Debug + NumAssign> PositionalEncoding<F> for RotaryPositionalEncoding<F>
Source§fn encode(&self, seq_len: usize) -> Array2<F>
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>>
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>
fn clone_box(&self) -> Box<dyn PositionalEncoding<F> + Send + Sync>
Clone the positional encoding into a boxed trait object
Auto Trait Implementations§
impl<F> Freeze for RotaryPositionalEncoding<F>
impl<F> RefUnwindSafe for RotaryPositionalEncoding<F>where
F: RefUnwindSafe,
impl<F> Send for RotaryPositionalEncoding<F>where
F: Send,
impl<F> Sync for RotaryPositionalEncoding<F>where
F: Sync,
impl<F> Unpin for RotaryPositionalEncoding<F>
impl<F> UnsafeUnpin for RotaryPositionalEncoding<F>
impl<F> UnwindSafe for RotaryPositionalEncoding<F>where
F: RefUnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
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
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
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.