This commit is contained in:
CircleCI Docs
2024-12-06 21:22:39 +00:00
parent 379b7b4027
commit 1c60f94127
896 changed files with 12293 additions and 11212 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.21.0 documentation</title>
<title>Index &#8212; MLX 0.21.1 documentation</title>
@@ -38,7 +38,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=174dfe6e"></script>
<script src="_static/documentation_options.js?v=acb17c73"></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>
@@ -48,7 +48,7 @@
<link rel="search" title="Search" href="search.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="0.21.0" />
<meta name="docsearch:version" content="0.21.1" />
</head>
@@ -129,8 +129,8 @@
<img src="_static/mlx_logo.png" class="logo__image only-light" alt="MLX 0.21.0 documentation - Home"/>
<img src="_static/mlx_logo_dark.png" class="logo__image only-dark pst-js-only" alt="MLX 0.21.0 documentation - Home"/>
<img src="_static/mlx_logo.png" class="logo__image only-light" alt="MLX 0.21.1 documentation - Home"/>
<img src="_static/mlx_logo_dark.png" class="logo__image only-dark pst-js-only" alt="MLX 0.21.1 documentation - Home"/>
</a></div>
@@ -983,7 +983,7 @@
</li>
<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><a href="cpp/ops.html#_CPPv410as_strided5array5Shape7Strides6size_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>
@@ -1043,7 +1043,7 @@
</li>
<li><a href="cpp/ops.html#_CPPv416broadcast_arraysRKNSt6vectorI5arrayEE14StreamOrDevice">broadcast_arrays (C++ function)</a>
</li>
<li><a href="cpp/ops.html#_CPPv412broadcast_toRK5arrayRKNSt6vectorIiEE14StreamOrDevice">broadcast_to (C++ function)</a>
<li><a href="cpp/ops.html#_CPPv412broadcast_toRK5arrayRK5Shape14StreamOrDevice">broadcast_to (C++ function)</a>
</li>
<li><a href="python/_autosummary/mlx.core.broadcast_to.html#mlx.core.broadcast_to">broadcast_to() (in module mlx.core)</a>
</li>
@@ -1359,7 +1359,7 @@
</li>
<li><a href="python/nn/_autosummary/mlx.nn.Module.freeze.html#mlx.nn.Module.freeze">freeze() (Module method)</a>
</li>
<li><a href="cpp/ops.html#_CPPv44fullNSt6vectorIiEE5array14StreamOrDevice">full (C++ function)</a>, <a href="cpp/ops.html#_CPPv44fullNSt6vectorIiEE5array5Dtype14StreamOrDevice">[1]</a>, <a href="cpp/ops.html#_CPPv4I0E4full5arrayNSt6vectorIiEE1T14StreamOrDevice">[2]</a>, <a href="cpp/ops.html#_CPPv4I0E4full5arrayNSt6vectorIiEE1T5Dtype14StreamOrDevice">[3]</a>
<li><a href="cpp/ops.html#_CPPv44full5Shape5array14StreamOrDevice">full (C++ function)</a>, <a href="cpp/ops.html#_CPPv44full5Shape5array5Dtype14StreamOrDevice">[1]</a>, <a href="cpp/ops.html#_CPPv4I0E4full5array5Shape1T14StreamOrDevice">[2]</a>, <a href="cpp/ops.html#_CPPv4I0E4full5array5Shape1T5Dtype14StreamOrDevice">[3]</a>
</li>
<li><a href="python/_autosummary/mlx.core.full.html#mlx.core.full">full() (in module mlx.core)</a>
</li>
@@ -1369,7 +1369,7 @@
<h2 id="G">G</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="cpp/ops.html#_CPPv46gatherRK5arrayRK5arrayiRKNSt6vectorIiEE14StreamOrDevice">gather (C++ function)</a>, <a href="cpp/ops.html#_CPPv46gatherRK5arrayRKNSt6vectorI5arrayEERKNSt6vectorIiEERKNSt6vectorIiEE14StreamOrDevice">[1]</a>
<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>
@@ -1807,7 +1807,7 @@
<h2 id="O">O</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="cpp/ops.html#_CPPv44onesRKNSt6vectorIiEE14StreamOrDevice">ones (C++ function)</a>, <a href="cpp/ops.html#_CPPv44onesRKNSt6vectorIiEE5Dtype14StreamOrDevice">[1]</a>
<li><a href="cpp/ops.html#_CPPv44onesRK5Shape14StreamOrDevice">ones (C++ function)</a>, <a href="cpp/ops.html#_CPPv44onesRK5Shape5Dtype14StreamOrDevice">[1]</a>
</li>
<li><a href="python/_autosummary/mlx.core.ones.html#mlx.core.ones">ones() (in module mlx.core)</a>
</li>
@@ -1971,7 +1971,7 @@
</li>
<li><a href="python/_autosummary/mlx.core.metal.reset_peak_memory.html#mlx.core.metal.reset_peak_memory">reset_peak_memory() (in module mlx.core.metal)</a>
</li>
<li><a href="cpp/ops.html#_CPPv47reshapeRK5arrayNSt6vectorIiEE14StreamOrDevice">reshape (C++ function)</a>
<li><a href="cpp/ops.html#_CPPv47reshapeRK5array5Shape14StreamOrDevice">reshape (C++ function)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
@@ -1999,7 +1999,7 @@
</li>
<li><a href="python/nn/_autosummary/mlx.nn.RNN.html#mlx.nn.RNN">RNN (class in mlx.nn)</a>
</li>
<li><a href="cpp/ops.html#_CPPv44rollRK5arrayRKNSt6vectorIiEE14StreamOrDevice">roll (C++ function)</a>, <a href="cpp/ops.html#_CPPv44rollRK5arrayRKNSt6vectorIiEERKNSt6vectorIiEE14StreamOrDevice">[1]</a>, <a href="cpp/ops.html#_CPPv44rollRK5arrayRKNSt6vectorIiEEi14StreamOrDevice">[2]</a>, <a href="cpp/ops.html#_CPPv44rollRK5arrayi14StreamOrDevice">[3]</a>, <a href="cpp/ops.html#_CPPv44rollRK5arrayiRKNSt6vectorIiEE14StreamOrDevice">[4]</a>, <a href="cpp/ops.html#_CPPv44rollRK5arrayii14StreamOrDevice">[5]</a>
<li><a href="cpp/ops.html#_CPPv44rollRK5arrayRK5Shape14StreamOrDevice">roll (C++ function)</a>, <a href="cpp/ops.html#_CPPv44rollRK5arrayRK5ShapeRKNSt6vectorIiEE14StreamOrDevice">[1]</a>, <a href="cpp/ops.html#_CPPv44rollRK5arrayRK5Shapei14StreamOrDevice">[2]</a>, <a href="cpp/ops.html#_CPPv44rollRK5arrayi14StreamOrDevice">[3]</a>, <a href="cpp/ops.html#_CPPv44rollRK5arrayiRK5Shape14StreamOrDevice">[4]</a>, <a href="cpp/ops.html#_CPPv44rollRK5arrayii14StreamOrDevice">[5]</a>
</li>
<li><a href="python/_autosummary/mlx.core.roll.html#mlx.core.roll">roll() (in module mlx.core)</a>
</li>
@@ -2111,9 +2111,9 @@
</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#_CPPv45sliceRK5arrayNSt6vectorIiEENSt6vectorIiEE14StreamOrDevice">slice (C++ function)</a>, <a href="cpp/ops.html#_CPPv45sliceRK5arrayNSt6vectorIiEENSt6vectorIiEENSt6vectorIiEE14StreamOrDevice">[1]</a>
<li><a href="cpp/ops.html#_CPPv45sliceRK5array5Shape5Shape14StreamOrDevice">slice (C++ function)</a>, <a href="cpp/ops.html#_CPPv45sliceRK5array5Shape5Shape5Shape14StreamOrDevice">[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><a href="cpp/ops.html#_CPPv412slice_updateRK5arrayRK5array5Shape5Shape14StreamOrDevice">slice_update (C++ function)</a>, <a href="cpp/ops.html#_CPPv412slice_updateRK5arrayRK5array5Shape5Shape5Shape14StreamOrDevice">[1]</a>
</li>
<li><a href="python/nn/_autosummary_functions/mlx.nn.losses.smooth_l1_loss.html#mlx.nn.losses.smooth_l1_loss">smooth_l1_loss (class in mlx.nn.losses)</a>
</li>
@@ -2409,7 +2409,7 @@
<h2 id="Z">Z</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="cpp/ops.html#_CPPv45zerosRKNSt6vectorIiEE14StreamOrDevice">zeros (C++ function)</a>, <a href="cpp/ops.html#_CPPv45zerosRKNSt6vectorIiEE5Dtype14StreamOrDevice">[1]</a>
<li><a href="cpp/ops.html#_CPPv45zerosRK5Shape14StreamOrDevice">zeros (C++ function)</a>, <a href="cpp/ops.html#_CPPv45zerosRK5Shape5Dtype14StreamOrDevice">[1]</a>
</li>
<li><a href="python/_autosummary/mlx.core.zeros.html#mlx.core.zeros">zeros() (in module mlx.core)</a>
</li>