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
3e724a7c98
commit
c620a28b16
47
docs/build/html/genindex.html
vendored
47
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.13.0 documentation</title>
|
||||
<title>Index — MLX 0.13.1 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=1539091c"></script>
|
||||
<script src="_static/documentation_options.js?v=aec58b01"></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.13.0 documentation - Home"/>
|
||||
<script>document.write(`<img src="_static/mlx_logo_dark.png" class="logo__image only-dark" alt="MLX 0.13.0 documentation - Home"/>`);</script>
|
||||
<img src="_static/mlx_logo.png" class="logo__image only-light" alt="MLX 0.13.1 documentation - Home"/>
|
||||
<script>document.write(`<img src="_static/mlx_logo_dark.png" class="logo__image only-dark" alt="MLX 0.13.1 documentation - Home"/>`);</script>
|
||||
|
||||
|
||||
</a></div>
|
||||
@@ -243,6 +243,7 @@
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="python/ops.html">Operations</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-4"><i class="fa-solid fa-chevron-down"></i></label><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.abs.html">mlx.core.abs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.add.html">mlx.core.add</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.addmm.html">mlx.core.addmm</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.all.html">mlx.core.all</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.allclose.html">mlx.core.allclose</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.any.html">mlx.core.any</a></li>
|
||||
@@ -259,6 +260,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.argpartition.html">mlx.core.argpartition</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.argsort.html">mlx.core.argsort</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array_equal.html">mlx.core.array_equal</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.as_strided.html">mlx.core.as_strided</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.atleast_1d.html">mlx.core.atleast_1d</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.atleast_2d.html">mlx.core.atleast_2d</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.atleast_3d.html">mlx.core.atleast_3d</a></li>
|
||||
@@ -309,6 +311,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.isnan.html">mlx.core.isnan</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.isneginf.html">mlx.core.isneginf</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.isposinf.html">mlx.core.isposinf</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.issubdtype.html">mlx.core.issubdtype</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.left_shift.html">mlx.core.left_shift</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.less.html">mlx.core.less</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.less_equal.html">mlx.core.less_equal</a></li>
|
||||
@@ -339,11 +342,13 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.outer.html">mlx.core.outer</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.partition.html">mlx.core.partition</a></li>
|
||||
<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.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>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.reciprocal.html">mlx.core.reciprocal</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.remainder.html">mlx.core.remainder</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.repeat.html">mlx.core.repeat</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.reshape.html">mlx.core.reshape</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.right_shift.html">mlx.core.right_shift</a></li>
|
||||
@@ -436,8 +441,11 @@
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="python/linalg.html">Linear Algebra</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-l2"><a class="reference internal" href="python/_autosummary/mlx.core.linalg.inv.html">mlx.core.linalg.inv</a></li>
|
||||
<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.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>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="python/metal.html">Metal</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-10"><i class="fa-solid fa-chevron-down"></i></label><ul>
|
||||
@@ -487,6 +495,7 @@
|
||||
<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.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>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.Dropout.html">mlx.nn.Dropout</a></li>
|
||||
<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>
|
||||
@@ -619,7 +628,7 @@
|
||||
</ul>
|
||||
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Further Reading</span></p>
|
||||
<ul class="nav bd-sidenav">
|
||||
<li class="toctree-l1"><a class="reference internal" href="dev/extensions.html">Developer Documentation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="dev/extensions.html">Custom Extensions in MLX</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="dev/metal_debugger.html">Metal Debugger</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -815,6 +824,8 @@ document.write(`
|
||||
<li><a href="python/_autosummary/mlx.core.add.html#mlx.core.add">add() (in module mlx.core)</a>
|
||||
</li>
|
||||
<li><a href="cpp/ops.html#_CPPv45addmm5array5array5arrayRKfRKf14StreamOrDevice">addmm (C++ function)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.addmm.html#mlx.core.addmm">addmm() (in module mlx.core)</a>
|
||||
</li>
|
||||
<li><a href="python/nn/_autosummary/mlx.nn.ALiBi.html#mlx.nn.ALiBi">ALiBi (class in mlx.nn)</a>
|
||||
</li>
|
||||
@@ -909,6 +920,8 @@ document.write(`
|
||||
<li><a href="python/_autosummary/mlx.core.array_equal.html#mlx.core.array_equal">array_equal() (in module mlx.core)</a>
|
||||
</li>
|
||||
<li><a href="cpp/ops.html#_CPPv410as_strided5arrayNSt6vectorIiEENSt6vectorI6size_tEE6size_t14StreamOrDevice">as_strided (C++ function)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.as_strided.html#mlx.core.as_strided">as_strided() (in module mlx.core)</a>
|
||||
</li>
|
||||
<li><a href="cpp/ops.html#_CPPv46astype5array5Dtype14StreamOrDevice">astype (C++ function)</a>
|
||||
</li>
|
||||
@@ -965,6 +978,8 @@ document.write(`
|
||||
<li><a href="cpp/ops.html#_CPPv415block_sparse_mm5array5arrayNSt8optionalI5arrayEENSt8optionalI5arrayEE14StreamOrDevice">block_sparse_mm (C++ function)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.block_sparse_mm.html#mlx.core.block_sparse_mm">block_sparse_mm() (in module mlx.core)</a>
|
||||
</li>
|
||||
<li><a href="cpp/ops.html#_CPPv416block_sparse_qmmRK5arrayRK5arrayRK5arrayRK5arrayNSt8optionalI5arrayEENSt8optionalI5arrayEEbii14StreamOrDevice">block_sparse_qmm (C++ function)</a>
|
||||
</li>
|
||||
<li><a href="cpp/ops.html#_CPPv416broadcast_arraysRKNSt6vectorI5arrayEE14StreamOrDevice">broadcast_arrays (C++ function)</a>
|
||||
</li>
|
||||
@@ -985,6 +1000,8 @@ document.write(`
|
||||
<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.Module.children.html#mlx.nn.Module.children">children() (Module method)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.linalg.cholesky.html#mlx.core.linalg.cholesky">cholesky() (in module mlx.core.linalg)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.metal.clear_cache.html#mlx.core.metal.clear_cache">clear_cache() (in module mlx.core.metal)</a>
|
||||
</li>
|
||||
@@ -1020,10 +1037,14 @@ document.write(`
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.conv2d.html#mlx.core.conv2d">conv2d() (in module mlx.core)</a>
|
||||
</li>
|
||||
<li><a href="cpp/ops.html#_CPPv412conv_general5array5arrayNSt6vectorIiEENSt6vectorIiEENSt6vectorIiEENSt6vectorIiEENSt6vectorIiEEib14StreamOrDevice">conv_general (C++ function)</a>, <a href="cpp/ops.html#_CPPv412conv_generalRK5arrayRK5arrayNSt6vectorIiEENSt6vectorIiEENSt6vectorIiEENSt6vectorIiEEib14StreamOrDevice">[1]</a>
|
||||
<li><a href="cpp/ops.html#_CPPv46conv3dRK5arrayRK5arrayRKNSt5tupleIiiiEERKNSt5tupleIiiiEERKNSt5tupleIiiiEEi14StreamOrDevice">conv3d (C++ function)</a>
|
||||
</li>
|
||||
<li><a href="python/nn/_autosummary/mlx.nn.Conv3d.html#mlx.nn.Conv3d">Conv3d (class in mlx.nn)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="cpp/ops.html#_CPPv412conv_general5array5arrayNSt6vectorIiEENSt6vectorIiEENSt6vectorIiEENSt6vectorIiEENSt6vectorIiEEib14StreamOrDevice">conv_general (C++ function)</a>, <a href="cpp/ops.html#_CPPv412conv_generalRK5arrayRK5arrayNSt6vectorIiEENSt6vectorIiEENSt6vectorIiEENSt6vectorIiEEib14StreamOrDevice">[1]</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.conv_general.html#mlx.core.conv_general">conv_general() (in module mlx.core)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.convolve.html#mlx.core.convolve">convolve() (in module mlx.core)</a>
|
||||
@@ -1329,6 +1350,8 @@ document.write(`
|
||||
<li><a href="python/_autosummary/mlx.core.inner.html#mlx.core.inner">inner() (in module mlx.core)</a>
|
||||
</li>
|
||||
<li><a href="python/nn/_autosummary/mlx.nn.InstanceNorm.html#mlx.nn.InstanceNorm">InstanceNorm (class in mlx.nn)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.linalg.inv.html#mlx.core.linalg.inv">inv() (in module mlx.core.linalg)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.fft.irfft.html#mlx.core.fft.irfft">irfft() (in module mlx.core.fft)</a>
|
||||
</li>
|
||||
@@ -1687,10 +1710,12 @@ document.write(`
|
||||
<li><a href="cpp/ops.html#_CPPv49partitionRK5arrayi14StreamOrDevice">partition (C++ function)</a>, <a href="cpp/ops.html#_CPPv49partitionRK5arrayii14StreamOrDevice">[1]</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.partition.html#mlx.core.partition">partition() (in module mlx.core)</a>
|
||||
</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="cpp/ops.html#_CPPv45powerRK5arrayRK5array14StreamOrDevice">power (C++ function)</a>
|
||||
<li><a href="python/_autosummary/mlx.core.power.html#mlx.core.power">power() (in module mlx.core)</a>
|
||||
</li>
|
||||
<li><a href="python/nn/_autosummary/mlx.nn.PReLU.html#mlx.nn.PReLU">PReLU (class in mlx.nn)</a>
|
||||
</li>
|
||||
@@ -1757,6 +1782,8 @@ document.write(`
|
||||
<li><a href="python/nn/_autosummary_functions/mlx.nn.relu6.html#mlx.nn.relu6">relu6 (class in mlx.nn)</a>
|
||||
</li>
|
||||
<li><a href="cpp/ops.html#_CPPv49remainderRK5arrayRK5array14StreamOrDevice">remainder (C++ function)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.remainder.html#mlx.core.remainder">remainder() (in module mlx.core)</a>
|
||||
</li>
|
||||
<li><a href="cpp/ops.html#_CPPv46repeatRK5arrayi14StreamOrDevice">repeat (C++ function)</a>, <a href="cpp/ops.html#_CPPv46repeatRK5arrayii14StreamOrDevice">[1]</a>
|
||||
</li>
|
||||
@@ -1908,10 +1935,10 @@ document.write(`
|
||||
<li><a href="python/nn/_autosummary_functions/mlx.nn.softmax.html#mlx.nn.softmax">(class in mlx.nn)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="python/_autosummary/mlx.core.softmax.html#mlx.core.softmax">softmax() (in module mlx.core)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="python/nn/_autosummary_functions/mlx.nn.softplus.html#mlx.nn.softplus">softplus (class in mlx.nn)</a>
|
||||
</li>
|
||||
<li><a href="python/nn/_autosummary/mlx.nn.Softshrink.html#mlx.nn.Softshrink">Softshrink (class in mlx.nn)</a>
|
||||
@@ -2000,6 +2027,8 @@ document.write(`
|
||||
<li><a href="python/_autosummary/mlx.core.sum.html#mlx.core.sum">(in module mlx.core)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="python/_autosummary/mlx.core.linalg.svd.html#mlx.core.linalg.svd">svd() (in module mlx.core.linalg)</a>
|
||||
</li>
|
||||
<li><a href="cpp/ops.html#_CPPv48swapaxesRK5arrayii14StreamOrDevice">swapaxes (C++ function)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.array.swapaxes.html#mlx.core.array.swapaxes">swapaxes() (array method)</a>
|
||||
|
||||
Reference in New Issue
Block a user