Skip to content

fast::rms_norm: accept Option<&Array> for weight #347

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Ogilthorp3 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fast::rms_norm: accept Option<&Array> for weight #347

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 13 additions & 7 deletions mlx-rs/src/fast.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,22 +182,28 @@ pub fn scaled_dot_product_attention_device<'a>(
/// # Params
///
/// - x: input array
/// - weight: A multiplicative weight to scale the result by. The `weight` should be one-dimensional with the same size as the last axis of `x`.
/// - weight: A multiplicative weight to scale the result by. The `weight` should be one-dimensional
/// with the same size as the last axis of `x`. If not given, no scaling will occur (matches
/// Python's `mx.fast.rms_norm(x, None, eps)` semantics — the underlying Metal kernel skips
/// the per-element multiply, saving a kernel pass).
/// - eps: A small additive constant for numerical stability
/// - stream: stream or device to evaluate on
#[generate_macro(customize(root = "$crate::fast"))]
#[default_device]
pub fn rms_norm_device(
x: impl AsRef<Array>,
weight: impl AsRef<Array>,
eps: f32,
pub fn rms_norm_device<'a>(
#[named] x: impl AsRef<Array>,
#[optional] weight: impl Into<Option<&'a Array>>,
#[named] eps: f32,
#[optional] stream: impl AsRef<Stream>,
) -> Result<Array> {
Array::try_from_op(|res| unsafe {
mlx_sys::mlx_fast_rms_norm(
res,
x.as_ref().as_ptr(),
weight.as_ref().as_ptr(),
weight
.into()
.map(|w| w.as_ptr())
.unwrap_or_else(|| mlx_sys::mlx_array_new()),
eps,
stream.as_ref().as_ptr(),
)
Expand Down Expand Up @@ -308,7 +314,7 @@ mod tests {
assert_eq!(a.dtype(), crate::Dtype::Float32);

let weight = Array::ones::<f32>(&[16]).unwrap();
let result = rms_norm(a, weight, 1e-5).unwrap();
let result = rms_norm(a, &weight, 1e-5).unwrap();
assert_eq!(result.shape(), [2, 8, 16]);
assert_eq!(result.dtype(), crate::Dtype::Float32);
assert_float_eq!(
Expand Down