This commit is contained in:
Awni Hannun
2025-10-17 19:14:53 +00:00
committed by CircleCI Docs
parent 4bce5f9b2d
commit a372a3844d
440 changed files with 66856 additions and 0 deletions
@@ -0,0 +1,28 @@
mlx.core.Device
===============
.. currentmodule:: mlx.core
.. autoclass:: Device
.. automethod:: __init__
.. rubric:: Methods
.. autosummary::
~Device.__init__
.. rubric:: Attributes
.. autosummary::
~Device.type
@@ -0,0 +1,28 @@
mlx.core.Dtype
==============
.. currentmodule:: mlx.core
.. autoclass:: Dtype
.. automethod:: __init__
.. rubric:: Methods
.. autosummary::
~Dtype.__init__
.. rubric:: Attributes
.. autosummary::
~Dtype.size
@@ -0,0 +1,28 @@
mlx.core.Stream
===============
.. currentmodule:: mlx.core
.. autoclass:: Stream
.. automethod:: __init__
.. rubric:: Methods
.. autosummary::
~Stream.__init__
.. rubric:: Attributes
.. autosummary::
~Stream.device
@@ -0,0 +1,6 @@
mlx.core.abs
============
.. currentmodule:: mlx.core
.. autofunction:: abs
@@ -0,0 +1,6 @@
mlx.core.add
============
.. currentmodule:: mlx.core
.. autofunction:: add
@@ -0,0 +1,6 @@
mlx.core.all
============
.. currentmodule:: mlx.core
.. autofunction:: all
@@ -0,0 +1,6 @@
mlx.core.allclose
=================
.. currentmodule:: mlx.core
.. autofunction:: allclose
@@ -0,0 +1,6 @@
mlx.core.any
============
.. currentmodule:: mlx.core
.. autofunction:: any
@@ -0,0 +1,6 @@
mlx.core.arange
===============
.. currentmodule:: mlx.core
.. autofunction:: arange
@@ -0,0 +1,6 @@
mlx.core.arccos
===============
.. currentmodule:: mlx.core
.. autofunction:: arccos
@@ -0,0 +1,6 @@
mlx.core.arccosh
================
.. currentmodule:: mlx.core
.. autofunction:: arccosh
@@ -0,0 +1,6 @@
mlx.core.arcsin
===============
.. currentmodule:: mlx.core
.. autofunction:: arcsin
@@ -0,0 +1,6 @@
mlx.core.arcsinh
================
.. currentmodule:: mlx.core
.. autofunction:: arcsinh
@@ -0,0 +1,6 @@
mlx.core.arctan
===============
.. currentmodule:: mlx.core
.. autofunction:: arctan
@@ -0,0 +1,6 @@
mlx.core.arctanh
================
.. currentmodule:: mlx.core
.. autofunction:: arctanh
@@ -0,0 +1,6 @@
mlx.core.argmax
===============
.. currentmodule:: mlx.core
.. autofunction:: argmax
@@ -0,0 +1,6 @@
mlx.core.argmin
===============
.. currentmodule:: mlx.core
.. autofunction:: argmin
@@ -0,0 +1,6 @@
mlx.core.argpartition
=====================
.. currentmodule:: mlx.core
.. autofunction:: argpartition
@@ -0,0 +1,6 @@
mlx.core.argsort
================
.. currentmodule:: mlx.core
.. autofunction:: argsort
@@ -0,0 +1,6 @@
mlx.core.array.T
================
.. currentmodule:: mlx.core
.. autoproperty:: array.T
@@ -0,0 +1,6 @@
mlx.core.array.abs
==================
.. currentmodule:: mlx.core
.. automethod:: array.abs
@@ -0,0 +1,6 @@
mlx.core.array.all
==================
.. currentmodule:: mlx.core
.. automethod:: array.all
@@ -0,0 +1,6 @@
mlx.core.array.any
==================
.. currentmodule:: mlx.core
.. automethod:: array.any
@@ -0,0 +1,6 @@
mlx.core.array.argmax
=====================
.. currentmodule:: mlx.core
.. automethod:: array.argmax
@@ -0,0 +1,6 @@
mlx.core.array.argmin
=====================
.. currentmodule:: mlx.core
.. automethod:: array.argmin
@@ -0,0 +1,6 @@
mlx.core.array.astype
=====================
.. currentmodule:: mlx.core
.. automethod:: array.astype
@@ -0,0 +1,6 @@
mlx.core.array.cos
==================
.. currentmodule:: mlx.core
.. automethod:: array.cos
@@ -0,0 +1,6 @@
mlx.core.array.dtype
====================
.. currentmodule:: mlx.core
.. autoproperty:: array.dtype
@@ -0,0 +1,6 @@
mlx.core.array.exp
==================
.. currentmodule:: mlx.core
.. automethod:: array.exp
@@ -0,0 +1,6 @@
mlx.core.array.item
===================
.. currentmodule:: mlx.core
.. automethod:: array.item
@@ -0,0 +1,6 @@
mlx.core.array.log
==================
.. currentmodule:: mlx.core
.. automethod:: array.log
@@ -0,0 +1,6 @@
mlx.core.array.log1p
====================
.. currentmodule:: mlx.core
.. automethod:: array.log1p
@@ -0,0 +1,6 @@
mlx.core.array.logsumexp
========================
.. currentmodule:: mlx.core
.. automethod:: array.logsumexp
@@ -0,0 +1,6 @@
mlx.core.array.max
==================
.. currentmodule:: mlx.core
.. automethod:: array.max
@@ -0,0 +1,6 @@
mlx.core.array.mean
===================
.. currentmodule:: mlx.core
.. automethod:: array.mean
@@ -0,0 +1,6 @@
mlx.core.array.min
==================
.. currentmodule:: mlx.core
.. automethod:: array.min
@@ -0,0 +1,6 @@
mlx.core.array.ndim
===================
.. currentmodule:: mlx.core
.. autoproperty:: array.ndim
@@ -0,0 +1,6 @@
mlx.core.array.prod
===================
.. currentmodule:: mlx.core
.. automethod:: array.prod
@@ -0,0 +1,6 @@
mlx.core.array.reciprocal
=========================
.. currentmodule:: mlx.core
.. automethod:: array.reciprocal
@@ -0,0 +1,6 @@
mlx.core.array.reshape
======================
.. currentmodule:: mlx.core
.. automethod:: array.reshape
@@ -0,0 +1,6 @@
mlx.core.array.rsqrt
====================
.. currentmodule:: mlx.core
.. automethod:: array.rsqrt
@@ -0,0 +1,66 @@
mlx.core.array
==============
.. currentmodule:: mlx.core
.. autoclass:: array
.. automethod:: __init__
.. rubric:: Methods
.. autosummary::
~array.__init__
~array.abs
~array.all
~array.any
~array.argmax
~array.argmin
~array.astype
~array.cos
~array.cummax
~array.cummin
~array.cumprod
~array.cumsum
~array.exp
~array.item
~array.log
~array.log10
~array.log1p
~array.log2
~array.logsumexp
~array.max
~array.mean
~array.min
~array.prod
~array.reciprocal
~array.reshape
~array.rsqrt
~array.sin
~array.split
~array.sqrt
~array.square
~array.squeeze
~array.sum
~array.tolist
~array.transpose
~array.var
.. rubric:: Attributes
.. autosummary::
~array.T
~array.dtype
~array.ndim
~array.shape
~array.size
@@ -0,0 +1,6 @@
mlx.core.array.shape
====================
.. currentmodule:: mlx.core
.. autoproperty:: array.shape
@@ -0,0 +1,6 @@
mlx.core.array.sin
==================
.. currentmodule:: mlx.core
.. automethod:: array.sin
@@ -0,0 +1,6 @@
mlx.core.array.size
===================
.. currentmodule:: mlx.core
.. autoproperty:: array.size
@@ -0,0 +1,6 @@
mlx.core.array.split
====================
.. currentmodule:: mlx.core
.. automethod:: array.split
@@ -0,0 +1,6 @@
mlx.core.array.sqrt
===================
.. currentmodule:: mlx.core
.. automethod:: array.sqrt
@@ -0,0 +1,6 @@
mlx.core.array.square
=====================
.. currentmodule:: mlx.core
.. automethod:: array.square
@@ -0,0 +1,6 @@
mlx.core.array.sum
==================
.. currentmodule:: mlx.core
.. automethod:: array.sum
@@ -0,0 +1,6 @@
mlx.core.array.tolist
=====================
.. currentmodule:: mlx.core
.. automethod:: array.tolist
@@ -0,0 +1,6 @@
mlx.core.array.transpose
========================
.. currentmodule:: mlx.core
.. automethod:: array.transpose
@@ -0,0 +1,6 @@
mlx.core.array.var
==================
.. currentmodule:: mlx.core
.. automethod:: array.var
@@ -0,0 +1,6 @@
mlx.core.array\_equal
=====================
.. currentmodule:: mlx.core
.. autofunction:: array_equal
@@ -0,0 +1,6 @@
mlx.core.broadcast\_to
======================
.. currentmodule:: mlx.core
.. autofunction:: broadcast_to
@@ -0,0 +1,6 @@
mlx.core.concatenate
====================
.. currentmodule:: mlx.core
.. autofunction:: concatenate
@@ -0,0 +1,6 @@
mlx.core.conv1d
===============
.. currentmodule:: mlx.core
.. autofunction:: conv1d
@@ -0,0 +1,6 @@
mlx.core.conv2d
===============
.. currentmodule:: mlx.core
.. autofunction:: conv2d
@@ -0,0 +1,6 @@
mlx.core.convolve
=================
.. currentmodule:: mlx.core
.. autofunction:: convolve
@@ -0,0 +1,6 @@
mlx.core.cos
============
.. currentmodule:: mlx.core
.. autofunction:: cos
@@ -0,0 +1,6 @@
mlx.core.cosh
=============
.. currentmodule:: mlx.core
.. autofunction:: cosh
@@ -0,0 +1,6 @@
mlx.core.default\_device
========================
.. currentmodule:: mlx.core
.. autofunction:: default_device
@@ -0,0 +1,6 @@
mlx.core.default\_stream
========================
.. currentmodule:: mlx.core
.. autofunction:: default_stream
@@ -0,0 +1,6 @@
mlx.core.divide
===============
.. currentmodule:: mlx.core
.. autofunction:: divide
@@ -0,0 +1,6 @@
mlx.core.equal
==============
.. currentmodule:: mlx.core
.. autofunction:: equal
@@ -0,0 +1,6 @@
mlx.core.erf
============
.. currentmodule:: mlx.core
.. autofunction:: erf
@@ -0,0 +1,6 @@
mlx.core.erfinv
===============
.. currentmodule:: mlx.core
.. autofunction:: erfinv
@@ -0,0 +1,6 @@
mlx.core.eval
=============
.. currentmodule:: mlx.core
.. autofunction:: eval
@@ -0,0 +1,6 @@
mlx.core.exp
============
.. currentmodule:: mlx.core
.. autofunction:: exp
@@ -0,0 +1,6 @@
mlx.core.expand\_dims
=====================
.. currentmodule:: mlx.core
.. autofunction:: expand_dims
@@ -0,0 +1,6 @@
mlx.core.fft.fft
================
.. currentmodule:: mlx.core.fft
.. autofunction:: fft
@@ -0,0 +1,6 @@
mlx.core.fft.fft2
=================
.. currentmodule:: mlx.core.fft
.. autofunction:: fft2
@@ -0,0 +1,6 @@
mlx.core.fft.fftn
=================
.. currentmodule:: mlx.core.fft
.. autofunction:: fftn
@@ -0,0 +1,6 @@
mlx.core.fft.ifft
=================
.. currentmodule:: mlx.core.fft
.. autofunction:: ifft
@@ -0,0 +1,6 @@
mlx.core.fft.ifft2
==================
.. currentmodule:: mlx.core.fft
.. autofunction:: ifft2
@@ -0,0 +1,6 @@
mlx.core.fft.ifftn
==================
.. currentmodule:: mlx.core.fft
.. autofunction:: ifftn
@@ -0,0 +1,6 @@
mlx.core.fft.irfft
==================
.. currentmodule:: mlx.core.fft
.. autofunction:: irfft
@@ -0,0 +1,6 @@
mlx.core.fft.irfft2
===================
.. currentmodule:: mlx.core.fft
.. autofunction:: irfft2
@@ -0,0 +1,6 @@
mlx.core.fft.irfftn
===================
.. currentmodule:: mlx.core.fft
.. autofunction:: irfftn
@@ -0,0 +1,6 @@
mlx.core.fft.rfft
=================
.. currentmodule:: mlx.core.fft
.. autofunction:: rfft
@@ -0,0 +1,6 @@
mlx.core.fft.rfft2
==================
.. currentmodule:: mlx.core.fft
.. autofunction:: rfft2
@@ -0,0 +1,6 @@
mlx.core.fft.rfftn
==================
.. currentmodule:: mlx.core.fft
.. autofunction:: rfftn
@@ -0,0 +1,6 @@
mlx.core.full
=============
.. currentmodule:: mlx.core
.. autofunction:: full
@@ -0,0 +1,6 @@
mlx.core.grad
=============
.. currentmodule:: mlx.core
.. autofunction:: grad
@@ -0,0 +1,6 @@
mlx.core.greater
================
.. currentmodule:: mlx.core
.. autofunction:: greater
@@ -0,0 +1,6 @@
mlx.core.greater\_equal
=======================
.. currentmodule:: mlx.core
.. autofunction:: greater_equal
@@ -0,0 +1,6 @@
mlx.core.jvp
============
.. currentmodule:: mlx.core
.. autofunction:: jvp
@@ -0,0 +1,6 @@
mlx.core.less
=============
.. currentmodule:: mlx.core
.. autofunction:: less
@@ -0,0 +1,6 @@
mlx.core.less\_equal
====================
.. currentmodule:: mlx.core
.. autofunction:: less_equal
@@ -0,0 +1,6 @@
mlx.core.load
=============
.. currentmodule:: mlx.core
.. autofunction:: load
@@ -0,0 +1,6 @@
mlx.core.log
============
.. currentmodule:: mlx.core
.. autofunction:: log
@@ -0,0 +1,6 @@
mlx.core.log10
==============
.. currentmodule:: mlx.core
.. autofunction:: log10
@@ -0,0 +1,6 @@
mlx.core.log1p
==============
.. currentmodule:: mlx.core
.. autofunction:: log1p
@@ -0,0 +1,6 @@
mlx.core.log2
=============
.. currentmodule:: mlx.core
.. autofunction:: log2
@@ -0,0 +1,6 @@
mlx.core.logaddexp
==================
.. currentmodule:: mlx.core
.. autofunction:: logaddexp
@@ -0,0 +1,6 @@
mlx.core.logical\_not
=====================
.. currentmodule:: mlx.core
.. autofunction:: logical_not
@@ -0,0 +1,6 @@
mlx.core.logsumexp
==================
.. currentmodule:: mlx.core
.. autofunction:: logsumexp
@@ -0,0 +1,6 @@
mlx.core.matmul
===============
.. currentmodule:: mlx.core
.. autofunction:: matmul
@@ -0,0 +1,6 @@
mlx.core.max
============
.. currentmodule:: mlx.core
.. autofunction:: max
@@ -0,0 +1,6 @@
mlx.core.maximum
================
.. currentmodule:: mlx.core
.. autofunction:: maximum
@@ -0,0 +1,6 @@
mlx.core.mean
=============
.. currentmodule:: mlx.core
.. autofunction:: mean

Some files were not shown because too many files have changed in this diff Show More