docs update

2025-09-16 08:28:13 +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/genindex.html
+++ b/docs/build/html/genindex.html
@@ -8,7 +8,7 @@
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Index &#8212; MLX 0.1.0 documentation</title>
+    <title>Index &#8212; MLX 0.2.0 documentation</title>
  
  
  
@@ -131,8 +131,8 @@
      
    
    
-    <img src="_static/mlx_logo.png" class="logo__image only-light" alt="MLX 0.1.0 documentation - Home"/>
-    <script>document.write(`<img src="_static/mlx_logo.png" class="logo__image only-dark" alt="MLX 0.1.0 documentation - Home"/>`);</script>
+    <img src="_static/mlx_logo.png" class="logo__image only-light" alt="MLX 0.2.0 documentation - Home"/>
+    <script>document.write(`<img src="_static/mlx_logo.png" class="logo__image only-dark" alt="MLX 0.2.0 documentation - Home"/>`);</script>
  
  
 </a></div>
@@ -150,6 +150,7 @@
 <li class="toctree-l1"><a class="reference internal" href="usage/indexing.html">Indexing Arrays</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage/saving_and_loading.html">Saving and Loading Arrays</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage/function_transforms.html">Function Transforms</a></li>
+<li class="toctree-l1"><a class="reference internal" href="usage/compile.html">Compilation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage/numpy.html">Conversion to NumPy and Other Frameworks</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage/using_streams.html">Using Streams</a></li>
 </ul>
@@ -345,6 +346,9 @@
 </li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="python/transforms.html">Transforms</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-5"><i class="fa-solid fa-chevron-down"></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.eval.html">mlx.core.eval</a></li>
+<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.compile.html">mlx.core.compile</a></li>
+<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.disable_compile.html">mlx.core.disable_compile</a></li>
+<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.enable_compile.html">mlx.core.enable_compile</a></li>
 <li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.grad.html">mlx.core.grad</a></li>
 <li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.value_and_grad.html">mlx.core.value_and_grad</a></li>
 <li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.jvp.html">mlx.core.jvp</a></li>
@@ -376,6 +380,7 @@
 <li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.nn.value_and_grad.html">mlx.nn.value_and_grad</a></li>
 <li class="toctree-l2 has-children"><a class="reference internal" href="python/nn/module.html">Module</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-9"><i class="fa-solid fa-chevron-down"></i></label><ul>
 <li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.Module.training.html">mlx.nn.Module.training</a></li>
+<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.Module.state.html">mlx.nn.Module.state</a></li>
 <li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.Module.apply.html">mlx.nn.Module.apply</a></li>
 <li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.Module.apply_to_modules.html">mlx.nn.Module.apply_to_modules</a></li>
 <li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.Module.children.html">mlx.nn.Module.children</a></li>
@@ -448,6 +453,7 @@
 <li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary_functions/mlx.nn.losses.kl_div_loss.html">mlx.nn.losses.kl_div_loss</a></li>
 <li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary_functions/mlx.nn.losses.l1_loss.html">mlx.nn.losses.l1_loss</a></li>
 <li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary_functions/mlx.nn.losses.log_cosh_loss.html">mlx.nn.losses.log_cosh_loss</a></li>
+<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary_functions/mlx.nn.losses.margin_ranking_loss.html">mlx.nn.losses.margin_ranking_loss</a></li>
 <li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary_functions/mlx.nn.losses.mse_loss.html">mlx.nn.losses.mse_loss</a></li>
 <li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary_functions/mlx.nn.losses.nll_loss.html">mlx.nn.losses.nll_loss</a></li>
 <li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary_functions/mlx.nn.losses.smooth_l1_loss.html">mlx.nn.losses.smooth_l1_loss</a></li>
@@ -468,8 +474,13 @@
 </ul>
 </li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="python/optimizers.html">Optimizers</a><input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-14"><i class="fa-solid fa-chevron-down"></i></label><ul>
-<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.optimizers.OptimizerState.html">mlx.optimizers.OptimizerState</a></li>
-<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.optimizers.Optimizer.html">mlx.optimizers.Optimizer</a></li>
+<li class="toctree-l2 has-children"><a class="reference internal" href="python/optimizer.html">Optimizer</a><input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-15"><i class="fa-solid fa-chevron-down"></i></label><ul>
+<li class="toctree-l3"><a class="reference internal" href="python/_autosummary/mlx.optimizers.Optimizer.state.html">mlx.optimizers.Optimizer.state</a></li>
+<li class="toctree-l3"><a class="reference internal" href="python/_autosummary/mlx.optimizers.Optimizer.apply_gradients.html">mlx.optimizers.Optimizer.apply_gradients</a></li>
+<li class="toctree-l3"><a class="reference internal" href="python/_autosummary/mlx.optimizers.Optimizer.init.html">mlx.optimizers.Optimizer.init</a></li>
+<li class="toctree-l3"><a class="reference internal" href="python/_autosummary/mlx.optimizers.Optimizer.update.html">mlx.optimizers.Optimizer.update</a></li>
+</ul>
+</li>
 <li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.optimizers.SGD.html">mlx.optimizers.SGD</a></li>
 <li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.optimizers.RMSprop.html">mlx.optimizers.RMSprop</a></li>
 <li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.optimizers.Adagrad.html">mlx.optimizers.Adagrad</a></li>
@@ -481,7 +492,7 @@
 <li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.optimizers.Lion.html">mlx.optimizers.Lion</a></li>
 </ul>
 </li>
-<li class="toctree-l1 has-children"><a class="reference internal" href="python/tree_utils.html">Tree Utils</a><input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-15"><i class="fa-solid fa-chevron-down"></i></label><ul>
+<li class="toctree-l1 has-children"><a class="reference internal" href="python/tree_utils.html">Tree Utils</a><input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-16"><i class="fa-solid fa-chevron-down"></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.utils.tree_flatten.html">mlx.utils.tree_flatten</a></li>
 <li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.utils.tree_unflatten.html">mlx.utils.tree_unflatten</a></li>
 <li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.utils.tree_map.html">mlx.utils.tree_map</a></li>
@@ -705,6 +716,8 @@ document.write(`
 </li>
      </ul></li>
      <li><a href="python/nn/_autosummary/mlx.nn.Module.apply.html#mlx.nn.Module.apply">apply() (mlx.nn.Module method)</a>
+</li>
+      <li><a href="python/_autosummary/mlx.optimizers.Optimizer.apply_gradients.html#mlx.optimizers.Optimizer.apply_gradients">apply_gradients() (mlx.optimizers.Optimizer method)</a>
 </li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
@@ -758,7 +771,7 @@ document.write(`
 </li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="python/nn/_autosummary_functions/mlx.nn.losses.binary_cross_entropy.html#mlx.nn.losses.binary_cross_entropy">binary_cross_entropy (class in mlx.nn.losses)</a>
+      <li><a href="python/nn/_autosummary_functions/mlx.nn.losses.binary_cross_entropy.html#mlx.nn.losses.binary_cross_entropy">binary_cross_entropy() (in module mlx.nn.losses)</a>
 </li>
      <li><a href="python/_autosummary/mlx.core.broadcast_to.html#mlx.core.broadcast_to">broadcast_to() (in module mlx.core)</a>
 </li>
@@ -775,17 +788,19 @@ document.write(`
      <li><a href="python/nn/_autosummary/mlx.nn.Module.children.html#mlx.nn.Module.children">children() (mlx.nn.Module method)</a>
 </li>
      <li><a href="python/_autosummary/mlx.core.clip.html#mlx.core.clip">clip() (in module mlx.core)</a>
+</li>
+      <li><a href="python/_autosummary/mlx.core.compile.html#mlx.core.compile">compile() (in module mlx.core)</a>
 </li>
      <li><a href="python/_autosummary/mlx.core.concatenate.html#mlx.core.concatenate">concatenate() (in module mlx.core)</a>
 </li>
      <li><a href="python/nn/_autosummary/mlx.nn.init.constant.html#mlx.nn.init.constant">constant() (in module mlx.nn.init)</a>
 </li>
      <li><a href="python/nn/_autosummary/mlx.nn.Conv1d.html#mlx.nn.Conv1d">Conv1d (class in mlx.nn)</a>
-</li>
-      <li><a href="python/_autosummary/mlx.core.conv1d.html#mlx.core.conv1d">conv1d() (in module mlx.core)</a>
 </li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="python/_autosummary/mlx.core.conv1d.html#mlx.core.conv1d">conv1d() (in module mlx.core)</a>
+</li>
      <li><a href="python/nn/_autosummary/mlx.nn.Conv2d.html#mlx.nn.Conv2d">Conv2d (class in mlx.nn)</a>
 </li>
      <li><a href="python/_autosummary/mlx.core.conv2d.html#mlx.core.conv2d">conv2d() (in module mlx.core)</a>
@@ -800,9 +815,9 @@ document.write(`
      </ul></li>
      <li><a href="python/_autosummary/mlx.core.cosh.html#mlx.core.cosh">cosh() (in module mlx.core)</a>
 </li>
-      <li><a href="python/nn/_autosummary_functions/mlx.nn.losses.cosine_similarity_loss.html#mlx.nn.losses.cosine_similarity_loss">cosine_similarity_loss (class in mlx.nn.losses)</a>
+      <li><a href="python/nn/_autosummary_functions/mlx.nn.losses.cosine_similarity_loss.html#mlx.nn.losses.cosine_similarity_loss">cosine_similarity_loss() (in module mlx.nn.losses)</a>
 </li>
-      <li><a href="python/nn/_autosummary_functions/mlx.nn.losses.cross_entropy.html#mlx.nn.losses.cross_entropy">cross_entropy (class in mlx.nn.losses)</a>
+      <li><a href="python/nn/_autosummary_functions/mlx.nn.losses.cross_entropy.html#mlx.nn.losses.cross_entropy">cross_entropy() (in module mlx.nn.losses)</a>
 </li>
  </ul></td>
 </tr></table>
@@ -821,6 +836,8 @@ document.write(`
      <li><a href="python/_autosummary/mlx.core.diag.html#mlx.core.diag">diag() (in module mlx.core)</a>
 </li>
      <li><a href="python/_autosummary/mlx.core.diagonal.html#mlx.core.diagonal">diagonal() (in module mlx.core)</a>
+</li>
+      <li><a href="python/_autosummary/mlx.core.disable_compile.html#mlx.core.disable_compile">disable_compile() (in module mlx.core)</a>
 </li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
@@ -845,6 +862,8 @@ document.write(`
 <table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="python/nn/_autosummary/mlx.nn.Embedding.html#mlx.nn.Embedding">Embedding (class in mlx.nn)</a>
+</li>
+      <li><a href="python/_autosummary/mlx.core.enable_compile.html#mlx.core.enable_compile">enable_compile() (in module mlx.core)</a>
 </li>
      <li><a href="python/_autosummary/mlx.core.equal.html#mlx.core.equal">equal() (in module mlx.core)</a>
 </li>
@@ -852,14 +871,14 @@ document.write(`
 </li>
      <li><a href="python/_autosummary/mlx.core.erfinv.html#mlx.core.erfinv">erfinv() (in module mlx.core)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="python/_autosummary/mlx.core.eval.html#mlx.core.eval">eval() (in module mlx.core)</a>

      <ul>
        <li><a href="python/nn/_autosummary/mlx.nn.Module.eval.html#mlx.nn.Module.eval">(mlx.nn.Module method)</a>
 </li>
      </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="python/_autosummary/mlx.core.exp.html#mlx.core.exp">exp() (in module mlx.core)</a>

      <ul>
@@ -902,15 +921,15 @@ document.write(`
 <h2 id="G">G</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="python/nn/_autosummary_functions/mlx.nn.losses.gaussian_nll_loss.html#mlx.nn.losses.gaussian_nll_loss">gaussian_nll_loss (class in mlx.nn.losses)</a>
+      <li><a href="python/nn/_autosummary_functions/mlx.nn.losses.gaussian_nll_loss.html#mlx.nn.losses.gaussian_nll_loss">gaussian_nll_loss() (in module mlx.nn.losses)</a>
 </li>
      <li><a href="python/nn/_autosummary/mlx.nn.GELU.html#mlx.nn.GELU">GELU (class in mlx.nn)</a>
 </li>
-      <li><a href="python/nn/_autosummary_functions/mlx.nn.gelu.html#mlx.nn.gelu">gelu (class in mlx.nn)</a>
+      <li><a href="python/nn/_autosummary_functions/mlx.nn.gelu.html#mlx.nn.gelu">gelu() (in module mlx.nn)</a>
 </li>
-      <li><a href="python/nn/_autosummary_functions/mlx.nn.gelu_approx.html#mlx.nn.gelu_approx">gelu_approx (class in mlx.nn)</a>
+      <li><a href="python/nn/_autosummary_functions/mlx.nn.gelu_approx.html#mlx.nn.gelu_approx">gelu_approx() (in module mlx.nn)</a>
 </li>
-      <li><a href="python/nn/_autosummary_functions/mlx.nn.gelu_fast_approx.html#mlx.nn.gelu_fast_approx">gelu_fast_approx (class in mlx.nn)</a>
+      <li><a href="python/nn/_autosummary_functions/mlx.nn.gelu_fast_approx.html#mlx.nn.gelu_fast_approx">gelu_fast_approx() (in module mlx.nn)</a>
 </li>
      <li><a href="python/nn/_autosummary/mlx.nn.init.glorot_normal.html#mlx.nn.init.glorot_normal">glorot_normal() (in module mlx.nn.init)</a>
 </li>
@@ -940,9 +959,9 @@ document.write(`
 </li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="python/nn/_autosummary_functions/mlx.nn.losses.hinge_loss.html#mlx.nn.losses.hinge_loss">hinge_loss (class in mlx.nn.losses)</a>
+      <li><a href="python/nn/_autosummary_functions/mlx.nn.losses.hinge_loss.html#mlx.nn.losses.hinge_loss">hinge_loss() (in module mlx.nn.losses)</a>
 </li>
-      <li><a href="python/nn/_autosummary_functions/mlx.nn.losses.huber_loss.html#mlx.nn.losses.huber_loss">huber_loss (class in mlx.nn.losses)</a>
+      <li><a href="python/nn/_autosummary_functions/mlx.nn.losses.huber_loss.html#mlx.nn.losses.huber_loss">huber_loss() (in module mlx.nn.losses)</a>
 </li>
  </ul></td>
 </tr></table>
@@ -961,6 +980,8 @@ document.write(`
      <li><a href="python/_autosummary/mlx.core.fft.ifft2.html#mlx.core.fft.ifft2">ifft2() (in module mlx.core.fft)</a>
 </li>
      <li><a href="python/_autosummary/mlx.core.fft.ifftn.html#mlx.core.fft.ifftn">ifftn() (in module mlx.core.fft)</a>
+</li>
+      <li><a href="python/_autosummary/mlx.optimizers.Optimizer.init.html#mlx.optimizers.Optimizer.init">init() (mlx.optimizers.Optimizer method)</a>
 </li>
      <li><a href="python/_autosummary/mlx.core.inner.html#mlx.core.inner">inner() (in module mlx.core)</a>
 </li>
@@ -1002,7 +1023,7 @@ document.write(`
 </li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="python/nn/_autosummary_functions/mlx.nn.losses.kl_div_loss.html#mlx.nn.losses.kl_div_loss">kl_div_loss (class in mlx.nn.losses)</a>
+      <li><a href="python/nn/_autosummary_functions/mlx.nn.losses.kl_div_loss.html#mlx.nn.losses.kl_div_loss">kl_div_loss() (in module mlx.nn.losses)</a>
 </li>
  </ul></td>
 </tr></table>
@@ -1010,7 +1031,7 @@ document.write(`
 <h2 id="L">L</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="python/nn/_autosummary_functions/mlx.nn.losses.l1_loss.html#mlx.nn.losses.l1_loss">l1_loss (class in mlx.nn.losses)</a>
+      <li><a href="python/nn/_autosummary_functions/mlx.nn.losses.l1_loss.html#mlx.nn.losses.l1_loss">l1_loss() (in module mlx.nn.losses)</a>
 </li>
      <li><a href="python/nn/_autosummary/mlx.nn.LayerNorm.html#mlx.nn.LayerNorm">LayerNorm (class in mlx.nn)</a>
 </li>
@@ -1048,7 +1069,7 @@ document.write(`
      </ul></li>
      <li><a href="python/_autosummary/mlx.core.log2.html#mlx.core.log2">log2() (in module mlx.core)</a>
 </li>
-      <li><a href="python/nn/_autosummary_functions/mlx.nn.losses.log_cosh_loss.html#mlx.nn.losses.log_cosh_loss">log_cosh_loss (class in mlx.nn.losses)</a>
+      <li><a href="python/nn/_autosummary_functions/mlx.nn.losses.log_cosh_loss.html#mlx.nn.losses.log_cosh_loss">log_cosh_loss() (in module mlx.nn.losses)</a>
 </li>
      <li><a href="python/_autosummary/mlx.core.logaddexp.html#mlx.core.logaddexp">logaddexp() (in module mlx.core)</a>
 </li>
@@ -1070,6 +1091,8 @@ document.write(`
 <h2 id="M">M</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="python/nn/_autosummary_functions/mlx.nn.losses.margin_ranking_loss.html#mlx.nn.losses.margin_ranking_loss">margin_ranking_loss() (in module mlx.nn.losses)</a>
+</li>
      <li><a href="python/_autosummary/mlx.core.matmul.html#mlx.core.matmul">matmul() (in module mlx.core)</a>
 </li>
      <li><a href="python/_autosummary/mlx.core.max.html#mlx.core.max">max() (in module mlx.core)</a>
@@ -1098,7 +1121,7 @@ document.write(`
 </li>
      <li><a href="python/nn/_autosummary/mlx.nn.Mish.html#mlx.nn.Mish">Mish (class in mlx.nn)</a>
 </li>
-      <li><a href="python/nn/_autosummary_functions/mlx.nn.mish.html#mlx.nn.mish">mish (class in mlx.nn)</a>
+      <li><a href="python/nn/_autosummary_functions/mlx.nn.mish.html#mlx.nn.mish">mish() (in module mlx.nn)</a>
 </li>
      <li><a href="python/nn/module.html#mlx.nn.Module">Module (class in mlx.nn)</a>
 </li>
@@ -1106,7 +1129,7 @@ document.write(`
 </li>
      <li><a href="python/_autosummary/mlx.core.moveaxis.html#mlx.core.moveaxis">moveaxis() (in module mlx.core)</a>
 </li>
-      <li><a href="python/nn/_autosummary_functions/mlx.nn.losses.mse_loss.html#mlx.nn.losses.mse_loss">mse_loss (class in mlx.nn.losses)</a>
+      <li><a href="python/nn/_autosummary_functions/mlx.nn.losses.mse_loss.html#mlx.nn.losses.mse_loss">mse_loss() (in module mlx.nn.losses)</a>
 </li>
      <li><a href="python/nn/_autosummary/mlx.nn.MultiHeadAttention.html#mlx.nn.MultiHeadAttention">MultiHeadAttention (class in mlx.nn)</a>
 </li>
@@ -1128,7 +1151,7 @@ document.write(`
 </li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="python/nn/_autosummary_functions/mlx.nn.losses.nll_loss.html#mlx.nn.losses.nll_loss">nll_loss (class in mlx.nn.losses)</a>
+      <li><a href="python/nn/_autosummary_functions/mlx.nn.losses.nll_loss.html#mlx.nn.losses.nll_loss">nll_loss() (in module mlx.nn.losses)</a>
 </li>
      <li><a href="python/_autosummary/mlx.core.linalg.norm.html#mlx.core.linalg.norm">norm() (in module mlx.core.linalg)</a>
 </li>
@@ -1150,9 +1173,7 @@ document.write(`
 </li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="python/_autosummary/mlx.optimizers.Optimizer.html#mlx.optimizers.Optimizer">Optimizer (class in mlx.optimizers)</a>
-</li>
-      <li><a href="python/_autosummary/mlx.optimizers.OptimizerState.html#mlx.optimizers.OptimizerState">OptimizerState (class in mlx.optimizers)</a>
+      <li><a href="python/optimizer.html#mlx.optimizers.Optimizer">Optimizer (class in mlx.optimizers)</a>
 </li>
      <li><a href="python/_autosummary/mlx.core.outer.html#mlx.core.outer">outer() (in module mlx.core)</a>
 </li>
@@ -1172,7 +1193,7 @@ document.write(`
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="python/nn/_autosummary/mlx.nn.PReLU.html#mlx.nn.PReLU">PReLU (class in mlx.nn)</a>
 </li>
-      <li><a href="python/nn/_autosummary_functions/mlx.nn.prelu.html#mlx.nn.prelu">prelu (class in mlx.nn)</a>
+      <li><a href="python/nn/_autosummary_functions/mlx.nn.prelu.html#mlx.nn.prelu">prelu() (in module mlx.nn)</a>
 </li>
      <li><a href="python/_autosummary/mlx.core.prod.html#mlx.core.prod">prod() (in module mlx.core)</a>

@@ -1212,7 +1233,7 @@ document.write(`
      </ul></li>
      <li><a href="python/nn/_autosummary/mlx.nn.ReLU.html#mlx.nn.ReLU">ReLU (class in mlx.nn)</a>
 </li>
-      <li><a href="python/nn/_autosummary_functions/mlx.nn.relu.html#mlx.nn.relu">relu (class in mlx.nn)</a>
+      <li><a href="python/nn/_autosummary_functions/mlx.nn.relu.html#mlx.nn.relu">relu() (in module mlx.nn)</a>
 </li>
      <li><a href="python/_autosummary/mlx.core.repeat.html#mlx.core.repeat">repeat() (in module mlx.core)</a>
 </li>
@@ -1270,7 +1291,7 @@ document.write(`
 </li>
      <li><a href="python/nn/_autosummary/mlx.nn.SELU.html#mlx.nn.SELU">SELU (class in mlx.nn)</a>
 </li>
-      <li><a href="python/nn/_autosummary_functions/mlx.nn.selu.html#mlx.nn.selu">selu (class in mlx.nn)</a>
+      <li><a href="python/nn/_autosummary_functions/mlx.nn.selu.html#mlx.nn.selu">selu() (in module mlx.nn)</a>
 </li>
      <li><a href="python/nn/_autosummary/mlx.nn.Sequential.html#mlx.nn.Sequential">Sequential (class in mlx.nn)</a>
 </li>
@@ -1288,7 +1309,7 @@ document.write(`
 </li>
      <li><a href="python/nn/_autosummary/mlx.nn.SiLU.html#mlx.nn.SiLU">SiLU (class in mlx.nn)</a>
 </li>
-      <li><a href="python/nn/_autosummary_functions/mlx.nn.silu.html#mlx.nn.silu">silu (class in mlx.nn)</a>
+      <li><a href="python/nn/_autosummary_functions/mlx.nn.silu.html#mlx.nn.silu">silu() (in module mlx.nn)</a>
 </li>
      <li><a href="python/_autosummary/mlx.core.sin.html#mlx.core.sin">sin() (in module mlx.core)</a>

@@ -1304,13 +1325,13 @@ document.write(`
 </li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="python/nn/_autosummary_functions/mlx.nn.losses.smooth_l1_loss.html#mlx.nn.losses.smooth_l1_loss">smooth_l1_loss (class in mlx.nn.losses)</a>
+      <li><a href="python/nn/_autosummary_functions/mlx.nn.losses.smooth_l1_loss.html#mlx.nn.losses.smooth_l1_loss">smooth_l1_loss() (in module mlx.nn.losses)</a>
 </li>
      <li><a href="python/_autosummary/mlx.core.softmax.html#mlx.core.softmax">softmax() (in module mlx.core)</a>
 </li>
      <li><a href="python/nn/_autosummary/mlx.nn.Softshrink.html#mlx.nn.Softshrink">Softshrink (class in mlx.nn)</a>
 </li>
-      <li><a href="python/nn/_autosummary_functions/mlx.nn.softshrink.html#mlx.nn.softshrink">softshrink (class in mlx.nn)</a>
+      <li><a href="python/nn/_autosummary_functions/mlx.nn.softshrink.html#mlx.nn.softshrink">softshrink() (in module mlx.nn)</a>
 </li>
      <li><a href="python/_autosummary/mlx.core.sort.html#mlx.core.sort">sort() (in module mlx.core)</a>
 </li>
@@ -1338,11 +1359,15 @@ document.write(`
 </li>
      <li><a href="python/_autosummary/mlx.core.stack.html#mlx.core.stack">stack() (in module mlx.core)</a>
 </li>
-      <li><a href="python/_autosummary/mlx.optimizers.Optimizer.html#mlx.optimizers.Optimizer.state">state (mlx.optimizers.Optimizer attribute)</a>
+      <li><a href="python/nn/_autosummary/mlx.nn.Module.state.html#mlx.nn.Module.state">state (mlx.nn.Module property)</a>
+
+      <ul>
+        <li><a href="python/_autosummary/mlx.optimizers.Optimizer.state.html#mlx.optimizers.Optimizer.state">(mlx.optimizers.Optimizer property)</a>
 </li>
+      </ul></li>
      <li><a href="python/nn/_autosummary/mlx.nn.Step.html#mlx.nn.Step">Step (class in mlx.nn)</a>
 </li>
-      <li><a href="python/nn/_autosummary_functions/mlx.nn.step.html#mlx.nn.step">step (class in mlx.nn)</a>
+      <li><a href="python/nn/_autosummary_functions/mlx.nn.step.html#mlx.nn.step">step() (in module mlx.nn)</a>
 </li>
      <li><a href="python/_autosummary/mlx.core.stop_gradient.html#mlx.core.stop_gradient">stop_gradient() (in module mlx.core)</a>
 </li>
@@ -1404,7 +1429,7 @@ document.write(`
 </li>
      <li><a href="python/_autosummary/mlx.core.tril.html#mlx.core.tril">tril() (in module mlx.core)</a>
 </li>
-      <li><a href="python/nn/_autosummary_functions/mlx.nn.losses.triplet_loss.html#mlx.nn.losses.triplet_loss">triplet_loss (class in mlx.nn.losses)</a>
+      <li><a href="python/nn/_autosummary_functions/mlx.nn.losses.triplet_loss.html#mlx.nn.losses.triplet_loss">triplet_loss() (in module mlx.nn.losses)</a>
 </li>
      <li><a href="python/_autosummary/mlx.core.triu.html#mlx.core.triu">triu() (in module mlx.core)</a>
 </li>
@@ -1427,7 +1452,11 @@ document.write(`
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="python/nn/_autosummary/mlx.nn.Module.update.html#mlx.nn.Module.update">update() (mlx.nn.Module method)</a>
+
+      <ul>
+        <li><a href="python/_autosummary/mlx.optimizers.Optimizer.update.html#mlx.optimizers.Optimizer.update">(mlx.optimizers.Optimizer method)</a>
 </li>
+      </ul></li>
      <li><a href="python/nn/_autosummary/mlx.nn.Module.update_modules.html#mlx.nn.Module.update_modules">update_modules() (mlx.nn.Module method)</a>
 </li>
  </ul></td>