diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo index 61885dc99..8c5f7ab98 100644 --- a/docs/build/html/.buildinfo +++ b/docs/build/html/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 2a306b1bab538696d27d81f66f046d0d +config: 57f717b9ebf2db0403bb08af977fd504 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/build/html/_sources/index.rst b/docs/build/html/_sources/index.rst index 50dfe9083..e54a55b7a 100644 --- a/docs/build/html/_sources/index.rst +++ b/docs/build/html/_sources/index.rst @@ -64,6 +64,7 @@ are the CPU and GPU. python/transforms python/fft python/linalg + python/metal python/nn python/optimizers python/tree_utils diff --git a/docs/build/html/_sources/install.rst b/docs/build/html/_sources/install.rst index 6c0535079..ce549247f 100644 --- a/docs/build/html/_sources/install.rst +++ b/docs/build/html/_sources/install.rst @@ -15,10 +15,10 @@ To install from PyPI you must meet the following requirements: - Using an M series chip (Apple silicon) - Using a native Python >= 3.8 -- macOS >= 13.3 +- macOS >= 13.5 .. note:: - MLX is only available on devices running macOS >= 13.3 + MLX is only available on devices running macOS >= 13.5 It is highly recommended to use macOS 14 (Sonoma) @@ -54,7 +54,7 @@ Build Requirements - A C++ compiler with C++17 support (e.g. Clang >= 5.0) - `cmake `_ -- version 3.24 or later, and ``make`` -- Xcode >= 14.3 (Xcode >= 15.0 for macOS 14 and above) +- Xcode >= 15.0 and macOS SDK >= 14.0 .. note:: Ensure your shell environment is native ``arm``, not ``x86`` via Rosetta. If diff --git a/docs/build/html/_sources/python/_autosummary/mlx.core.isclose.rst b/docs/build/html/_sources/python/_autosummary/mlx.core.isclose.rst new file mode 100644 index 000000000..cae5ac0c7 --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary/mlx.core.isclose.rst @@ -0,0 +1,6 @@ +mlx.core.isclose +================ + +.. currentmodule:: mlx.core + +.. autofunction:: isclose \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary/mlx.core.metal.get_active_memory.rst b/docs/build/html/_sources/python/_autosummary/mlx.core.metal.get_active_memory.rst new file mode 100644 index 000000000..b705b936b --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary/mlx.core.metal.get_active_memory.rst @@ -0,0 +1,6 @@ +mlx.core.metal.get\_active\_memory +================================== + +.. currentmodule:: mlx.core.metal + +.. autofunction:: get_active_memory \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary/mlx.core.metal.get_cache_memory.rst b/docs/build/html/_sources/python/_autosummary/mlx.core.metal.get_cache_memory.rst new file mode 100644 index 000000000..bd0359013 --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary/mlx.core.metal.get_cache_memory.rst @@ -0,0 +1,6 @@ +mlx.core.metal.get\_cache\_memory +================================= + +.. currentmodule:: mlx.core.metal + +.. autofunction:: get_cache_memory \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary/mlx.core.metal.get_peak_memory.rst b/docs/build/html/_sources/python/_autosummary/mlx.core.metal.get_peak_memory.rst new file mode 100644 index 000000000..a887cf005 --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary/mlx.core.metal.get_peak_memory.rst @@ -0,0 +1,6 @@ +mlx.core.metal.get\_peak\_memory +================================ + +.. currentmodule:: mlx.core.metal + +.. autofunction:: get_peak_memory \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary/mlx.core.metal.is_available.rst b/docs/build/html/_sources/python/_autosummary/mlx.core.metal.is_available.rst new file mode 100644 index 000000000..b90054291 --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary/mlx.core.metal.is_available.rst @@ -0,0 +1,6 @@ +mlx.core.metal.is\_available +============================ + +.. currentmodule:: mlx.core.metal + +.. autofunction:: is_available \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary/mlx.core.metal.set_cache_limit.rst b/docs/build/html/_sources/python/_autosummary/mlx.core.metal.set_cache_limit.rst new file mode 100644 index 000000000..25a9cac7b --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary/mlx.core.metal.set_cache_limit.rst @@ -0,0 +1,6 @@ +mlx.core.metal.set\_cache\_limit +================================ + +.. currentmodule:: mlx.core.metal + +.. autofunction:: set_cache_limit \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary/mlx.core.metal.set_memory_limit.rst b/docs/build/html/_sources/python/_autosummary/mlx.core.metal.set_memory_limit.rst new file mode 100644 index 000000000..fbe59f6e1 --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary/mlx.core.metal.set_memory_limit.rst @@ -0,0 +1,6 @@ +mlx.core.metal.set\_memory\_limit +================================= + +.. currentmodule:: mlx.core.metal + +.. autofunction:: set_memory_limit \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary/mlx.core.tile.rst b/docs/build/html/_sources/python/_autosummary/mlx.core.tile.rst new file mode 100644 index 000000000..f841d583e --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary/mlx.core.tile.rst @@ -0,0 +1,6 @@ +mlx.core.tile +============= + +.. currentmodule:: mlx.core + +.. autofunction:: tile \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary/mlx.core.topk.rst b/docs/build/html/_sources/python/_autosummary/mlx.core.topk.rst new file mode 100644 index 000000000..6c9f575a9 --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary/mlx.core.topk.rst @@ -0,0 +1,6 @@ +mlx.core.topk +============= + +.. currentmodule:: mlx.core + +.. autofunction:: topk \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.AdaDelta.rst b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.AdaDelta.rst deleted file mode 100644 index 55792c434..000000000 --- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.AdaDelta.rst +++ /dev/null @@ -1,19 +0,0 @@ -mlx.optimizers.AdaDelta -======================= - -.. currentmodule:: mlx.optimizers - -.. autoclass:: AdaDelta - - - - - .. rubric:: Methods - - .. autosummary:: - - ~AdaDelta.__init__ - ~AdaDelta.apply_single - ~AdaDelta.init_single - - diff --git a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adafactor.rst b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adafactor.rst deleted file mode 100644 index 9047eea41..000000000 --- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adafactor.rst +++ /dev/null @@ -1,19 +0,0 @@ -mlx.optimizers.Adafactor -======================== - -.. currentmodule:: mlx.optimizers - -.. autoclass:: Adafactor - - - - - .. rubric:: Methods - - .. autosummary:: - - ~Adafactor.__init__ - ~Adafactor.apply_single - ~Adafactor.init_single - - diff --git a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adagrad.rst b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adagrad.rst deleted file mode 100644 index c12713e8a..000000000 --- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adagrad.rst +++ /dev/null @@ -1,19 +0,0 @@ -mlx.optimizers.Adagrad -====================== - -.. currentmodule:: mlx.optimizers - -.. autoclass:: Adagrad - - - - - .. rubric:: Methods - - .. autosummary:: - - ~Adagrad.__init__ - ~Adagrad.apply_single - ~Adagrad.init_single - - diff --git a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adam.rst b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adam.rst deleted file mode 100644 index 9ca26adfa..000000000 --- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adam.rst +++ /dev/null @@ -1,19 +0,0 @@ -mlx.optimizers.Adam -=================== - -.. currentmodule:: mlx.optimizers - -.. autoclass:: Adam - - - - - .. rubric:: Methods - - .. autosummary:: - - ~Adam.__init__ - ~Adam.apply_single - ~Adam.init_single - - diff --git a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.AdamW.rst b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.AdamW.rst deleted file mode 100644 index b5259844f..000000000 --- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.AdamW.rst +++ /dev/null @@ -1,18 +0,0 @@ -mlx.optimizers.AdamW -==================== - -.. currentmodule:: mlx.optimizers - -.. autoclass:: AdamW - - - - - .. rubric:: Methods - - .. autosummary:: - - ~AdamW.__init__ - ~AdamW.apply_single - - diff --git a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adamax.rst b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adamax.rst deleted file mode 100644 index 73dc7314d..000000000 --- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adamax.rst +++ /dev/null @@ -1,19 +0,0 @@ -mlx.optimizers.Adamax -===================== - -.. currentmodule:: mlx.optimizers - -.. autoclass:: Adamax - - - - - .. rubric:: Methods - - .. autosummary:: - - ~Adamax.__init__ - ~Adamax.apply_single - ~Adamax.init_single - - diff --git a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Lion.rst b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Lion.rst deleted file mode 100644 index 1454aada1..000000000 --- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Lion.rst +++ /dev/null @@ -1,19 +0,0 @@ -mlx.optimizers.Lion -=================== - -.. currentmodule:: mlx.optimizers - -.. autoclass:: Lion - - - - - .. rubric:: Methods - - .. autosummary:: - - ~Lion.__init__ - ~Lion.apply_single - ~Lion.init_single - - diff --git a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Optimizer.apply_gradients.rst b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Optimizer.apply_gradients.rst deleted file mode 100644 index 763eeb293..000000000 --- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Optimizer.apply_gradients.rst +++ /dev/null @@ -1,6 +0,0 @@ -mlx.optimizers.Optimizer.apply\_gradients -========================================= - -.. currentmodule:: mlx.optimizers - -.. automethod:: Optimizer.apply_gradients \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Optimizer.init.rst b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Optimizer.init.rst deleted file mode 100644 index e0245cf02..000000000 --- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Optimizer.init.rst +++ /dev/null @@ -1,6 +0,0 @@ -mlx.optimizers.Optimizer.init -============================= - -.. currentmodule:: mlx.optimizers - -.. automethod:: Optimizer.init \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Optimizer.state.rst b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Optimizer.state.rst deleted file mode 100644 index e0bf31dbe..000000000 --- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Optimizer.state.rst +++ /dev/null @@ -1,6 +0,0 @@ -mlx.optimizers.Optimizer.state -============================== - -.. currentmodule:: mlx.optimizers - -.. autoproperty:: Optimizer.state \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Optimizer.update.rst b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Optimizer.update.rst deleted file mode 100644 index e7610999e..000000000 --- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Optimizer.update.rst +++ /dev/null @@ -1,6 +0,0 @@ -mlx.optimizers.Optimizer.update -=============================== - -.. currentmodule:: mlx.optimizers - -.. automethod:: Optimizer.update \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.RMSprop.rst b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.RMSprop.rst deleted file mode 100644 index d9ba20078..000000000 --- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.RMSprop.rst +++ /dev/null @@ -1,19 +0,0 @@ -mlx.optimizers.RMSprop -====================== - -.. currentmodule:: mlx.optimizers - -.. autoclass:: RMSprop - - - - - .. rubric:: Methods - - .. autosummary:: - - ~RMSprop.__init__ - ~RMSprop.apply_single - ~RMSprop.init_single - - diff --git a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.SGD.rst b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.SGD.rst deleted file mode 100644 index 4b6f397ec..000000000 --- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.SGD.rst +++ /dev/null @@ -1,19 +0,0 @@ -mlx.optimizers.SGD -================== - -.. currentmodule:: mlx.optimizers - -.. autoclass:: SGD - - - - - .. rubric:: Methods - - .. autosummary:: - - ~SGD.__init__ - ~SGD.apply_single - ~SGD.init_single - - diff --git a/docs/build/html/_sources/python/_autosummary_stream/Stream.rst b/docs/build/html/_sources/python/_autosummary_stream/Stream.rst deleted file mode 100644 index 14a00e70b..000000000 --- a/docs/build/html/_sources/python/_autosummary_stream/Stream.rst +++ /dev/null @@ -1,28 +0,0 @@ -mlx.core.Stream -=============== - -.. currentmodule:: mlx.core - -.. autoclass:: Stream - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~Stream.__init__ - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~Stream.device - - \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary_stream/mlx.core.Device.rst b/docs/build/html/_sources/python/_autosummary_stream/mlx.core.Device.rst deleted file mode 100644 index eafe9082b..000000000 --- a/docs/build/html/_sources/python/_autosummary_stream/mlx.core.Device.rst +++ /dev/null @@ -1,28 +0,0 @@ -mlx.core.Device -=============== - -.. currentmodule:: mlx.core - -.. autoclass:: Device - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~Device.__init__ - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~Device.type - - \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary_stream/mlx.core.Stream.rst b/docs/build/html/_sources/python/_autosummary_stream/mlx.core.Stream.rst deleted file mode 100644 index 14a00e70b..000000000 --- a/docs/build/html/_sources/python/_autosummary_stream/mlx.core.Stream.rst +++ /dev/null @@ -1,28 +0,0 @@ -mlx.core.Stream -=============== - -.. currentmodule:: mlx.core - -.. autoclass:: Stream - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~Stream.__init__ - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~Stream.device - - \ No newline at end of file diff --git a/docs/build/html/_sources/python/metal.rst b/docs/build/html/_sources/python/metal.rst new file mode 100644 index 000000000..c11deb4fa --- /dev/null +++ b/docs/build/html/_sources/python/metal.rst @@ -0,0 +1,14 @@ +Metal +===== + +.. currentmodule:: mlx.core.metal + +.. autosummary:: + :toctree: _autosummary + + is_available + get_active_memory + get_peak_memory + get_cache_memory + set_memory_limit + set_cache_limit diff --git a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.GRU.rst b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.GRU.rst new file mode 100644 index 000000000..568e2f6f4 --- /dev/null +++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.GRU.rst @@ -0,0 +1,6 @@ +mlx.nn.GRU +========== + +.. currentmodule:: mlx.nn + +.. autoclass:: GRU \ No newline at end of file diff --git a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.LSTM.rst b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.LSTM.rst new file mode 100644 index 000000000..08344b86d --- /dev/null +++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.LSTM.rst @@ -0,0 +1,6 @@ +mlx.nn.LSTM +=========== + +.. currentmodule:: mlx.nn + +.. autoclass:: LSTM \ No newline at end of file diff --git a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.RNN.rst b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.RNN.rst new file mode 100644 index 000000000..6a6a1edb7 --- /dev/null +++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.RNN.rst @@ -0,0 +1,6 @@ +mlx.nn.RNN +========== + +.. currentmodule:: mlx.nn + +.. autoclass:: RNN \ No newline at end of file diff --git a/docs/build/html/_sources/python/nn/layers.rst b/docs/build/html/_sources/python/nn/layers.rst index f6755e8fe..c0b59b6d4 100644 --- a/docs/build/html/_sources/python/nn/layers.rst +++ b/docs/build/html/_sources/python/nn/layers.rst @@ -21,9 +21,11 @@ Layers Embedding GELU GroupNorm + GRU InstanceNorm LayerNorm Linear + LSTM MaxPool1d MaxPool2d Mish @@ -32,6 +34,7 @@ Layers QuantizedLinear RMSNorm ReLU + RNN RoPE SELU Sequential diff --git a/docs/build/html/_sources/python/ops.rst b/docs/build/html/_sources/python/ops.rst index 2cc2b6d6b..6396bb3c6 100644 --- a/docs/build/html/_sources/python/ops.rst +++ b/docs/build/html/_sources/python/ops.rst @@ -57,6 +57,7 @@ Operations greater_equal identity inner + isclose isnan isposinf isneginf @@ -121,6 +122,8 @@ Operations tan tanh tensordot + tile + topk transpose tri tril diff --git a/docs/build/html/_sources/python/optimizer.rst b/docs/build/html/_sources/python/optimizer.rst deleted file mode 100644 index cf6034dee..000000000 --- a/docs/build/html/_sources/python/optimizer.rst +++ /dev/null @@ -1,23 +0,0 @@ -Optimizer -========= - -.. currentmodule:: mlx.optimizers - -.. autoclass:: Optimizer - - - .. rubric:: Attributes - - .. autosummary:: - :toctree: _autosummary - - Optimizer.state - - .. rubric:: Methods - - .. autosummary:: - :toctree: _autosummary - - Optimizer.apply_gradients - Optimizer.init - Optimizer.update diff --git a/docs/build/html/_sources/usage/function_transforms.rst b/docs/build/html/_sources/usage/function_transforms.rst index 02c5dec48..77e58058a 100644 --- a/docs/build/html/_sources/usage/function_transforms.rst +++ b/docs/build/html/_sources/usage/function_transforms.rst @@ -40,7 +40,7 @@ getting higher order derivatives. Any of the MLX function transformations can be composed in any order to any depth. See the following sections for more information on :ref:`automatic -differentiaion ` and :ref:`automatic vectorization `. +differentiation ` and :ref:`automatic vectorization `. For more information on :func:`compile` see the :ref:`compile documentation `. diff --git a/docs/build/html/_static/documentation_options.js b/docs/build/html/_static/documentation_options.js index a168ebdde..f9bd6663c 100644 --- a/docs/build/html/_static/documentation_options.js +++ b/docs/build/html/_static/documentation_options.js @@ -1,6 +1,6 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '0.5.0', + VERSION: '0.6.0', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/docs/build/html/cpp/ops.html b/docs/build/html/cpp/ops.html index 0f5b651d5..337c8fb17 100644 --- a/docs/build/html/cpp/ops.html +++ b/docs/build/html/cpp/ops.html @@ -9,7 +9,7 @@ - Operations — MLX 0.5.0 documentation + Operations — MLX 0.6.0 documentation @@ -134,8 +134,8 @@ - MLX 0.5.0 documentation - Home - + MLX 0.6.0 documentation - Home + @@ -265,6 +265,7 @@
  • mlx.core.greater_equal
  • mlx.core.identity
  • mlx.core.inner
    • +
  • mlx.core.isclose
  • mlx.core.isnan
  • mlx.core.isposinf
  • mlx.core.isneginf
    • @@ -329,6 +330,8 @@
  • mlx.core.tan
  • mlx.core.tanh
  • mlx.core.tensordot
    • +
  • mlx.core.tile
    • +
  • mlx.core.topk
  • mlx.core.transpose
  • mlx.core.tri
  • mlx.core.tril
    • @@ -384,9 +387,18 @@
  • mlx.core.linalg.qr
    • -
  • Neural Networks