Enum RopeScaling 

#[non_exhaustive]
pub enum RopeScaling {
    None,
    Linear {
        factor: f32,
    },
    Llama3(Llama3),
    Yarn(Yarn),
    LongRope(LongRope),
    Proportional {
        rotated_dims: i32,
        factor: f32,
    },
}

How a rotary embedding’s frequencies (or positions) are scaled, as mlx-lm’s RoPE classes. Frequencies are computed in float32 with mlx-lm’s formulas.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

None

The plain base^(-2i/dims) frequencies (default).

Linear

Positions divided by factor (linear).

Fields

factor: f32

The division factor.

Llama3(Llama3)

Llama 3’s frequency-dependent scaling (Llama3RoPE).

Yarn(Yarn)

YaRN (YarnRoPE): interpolated frequencies and an input scale (mscale).

LongRope(LongRope)

LongRoPE (SuScaledRoPE): per-pair long factors and an input scale.

Proportional

Gemma 4’s proportional RoPE (ProportionalRoPE): the first rotated_dims of the head’s features rotate with exponents over the whole head, scaled by factor; the rest keep their values (infinite wavelength).

Fields

rotated_dims: i32

Features that rotate (a multiple of 2, at most the head’s).

factor: f32

The frequencies’ scale.

Implementations

impl RopeScaling

pub fn frequencies(&self, dims: i32, base: f32) -> Option<Array>

The per-pair frequencies ([dims / 2], float32) for dims rotated features and base, or None when the plain base (and RopeScaling::position_scale) applies.

pub fn mscale(&self) -> f32

The scale mlx-lm applies to the rotated features before the rotation (YaRN’s mscale, LongRoPE’s; 1 otherwise).

pub fn position_scale(&self) -> f32

The scale of positions (1 / factor for RopeScaling::Linear; 1 otherwise).

Trait Implementations

impl Clone for RopeScaling

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 RopeScaling

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

Formats the value using the given formatter.

impl PartialEq for RopeScaling

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Static for RopeScaling

fn hash_static(&self, __h: &mut dyn Hasher)

Feeds the value to h.

impl StructuralPartialEq for RopeScaling