This commit is contained in:
CircleCI Docs
2025-04-17 22:29:33 +00:00
parent 9910926f73
commit 1fce7f2c4c
530 changed files with 6964 additions and 2221 deletions

View File

@@ -7,7 +7,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Index &#8212; MLX 0.24.2 documentation</title>
<title>Index &#8212; MLX 0.25.0 documentation</title>
@@ -35,7 +35,7 @@
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
<script src="_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
<script src="_static/documentation_options.js?v=029512cb"></script>
<script src="_static/documentation_options.js?v=52c7255c"></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>
@@ -136,8 +136,8 @@
<img src="_static/mlx_logo.png" class="logo__image only-light" alt="MLX 0.24.2 documentation - Home"/>
<script>document.write(`<img src="_static/mlx_logo_dark.png" class="logo__image only-dark" alt="MLX 0.24.2 documentation - Home"/>`);</script>
<img src="_static/mlx_logo.png" class="logo__image only-light" alt="MLX 0.25.0 documentation - Home"/>
<script>document.write(`<img src="_static/mlx_logo_dark.png" class="logo__image only-dark" alt="MLX 0.25.0 documentation - Home"/>`);</script>
</a></div>
@@ -211,6 +211,7 @@
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.log10.html">mlx.core.array.log10</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.log1p.html">mlx.core.array.log1p</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.log2.html">mlx.core.array.log2</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.logcumsumexp.html">mlx.core.array.logcumsumexp</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.logsumexp.html">mlx.core.array.logsumexp</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.max.html">mlx.core.array.max</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.mean.html">mlx.core.array.mean</a></li>
@@ -357,6 +358,7 @@
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.log10.html">mlx.core.log10</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.log1p.html">mlx.core.log1p</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.logaddexp.html">mlx.core.logaddexp</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.logcumsumexp.html">mlx.core.logcumsumexp</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.logical_not.html">mlx.core.logical_not</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.logical_and.html">mlx.core.logical_and</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.logical_or.html">mlx.core.logical_or</a></li>
@@ -689,6 +691,7 @@
<li class="toctree-l3"><a class="reference internal" href="python/optimizers/_autosummary/mlx.optimizers.AdamW.html">mlx.optimizers.AdamW</a></li>
<li class="toctree-l3"><a class="reference internal" href="python/optimizers/_autosummary/mlx.optimizers.Adamax.html">mlx.optimizers.Adamax</a></li>
<li class="toctree-l3"><a class="reference internal" href="python/optimizers/_autosummary/mlx.optimizers.Lion.html">mlx.optimizers.Lion</a></li>
<li class="toctree-l3"><a class="reference internal" href="python/optimizers/_autosummary/mlx.optimizers.MultiOptimizer.html">mlx.optimizers.MultiOptimizer</a></li>
</ul>
</details></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="python/optimizers/schedulers.html">Schedulers</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
@@ -1439,11 +1442,11 @@ document.write(`
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="cpp/ops.html#_CPPv46gatherRK5arrayRK5arrayiRK5Shape14StreamOrDevice">gather (C++ function)</a>, <a href="cpp/ops.html#_CPPv46gatherRK5arrayRKNSt6vectorI5arrayEERKNSt6vectorIiEERK5Shape14StreamOrDevice">[1]</a>
</li>
<li><a href="cpp/ops.html#_CPPv49gather_mm5array5arrayNSt8optionalI5arrayEENSt8optionalI5arrayEE14StreamOrDevice">gather_mm (C++ function)</a>
<li><a href="cpp/ops.html#_CPPv49gather_mm5array5arrayNSt8optionalI5arrayEENSt8optionalI5arrayEEb14StreamOrDevice">gather_mm (C++ function)</a>
</li>
<li><a href="python/_autosummary/mlx.core.gather_mm.html#mlx.core.gather_mm">gather_mm() (in module mlx.core)</a>
</li>
<li><a href="cpp/ops.html#_CPPv410gather_qmmRK5arrayRK5arrayRK5arrayRK5arrayNSt8optionalI5arrayEENSt8optionalI5arrayEEbii14StreamOrDevice">gather_qmm (C++ function)</a>
<li><a href="cpp/ops.html#_CPPv410gather_qmmRK5arrayRK5arrayRK5arrayRK5arrayNSt8optionalI5arrayEENSt8optionalI5arrayEEbiib14StreamOrDevice">gather_qmm (C++ function)</a>
</li>
<li><a href="python/_autosummary/mlx.core.gather_qmm.html#mlx.core.gather_qmm">gather_qmm() (in module mlx.core)</a>
</li>
@@ -1697,10 +1700,10 @@ document.write(`
<li><a href="python/_autosummary/mlx.core.log10.html#mlx.core.log10">(in module mlx.core)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="cpp/ops.html#_CPPv45log1pRK5array14StreamOrDevice">log1p (C++ function)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="python/_autosummary/mlx.core.array.log1p.html#mlx.core.array.log1p">log1p() (array method)</a>
<ul>
@@ -1725,6 +1728,14 @@ document.write(`
</li>
<li><a href="python/_autosummary/mlx.core.logaddexp.html#mlx.core.logaddexp">logaddexp() (in module mlx.core)</a>
</li>
<li><a href="cpp/ops.html#_CPPv412logcumsumexpRK5arrayibb14StreamOrDevice">logcumsumexp (C++ function)</a>
</li>
<li><a href="python/_autosummary/mlx.core.array.logcumsumexp.html#mlx.core.array.logcumsumexp">logcumsumexp() (array method)</a>
<ul>
<li><a href="python/_autosummary/mlx.core.logcumsumexp.html#mlx.core.logcumsumexp">(in module mlx.core)</a>
</li>
</ul></li>
<li><a href="cpp/ops.html#_CPPv411logical_andRK5arrayRK5array14StreamOrDevice">logical_and (C++ function)</a>
</li>
<li><a href="python/_autosummary/mlx.core.logical_and.html#mlx.core.logical_and">logical_and() (in module mlx.core)</a>
@@ -1832,6 +1843,8 @@ document.write(`
<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>
<li><a href="python/nn/_autosummary/mlx.nn.MultiHeadAttention.html#mlx.nn.MultiHeadAttention">MultiHeadAttention (class in mlx.nn)</a>
</li>
<li><a href="python/optimizers/_autosummary/mlx.optimizers.MultiOptimizer.html#mlx.optimizers.MultiOptimizer">MultiOptimizer (class in mlx.optimizers)</a>
</li>
<li><a href="cpp/ops.html#_CPPv48multiplyRK5arrayRK5array14StreamOrDevice">multiply (C++ function)</a>
</li>