docs: build for v0.4.0

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: 6554eb9f888c859fe5fe16458d05022f
+config: 73b2205e00ef9121ef650097edd65644
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/build/html/_autosummary/mlx_optimizers.ADOPT.html

@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>mlx_optimizers.ADOPT &#8212; mlx-optimizers 0.3.0 documentation</title>
+    <title>mlx_optimizers.ADOPT &#8212; mlx-optimizers 0.4.0 documentation</title>
 
 
 
@@ -40,7 +40,7 @@
   <link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549" />
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549" />
 
-    <script src="../_static/documentation_options.js?v=83a61292"></script>
+    <script src="../_static/documentation_options.js?v=183391d5"></script>
     <script src="../_static/doctools.js?v=9a2dae69"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/scripts/sphinx-book-theme.js?v=887ef09a"></script>
@@ -53,7 +53,7 @@
     <link rel="prev" title="Optimizers" href="../optimizers.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
-  <meta name="docsearch:version" content="0.3.0" />
+  <meta name="docsearch:version" content="0.4.0" />
   </head>
 
 
@@ -132,8 +132,8 @@
 
 
 
-    <img src="../_static/light-mode-logo.svg" class="logo__image only-light" alt="mlx-optimizers 0.3.0 documentation - Home"/>
-    <img src="../_static/dark-mode-logo.svg" class="logo__image only-dark pst-js-only" alt="mlx-optimizers 0.3.0 documentation - Home"/>
+    <img src="../_static/light-mode-logo.svg" class="logo__image only-light" alt="mlx-optimizers 0.4.0 documentation - Home"/>
+    <img src="../_static/dark-mode-logo.svg" class="logo__image only-dark pst-js-only" alt="mlx-optimizers 0.4.0 documentation - Home"/>
 
 
 </a></div>
@@ -156,6 +156,7 @@
 <li class="toctree-l2 current active"><a class="current reference internal" href="#">mlx_optimizers.ADOPT</a></li>
 <li class="toctree-l2"><a class="reference internal" href="mlx_optimizers.DiffGrad.html">mlx_optimizers.DiffGrad</a></li>
 <li class="toctree-l2"><a class="reference internal" href="mlx_optimizers.Muon.html">mlx_optimizers.Muon</a></li>
+<li class="toctree-l2"><a class="reference internal" href="mlx_optimizers.MARS.html">mlx_optimizers.MARS</a></li>
 <li class="toctree-l2"><a class="reference internal" href="mlx_optimizers.QHAdam.html">mlx_optimizers.QHAdam</a></li>
 <li class="toctree-l2"><a class="reference internal" href="mlx_optimizers.MADGRAD.html">mlx_optimizers.MADGRAD</a></li>
 <li class="toctree-l2"><a class="reference internal" href="mlx_optimizers.Lamb.html">mlx_optimizers.Lamb</a></li>
@@ -339,7 +340,7 @@ <h2> Contents </h2>
 <h1>mlx_optimizers.ADOPT<a class="headerlink" href="#mlx-optimizers-adopt" title="Link to this heading">#</a></h1>
 <dl class="py class">
 <dt class="sig sig-object py" id="mlx_optimizers.ADOPT">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ADOPT</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">learning_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><span class="pre">float</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.13)"><span class="pre">Callable</span></a><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="pre">array</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">array</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">betas</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.13)"><span class="pre">List</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><span class="pre">float</span></a><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">[0.9,</span> <span class="pre">0.9999]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eps</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><span class="pre">float</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1e-06</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mlx_optimizers.ADOPT" title="Link to this definition">#</a></dt>
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ADOPT</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">learning_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><span class="pre">float</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.13)"><span class="pre">Callable</span></a><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="pre">array</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">array</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">betas</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.13)"><span class="pre">List</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><span class="pre">float</span></a><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">[0.9,</span> <span class="pre">0.9999]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">weight_decay</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><span class="pre">float</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eps</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><span class="pre">float</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1e-06</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mlx_optimizers.ADOPT" title="Link to this definition">#</a></dt>
 <dd><p>ADaptive gradient method with the OPTimal convergence rate [1].</p>
 <div class="math notranslate nohighlight">
 \[\begin{split}v_0 &amp;= g_0^2, m_1 = g_1 / \max{\sqrt{v_0}, \epsilon} \\
@@ -354,9 +355,10 @@ <h1>mlx_optimizers.ADOPT<a class="headerlink" href="#mlx-optimizers-adopt" title
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>learning_rate</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><em>float</em></a><em> or </em><em>callable</em>) – The learning rate <span class="math notranslate nohighlight">\(\eta\)</span>.</p></li>
-<li><p><strong>betas</strong> (<em>Tuple</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><em>float</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><em>float</em></a><em>]</em><em>, </em><em>optional</em>) – The coefficients
+<li><p><strong>betas</strong> (<em>List</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><em>float</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><em>float</em></a><em>]</em><em>, </em><em>optional</em>) – The coefficients
 <span class="math notranslate nohighlight">\((\beta_1, \beta_2)\)</span> used for computing running averages of the
 gradient and its square. Default: <code class="docutils literal notranslate"><span class="pre">(0.9,</span> <span class="pre">0.9999)</span></code></p></li>
+<li><p><strong>weight_decay</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><em>float</em></a><em>, </em><em>optional</em>) – The weight decay. Default: <code class="docutils literal notranslate"><span class="pre">0.0</span></code></p></li>
 <li><p><strong>eps</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><em>float</em></a><em>, </em><em>optional</em>) – The term <span class="math notranslate nohighlight">\(\epsilon\)</span> added to the
 denominator to improve numerical stability. Default: <code class="docutils literal notranslate"><span class="pre">1e-6</span></code></p></li>
 </ul>
@@ -368,7 +370,7 @@ <h1>mlx_optimizers.ADOPT<a class="headerlink" href="#mlx-optimizers-adopt" title
 <p class="rubric">Methods</p>
 <div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
 <tbody>
-<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">__init__</span></code>(learning_rate[, betas, eps])</p></td>
+<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">__init__</span></code>(learning_rate[, betas, ...])</p></td>
 <td><p></p></td>
 </tr>
 <tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">apply_single</span></code>(gradient, parameter, state)</p></td>

docs/build/html/_autosummary/mlx_optimizers.DiffGrad.html

@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>mlx_optimizers.DiffGrad &#8212; mlx-optimizers 0.3.0 documentation</title>
+    <title>mlx_optimizers.DiffGrad &#8212; mlx-optimizers 0.4.0 documentation</title>
 
 
 
@@ -40,7 +40,7 @@
   <link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549" />
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549" />
 
-    <script src="../_static/documentation_options.js?v=83a61292"></script>
+    <script src="../_static/documentation_options.js?v=183391d5"></script>
     <script src="../_static/doctools.js?v=9a2dae69"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/scripts/sphinx-book-theme.js?v=887ef09a"></script>
@@ -53,7 +53,7 @@
     <link rel="prev" title="mlx_optimizers.ADOPT" href="mlx_optimizers.ADOPT.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
-  <meta name="docsearch:version" content="0.3.0" />
+  <meta name="docsearch:version" content="0.4.0" />
   </head>
 
 
@@ -132,8 +132,8 @@
 
 
 
-    <img src="../_static/light-mode-logo.svg" class="logo__image only-light" alt="mlx-optimizers 0.3.0 documentation - Home"/>
-    <img src="../_static/dark-mode-logo.svg" class="logo__image only-dark pst-js-only" alt="mlx-optimizers 0.3.0 documentation - Home"/>
+    <img src="../_static/light-mode-logo.svg" class="logo__image only-light" alt="mlx-optimizers 0.4.0 documentation - Home"/>
+    <img src="../_static/dark-mode-logo.svg" class="logo__image only-dark pst-js-only" alt="mlx-optimizers 0.4.0 documentation - Home"/>
 
 
 </a></div>
@@ -156,6 +156,7 @@
 <li class="toctree-l2"><a class="reference internal" href="mlx_optimizers.ADOPT.html">mlx_optimizers.ADOPT</a></li>
 <li class="toctree-l2 current active"><a class="current reference internal" href="#">mlx_optimizers.DiffGrad</a></li>
 <li class="toctree-l2"><a class="reference internal" href="mlx_optimizers.Muon.html">mlx_optimizers.Muon</a></li>
+<li class="toctree-l2"><a class="reference internal" href="mlx_optimizers.MARS.html">mlx_optimizers.MARS</a></li>
 <li class="toctree-l2"><a class="reference internal" href="mlx_optimizers.QHAdam.html">mlx_optimizers.QHAdam</a></li>
 <li class="toctree-l2"><a class="reference internal" href="mlx_optimizers.MADGRAD.html">mlx_optimizers.MADGRAD</a></li>
 <li class="toctree-l2"><a class="reference internal" href="mlx_optimizers.Lamb.html">mlx_optimizers.Lamb</a></li>

docs/build/html/_autosummary/mlx_optimizers.Kron.html

@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>mlx_optimizers.Kron &#8212; mlx-optimizers 0.3.0 documentation</title>
+    <title>mlx_optimizers.Kron &#8212; mlx-optimizers 0.4.0 documentation</title>
 
 
 
@@ -40,7 +40,7 @@
   <link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549" />
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549" />
 
-    <script src="../_static/documentation_options.js?v=83a61292"></script>
+    <script src="../_static/documentation_options.js?v=183391d5"></script>
     <script src="../_static/doctools.js?v=9a2dae69"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/scripts/sphinx-book-theme.js?v=887ef09a"></script>
@@ -53,7 +53,7 @@
     <link rel="prev" title="mlx_optimizers.Lamb" href="mlx_optimizers.Lamb.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
-  <meta name="docsearch:version" content="0.3.0" />
+  <meta name="docsearch:version" content="0.4.0" />
   </head>
 
 
@@ -132,8 +132,8 @@
 
 
 
-    <img src="../_static/light-mode-logo.svg" class="logo__image only-light" alt="mlx-optimizers 0.3.0 documentation - Home"/>
-    <img src="../_static/dark-mode-logo.svg" class="logo__image only-dark pst-js-only" alt="mlx-optimizers 0.3.0 documentation - Home"/>
+    <img src="../_static/light-mode-logo.svg" class="logo__image only-light" alt="mlx-optimizers 0.4.0 documentation - Home"/>
+    <img src="../_static/dark-mode-logo.svg" class="logo__image only-dark pst-js-only" alt="mlx-optimizers 0.4.0 documentation - Home"/>
 
 
 </a></div>
@@ -156,6 +156,7 @@
 <li class="toctree-l2"><a class="reference internal" href="mlx_optimizers.ADOPT.html">mlx_optimizers.ADOPT</a></li>
 <li class="toctree-l2"><a class="reference internal" href="mlx_optimizers.DiffGrad.html">mlx_optimizers.DiffGrad</a></li>
 <li class="toctree-l2"><a class="reference internal" href="mlx_optimizers.Muon.html">mlx_optimizers.Muon</a></li>
+<li class="toctree-l2"><a class="reference internal" href="mlx_optimizers.MARS.html">mlx_optimizers.MARS</a></li>
 <li class="toctree-l2"><a class="reference internal" href="mlx_optimizers.QHAdam.html">mlx_optimizers.QHAdam</a></li>
 <li class="toctree-l2"><a class="reference internal" href="mlx_optimizers.MADGRAD.html">mlx_optimizers.MADGRAD</a></li>
 <li class="toctree-l2"><a class="reference internal" href="mlx_optimizers.Lamb.html">mlx_optimizers.Lamb</a></li>

docs/build/html/_autosummary/mlx_optimizers.Lamb.html

@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>mlx_optimizers.Lamb &#8212; mlx-optimizers 0.3.0 documentation</title>
+    <title>mlx_optimizers.Lamb &#8212; mlx-optimizers 0.4.0 documentation</title>
 
 
 
@@ -40,7 +40,7 @@
   <link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549" />
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549" />
 
-    <script src="../_static/documentation_options.js?v=83a61292"></script>
+    <script src="../_static/documentation_options.js?v=183391d5"></script>
     <script src="../_static/doctools.js?v=9a2dae69"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/scripts/sphinx-book-theme.js?v=887ef09a"></script>
@@ -53,7 +53,7 @@
     <link rel="prev" title="mlx_optimizers.MADGRAD" href="mlx_optimizers.MADGRAD.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
-  <meta name="docsearch:version" content="0.3.0" />
+  <meta name="docsearch:version" content="0.4.0" />
   </head>
 
 
@@ -132,8 +132,8 @@
 
 
 
-    <img src="../_static/light-mode-logo.svg" class="logo__image only-light" alt="mlx-optimizers 0.3.0 documentation - Home"/>
-    <img src="../_static/dark-mode-logo.svg" class="logo__image only-dark pst-js-only" alt="mlx-optimizers 0.3.0 documentation - Home"/>
+    <img src="../_static/light-mode-logo.svg" class="logo__image only-light" alt="mlx-optimizers 0.4.0 documentation - Home"/>
+    <img src="../_static/dark-mode-logo.svg" class="logo__image only-dark pst-js-only" alt="mlx-optimizers 0.4.0 documentation - Home"/>
 
 
 </a></div>
@@ -156,6 +156,7 @@
 <li class="toctree-l2"><a class="reference internal" href="mlx_optimizers.ADOPT.html">mlx_optimizers.ADOPT</a></li>
 <li class="toctree-l2"><a class="reference internal" href="mlx_optimizers.DiffGrad.html">mlx_optimizers.DiffGrad</a></li>
 <li class="toctree-l2"><a class="reference internal" href="mlx_optimizers.Muon.html">mlx_optimizers.Muon</a></li>
+<li class="toctree-l2"><a class="reference internal" href="mlx_optimizers.MARS.html">mlx_optimizers.MARS</a></li>
 <li class="toctree-l2"><a class="reference internal" href="mlx_optimizers.QHAdam.html">mlx_optimizers.QHAdam</a></li>
 <li class="toctree-l2"><a class="reference internal" href="mlx_optimizers.MADGRAD.html">mlx_optimizers.MADGRAD</a></li>
 <li class="toctree-l2 current active"><a class="current reference internal" href="#">mlx_optimizers.Lamb</a></li>