Struct Rope 

pub struct Rope {
    pub dims: usize,
    pub traditional: bool,
    pub base: f32,
    pub scale: f32,
}

Rotary position embedding of the first dims features (MLX’s nn.RoPE, the fused fast::rope). No parameters.

Fields

dims: usize

Rotated features.

traditional: bool

Rotate consecutive pairs (true) or the two halves (false, MLX’s default).

base: f32

The frequency base (MLX’s default 10000).

scale: f32

Scale applied to positions.

Implementations

impl Rope

pub fn new(dims: usize) -> Self

RoPE over dims features with MLX’s defaults (halves, base 10000, scale 1).

pub fn forward(&self, x: &Array, offset: usize) -> Result<Array>

x ([..., sequence, features]) rotated for positions offset, offset + 1, ….

Trait Implementations

impl Clone for Rope

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Rope

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

Formats the value using the given formatter.

impl Module for Rope

fn visit(&mut self, _: &mut Parameters<'_>)

Reports every parameter and submodule to p, frozen ones included.

fn parameters(&self) -> Vec<(String, Array)>

Every parameter with its path (layers.0.weight), in visiting order.

fn trainable_parameters(&self) -> Vec<(String, Array)>

The parameters that are trained (not frozen), with their paths.

fn update_trainable(&mut self, values: &[Array]) -> Result<()>

Replaces the trainable parameters, given in the order of Module::trainable_parameters (as optimizers return them).

fn load_weights( &mut self, weights: impl IntoIterator<Item = (String, Array)>, strict: bool, ) -> Result<()>

Replaces parameters by path, as MLX’s load_weights: each weight must have its parameter’s shape (the dtype is kept as loaded). With strict, every parameter must be given and no unknown names are allowed.