mirror of
https://github.com/ml-explore/mlx.git
synced 2025-09-18 01:50:16 +08:00
docs update
This commit is contained in:
Awni Hannun
committed by
CircleCI Docs
CircleCI Docs
parent
6a6ffb598d
commit
a68317ae17
52
docs/build/html/genindex.html
vendored
52
docs/build/html/genindex.html
vendored
@@ -7,7 +7,7 @@
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Index — MLX 0.17.3 documentation</title>
|
||||
<title>Index — MLX 0.18.0 documentation</title>
|
||||
|
||||
|
||||
|
||||
@@ -35,7 +35,7 @@
|
||||
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=5b4479735964841361fd" />
|
||||
<script src="_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=5b4479735964841361fd"></script>
|
||||
|
||||
<script src="_static/documentation_options.js?v=47c75248"></script>
|
||||
<script src="_static/documentation_options.js?v=4033e70d"></script>
|
||||
<script src="_static/doctools.js?v=888ff710"></script>
|
||||
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="_static/scripts/sphinx-book-theme.js?v=efea14e4"></script>
|
||||
@@ -128,8 +128,8 @@
|
||||
|
||||
|
||||
|
||||
<img src="_static/mlx_logo.png" class="logo__image only-light" alt="MLX 0.17.3 documentation - Home"/>
|
||||
<script>document.write(`<img src="_static/mlx_logo_dark.png" class="logo__image only-dark" alt="MLX 0.17.3 documentation - Home"/>`);</script>
|
||||
<img src="_static/mlx_logo.png" class="logo__image only-light" alt="MLX 0.18.0 documentation - Home"/>
|
||||
<script>document.write(`<img src="_static/mlx_logo_dark.png" class="logo__image only-dark" alt="MLX 0.18.0 documentation - Home"/>`);</script>
|
||||
|
||||
|
||||
</a></div>
|
||||
@@ -358,6 +358,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.pad.html">mlx.core.pad</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.power.html">mlx.core.power</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.prod.html">mlx.core.prod</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.put_along_axis.html">mlx.core.put_along_axis</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.quantize.html">mlx.core.quantize</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.quantized_matmul.html">mlx.core.quantized_matmul</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.radians.html">mlx.core.radians</a></li>
|
||||
@@ -466,6 +467,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.linalg.norm.html">mlx.core.linalg.norm</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.linalg.cholesky.html">mlx.core.linalg.cholesky</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.linalg.cholesky_inv.html">mlx.core.linalg.cholesky_inv</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.linalg.cross.html">mlx.core.linalg.cross</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.linalg.qr.html">mlx.core.linalg.qr</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.linalg.svd.html">mlx.core.linalg.svd</a></li>
|
||||
</ul>
|
||||
@@ -515,6 +517,7 @@
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.AvgPool1d.html">mlx.nn.AvgPool1d</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.AvgPool2d.html">mlx.nn.AvgPool2d</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.BatchNorm.html">mlx.nn.BatchNorm</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.CELU.html">mlx.nn.CELU</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.Conv1d.html">mlx.nn.Conv1d</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.Conv2d.html">mlx.nn.Conv2d</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.Conv3d.html">mlx.nn.Conv3d</a></li>
|
||||
@@ -525,6 +528,7 @@
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.Dropout2d.html">mlx.nn.Dropout2d</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.Dropout3d.html">mlx.nn.Dropout3d</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.Embedding.html">mlx.nn.Embedding</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.ELU.html">mlx.nn.ELU</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.GELU.html">mlx.nn.GELU</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.GLU.html">mlx.nn.GLU</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.GroupNorm.html">mlx.nn.GroupNorm</a></li>
|
||||
@@ -536,6 +540,8 @@
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.LayerNorm.html">mlx.nn.LayerNorm</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.LeakyReLU.html">mlx.nn.LeakyReLU</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.Linear.html">mlx.nn.Linear</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.LogSigmoid.html">mlx.nn.LogSigmoid</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.LogSoftmax.html">mlx.nn.LogSoftmax</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.LSTM.html">mlx.nn.LSTM</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.MaxPool1d.html">mlx.nn.MaxPool1d</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.MaxPool2d.html">mlx.nn.MaxPool2d</a></li>
|
||||
@@ -551,6 +557,7 @@
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.RoPE.html">mlx.nn.RoPE</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.SELU.html">mlx.nn.SELU</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.Sequential.html">mlx.nn.Sequential</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.Sigmoid.html">mlx.nn.Sigmoid</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.SiLU.html">mlx.nn.SiLU</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.SinusoidalPositionalEncoding.html">mlx.nn.SinusoidalPositionalEncoding</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.Softmin.html">mlx.nn.Softmin</a></li>
|
||||
@@ -566,6 +573,7 @@
|
||||
</li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="python/nn/functions.html">Functions</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-l3"><a class="reference internal" href="python/nn/_autosummary_functions/mlx.nn.elu.html">mlx.nn.elu</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary_functions/mlx.nn.celu.html">mlx.nn.celu</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary_functions/mlx.nn.gelu.html">mlx.nn.gelu</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary_functions/mlx.nn.gelu_approx.html">mlx.nn.gelu_approx</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary_functions/mlx.nn.gelu_fast_approx.html">mlx.nn.gelu_fast_approx</a></li>
|
||||
@@ -1053,6 +1061,10 @@ document.write(`
|
||||
<li><a href="cpp/ops.html#_CPPv44ceilRK5array14StreamOrDevice">ceil (C++ function)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.ceil.html#mlx.core.ceil">ceil() (in module mlx.core)</a>
|
||||
</li>
|
||||
<li><a href="python/nn/_autosummary/mlx.nn.CELU.html#mlx.nn.CELU">CELU (class in mlx.nn)</a>
|
||||
</li>
|
||||
<li><a href="python/nn/_autosummary_functions/mlx.nn.celu.html#mlx.nn.celu">celu (class in mlx.nn)</a>
|
||||
</li>
|
||||
<li><a href="python/nn/_autosummary/mlx.nn.Module.children.html#mlx.nn.Module.children">children() (Module method)</a>
|
||||
</li>
|
||||
@@ -1147,6 +1159,8 @@ document.write(`
|
||||
<li><a href="python/optimizers/_autosummary/mlx.optimizers.cosine_decay.html#mlx.optimizers.cosine_decay">cosine_decay() (in module mlx.optimizers)</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>
|
||||
<li><a href="python/_autosummary/mlx.core.linalg.cross.html#mlx.core.linalg.cross">cross() (in module mlx.core.linalg)</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>
|
||||
@@ -1257,6 +1271,8 @@ document.write(`
|
||||
<li><a href="python/_autosummary/mlx.core.einsum.html#mlx.core.einsum">einsum() (in module mlx.core)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.einsum_path.html#mlx.core.einsum_path">einsum_path() (in module mlx.core)</a>
|
||||
</li>
|
||||
<li><a href="python/nn/_autosummary/mlx.nn.ELU.html#mlx.nn.ELU">ELU (class in mlx.nn)</a>
|
||||
</li>
|
||||
<li><a href="python/nn/_autosummary_functions/mlx.nn.elu.html#mlx.nn.elu">elu (class in mlx.nn)</a>
|
||||
</li>
|
||||
@@ -1592,10 +1608,10 @@ document.write(`
|
||||
<li><a href="python/_autosummary/mlx.core.log.html#mlx.core.log">(in module mlx.core)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="cpp/ops.html#_CPPv45log10RK5array14StreamOrDevice">log10 (C++ function)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="python/_autosummary/mlx.core.array.log10.html#mlx.core.array.log10">log10() (array method)</a>
|
||||
|
||||
<ul>
|
||||
@@ -1639,6 +1655,10 @@ document.write(`
|
||||
<li><a href="cpp/ops.html#_CPPv410logical_orRK5arrayRK5array14StreamOrDevice">logical_or (C++ function)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.logical_or.html#mlx.core.logical_or">logical_or() (in module mlx.core)</a>
|
||||
</li>
|
||||
<li><a href="python/nn/_autosummary/mlx.nn.LogSigmoid.html#mlx.nn.LogSigmoid">LogSigmoid (class in mlx.nn)</a>
|
||||
</li>
|
||||
<li><a href="python/nn/_autosummary/mlx.nn.LogSoftmax.html#mlx.nn.LogSoftmax">LogSoftmax (class in mlx.nn)</a>
|
||||
</li>
|
||||
<li><a href="cpp/ops.html#_CPPv49logsumexpRK5array14StreamOrDevice">logsumexp (C++ function)</a>, <a href="cpp/ops.html#_CPPv49logsumexpRK5arrayRKNSt6vectorIiEEb14StreamOrDevice">[1]</a>, <a href="cpp/ops.html#_CPPv49logsumexpRK5arrayb14StreamOrDevice">[2]</a>, <a href="cpp/ops.html#_CPPv49logsumexpRK5arrayib14StreamOrDevice">[3]</a>
|
||||
</li>
|
||||
@@ -1848,10 +1868,10 @@ document.write(`
|
||||
</li>
|
||||
<li><a href="cpp/ops.html#_CPPv45powerRK5arrayRK5array14StreamOrDevice">power (C++ function)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="python/_autosummary/mlx.core.power.html#mlx.core.power">power() (in module mlx.core)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<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>
|
||||
@@ -1864,6 +1884,10 @@ document.write(`
|
||||
<li><a href="python/_autosummary/mlx.core.prod.html#mlx.core.prod">(in module mlx.core)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="cpp/ops.html#_CPPv414put_along_axisRK5arrayRK5arrayRK5arrayi14StreamOrDevice">put_along_axis (C++ function)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.put_along_axis.html#mlx.core.put_along_axis">put_along_axis() (in module mlx.core)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
@@ -2035,11 +2059,11 @@ document.write(`
|
||||
<li><a href="python/_autosummary/mlx.core.array.shape.html#mlx.core.array.shape">shape (array property)</a>
|
||||
</li>
|
||||
<li><a href="cpp/ops.html#_CPPv47sigmoidRK5array14StreamOrDevice">sigmoid (C++ function)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="python/nn/_autosummary_functions/mlx.nn.sigmoid.html#mlx.nn.sigmoid">(class in mlx.nn)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="python/nn/_autosummary/mlx.nn.Sigmoid.html#mlx.nn.Sigmoid">Sigmoid (class in mlx.nn)</a>
|
||||
</li>
|
||||
<li><a href="python/nn/_autosummary_functions/mlx.nn.sigmoid.html#mlx.nn.sigmoid">sigmoid (class in mlx.nn)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.sigmoid.html#mlx.core.sigmoid">sigmoid() (in module mlx.core)</a>
|
||||
</li>
|
||||
<li><a href="cpp/ops.html#_CPPv44signRK5array14StreamOrDevice">sign (C++ function)</a>
|
||||
@@ -2066,7 +2090,7 @@ document.write(`
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.array.size.html#mlx.core.array.size">size (array property)</a>
|
||||
</li>
|
||||
<li><a href="cpp/ops.html#_CPPv45sliceRK5arrayNSt6vectorIiEENSt6vectorIiEENSt6vectorIiEE14StreamOrDevice">slice (C++ function)</a>, <a href="cpp/ops.html#_CPPv45sliceRK5arrayRKNSt6vectorIiEERKNSt6vectorIiEE14StreamOrDevice">[1]</a>
|
||||
<li><a href="cpp/ops.html#_CPPv45sliceRK5arrayNSt6vectorIiEENSt6vectorIiEE14StreamOrDevice">slice (C++ function)</a>, <a href="cpp/ops.html#_CPPv45sliceRK5arrayNSt6vectorIiEENSt6vectorIiEENSt6vectorIiEE14StreamOrDevice">[1]</a>
|
||||
</li>
|
||||
<li><a href="cpp/ops.html#_CPPv412slice_updateRK5arrayRK5arrayNSt6vectorIiEENSt6vectorIiEE14StreamOrDevice">slice_update (C++ function)</a>, <a href="cpp/ops.html#_CPPv412slice_updateRK5arrayRK5arrayNSt6vectorIiEENSt6vectorIiEENSt6vectorIiEE14StreamOrDevice">[1]</a>
|
||||
</li>
|
||||
@@ -2202,7 +2226,7 @@ document.write(`
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="python/_autosummary/mlx.core.array.T.html#mlx.core.array.T">T (array property)</a>
|
||||
</li>
|
||||
<li><a href="cpp/ops.html#_CPPv44takeRK5arrayRK5array14StreamOrDevice">take (C++ function)</a>, <a href="cpp/ops.html#_CPPv44takeRK5arrayRK5arrayi14StreamOrDevice">[1]</a>
|
||||
<li><a href="cpp/ops.html#_CPPv44takeRK5arrayRK5array14StreamOrDevice">take (C++ function)</a>, <a href="cpp/ops.html#_CPPv44takeRK5arrayRK5arrayi14StreamOrDevice">[1]</a>, <a href="cpp/ops.html#_CPPv44takeRK5arrayi14StreamOrDevice">[2]</a>, <a href="cpp/ops.html#_CPPv44takeRK5arrayii14StreamOrDevice">[3]</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.take.html#mlx.core.take">take() (in module mlx.core)</a>
|
||||
</li>
|
||||
|
||||
Reference in New Issue
Block a user