docs update

2025-11-06 03:58:12 +08:00 · 2024-03-14 12:46:45 -07:00
parent 2bc2b00a93
commit ba2f0b1e8e
411 changed files with 15444 additions and 13066 deletions
--- a/docs/build/html/_sources/python/_autosummary/mlx.core.isclose.rst
+++ b/docs/build/html/_sources/python/_autosummary/mlx.core.isclose.rst
@@ -0,0 +1,6 @@
+mlx.core.isclose
+================
+
+.. currentmodule:: mlx.core
+
+.. autofunction:: isclose
--- 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
@@ -0,0 +1,6 @@
+mlx.core.metal.get\_active\_memory
+==================================
+
+.. currentmodule:: mlx.core.metal
+
+.. autofunction:: get_active_memory
--- 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
@@ -0,0 +1,6 @@
+mlx.core.metal.get\_cache\_memory
+=================================
+
+.. currentmodule:: mlx.core.metal
+
+.. autofunction:: get_cache_memory
--- 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
@@ -0,0 +1,6 @@
+mlx.core.metal.get\_peak\_memory
+================================
+
+.. currentmodule:: mlx.core.metal
+
+.. autofunction:: get_peak_memory
--- 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
@@ -0,0 +1,6 @@
+mlx.core.metal.is\_available
+============================
+
+.. currentmodule:: mlx.core.metal
+
+.. autofunction:: is_available
--- 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
@@ -0,0 +1,6 @@
+mlx.core.metal.set\_cache\_limit
+================================
+
+.. currentmodule:: mlx.core.metal
+
+.. autofunction:: set_cache_limit
--- 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
@@ -0,0 +1,6 @@
+mlx.core.metal.set\_memory\_limit
+=================================
+
+.. currentmodule:: mlx.core.metal
+
+.. autofunction:: set_memory_limit
--- a/docs/build/html/_sources/python/_autosummary/mlx.core.tile.rst
+++ b/docs/build/html/_sources/python/_autosummary/mlx.core.tile.rst
@@ -0,0 +1,6 @@
+mlx.core.tile
+=============
+
+.. currentmodule:: mlx.core
+
+.. autofunction:: tile
--- a/docs/build/html/_sources/python/_autosummary/mlx.core.topk.rst
+++ b/docs/build/html/_sources/python/_autosummary/mlx.core.topk.rst
@@ -0,0 +1,6 @@
+mlx.core.topk
+=============
+
+.. currentmodule:: mlx.core
+
+.. autofunction:: topk
--- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.AdaDelta.rst
+++ b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.AdaDelta.rst
@@ -1,19 +0,0 @@
-mlx.optimizers.AdaDelta
-=======================
-
-.. currentmodule:: mlx.optimizers
-
-.. autoclass:: AdaDelta
-
-   
-
-   
-   .. rubric:: Methods
-
-   .. autosummary::
-   
-         ~AdaDelta.__init__
-         ~AdaDelta.apply_single
-         ~AdaDelta.init_single
-   
-   
--- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adafactor.rst
+++ b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adafactor.rst
@@ -1,19 +0,0 @@
-mlx.optimizers.Adafactor
-========================
-
-.. currentmodule:: mlx.optimizers
-
-.. autoclass:: Adafactor
-
-   
-
-   
-   .. rubric:: Methods
-
-   .. autosummary::
-   
-         ~Adafactor.__init__
-         ~Adafactor.apply_single
-         ~Adafactor.init_single
-   
-   
--- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adagrad.rst
+++ b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adagrad.rst
@@ -1,19 +0,0 @@
-mlx.optimizers.Adagrad
-======================
-
-.. currentmodule:: mlx.optimizers
-
-.. autoclass:: Adagrad
-
-   
-
-   
-   .. rubric:: Methods
-
-   .. autosummary::
-   
-         ~Adagrad.__init__
-         ~Adagrad.apply_single
-         ~Adagrad.init_single
-   
-   
--- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adam.rst
+++ b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adam.rst
@@ -1,19 +0,0 @@
-mlx.optimizers.Adam
-===================
-
-.. currentmodule:: mlx.optimizers
-
-.. autoclass:: Adam
-
-   
-
-   
-   .. rubric:: Methods
-
-   .. autosummary::
-   
-         ~Adam.__init__
-         ~Adam.apply_single
-         ~Adam.init_single
-   
-   
--- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.AdamW.rst
+++ b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.AdamW.rst
@@ -1,18 +0,0 @@
-mlx.optimizers.AdamW
-====================
-
-.. currentmodule:: mlx.optimizers
-
-.. autoclass:: AdamW
-
-   
-
-   
-   .. rubric:: Methods
-
-   .. autosummary::
-   
-         ~AdamW.__init__
-         ~AdamW.apply_single
-   
-   
--- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adamax.rst
+++ b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adamax.rst
@@ -1,19 +0,0 @@
-mlx.optimizers.Adamax
-=====================
-
-.. currentmodule:: mlx.optimizers
-
-.. autoclass:: Adamax
-
-   
-
-   
-   .. rubric:: Methods
-
-   .. autosummary::
-   
-         ~Adamax.__init__
-         ~Adamax.apply_single
-         ~Adamax.init_single
-   
-   
--- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Lion.rst
+++ b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Lion.rst
@@ -1,19 +0,0 @@
-mlx.optimizers.Lion
-===================
-
-.. currentmodule:: mlx.optimizers
-
-.. autoclass:: Lion
-
-   
-
-   
-   .. rubric:: Methods
-
-   .. autosummary::
-   
-         ~Lion.__init__
-         ~Lion.apply_single
-         ~Lion.init_single
-   
-   
--- 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
@@ -1,6 +0,0 @@
-mlx.optimizers.Optimizer.apply\_gradients
-=========================================
-
-.. currentmodule:: mlx.optimizers
-
-.. automethod:: Optimizer.apply_gradients
--- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Optimizer.init.rst
+++ b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Optimizer.init.rst
@@ -1,6 +0,0 @@
-mlx.optimizers.Optimizer.init
-=============================
-
-.. currentmodule:: mlx.optimizers
-
-.. automethod:: Optimizer.init
--- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Optimizer.state.rst
+++ b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Optimizer.state.rst
@@ -1,6 +0,0 @@
-mlx.optimizers.Optimizer.state
-==============================
-
-.. currentmodule:: mlx.optimizers
-
-.. autoproperty:: Optimizer.state
--- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Optimizer.update.rst
+++ b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Optimizer.update.rst
@@ -1,6 +0,0 @@
-mlx.optimizers.Optimizer.update
-===============================
-
-.. currentmodule:: mlx.optimizers
-
-.. automethod:: Optimizer.update
--- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.RMSprop.rst
+++ b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.RMSprop.rst
@@ -1,19 +0,0 @@
-mlx.optimizers.RMSprop
-======================
-
-.. currentmodule:: mlx.optimizers
-
-.. autoclass:: RMSprop
-
-   
-
-   
-   .. rubric:: Methods
-
-   .. autosummary::
-   
-         ~RMSprop.__init__
-         ~RMSprop.apply_single
-         ~RMSprop.init_single
-   
-   
--- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.SGD.rst
+++ b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.SGD.rst
@@ -1,19 +0,0 @@
-mlx.optimizers.SGD
-==================
-
-.. currentmodule:: mlx.optimizers
-
-.. autoclass:: SGD
-
-   
-
-   
-   .. rubric:: Methods
-
-   .. autosummary::
-   
-         ~SGD.__init__
-         ~SGD.apply_single
-         ~SGD.init_single
-   
-   
--- a/docs/build/html/_sources/python/_autosummary_stream/Stream.rst
+++ b/docs/build/html/_sources/python/_autosummary_stream/Stream.rst
@@ -1,28 +0,0 @@
-mlx.core.Stream
-===============
-
-.. currentmodule:: mlx.core
-
-.. autoclass:: Stream
-
-   
-   .. automethod:: __init__
-
-   
-   .. rubric:: Methods
-
-   .. autosummary::
-   
-      ~Stream.__init__
-   
-   
-
-   
-   
-   .. rubric:: Attributes
-
-   .. autosummary::
-   
-      ~Stream.device
-   
-   
--- a/docs/build/html/_sources/python/_autosummary_stream/mlx.core.Device.rst
+++ b/docs/build/html/_sources/python/_autosummary_stream/mlx.core.Device.rst
@@ -1,28 +0,0 @@
-mlx.core.Device
-===============
-
-.. currentmodule:: mlx.core
-
-.. autoclass:: Device
-
-   
-   .. automethod:: __init__
-
-   
-   .. rubric:: Methods
-
-   .. autosummary::
-   
-      ~Device.__init__
-   
-   
-
-   
-   
-   .. rubric:: Attributes
-
-   .. autosummary::
-   
-      ~Device.type
-   
-   
--- a/docs/build/html/_sources/python/_autosummary_stream/mlx.core.Stream.rst
+++ b/docs/build/html/_sources/python/_autosummary_stream/mlx.core.Stream.rst
@@ -1,28 +0,0 @@
-mlx.core.Stream
-===============
-
-.. currentmodule:: mlx.core
-
-.. autoclass:: Stream
-
-   
-   .. automethod:: __init__
-
-   
-   .. rubric:: Methods
-
-   .. autosummary::
-   
-      ~Stream.__init__
-   
-   
-
-   
-   
-   .. rubric:: Attributes
-
-   .. autosummary::
-   
-      ~Stream.device
-   
-   
--- a/docs/build/html/_sources/python/metal.rst
+++ 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
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.GRU.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.GRU.rst
@@ -0,0 +1,6 @@
+mlx.nn.GRU
+==========
+
+.. currentmodule:: mlx.nn
+
+.. autoclass:: GRU
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.LSTM.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.LSTM.rst
@@ -0,0 +1,6 @@
+mlx.nn.LSTM
+===========
+
+.. currentmodule:: mlx.nn
+
+.. autoclass:: LSTM
--- a/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.RNN.rst
+++ b/docs/build/html/_sources/python/nn/_autosummary/mlx.nn.RNN.rst
@@ -0,0 +1,6 @@
+mlx.nn.RNN
+==========
+
+.. currentmodule:: mlx.nn
+
+.. autoclass:: RNN
--- 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
--- 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
--- a/docs/build/html/_sources/python/optimizer.rst
+++ b/docs/build/html/_sources/python/optimizer.rst
@@ -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