docs update

2025-09-24 23:08:15 +08:00 · 2024-02-08 12:44:23 -08:00
parent f65f98fc82
commit 9c44222630
437 changed files with 11568 additions and 13689 deletions
--- a/docs/build/html/_sources/python/_autosummary/mlx.core.compile.rst
+++ b/docs/build/html/_sources/python/_autosummary/mlx.core.compile.rst
@@ -0,0 +1,6 @@
+mlx.core.compile
+================
+
+.. currentmodule:: mlx.core
+
+.. autofunction:: compile
--- a/docs/build/html/_sources/python/_autosummary/mlx.core.disable_compile.rst
+++ b/docs/build/html/_sources/python/_autosummary/mlx.core.disable_compile.rst
@@ -0,0 +1,6 @@
+mlx.core.disable\_compile
+=========================
+
+.. currentmodule:: mlx.core
+
+.. autofunction:: disable_compile
--- a/docs/build/html/_sources/python/_autosummary/mlx.core.enable_compile.rst
+++ b/docs/build/html/_sources/python/_autosummary/mlx.core.enable_compile.rst
@@ -0,0 +1,6 @@
+mlx.core.enable\_compile
+========================
+
+.. currentmodule:: mlx.core
+
+.. autofunction:: enable_compile
--- a/docs/build/html/_sources/python/_autosummary/mlx.core.simplify.rst
+++ b/docs/build/html/_sources/python/_autosummary/mlx.core.simplify.rst
@@ -1,6 +0,0 @@
-mlx.core.simplify
-=================
-
-.. currentmodule:: mlx.core
-
-.. autofunction:: simplify
--- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.AdaDelta.rst
+++ b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.AdaDelta.rst
@@ -14,5 +14,6 @@
   
         ~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
@@ -14,5 +14,6 @@
   
         ~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
@@ -14,5 +14,6 @@
   
         ~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
@@ -14,5 +14,6 @@
   
         ~Adam.__init__
         ~Adam.apply_single
+         ~Adam.init_single
   
   
--- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adamax.rst
+++ b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Adamax.rst
@@ -14,5 +14,6 @@
   
         ~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
@@ -14,5 +14,6 @@
   
         ~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
@@ -0,0 +1,6 @@
+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
@@ -0,0 +1,6 @@
+mlx.optimizers.Optimizer.init
+=============================
+
+.. currentmodule:: mlx.optimizers
+
+.. automethod:: Optimizer.init
--- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Optimizer.rst
+++ b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Optimizer.rst
@@ -1,20 +0,0 @@
-mlx.optimizers.Optimizer
-========================
-
-.. currentmodule:: mlx.optimizers
-
-.. autoclass:: Optimizer
-
-   
-
-   
-   .. rubric:: Methods
-
-   .. autosummary::
-   
-         ~Optimizer.__init__
-         ~Optimizer.apply_gradients
-         ~Optimizer.apply_single
-         ~Optimizer.update
-   
-   
--- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Optimizer.state.rst
+++ b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.Optimizer.state.rst
@@ -0,0 +1,6 @@
+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
@@ -0,0 +1,6 @@
+mlx.optimizers.Optimizer.update
+===============================
+
+.. currentmodule:: mlx.optimizers
+
+.. automethod:: Optimizer.update
--- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.OptimizerState.rst
+++ b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.OptimizerState.rst
@@ -1,17 +0,0 @@
-mlx.optimizers.OptimizerState
-=============================
-
-.. currentmodule:: mlx.optimizers
-
-.. autoclass:: OptimizerState
-
-   
-
-   
-   .. rubric:: Methods
-
-   .. autosummary::
-   
-         ~OptimizerState.get
-   
-   
--- a/docs/build/html/_sources/python/_autosummary/mlx.optimizers.RMSprop.rst
+++ b/docs/build/html/_sources/python/_autosummary/mlx.optimizers.RMSprop.rst
@@ -14,5 +14,6 @@
   
         ~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
@@ -14,5 +14,6 @@
   
         ~SGD.__init__
         ~SGD.apply_single
+         ~SGD.init_single