docs update

2025-09-20 03:48:15 +08:00 · 2024-03-14 12:46:45 -07:00
parent 1fbcfa159f
commit bc695f2050
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
-   
-