Skip to main content
Back to top
Ctrl
+
K
Install
Build and Install
Usage
Quick Start Guide
Lazy Evaluation
Unified Memory
Indexing Arrays
Saving and Loading Arrays
Function Transforms
Compilation
Conversion to NumPy and Other Frameworks
Distributed Communication
Using Streams
Exporting Functions
Examples
Linear Regression
Multi-Layer Perceptron
LLM inference
Data Parallelism
Tensor Parallelism
Python API Reference
Array
mlx.core.array
mlx.core.array.astype
mlx.core.array.at
mlx.core.array.item
mlx.core.array.tolist
mlx.core.array.dtype
mlx.core.array.itemsize
mlx.core.array.nbytes
mlx.core.array.ndim
mlx.core.array.shape
mlx.core.array.size
mlx.core.array.real
mlx.core.array.imag
mlx.core.array.abs
mlx.core.array.all
mlx.core.array.any
mlx.core.array.argmax
mlx.core.array.argmin
mlx.core.array.conj
mlx.core.array.cos
mlx.core.array.cummax
mlx.core.array.cummin
mlx.core.array.cumprod
mlx.core.array.cumsum
mlx.core.array.diag
mlx.core.array.diagonal
mlx.core.array.exp
mlx.core.array.flatten
mlx.core.array.log
mlx.core.array.log10
mlx.core.array.log1p
mlx.core.array.log2
mlx.core.array.logcumsumexp
mlx.core.array.logsumexp
mlx.core.array.max
mlx.core.array.mean
mlx.core.array.min
mlx.core.array.moveaxis
mlx.core.array.prod
mlx.core.array.reciprocal
mlx.core.array.reshape
mlx.core.array.round
mlx.core.array.rsqrt
mlx.core.array.sin
mlx.core.array.split
mlx.core.array.sqrt
mlx.core.array.square
mlx.core.array.squeeze
mlx.core.array.std
mlx.core.array.sum
mlx.core.array.swapaxes
mlx.core.array.transpose
mlx.core.array.T
mlx.core.array.var
mlx.core.array.view
Data Types
mlx.core.Dtype
mlx.core.DtypeCategory
mlx.core.issubdtype
mlx.core.finfo
Devices and Streams
mlx.core.Device
mlx.core.Stream
mlx.core.default_device
mlx.core.set_default_device
mlx.core.default_stream
mlx.core.new_stream
mlx.core.set_default_stream
mlx.core.stream
mlx.core.synchronize
mlx.core.device_count
mlx.core.device_info
Export Functions
mlx.core.export_function
mlx.core.import_function
mlx.core.exporter
mlx.core.export_to_dot
Operations
mlx.core.abs
mlx.core.add
mlx.core.addmm
mlx.core.all
mlx.core.allclose
mlx.core.any
mlx.core.arange
mlx.core.arccos
mlx.core.arccosh
mlx.core.arcsin
mlx.core.arcsinh
mlx.core.arctan
mlx.core.arctan2
mlx.core.arctanh
mlx.core.argmax
mlx.core.argmin
mlx.core.argpartition
mlx.core.argsort
mlx.core.array_equal
mlx.core.as_strided
mlx.core.atleast_1d
mlx.core.atleast_2d
mlx.core.atleast_3d
mlx.core.bitwise_and
mlx.core.bitwise_invert
mlx.core.bitwise_or
mlx.core.bitwise_xor
mlx.core.block_masked_mm
mlx.core.broadcast_arrays
mlx.core.broadcast_to
mlx.core.ceil
mlx.core.clip
mlx.core.concatenate
mlx.core.contiguous
mlx.core.conj
mlx.core.conjugate
mlx.core.convolve
mlx.core.conv1d
mlx.core.conv2d
mlx.core.conv3d
mlx.core.conv_transpose1d
mlx.core.conv_transpose2d
mlx.core.conv_transpose3d
mlx.core.conv_general
mlx.core.cos
mlx.core.cosh
mlx.core.cummax
mlx.core.cummin
mlx.core.cumprod
mlx.core.cumsum
mlx.core.degrees
mlx.core.dequantize
mlx.core.diag
mlx.core.diagonal
mlx.core.divide
mlx.core.divmod
mlx.core.einsum
mlx.core.einsum_path
mlx.core.equal
mlx.core.erf
mlx.core.erfinv
mlx.core.exp
mlx.core.expm1
mlx.core.expand_dims
mlx.core.eye
mlx.core.flatten
mlx.core.floor
mlx.core.floor_divide
mlx.core.full
mlx.core.gather_mm
mlx.core.gather_qmm
mlx.core.greater
mlx.core.greater_equal
mlx.core.hadamard_transform
mlx.core.identity
mlx.core.imag
mlx.core.inner
mlx.core.isfinite
mlx.core.isclose
mlx.core.isinf
mlx.core.isnan
mlx.core.isneginf
mlx.core.isposinf
mlx.core.issubdtype
mlx.core.kron
mlx.core.left_shift
mlx.core.less
mlx.core.less_equal
mlx.core.linspace
mlx.core.load
mlx.core.log
mlx.core.log2
mlx.core.log10
mlx.core.log1p
mlx.core.logaddexp
mlx.core.logcumsumexp
mlx.core.logical_not
mlx.core.logical_and
mlx.core.logical_or
mlx.core.logsumexp
mlx.core.matmul
mlx.core.max
mlx.core.maximum
mlx.core.mean
mlx.core.median
mlx.core.meshgrid
mlx.core.min
mlx.core.minimum
mlx.core.moveaxis
mlx.core.multiply
mlx.core.nan_to_num
mlx.core.negative
mlx.core.not_equal
mlx.core.ones
mlx.core.ones_like
mlx.core.outer
mlx.core.partition
mlx.core.pad
mlx.core.power
mlx.core.prod
mlx.core.put_along_axis
mlx.core.quantize
mlx.core.quantized_matmul
mlx.core.radians
mlx.core.real
mlx.core.reciprocal
mlx.core.remainder
mlx.core.repeat
mlx.core.reshape
mlx.core.right_shift
mlx.core.roll
mlx.core.round
mlx.core.rsqrt
mlx.core.save
mlx.core.savez
mlx.core.savez_compressed
mlx.core.save_gguf
mlx.core.save_safetensors
mlx.core.sigmoid
mlx.core.sign
mlx.core.sin
mlx.core.sinh
mlx.core.slice
mlx.core.slice_update
mlx.core.softmax
mlx.core.sort
mlx.core.split
mlx.core.sqrt
mlx.core.square
mlx.core.squeeze
mlx.core.stack
mlx.core.std
mlx.core.stop_gradient
mlx.core.subtract
mlx.core.sum
mlx.core.swapaxes
mlx.core.take
mlx.core.take_along_axis
mlx.core.tan
mlx.core.tanh
mlx.core.tensordot
mlx.core.tile
mlx.core.topk
mlx.core.trace
mlx.core.transpose
mlx.core.tri
mlx.core.tril
mlx.core.triu
mlx.core.unflatten
mlx.core.var
mlx.core.view
mlx.core.where
mlx.core.zeros
mlx.core.zeros_like
Random
mlx.core.random.bernoulli
mlx.core.random.categorical
mlx.core.random.gumbel
mlx.core.random.key
mlx.core.random.normal
mlx.core.random.multivariate_normal
mlx.core.random.randint
mlx.core.random.seed
mlx.core.random.split
mlx.core.random.truncated_normal
mlx.core.random.uniform
mlx.core.random.laplace
mlx.core.random.permutation
Transforms
mlx.core.eval
mlx.core.async_eval
mlx.core.compile
mlx.core.checkpoint
mlx.core.custom_function
mlx.core.disable_compile
mlx.core.enable_compile
mlx.core.grad
mlx.core.value_and_grad
mlx.core.jvp
mlx.core.vjp
mlx.core.vmap
Fast
mlx.core.fast.rms_norm
mlx.core.fast.layer_norm
mlx.core.fast.rope
mlx.core.fast.scaled_dot_product_attention
mlx.core.fast.metal_kernel
mlx.core.fast.cuda_kernel
FFT
mlx.core.fft.fft
mlx.core.fft.ifft
mlx.core.fft.fft2
mlx.core.fft.ifft2
mlx.core.fft.fftn
mlx.core.fft.ifftn
mlx.core.fft.rfft
mlx.core.fft.irfft
mlx.core.fft.rfft2
mlx.core.fft.irfft2
mlx.core.fft.rfftn
mlx.core.fft.irfftn
mlx.core.fft.fftshift
mlx.core.fft.ifftshift
Linear Algebra
mlx.core.linalg.inv
mlx.core.linalg.tri_inv
mlx.core.linalg.norm
mlx.core.linalg.cholesky
mlx.core.linalg.cholesky_inv
mlx.core.linalg.cross
mlx.core.linalg.qr
mlx.core.linalg.svd
mlx.core.linalg.eigvals
mlx.core.linalg.eig
mlx.core.linalg.eigvalsh
mlx.core.linalg.eigh
mlx.core.linalg.lu
mlx.core.linalg.lu_factor
mlx.core.linalg.pinv
mlx.core.linalg.solve
mlx.core.linalg.solve_triangular
Metal
mlx.core.metal.is_available
mlx.core.metal.device_info
mlx.core.metal.start_capture
mlx.core.metal.stop_capture
CUDA
mlx.core.cuda.is_available
Memory Management
mlx.core.get_active_memory
mlx.core.get_peak_memory
mlx.core.reset_peak_memory
mlx.core.get_cache_memory
mlx.core.set_memory_limit
mlx.core.set_cache_limit
mlx.core.set_wired_limit
mlx.core.clear_cache
Neural Networks
mlx.nn.value_and_grad
mlx.nn.quantize
mlx.nn.average_gradients
Module
mlx.nn.Module.training
mlx.nn.Module.state
mlx.nn.Module.apply
mlx.nn.Module.apply_to_modules
mlx.nn.Module.children
mlx.nn.Module.eval
mlx.nn.Module.filter_and_map
mlx.nn.Module.freeze
mlx.nn.Module.leaf_modules
mlx.nn.Module.load_weights
mlx.nn.Module.modules
mlx.nn.Module.named_modules
mlx.nn.Module.parameters
mlx.nn.Module.save_weights
mlx.nn.Module.set_dtype
mlx.nn.Module.train
mlx.nn.Module.trainable_parameters
mlx.nn.Module.unfreeze
mlx.nn.Module.update
mlx.nn.Module.update_modules
Layers
mlx.nn.ALiBi
mlx.nn.AllToShardedLinear
mlx.nn.AvgPool1d
mlx.nn.AvgPool2d
mlx.nn.AvgPool3d
mlx.nn.BatchNorm
mlx.nn.CELU
mlx.nn.Conv1d
mlx.nn.Conv2d
mlx.nn.Conv3d
mlx.nn.ConvTranspose1d
mlx.nn.ConvTranspose2d
mlx.nn.ConvTranspose3d
mlx.nn.Dropout
mlx.nn.Dropout2d
mlx.nn.Dropout3d
mlx.nn.Embedding
mlx.nn.ELU
mlx.nn.GELU
mlx.nn.GLU
mlx.nn.GroupNorm
mlx.nn.GRU
mlx.nn.HardShrink
mlx.nn.HardTanh
mlx.nn.Hardswish
mlx.nn.InstanceNorm
mlx.nn.LayerNorm
mlx.nn.LeakyReLU
mlx.nn.Linear
mlx.nn.LogSigmoid
mlx.nn.LogSoftmax
mlx.nn.LSTM
mlx.nn.MaxPool1d
mlx.nn.MaxPool2d
mlx.nn.MaxPool3d
mlx.nn.Mish
mlx.nn.MultiHeadAttention
mlx.nn.PReLU
mlx.nn.QuantizedAllToShardedLinear
mlx.nn.QuantizedEmbedding
mlx.nn.QuantizedLinear
mlx.nn.QuantizedShardedToAllLinear
mlx.nn.RMSNorm
mlx.nn.ReLU
mlx.nn.ReLU2
mlx.nn.ReLU6
mlx.nn.RNN
mlx.nn.RoPE
mlx.nn.SELU
mlx.nn.Sequential
mlx.nn.ShardedToAllLinear
mlx.nn.Sigmoid
mlx.nn.SiLU
mlx.nn.SinusoidalPositionalEncoding
mlx.nn.Softmin
mlx.nn.Softshrink
mlx.nn.Softsign
mlx.nn.Softmax
mlx.nn.Softplus
mlx.nn.Step
mlx.nn.Tanh
mlx.nn.Transformer
mlx.nn.Upsample
Functions
mlx.nn.elu
mlx.nn.celu
mlx.nn.gelu
mlx.nn.gelu_approx
mlx.nn.gelu_fast_approx
mlx.nn.glu
mlx.nn.hard_shrink
mlx.nn.hard_tanh
mlx.nn.hardswish
mlx.nn.leaky_relu
mlx.nn.log_sigmoid
mlx.nn.log_softmax
mlx.nn.mish
mlx.nn.prelu
mlx.nn.relu
mlx.nn.relu2
mlx.nn.relu6
mlx.nn.selu
mlx.nn.sigmoid
mlx.nn.silu
mlx.nn.softmax
mlx.nn.softmin
mlx.nn.softplus
mlx.nn.softshrink
mlx.nn.step
mlx.nn.tanh
Loss Functions
mlx.nn.losses.binary_cross_entropy
mlx.nn.losses.cosine_similarity_loss
mlx.nn.losses.cross_entropy
mlx.nn.losses.gaussian_nll_loss
mlx.nn.losses.hinge_loss
mlx.nn.losses.huber_loss
mlx.nn.losses.kl_div_loss
mlx.nn.losses.l1_loss
mlx.nn.losses.log_cosh_loss
mlx.nn.losses.margin_ranking_loss
mlx.nn.losses.mse_loss
mlx.nn.losses.nll_loss
mlx.nn.losses.smooth_l1_loss
mlx.nn.losses.triplet_loss
Initializers
mlx.nn.init.constant
mlx.nn.init.normal
mlx.nn.init.uniform
mlx.nn.init.identity
mlx.nn.init.glorot_normal
mlx.nn.init.glorot_uniform
mlx.nn.init.he_normal
mlx.nn.init.he_uniform
Distributed
mlx.nn.layers.distributed.shard_linear
mlx.nn.layers.distributed.shard_inplace
mlx.nn.AllToShardedLinear
mlx.nn.ShardedToAllLinear
mlx.nn.QuantizedAllToShardedLinear
mlx.nn.QuantizedShardedToAllLinear
Optimizers
Optimizer
mlx.optimizers.Optimizer.state
mlx.optimizers.Optimizer.apply_gradients
mlx.optimizers.Optimizer.init
mlx.optimizers.Optimizer.update
Common Optimizers
mlx.optimizers.SGD
mlx.optimizers.RMSprop
mlx.optimizers.Adagrad
mlx.optimizers.Adafactor
mlx.optimizers.AdaDelta
mlx.optimizers.Adam
mlx.optimizers.AdamW
mlx.optimizers.Adamax
mlx.optimizers.Lion
mlx.optimizers.MultiOptimizer
mlx.optimizers.Muon
Schedulers
mlx.optimizers.cosine_decay
mlx.optimizers.exponential_decay
mlx.optimizers.join_schedules
mlx.optimizers.linear_schedule
mlx.optimizers.step_decay
mlx.optimizers.clip_grad_norm
Distributed Communication
mlx.core.distributed.Group
mlx.core.distributed.is_available
mlx.core.distributed.init
mlx.core.distributed.all_sum
mlx.core.distributed.all_gather
mlx.core.distributed.send
mlx.core.distributed.recv
mlx.core.distributed.recv_like
Tree Utils
mlx.utils.tree_flatten
mlx.utils.tree_unflatten
mlx.utils.tree_map
mlx.utils.tree_map_with_path
mlx.utils.tree_reduce
C++ API Reference
Operations
Further Reading
Custom Extensions in MLX
Metal Debugger
Metal Logging
Custom Metal Kernels
Using MLX in C++
.rst
.pdf
mlx.core.metal.device_info
Contents
device_info()
mlx.core.metal.device_info
#
device_info
(
)
→
dict
[
str
,
str
|
int
]
#
Contents
device_info()
