diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo index 0241e00e..e1d1fbf9 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: b49cb089891263e82aedf5bc4cacbe8a +config: 59497ac668d2f3a880c24eaae6f1b8ae tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/build/html/_sources/dev/extensions.rst b/docs/build/html/_sources/dev/extensions.rst index 3563305b..5f63c633 100644 --- a/docs/build/html/_sources/dev/extensions.rst +++ b/docs/build/html/_sources/dev/extensions.rst @@ -35,7 +35,7 @@ However, you work with vector math libraries often and realize that the You would really like the part of your applications that does this operation on the CPU to be very fast - so you decide that you want it to rely on the ``axpby`` routine provided by the Accelerate_ framework. Continuing to impose -our assumptions on to you, let's also assume that you want to learn how add +our assumptions on to you, let's also assume that you want to learn how to add your own implementation for the gradients of your new operation while going over the ins-and-outs of the MLX framework. diff --git a/docs/build/html/_sources/python/_autosummary/mlx.core.Stream.rst b/docs/build/html/_sources/python/_autosummary/mlx.core.Stream.rst index 14a00e70..9c8f4770 100644 --- a/docs/build/html/_sources/python/_autosummary/mlx.core.Stream.rst +++ b/docs/build/html/_sources/python/_autosummary/mlx.core.Stream.rst @@ -1,28 +1,6 @@ -mlx.core.Stream +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 +.. autofunction:: stream \ No newline at end of file diff --git a/docs/build/html/_sources/python/_autosummary/stream_class.rst b/docs/build/html/_sources/python/_autosummary/stream_class.rst new file mode 100644 index 00000000..14a00e70 --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary/stream_class.rst @@ -0,0 +1,28 @@ +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/Stream.rst b/docs/build/html/_sources/python/_autosummary_stream/Stream.rst new file mode 100644 index 00000000..14a00e70 --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary_stream/Stream.rst @@ -0,0 +1,28 @@ +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 new file mode 100644 index 00000000..eafe9082 --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary_stream/mlx.core.Device.rst @@ -0,0 +1,28 @@ +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 new file mode 100644 index 00000000..14a00e70 --- /dev/null +++ b/docs/build/html/_sources/python/_autosummary_stream/mlx.core.Stream.rst @@ -0,0 +1,28 @@ +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/devices_and_streams.rst b/docs/build/html/_sources/python/devices_and_streams.rst index bb9dfae2..e16ab987 100644 --- a/docs/build/html/_sources/python/devices_and_streams.rst +++ b/docs/build/html/_sources/python/devices_and_streams.rst @@ -9,9 +9,10 @@ Devices and Streams :toctree: _autosummary Device + Stream default_device set_default_device - Stream default_stream new_stream set_default_stream + stream diff --git a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.AvgPool1d.rst b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.AvgPool1d.rst new file mode 100644 index 00000000..55ec40f1 --- /dev/null +++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.AvgPool1d.rst @@ -0,0 +1,6 @@ +mlx.nn.AvgPool1d +================ + +.. currentmodule:: mlx.nn + +.. autoclass:: AvgPool1d \ No newline at end of file diff --git a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.AvgPool2d.rst b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.AvgPool2d.rst new file mode 100644 index 00000000..a31b6f43 --- /dev/null +++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.AvgPool2d.rst @@ -0,0 +1,6 @@ +mlx.nn.AvgPool2d +================ + +.. currentmodule:: mlx.nn + +.. autoclass:: AvgPool2d \ No newline at end of file diff --git a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.MaxPool1d.rst b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.MaxPool1d.rst new file mode 100644 index 00000000..43ac8cad --- /dev/null +++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.MaxPool1d.rst @@ -0,0 +1,6 @@ +mlx.nn.MaxPool1d +================ + +.. currentmodule:: mlx.nn + +.. autoclass:: MaxPool1d \ No newline at end of file diff --git a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.MaxPool2d.rst b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.MaxPool2d.rst new file mode 100644 index 00000000..ad93796f --- /dev/null +++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.MaxPool2d.rst @@ -0,0 +1,6 @@ +mlx.nn.MaxPool2d +================ + +.. currentmodule:: mlx.nn + +.. autoclass:: MaxPool2d \ 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 ef099ef2..0f5fca9d 100644 --- a/docs/build/html/_sources/python/nn/layers.rst +++ b/docs/build/html/_sources/python/nn/layers.rst @@ -10,6 +10,8 @@ Layers :template: nn-module-template.rst ALiBi + AvgPool1d + AvgPool2d BatchNorm Conv1d Conv2d @@ -22,6 +24,8 @@ Layers InstanceNorm LayerNorm Linear + MaxPool1d + MaxPool2d Mish MultiHeadAttention PReLU diff --git a/docs/build/html/_sources/python/optimizers.rst b/docs/build/html/_sources/python/optimizers.rst index 4ef43d50..f437ddc1 100644 --- a/docs/build/html/_sources/python/optimizers.rst +++ b/docs/build/html/_sources/python/optimizers.rst @@ -31,20 +31,6 @@ model's parameters and the **optimizer state**. .. toctree:: - optimizer - -.. currentmodule:: mlx.optimizers - -.. autosummary:: - :toctree: _autosummary - :template: optimizers-template.rst - - SGD - RMSprop - Adagrad - Adafactor - AdaDelta - Adam - AdamW - Adamax - Lion + optimizers/optimizer + optimizers/common_optimizers + optimizers/schedulers diff --git a/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.AdaDelta.rst b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.AdaDelta.rst new file mode 100644 index 00000000..55792c43 --- /dev/null +++ b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.AdaDelta.rst @@ -0,0 +1,19 @@ +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/optimizers/_autosummary/mlx.optimizers.Adafactor.rst b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Adafactor.rst new file mode 100644 index 00000000..9047eea4 --- /dev/null +++ b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Adafactor.rst @@ -0,0 +1,19 @@ +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/optimizers/_autosummary/mlx.optimizers.Adagrad.rst b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Adagrad.rst new file mode 100644 index 00000000..c12713e8 --- /dev/null +++ b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Adagrad.rst @@ -0,0 +1,19 @@ +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/optimizers/_autosummary/mlx.optimizers.Adam.rst b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Adam.rst new file mode 100644 index 00000000..9ca26adf --- /dev/null +++ b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Adam.rst @@ -0,0 +1,19 @@ +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/optimizers/_autosummary/mlx.optimizers.AdamW.rst b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.AdamW.rst new file mode 100644 index 00000000..b5259844 --- /dev/null +++ b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.AdamW.rst @@ -0,0 +1,18 @@ +mlx.optimizers.AdamW +==================== + +.. currentmodule:: mlx.optimizers + +.. autoclass:: AdamW + + + + + .. rubric:: Methods + + .. autosummary:: + + ~AdamW.__init__ + ~AdamW.apply_single + + diff --git a/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Adamax.rst b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Adamax.rst new file mode 100644 index 00000000..73dc7314 --- /dev/null +++ b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Adamax.rst @@ -0,0 +1,19 @@ +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/optimizers/_autosummary/mlx.optimizers.Lion.rst b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Lion.rst new file mode 100644 index 00000000..1454aada --- /dev/null +++ b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Lion.rst @@ -0,0 +1,19 @@ +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/optimizers/_autosummary/mlx.optimizers.Optimizer.apply_gradients.rst b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Optimizer.apply_gradients.rst new file mode 100644 index 00000000..763eeb29 --- /dev/null +++ b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Optimizer.apply_gradients.rst @@ -0,0 +1,6 @@ +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/optimizers/_autosummary/mlx.optimizers.Optimizer.init.rst b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Optimizer.init.rst new file mode 100644 index 00000000..e0245cf0 --- /dev/null +++ b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Optimizer.init.rst @@ -0,0 +1,6 @@ +mlx.optimizers.Optimizer.init +============================= + +.. currentmodule:: mlx.optimizers + +.. automethod:: Optimizer.init \ No newline at end of file diff --git a/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Optimizer.state.rst b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Optimizer.state.rst new file mode 100644 index 00000000..e0bf31db --- /dev/null +++ b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Optimizer.state.rst @@ -0,0 +1,6 @@ +mlx.optimizers.Optimizer.state +============================== + +.. currentmodule:: mlx.optimizers + +.. autoproperty:: Optimizer.state \ No newline at end of file diff --git a/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Optimizer.update.rst b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Optimizer.update.rst new file mode 100644 index 00000000..e7610999 --- /dev/null +++ b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.Optimizer.update.rst @@ -0,0 +1,6 @@ +mlx.optimizers.Optimizer.update +=============================== + +.. currentmodule:: mlx.optimizers + +.. automethod:: Optimizer.update \ No newline at end of file diff --git a/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.RMSprop.rst b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.RMSprop.rst new file mode 100644 index 00000000..d9ba2007 --- /dev/null +++ b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.RMSprop.rst @@ -0,0 +1,19 @@ +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/optimizers/_autosummary/mlx.optimizers.SGD.rst b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.SGD.rst new file mode 100644 index 00000000..4b6f397e --- /dev/null +++ b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.SGD.rst @@ -0,0 +1,19 @@ +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/optimizers/_autosummary/mlx.optimizers.cosine_decay.rst b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.cosine_decay.rst new file mode 100644 index 00000000..051af242 --- /dev/null +++ b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.cosine_decay.rst @@ -0,0 +1,6 @@ +mlx.optimizers.cosine\_decay +============================ + +.. currentmodule:: mlx.optimizers + +.. autofunction:: cosine_decay \ No newline at end of file diff --git a/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.exponential_decay.rst b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.exponential_decay.rst new file mode 100644 index 00000000..b5ceab51 --- /dev/null +++ b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.exponential_decay.rst @@ -0,0 +1,6 @@ +mlx.optimizers.exponential\_decay +================================= + +.. currentmodule:: mlx.optimizers + +.. autofunction:: exponential_decay \ No newline at end of file diff --git a/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.step_decay.rst b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.step_decay.rst new file mode 100644 index 00000000..2d691ecb --- /dev/null +++ b/docs/build/html/_sources/python/optimizers/_autosummary/mlx.optimizers.step_decay.rst @@ -0,0 +1,6 @@ +mlx.optimizers.step\_decay +========================== + +.. currentmodule:: mlx.optimizers + +.. autofunction:: step_decay \ No newline at end of file diff --git a/docs/build/html/_sources/python/optimizers/common_optimizers.rst b/docs/build/html/_sources/python/optimizers/common_optimizers.rst new file mode 100644 index 00000000..41b3fba0 --- /dev/null +++ b/docs/build/html/_sources/python/optimizers/common_optimizers.rst @@ -0,0 +1,20 @@ +.. _common_optimizers: + +Common Optimizers +================= + +.. currentmodule:: mlx.optimizers + +.. autosummary:: + :toctree: _autosummary + :template: optimizers-template.rst + + SGD + RMSprop + Adagrad + Adafactor + AdaDelta + Adam + AdamW + Adamax + Lion diff --git a/docs/build/html/_sources/python/optimizers/optimizer.rst b/docs/build/html/_sources/python/optimizers/optimizer.rst new file mode 100644 index 00000000..cf6034de --- /dev/null +++ b/docs/build/html/_sources/python/optimizers/optimizer.rst @@ -0,0 +1,23 @@ +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/python/optimizers/schedulers.rst b/docs/build/html/_sources/python/optimizers/schedulers.rst new file mode 100644 index 00000000..a83883dd --- /dev/null +++ b/docs/build/html/_sources/python/optimizers/schedulers.rst @@ -0,0 +1,13 @@ +.. _schedulers: + +Schedulers +========== + +.. currentmodule:: mlx.optimizers + +.. autosummary:: + :toctree: _autosummary + + step_decay + exponential_decay + cosine_decay diff --git a/docs/build/html/_static/documentation_options.js b/docs/build/html/_static/documentation_options.js index ff2bcd03..a117f34f 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.2.0', + VERSION: '0.3.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 fc78b923..0c9ffa37 100644 --- a/docs/build/html/cpp/ops.html +++ b/docs/build/html/cpp/ops.html @@ -9,7 +9,7 @@ - Operations — MLX 0.2.0 documentation + Operations — MLX 0.3.0 documentation @@ -134,8 +134,8 @@ - MLX 0.2.0 documentation - Home - + MLX 0.3.0 documentation - Home + @@ -206,12 +206,13 @@
  • Devices and Streams
  • Operations