Index

_

__init__() (array method) (custom_function method) (Device method) (Dtype method) (DtypeCategory method) (Group method) (Stream method)

A

abs (C++ function) abs() (array method) (in module mlx.core) AdaDelta (class in mlx.optimizers) Adafactor (class in mlx.optimizers) Adagrad (class in mlx.optimizers) Adam (class in mlx.optimizers) Adamax (class in mlx.optimizers) AdamW (class in mlx.optimizers) add (C++ function) add() (in module mlx.core) addmm (C++ function) addmm() (in module mlx.core) ALiBi (class in mlx.nn) all (C++ function), [1], [2], [3] all() (array method) (in module mlx.core) all_gather() (in module mlx.core.distributed) all_sum() (in module mlx.core.distributed) allclose (C++ function) allclose() (in module mlx.core) any (C++ function), [1], [2], [3] any() (array method) (in module mlx.core) apply() (Module method) apply_gradients() (Optimizer method) apply_to_modules() (Module method) arange (C++ function), [1], [2], [3], [4], [5], [6], [7], [8] arange() (in module mlx.core) arccos (C++ function) arccos() (in module mlx.core) arccosh (C++ function) arccosh() (in module mlx.core) arcsin (C++ function) arcsin() (in module mlx.core)

arcsinh (C++ function) arcsinh() (in module mlx.core) arctan (C++ function) arctan() (in module mlx.core) arctan2 (C++ function) arctan2() (in module mlx.core) arctanh (C++ function) arctanh() (in module mlx.core) argmax (C++ function), [1], [2] argmax() (array method) (in module mlx.core) argmin (C++ function), [1], [2] argmin() (array method) (in module mlx.core) argpartition (C++ function), [1] argpartition() (in module mlx.core) argsort (C++ function), [1] argsort() (in module mlx.core) array (class in mlx.core) array_equal (C++ function), [1] array_equal() (in module mlx.core) as_strided (C++ function) as_strided() (in module mlx.core) astype (C++ function) astype() (array method) at (array property) atleast_1d (C++ function), [1] atleast_1d() (in module mlx.core) atleast_2d (C++ function), [1] atleast_2d() (in module mlx.core) atleast_3d (C++ function), [1] atleast_3d() (in module mlx.core) AvgPool1d (class in mlx.nn) AvgPool2d (class in mlx.nn) AvgPool3d (class in mlx.nn)

B

BatchNorm (class in mlx.nn) bernoulli() (in module mlx.core.random) binary_cross_entropy (class in mlx.nn.losses) bitwise_and (C++ function) bitwise_and() (in module mlx.core) bitwise_or (C++ function) bitwise_or() (in module mlx.core)

bitwise_xor (C++ function) bitwise_xor() (in module mlx.core) block_masked_mm (C++ function) block_masked_mm() (in module mlx.core) broadcast_arrays (C++ function) broadcast_to (C++ function) broadcast_to() (in module mlx.core)

C

categorical() (in module mlx.core.random) ceil (C++ function) ceil() (in module mlx.core) CELU (class in mlx.nn) celu (class in mlx.nn) children() (Module method) cholesky() (in module mlx.core.linalg) cholesky_inv() (in module mlx.core.linalg) clear_cache() (in module mlx.core.metal) clip (C++ function) clip() (in module mlx.core) clip_grad_norm() (in module mlx.optimizers) compile() (in module mlx.core) concatenate (C++ function), [1] concatenate() (in module mlx.core) conj() (array method) (in module mlx.core) conjugate (C++ function) conjugate() (in module mlx.core) constant() (in module mlx.nn.init) contiguous (C++ function) conv1d (C++ function) Conv1d (class in mlx.nn) conv1d() (in module mlx.core) conv2d (C++ function) Conv2d (class in mlx.nn) conv2d() (in module mlx.core) conv3d (C++ function) Conv3d (class in mlx.nn) conv3d() (in module mlx.core) conv_general (C++ function), [1] conv_general() (in module mlx.core)

conv_transpose1d (C++ function) conv_transpose1d() (in module mlx.core) conv_transpose2d (C++ function) conv_transpose2d() (in module mlx.core) conv_transpose3d (C++ function) conv_transpose3d() (in module mlx.core) convolve() (in module mlx.core) ConvTranspose1d (class in mlx.nn) ConvTranspose2d (class in mlx.nn) ConvTranspose3d (class in mlx.nn) copy (C++ function) cos (C++ function) cos() (array method) (in module mlx.core) cosh (C++ function) cosh() (in module mlx.core) cosine_decay() (in module mlx.optimizers) cosine_similarity_loss (class in mlx.nn.losses) cross() (in module mlx.core.linalg) cross_entropy (class in mlx.nn.losses) cummax (C++ function) cummax() (array method) (in module mlx.core) cummin (C++ function) cummin() (array method) (in module mlx.core) cumprod (C++ function) cumprod() (array method) (in module mlx.core) cumsum (C++ function) cumsum() (array method) (in module mlx.core) custom_function (class in mlx.core)

D

default_device() (in module mlx.core) default_stream() (in module mlx.core) degrees (C++ function) degrees() (in module mlx.core) depends (C++ function) dequantize (C++ function) dequantize() (in module mlx.core) Device (class in mlx.core) device_info() (in module mlx.core.metal) diag (C++ function) diag() (array method) (in module mlx.core) diagonal (C++ function)

diagonal() (array method) (in module mlx.core) disable_compile() (in module mlx.core) divide (C++ function) divide() (in module mlx.core) divmod (C++ function) divmod() (in module mlx.core) Dropout (class in mlx.nn) Dropout2d (class in mlx.nn) Dropout3d (class in mlx.nn) dtype (array property) Dtype (class in mlx.core) DtypeCategory (class in mlx.core)

E

eigh() (in module mlx.core.linalg) eigvalsh() (in module mlx.core.linalg) einsum() (in module mlx.core) einsum_path() (in module mlx.core) ELU (class in mlx.nn) elu (class in mlx.nn) Embedding (class in mlx.nn) enable_compile() (in module mlx.core) equal (C++ function) equal() (in module mlx.core) erf (C++ function) erf() (in module mlx.core) erfinv (C++ function)

erfinv() (in module mlx.core) eval() (in module mlx.core) (Module method) exp (C++ function) exp() (array method) (in module mlx.core) expand_dims (C++ function), [1] expand_dims() (in module mlx.core) expm1 (C++ function) expm1() (in module mlx.core) exponential_decay() (in module mlx.optimizers) eye (C++ function), [1], [2], [3], [4] eye() (in module mlx.core)

F

fft() (in module mlx.core.fft) fft2() (in module mlx.core.fft) fftn() (in module mlx.core.fft) filter_and_map() (Module method) flatten (C++ function), [1] flatten() (array method) (in module mlx.core)

floor (C++ function) floor() (in module mlx.core) floor_divide (C++ function) floor_divide() (in module mlx.core) freeze() (Module method) full (C++ function), [1], [2], [3] full() (in module mlx.core)

G

gather (C++ function), [1] gather_mm (C++ function) gather_mm() (in module mlx.core) gather_qmm (C++ function) gather_qmm() (in module mlx.core) gaussian_nll_loss (class in mlx.nn.losses) GELU (class in mlx.nn) gelu (class in mlx.nn) gelu_approx (class in mlx.nn) gelu_fast_approx (class in mlx.nn) get_active_memory() (in module mlx.core.metal) get_cache_memory() (in module mlx.core.metal) get_peak_memory() (in module mlx.core.metal)

glorot_normal() (in module mlx.nn.init) glorot_uniform() (in module mlx.nn.init) GLU (class in mlx.nn) glu (class in mlx.nn) grad() (in module mlx.core) greater (C++ function) greater() (in module mlx.core) greater_equal (C++ function) greater_equal() (in module mlx.core) Group (class in mlx.core.distributed) GroupNorm (class in mlx.nn) GRU (class in mlx.nn) gumbel() (in module mlx.core.random)

H

hadamard_transform (C++ function) hadamard_transform() (in module mlx.core) hard_shrink (class in mlx.nn) hard_tanh (class in mlx.nn) HardShrink (class in mlx.nn) Hardswish (class in mlx.nn)

hardswish (class in mlx.nn) HardTanh (class in mlx.nn) he_normal() (in module mlx.nn.init) he_uniform() (in module mlx.nn.init) hinge_loss (class in mlx.nn.losses) huber_loss (class in mlx.nn.losses)

I

identity (C++ function), [1] identity() (in module mlx.core) (in module mlx.nn.init) ifft() (in module mlx.core.fft) ifft2() (in module mlx.core.fft) ifftn() (in module mlx.core.fft) imag (C++ function) imag() (in module mlx.core) init() (in module mlx.core.distributed) (Optimizer method) inner (C++ function) inner() (in module mlx.core) InstanceNorm (class in mlx.nn) inv() (in module mlx.core.linalg) irfft() (in module mlx.core.fft) irfft2() (in module mlx.core.fft) irfftn() (in module mlx.core.fft)

is_available() (in module mlx.core.distributed) (in module mlx.core.metal) isclose (C++ function) isclose() (in module mlx.core) isfinite (C++ function) isfinite() (in module mlx.core) isinf (C++ function) isinf() (in module mlx.core) isnan (C++ function) isnan() (in module mlx.core) isneginf (C++ function) isneginf() (in module mlx.core) isposinf (C++ function) isposinf() (in module mlx.core) issubdtype() (in module mlx.core) item() (array method) itemsize (array property)

J

join_schedules() (in module mlx.optimizers)

jvp() (in module mlx.core)

K

key() (in module mlx.core.random)

kl_div_loss (class in mlx.nn.losses)

L

l1_loss (class in mlx.nn.losses) laplace() (in module mlx.core.random) layer_norm() (in module mlx.core.fast) LayerNorm (class in mlx.nn) leaf_modules() (Module method) leaky_relu (class in mlx.nn) LeakyReLU (class in mlx.nn) left_shift (C++ function) left_shift() (in module mlx.core) less (C++ function) less() (in module mlx.core) less_equal (C++ function) less_equal() (in module mlx.core) Linear (class in mlx.nn) linear_schedule() (in module mlx.optimizers) linspace (C++ function) linspace() (in module mlx.core) Lion (class in mlx.optimizers) load() (in module mlx.core) load_weights() (Module method) log (C++ function) log() (array method) (in module mlx.core) log10 (C++ function)

log10() (array method) (in module mlx.core) log1p (C++ function) log1p() (array method) (in module mlx.core) log2 (C++ function) log2() (array method) (in module mlx.core) log_cosh_loss (class in mlx.nn.losses) log_sigmoid (class in mlx.nn) log_softmax (class in mlx.nn) logaddexp (C++ function) logaddexp() (in module mlx.core) logical_and (C++ function) logical_and() (in module mlx.core) logical_not (C++ function) logical_not() (in module mlx.core) logical_or (C++ function) logical_or() (in module mlx.core) LogSigmoid (class in mlx.nn) LogSoftmax (class in mlx.nn) logsumexp (C++ function), [1], [2], [3] logsumexp() (array method) (in module mlx.core) LSTM (class in mlx.nn)

M

margin_ranking_loss (class in mlx.nn.losses) matmul (C++ function) matmul() (in module mlx.core) max (C++ function), [1], [2], [3] max() (array method) (in module mlx.core) maximum (C++ function) maximum() (in module mlx.core) MaxPool1d (class in mlx.nn) MaxPool2d (class in mlx.nn) MaxPool3d (class in mlx.nn) mean (C++ function), [1], [2], [3] mean() (array method) (in module mlx.core) meshgrid (C++ function) meshgrid() (in module mlx.core) metal_kernel() (in module mlx.core.fast)

min (C++ function), [1], [2], [3] min() (array method) (in module mlx.core) minimum (C++ function) minimum() (in module mlx.core) Mish (class in mlx.nn) mish (class in mlx.nn) Module (class in mlx.nn) modules() (Module method) moveaxis (C++ function) moveaxis() (array method) (in module mlx.core) mse_loss (class in mlx.nn.losses) MultiHeadAttention (class in mlx.nn) multiply (C++ function) multiply() (in module mlx.core) multivariate_normal() (in module mlx.core.random)

N

named_modules() (Module method) nan_to_num (C++ function) nan_to_num() (in module mlx.core) nbytes (array property) ndim (array property) negative (C++ function) negative() (in module mlx.core)

new_stream() (in module mlx.core) nll_loss (class in mlx.nn.losses) norm() (in module mlx.core.linalg) normal() (in module mlx.core.random) (in module mlx.nn.init) not_equal (C++ function) not_equal() (in module mlx.core) number_of_elements (C++ function)

O

ones (C++ function), [1] ones() (in module mlx.core) ones_like (C++ function) ones_like() (in module mlx.core) operator!= (C++ function), [1], [2] operator% (C++ function), [1], [2] operator& (C++ function) operator&& (C++ function) operator* (C++ function), [1], [2] operator+ (C++ function), [1], [2] operator- (C++ function), [1], [2], [3] operator/ (C++ function), [1], [2]

operator< (C++ function), [1], [2] operator<< (C++ function) operator<= (C++ function), [1], [2] operator== (C++ function), [1], [2] operator> (C++ function), [1], [2] operator>= (C++ function), [1], [2] operator>> (C++ function) operator^ (C++ function) operator| (C++ function) operator|| (C++ function) Optimizer (class in mlx.optimizers) outer (C++ function) outer() (in module mlx.core)

P

pad (C++ function), [1], [2], [3] pad() (in module mlx.core) parameters() (Module method) partition (C++ function), [1] partition() (in module mlx.core) permutation() (in module mlx.core.random) power (C++ function)

power() (in module mlx.core) PReLU (class in mlx.nn) prelu (class in mlx.nn) prod (C++ function), [1], [2], [3] prod() (array method) (in module mlx.core) put_along_axis (C++ function) put_along_axis() (in module mlx.core)

Q

qr() (in module mlx.core.linalg) quantize (C++ function) quantize() (in module mlx.core) (in module mlx.nn)

quantized_matmul (C++ function) quantized_matmul() (in module mlx.core) QuantizedEmbedding (class in mlx.nn) QuantizedLinear (class in mlx.nn)

R

radians (C++ function) radians() (in module mlx.core) randint() (in module mlx.core.random) real (C++ function) real() (in module mlx.core) reciprocal (C++ function) reciprocal() (array method) (in module mlx.core) recv() (in module mlx.core.distributed) recv_like() (in module mlx.core.distributed) ReLU (class in mlx.nn) relu (class in mlx.nn) ReLU6 (class in mlx.nn) relu6 (class in mlx.nn) remainder (C++ function) remainder() (in module mlx.core) repeat (C++ function), [1] repeat() (in module mlx.core) reset_peak_memory() (in module mlx.core.metal) reshape (C++ function)

reshape() (array method) (in module mlx.core) rfft() (in module mlx.core.fft) rfft2() (in module mlx.core.fft) rfftn() (in module mlx.core.fft) right_shift (C++ function) right_shift() (in module mlx.core) rms_norm() (in module mlx.core.fast) RMSNorm (class in mlx.nn) RMSprop (class in mlx.optimizers) RNN (class in mlx.nn) roll (C++ function), [1], [2], [3], [4], [5] roll() (in module mlx.core) RoPE (class in mlx.nn) rope() (in module mlx.core.fast) round (C++ function), [1] round() (array method) (in module mlx.core) rsqrt (C++ function) rsqrt() (array method) (in module mlx.core)

S

save() (in module mlx.core) save_gguf() (in module mlx.core) save_safetensors() (in module mlx.core) save_weights() (Module method) savez() (in module mlx.core) savez_compressed() (in module mlx.core) scaled_dot_product_attention() (in module mlx.core.fast) scatter (C++ function), [1] scatter_add (C++ function), [1] scatter_max (C++ function), [1] scatter_min (C++ function), [1] scatter_prod (C++ function), [1] seed() (in module mlx.core.random) SELU (class in mlx.nn) selu (class in mlx.nn) send() (in module mlx.core.distributed) Sequential (class in mlx.nn) set_cache_limit() (in module mlx.core.metal) set_default_device() (in module mlx.core) set_default_stream() (in module mlx.core) set_dtype() (Module method) set_memory_limit() (in module mlx.core.metal) set_wired_limit() (in module mlx.core.metal) SGD (class in mlx.optimizers) shape (array property) sigmoid (C++ function) Sigmoid (class in mlx.nn) sigmoid (class in mlx.nn) sigmoid() (in module mlx.core) sign (C++ function) sign() (in module mlx.core) SiLU (class in mlx.nn) silu (class in mlx.nn) sin (C++ function) sin() (array method) (in module mlx.core) sinh (C++ function) sinh() (in module mlx.core) SinusoidalPositionalEncoding (class in mlx.nn) size (array property) slice (C++ function), [1] slice_update (C++ function), [1] smooth_l1_loss (class in mlx.nn.losses) softmax (C++ function), [1], [2] Softmax (class in mlx.nn) softmax (class in mlx.nn) softmax() (in module mlx.core)

Softmin (class in mlx.nn) softmin (class in mlx.nn) Softplus (class in mlx.nn) softplus (class in mlx.nn) Softshrink (class in mlx.nn) softshrink (class in mlx.nn) Softsign (class in mlx.nn) sort (C++ function), [1] sort() (in module mlx.core) split (C++ function), [1], [2], [3] split() (array method) (in module mlx.core) (in module mlx.core.random) sqrt (C++ function) sqrt() (array method) (in module mlx.core) square (C++ function) square() (array method) (in module mlx.core) squeeze (C++ function), [1], [2] squeeze() (array method) (in module mlx.core) stack (C++ function), [1] stack() (in module mlx.core) start_capture() (in module mlx.core.metal) state (Module property) (Optimizer property) std (C++ function), [1], [2], [3] std() (array method) (in module mlx.core) Step (class in mlx.nn) step (class in mlx.nn) step_decay() (in module mlx.optimizers) stop_capture() (in module mlx.core.metal) stop_gradient (C++ function) stop_gradient() (in module mlx.core) Stream (class in mlx.core) stream() (in module mlx.core) subtract (C++ function) subtract() (in module mlx.core) sum (C++ function), [1], [2], [3] sum() (array method) (in module mlx.core) svd() (in module mlx.core.linalg) swapaxes (C++ function) swapaxes() (array method) (in module mlx.core) synchronize() (in module mlx.core)

T

T (array property) take (C++ function), [1], [2], [3] take() (in module mlx.core) take_along_axis (C++ function) take_along_axis() (in module mlx.core) tan (C++ function) tan() (in module mlx.core) tanh (C++ function) Tanh (class in mlx.nn) tanh (class in mlx.nn) tanh() (in module mlx.core) tensordot (C++ function), [1] tensordot() (in module mlx.core) tile (C++ function) tile() (in module mlx.core) tolist() (array method) topk (C++ function), [1] topk() (in module mlx.core) trace (C++ function), [1], [2] trace() (in module mlx.core)

train() (Module method) trainable_parameters() (Module method) training (Module property) Transformer (class in mlx.nn) transpose (C++ function), [1], [2] transpose() (array method) (in module mlx.core) tree_flatten() (in module mlx.utils) tree_map() (in module mlx.utils) tree_map_with_path() (in module mlx.utils) tree_reduce() (in module mlx.utils) tree_unflatten() (in module mlx.utils) tri (C++ function), [1] tri() (in module mlx.core) tri_inv() (in module mlx.core.linalg) tril (C++ function) tril() (in module mlx.core) triplet_loss (class in mlx.nn.losses) triu (C++ function) triu() (in module mlx.core) truncated_normal() (in module mlx.core.random)

U

unfreeze() (Module method) uniform() (in module mlx.core.random) (in module mlx.nn.init)

update() (Module method) (Optimizer method) update_modules() (Module method) Upsample (class in mlx.nn)

V

value_and_grad() (in module mlx.core) (in module mlx.nn) var (C++ function), [1], [2], [3] var() (array method) (in module mlx.core)

view (C++ function) view() (array method) (in module mlx.core) vjp() (in module mlx.core) vmap() (in module mlx.core)

W

where (C++ function)

where() (in module mlx.core)

Z

zeros (C++ function), [1] zeros() (in module mlx.core)

zeros_like (C++ function) zeros_like() (in module mlx.core)