mlx/docs/build/html/_sources/python/ops.rst

.. _ops:

Operations
==========

.. currentmodule:: mlx.core

.. autosummary::
  :toctree: _autosummary

   abs
   add
   addmm
   all
   allclose
   any
   arange
   arccos
   arccosh
   arcsin
   arcsinh
   arctan
   arctan2
   arctanh
   argmax
   argmin
   argpartition
   argsort
   array_equal
   as_strided
   atleast_1d
   atleast_2d
   atleast_3d
   bitwise_and
   bitwise_invert
   bitwise_or
   bitwise_xor
   block_masked_mm
   broadcast_arrays
   broadcast_to
   ceil
   clip
   concatenate
   contiguous
   conj
   conjugate
   convolve
   conv1d
   conv2d
   conv3d
   conv_transpose1d
   conv_transpose2d
   conv_transpose3d
   conv_general
   cos
   cosh
   cummax
   cummin
   cumprod
   cumsum
   degrees
   dequantize
   diag
   diagonal
   divide
   divmod
   einsum
   einsum_path
   equal
   erf
   erfinv
   exp
   expm1
   expand_dims
   eye
   flatten
   floor
   floor_divide
   full
   gather_mm
   gather_qmm
   greater
   greater_equal
   hadamard_transform
   identity
   imag
   inner
   isfinite
   isclose
   isinf
   isnan
   isneginf
   isposinf
   issubdtype
   kron
   left_shift
   less
   less_equal
   linspace
   load
   log
   log2
   log10
   log1p
   logaddexp
   logcumsumexp
   logical_not
   logical_and
   logical_or
   logsumexp
   matmul
   max
   maximum
   mean
   meshgrid
   min
   minimum
   moveaxis
   multiply
   nan_to_num
   negative
   not_equal
   ones
   ones_like
   outer
   partition
   pad
   power
   prod
   put_along_axis
   quantize
   quantized_matmul
   radians
   real
   reciprocal
   remainder
   repeat
   reshape
   right_shift
   roll
   round
   rsqrt
   save
   savez
   savez_compressed
   save_gguf
   save_safetensors
   sigmoid
   sign
   sin
   sinh
   slice
   slice_update
   softmax
   sort
   split
   sqrt
   square
   squeeze
   stack
   std
   stop_gradient
   subtract
   sum
   swapaxes
   take
   take_along_axis
   tan
   tanh
   tensordot
   tile
   topk
   trace
   transpose
   tri
   tril
   triu
   unflatten
   var
   view
   where
   zeros
   zeros_like
docs 2023-11-30 04:41:56 +08:00			`.. _ops:`

			`Operations`
			`==========`

			`.. currentmodule:: mlx.core`

docs update 2024-04-12 08:33:33 +08:00			`.. autosummary::`
docs 2023-11-30 04:41:56 +08:00			`:toctree: _autosummary`

			`abs`
			`add`
docs update 2024-05-21 00:40:17 +08:00			`addmm`
docs 2023-11-30 04:41:56 +08:00			`all`
docs update 2024-04-12 08:33:33 +08:00			`allclose`
docs 2023-11-30 04:41:56 +08:00			`any`
			`arange`
			`arccos`
			`arccosh`
			`arcsin`
			`arcsinh`
			`arctan`
docs update 2024-05-10 23:49:36 +08:00			`arctan2`
docs 2023-11-30 04:41:56 +08:00			`arctanh`
			`argmax`
			`argmin`
			`argpartition`
			`argsort`
			`array_equal`
docs update 2024-05-21 00:40:17 +08:00			`as_strided`
docs update 2024-03-01 04:39:18 +08:00			`atleast_1d`
			`atleast_2d`
			`atleast_3d`
docs update 2024-05-10 23:49:36 +08:00			`bitwise_and`
rebase 2025-02-15 05:44:39 +08:00			`bitwise_invert`
docs update 2024-05-10 23:49:36 +08:00			`bitwise_or`
			`bitwise_xor`
docs update 2024-04-26 23:24:09 +08:00			`block_masked_mm`
rebase 2025-04-04 04:25:24 +08:00			`broadcast_arrays`
docs update 2024-05-10 23:49:36 +08:00			`broadcast_to`
docs 2023-12-18 05:23:03 +08:00			`ceil`
docs 2023-12-22 14:13:41 +08:00			`clip`
docs 2023-11-30 04:41:56 +08:00			`concatenate`
rebase 2025-04-04 04:25:24 +08:00			`contiguous`
docs update 2024-05-10 23:49:36 +08:00			`conj`
			`conjugate`
docs 2023-11-30 04:41:56 +08:00			`convolve`
			`conv1d`
			`conv2d`
docs update 2024-08-24 03:14:53 +08:00			`conv3d`
docs up 2024-09-18 03:06:14 +08:00			`conv_transpose1d`
			`conv_transpose2d`
			`conv_transpose3d`
docs update 2024-03-01 04:39:18 +08:00			`conv_general`
docs 2023-11-30 04:41:56 +08:00			`cos`
			`cosh`
docs update 2024-03-31 08:32:20 +08:00			`cummax`
			`cummin`
			`cumprod`
			`cumsum`
docs update 2024-04-26 23:24:09 +08:00			`degrees`
docs 2023-12-22 14:13:41 +08:00			`dequantize`
update docs 2024-02-02 05:08:29 +08:00			`diag`
			`diagonal`
docs 2023-11-30 04:41:56 +08:00			`divide`
docs up 2024-01-11 06:14:38 +08:00			`divmod`
docs update 2024-07-26 02:59:11 +08:00			`einsum`
			`einsum_path`
docs 2023-11-30 04:41:56 +08:00			`equal`
			`erf`
			`erfinv`
			`exp`
docs update 2024-04-12 08:33:33 +08:00			`expm1`
docs 2023-11-30 04:41:56 +08:00			`expand_dims`
update docs 2023-12-14 06:46:24 +08:00			`eye`
docs 2023-12-18 05:23:03 +08:00			`flatten`
docs 2023-12-22 14:13:41 +08:00			`floor`
			`floor_divide`
docs 2023-11-30 04:41:56 +08:00			`full`
docs 2024-05-24 12:11:24 +08:00			`gather_mm`
			`gather_qmm`
docs 2023-11-30 04:41:56 +08:00			`greater`
			`greater_equal`
docs update 2024-07-12 06:32:08 +08:00			`hadamard_transform`
update docs 2023-12-14 06:46:24 +08:00			`identity`
rebase 2024-10-19 03:13:44 +08:00			`imag`
docs up 2024-01-11 06:14:38 +08:00			`inner`
docs up 2024-09-18 03:06:14 +08:00			`isfinite`
docs update 2024-03-15 03:46:45 +08:00			`isclose`
docs update 2024-03-31 08:32:20 +08:00			`isinf`
docs update 2024-01-18 09:15:29 +08:00			`isnan`
			`isneginf`
docs update 2024-03-31 08:32:20 +08:00			`isposinf`
docs update 2024-05-21 00:40:17 +08:00			`issubdtype`
rebase 2025-01-10 05:56:20 +08:00			`kron`
docs update 2024-05-10 23:49:36 +08:00			`left_shift`
docs 2023-11-30 04:41:56 +08:00			`less`
			`less_equal`
docs 2023-12-22 14:13:41 +08:00			`linspace`
docs 2023-11-30 04:41:56 +08:00			`load`
			`log`
			`log2`
			`log10`
			`log1p`
			`logaddexp`
rebase 2025-04-18 06:29:33 +08:00			`logcumsumexp`
docs 2023-11-30 04:41:56 +08:00			`logical_not`
docs up 2024-01-11 06:14:38 +08:00			`logical_and`
			`logical_or`
docs 2023-11-30 04:41:56 +08:00			`logsumexp`
			`matmul`
			`max`
			`maximum`
			`mean`
docs update 2024-04-12 08:33:33 +08:00			`meshgrid`
docs 2023-11-30 04:41:56 +08:00			`min`
			`minimum`
docs 2023-12-18 05:23:03 +08:00			`moveaxis`
docs 2023-11-30 04:41:56 +08:00			`multiply`
docs update 2024-07-26 02:59:11 +08:00			`nan_to_num`
docs 2023-11-30 04:41:56 +08:00			`negative`
docs update 2024-04-26 23:24:09 +08:00			`not_equal`
docs 2023-11-30 04:41:56 +08:00			`ones`
			`ones_like`
docs up 2024-01-11 06:14:38 +08:00			`outer`
docs 2023-11-30 04:41:56 +08:00			`partition`
			`pad`
docs update 2024-05-21 00:40:17 +08:00			`power`
docs 2023-11-30 04:41:56 +08:00			`prod`
docs update 2024-09-29 02:04:59 +08:00			`put_along_axis`
docs 2023-12-22 14:13:41 +08:00			`quantize`
			`quantized_matmul`
docs update 2024-04-26 23:24:09 +08:00			`radians`
rebase 2024-10-19 03:13:44 +08:00			`real`
docs 2023-11-30 04:41:56 +08:00			`reciprocal`
docs update 2024-05-21 00:40:17 +08:00			`remainder`
docs update 2024-01-04 12:14:05 +08:00			`repeat`
docs 2023-11-30 04:41:56 +08:00			`reshape`
docs update 2024-05-10 23:49:36 +08:00			`right_shift`
rebase 2024-10-15 04:10:48 +08:00			`roll`
docs 2023-12-22 14:13:41 +08:00			`round`
docs 2023-11-30 04:41:56 +08:00			`rsqrt`
			`save`
			`savez`
			`savez_compressed`
docs up 2024-01-11 06:14:38 +08:00			`save_gguf`
docs update 2024-01-04 12:14:05 +08:00			`save_safetensors`
docs 2023-11-30 04:41:56 +08:00			`sigmoid`
			`sign`
			`sin`
			`sinh`
rebase 2025-01-10 05:56:20 +08:00			`slice`
			`slice_update`
docs 2023-11-30 04:41:56 +08:00			`softmax`
			`sort`
			`split`
			`sqrt`
			`square`
			`squeeze`
docs 2023-12-18 05:23:03 +08:00			`stack`
docs update 2024-04-12 08:33:33 +08:00			`std`
docs 2023-11-30 04:41:56 +08:00			`stop_gradient`
			`subtract`
			`sum`
docs 2023-12-18 05:23:03 +08:00			`swapaxes`
docs 2023-11-30 04:41:56 +08:00			`take`
			`take_along_axis`
			`tan`
			`tanh`
docs update 2024-01-04 12:14:05 +08:00			`tensordot`
docs update 2024-03-15 03:46:45 +08:00			`tile`
			`topk`
docs 2024-05-24 12:11:24 +08:00			`trace`
docs 2023-11-30 04:41:56 +08:00			`transpose`
docs 2023-12-18 05:23:03 +08:00			`tri`
			`tril`
			`triu`
rebase 2025-01-10 05:56:20 +08:00			`unflatten`
docs 2023-11-30 04:41:56 +08:00			`var`
docs update 2024-06-07 11:28:06 +08:00			`view`
docs 2023-11-30 04:41:56 +08:00			`where`
			`zeros`
			`zeros_like`