mirror of
https://github.com/ml-explore/mlx.git
synced 2025-09-18 10:26:56 +08:00
docs up
This commit is contained in:
Awni Hannun
committed by
CircleCI Docs
CircleCI Docs
parent
27e07888b0
commit
6a6ffb598d
71
docs/build/html/genindex.html
vendored
71
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.0 documentation</title>
|
||||
<title>Index — MLX 0.17.3 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=50b3d22e"></script>
|
||||
<script src="_static/documentation_options.js?v=47c75248"></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.0 documentation - Home"/>
|
||||
<script>document.write(`<img src="_static/mlx_logo_dark.png" class="logo__image only-dark" alt="MLX 0.17.0 documentation - Home"/>`);</script>
|
||||
<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>
|
||||
|
||||
|
||||
</a></div>
|
||||
@@ -217,8 +217,9 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.sqrt.html">mlx.core.array.sqrt</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.square.html">mlx.core.array.square</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.squeeze.html">mlx.core.array.squeeze</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.swapaxes.html">mlx.core.array.swapaxes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.std.html">mlx.core.array.std</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.sum.html">mlx.core.array.sum</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.swapaxes.html">mlx.core.array.swapaxes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.transpose.html">mlx.core.array.transpose</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.T.html">mlx.core.array.T</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.var.html">mlx.core.array.var</a></li>
|
||||
@@ -281,6 +282,9 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.conv1d.html">mlx.core.conv1d</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.conv2d.html">mlx.core.conv2d</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.conv3d.html">mlx.core.conv3d</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.conv_transpose1d.html">mlx.core.conv_transpose1d</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.conv_transpose2d.html">mlx.core.conv_transpose2d</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.conv_transpose3d.html">mlx.core.conv_transpose3d</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.conv_general.html">mlx.core.conv_general</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.cos.html">mlx.core.cos</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.cosh.html">mlx.core.cosh</a></li>
|
||||
@@ -314,6 +318,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.hadamard_transform.html">mlx.core.hadamard_transform</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.identity.html">mlx.core.identity</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.inner.html">mlx.core.inner</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.isfinite.html">mlx.core.isfinite</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.isclose.html">mlx.core.isclose</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.isinf.html">mlx.core.isinf</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.isnan.html">mlx.core.isnan</a></li>
|
||||
@@ -513,6 +518,9 @@
|
||||
<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.ConvTranspose1d.html">mlx.nn.ConvTranspose1d</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.ConvTranspose2d.html">mlx.nn.ConvTranspose2d</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.ConvTranspose3d.html">mlx.nn.ConvTranspose3d</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>
|
||||
@@ -650,6 +658,9 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.distributed.init.html">mlx.core.distributed.init</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.distributed.all_sum.html">mlx.core.distributed.all_sum</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.distributed.all_gather.html">mlx.core.distributed.all_gather</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.distributed.send.html">mlx.core.distributed.send</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.distributed.recv.html">mlx.core.distributed.recv</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.distributed.recv_like.html">mlx.core.distributed.recv_like</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-22" name="toctree-checkbox-22" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-22"><i class="fa-solid fa-chevron-down"></i></label><ul>
|
||||
@@ -833,8 +844,6 @@ document.write(`
|
||||
<li><a href="python/_autosummary/mlx.core.DtypeCategory.html#mlx.core.DtypeCategory.__init__">(DtypeCategory method)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.distributed.Group.html#mlx.core.distributed.Group.__init__">(Group method)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.fast.metal_kernel.html#mlx.core.fast.metal_kernel.__init__">(metal_kernel method)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/stream_class.html#mlx.core.Stream.__init__">(Stream method)</a>
|
||||
</li>
|
||||
@@ -1093,15 +1102,33 @@ document.write(`
|
||||
</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="python/_autosummary/mlx.core.conv3d.html#mlx.core.conv3d">conv3d() (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>
|
||||
<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="cpp/ops.html#_CPPv416conv_transpose1dRK5arrayRK5arrayiiii14StreamOrDevice">conv_transpose1d (C++ function)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="python/_autosummary/mlx.core.conv_transpose1d.html#mlx.core.conv_transpose1d">conv_transpose1d() (in module mlx.core)</a>
|
||||
</li>
|
||||
<li><a href="cpp/ops.html#_CPPv416conv_transpose2dRK5arrayRK5arrayRKNSt4pairIiiEERKNSt4pairIiiEERKNSt4pairIiiEEi14StreamOrDevice">conv_transpose2d (C++ function)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.conv_transpose2d.html#mlx.core.conv_transpose2d">conv_transpose2d() (in module mlx.core)</a>
|
||||
</li>
|
||||
<li><a href="cpp/ops.html#_CPPv416conv_transpose3dRK5arrayRK5arrayRKNSt5tupleIiiiEERKNSt5tupleIiiiEERKNSt5tupleIiiiEEi14StreamOrDevice">conv_transpose3d (C++ function)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.conv_transpose3d.html#mlx.core.conv_transpose3d">conv_transpose3d() (in module mlx.core)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.convolve.html#mlx.core.convolve">convolve() (in module mlx.core)</a>
|
||||
</li>
|
||||
<li><a href="python/nn/_autosummary/mlx.nn.ConvTranspose1d.html#mlx.nn.ConvTranspose1d">ConvTranspose1d (class in mlx.nn)</a>
|
||||
</li>
|
||||
<li><a href="python/nn/_autosummary/mlx.nn.ConvTranspose2d.html#mlx.nn.ConvTranspose2d">ConvTranspose2d (class in mlx.nn)</a>
|
||||
</li>
|
||||
<li><a href="python/nn/_autosummary/mlx.nn.ConvTranspose3d.html#mlx.nn.ConvTranspose3d">ConvTranspose3d (class in mlx.nn)</a>
|
||||
</li>
|
||||
<li><a href="cpp/ops.html#_CPPv44copy5array14StreamOrDevice">copy (C++ function)</a>
|
||||
</li>
|
||||
@@ -1449,19 +1476,21 @@ document.write(`
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.fft.irfftn.html#mlx.core.fft.irfftn">irfftn() (in module mlx.core.fft)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="python/_autosummary/mlx.core.distributed.is_available.html#mlx.core.distributed.is_available">is_available() (in module mlx.core.distributed)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="python/_autosummary/mlx.core.metal.is_available.html#mlx.core.metal.is_available">(in module mlx.core.metal)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="cpp/ops.html#_CPPv47iscloseRK5arrayRK5arrayddb14StreamOrDevice">isclose (C++ function)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.isclose.html#mlx.core.isclose">isclose() (in module mlx.core)</a>
|
||||
</li>
|
||||
<li><a href="cpp/ops.html#_CPPv48isfiniteRK5array14StreamOrDevice">isfinite (C++ function)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.isfinite.html#mlx.core.isfinite">isfinite() (in module mlx.core)</a>
|
||||
</li>
|
||||
<li><a href="cpp/ops.html#_CPPv45isinfRK5array14StreamOrDevice">isinf (C++ function)</a>
|
||||
</li>
|
||||
@@ -1661,7 +1690,7 @@ document.write(`
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.meshgrid.html#mlx.core.meshgrid">meshgrid() (in module mlx.core)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.fast.metal_kernel.html#mlx.core.fast.metal_kernel">metal_kernel (class in mlx.core.fast)</a>
|
||||
<li><a href="python/_autosummary/mlx.core.fast.metal_kernel.html#mlx.core.fast.metal_kernel">metal_kernel() (in module mlx.core.fast)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
@@ -1711,7 +1740,7 @@ document.write(`
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="python/nn/_autosummary/mlx.nn.Module.named_modules.html#mlx.nn.Module.named_modules">named_modules() (Module method)</a>
|
||||
</li>
|
||||
<li><a href="cpp/ops.html#_CPPv410nan_to_numRK5arrayfRKNSt8optionalIfEERKNSt8optionalIfEE14StreamOrDevice">nan_to_num (C++ function)</a>
|
||||
<li><a href="cpp/ops.html#_CPPv410nan_to_numRK5arrayfKNSt8optionalIfEEKNSt8optionalIfEE14StreamOrDevice">nan_to_num (C++ function)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.nan_to_num.html#mlx.core.nan_to_num">nan_to_num() (in module mlx.core)</a>
|
||||
</li>
|
||||
@@ -1881,6 +1910,10 @@ document.write(`
|
||||
<li><a href="python/_autosummary/mlx.core.reciprocal.html#mlx.core.reciprocal">(in module mlx.core)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="python/_autosummary/mlx.core.distributed.recv.html#mlx.core.distributed.recv">recv() (in module mlx.core.distributed)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.distributed.recv_like.html#mlx.core.distributed.recv_like">recv_like() (in module mlx.core.distributed)</a>
|
||||
</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>
|
||||
@@ -1901,14 +1934,14 @@ document.write(`
|
||||
</li>
|
||||
<li><a href="cpp/ops.html#_CPPv47reshapeRK5arrayNSt6vectorIiEE14StreamOrDevice">reshape (C++ function)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="python/_autosummary/mlx.core.array.reshape.html#mlx.core.array.reshape">reshape() (array method)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="python/_autosummary/mlx.core.reshape.html#mlx.core.reshape">(in module mlx.core)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="python/_autosummary/mlx.core.fft.rfft.html#mlx.core.fft.rfft">rfft() (in module mlx.core.fft)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.fft.rfft2.html#mlx.core.fft.rfft2">rfft2() (in module mlx.core.fft)</a>
|
||||
@@ -1982,6 +2015,8 @@ document.write(`
|
||||
<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>
|
||||
<li><a href="python/_autosummary/mlx.core.distributed.send.html#mlx.core.distributed.send">send() (in module mlx.core.distributed)</a>
|
||||
</li>
|
||||
<li><a href="python/nn/_autosummary/mlx.nn.Sequential.html#mlx.nn.Sequential">Sequential (class in mlx.nn)</a>
|
||||
</li>
|
||||
@@ -2113,8 +2148,12 @@ document.write(`
|
||||
</ul></li>
|
||||
<li><a href="cpp/ops.html#_CPPv4StRK5array14StreamOrDevice">std (C++ function)</a>, <a href="cpp/ops.html#_CPPv4StRK5arrayRKNSt6vectorIiEEbi14StreamOrDevice">[1]</a>, <a href="cpp/ops.html#_CPPv4StRK5arraybi14StreamOrDevice">[2]</a>, <a href="cpp/ops.html#_CPPv4StRK5arrayibi14StreamOrDevice">[3]</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.std.html#mlx.core.std">std() (in module mlx.core)</a>
|
||||
<li><a href="python/_autosummary/mlx.core.array.std.html#mlx.core.array.std">std() (array method)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="python/_autosummary/mlx.core.std.html#mlx.core.std">(in module mlx.core)</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>
|
||||
|
||||
Reference in New Issue
Block a user