zhangyiss/mlx
1
0
Fork 0
mirror of https://github.com/ml-explore/mlx.git synced 2025-09-18 18:28:12 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

rebase

Browse Source
This commit is contained in:
CircleCI Docs
2025-04-03 20:25:24 +00:00
parent e87bbad179
commit a4d0492a1d
528 changed files with 8356 additions and 2106 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
docs/build/html/python/transforms.html vendored
View File

@@ -8,7 +8,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Transforms &#8212; MLX 0.24.1 documentation</title>
<title>Transforms &#8212; MLX 0.24.2 documentation</title>
@@ -36,7 +36,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=15e192ad"></script>
<script src="../_static/documentation_options.js?v=029512cb"></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>
@@ -137,8 +137,8 @@
<img src="../_static/mlx_logo.png" class="logo__image only-light" alt="MLX 0.24.1 documentation - Home"/>
<script>document.write(`<img src="../_static/mlx_logo_dark.png" class="logo__image only-dark" alt="MLX 0.24.1 documentation - Home"/>`);</script>
<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>
</a></div>
@@ -291,10 +291,12 @@
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.bitwise_or.html">mlx.core.bitwise_or</a></li>
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.bitwise_xor.html">mlx.core.bitwise_xor</a></li>
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.block_masked_mm.html">mlx.core.block_masked_mm</a></li>
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.broadcast_arrays.html">mlx.core.broadcast_arrays</a></li>
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.broadcast_to.html">mlx.core.broadcast_to</a></li>
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.ceil.html">mlx.core.ceil</a></li>
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.clip.html">mlx.core.clip</a></li>
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.concatenate.html">mlx.core.concatenate</a></li>
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.contiguous.html">mlx.core.contiguous</a></li>
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.conj.html">mlx.core.conj</a></li>
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.conjugate.html">mlx.core.conjugate</a></li>
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.convolve.html">mlx.core.convolve</a></li>
@@ -453,6 +455,7 @@
</details></li>
<li class="toctree-l1 current active has-children"><a class="current reference internal" href="#">Transforms</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.eval.html">mlx.core.eval</a></li>
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.async_eval.html">mlx.core.async_eval</a></li>
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.compile.html">mlx.core.compile</a></li>
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.custom_function.html">mlx.core.custom_function</a></li>
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.disable_compile.html">mlx.core.disable_compile</a></li>
@@ -500,6 +503,7 @@
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.linalg.eigh.html">mlx.core.linalg.eigh</a></li>
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.linalg.lu.html">mlx.core.linalg.lu</a></li>
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.linalg.lu_factor.html">mlx.core.linalg.lu_factor</a></li>
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.linalg.pinv.html">mlx.core.linalg.pinv</a></li>
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.linalg.solve.html">mlx.core.linalg.solve</a></li>
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.linalg.solve_triangular.html">mlx.core.linalg.solve_triangular</a></li>
</ul>
@@ -901,31 +905,34 @@ document.write(`
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.eval.html#mlx.core.eval" title="mlx.core.eval"><code class="xref py py-obj docutils literal notranslate"><span class="pre">eval</span></code></a>(*args)</p></td>
<td><p>Evaluate an <a class="reference internal" href="_autosummary/mlx.core.array.html#mlx.core.array" title="mlx.core.array"><code class="xref py py-class docutils literal notranslate"><span class="pre">array</span></code></a> or tree of <a class="reference internal" href="_autosummary/mlx.core.array.html#mlx.core.array" title="mlx.core.array"><code class="xref py py-class docutils literal notranslate"><span class="pre">array</span></code></a>.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.compile.html#mlx.core.compile" title="mlx.core.compile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">compile</span></code></a>(fun[, inputs, outputs, shapeless])</p></td>
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.async_eval.html#mlx.core.async_eval" title="mlx.core.async_eval"><code class="xref py py-obj docutils literal notranslate"><span class="pre">async_eval</span></code></a>(*args)</p></td>
<td><p>Asynchronously evaluate an <a class="reference internal" href="_autosummary/mlx.core.array.html#mlx.core.array" title="mlx.core.array"><code class="xref py py-class docutils literal notranslate"><span class="pre">array</span></code></a> or tree of <a class="reference internal" href="_autosummary/mlx.core.array.html#mlx.core.array" title="mlx.core.array"><code class="xref py py-class docutils literal notranslate"><span class="pre">array</span></code></a>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.compile.html#mlx.core.compile" title="mlx.core.compile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">compile</span></code></a>(fun[, inputs, outputs, shapeless])</p></td>
<td><p>Returns a compiled function which produces the same output as <code class="docutils literal notranslate"><span class="pre">fun</span></code>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.custom_function.html#mlx.core.custom_function" title="mlx.core.custom_function"><code class="xref py py-obj docutils literal notranslate"><span class="pre">custom_function</span></code></a></p></td>
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.custom_function.html#mlx.core.custom_function" title="mlx.core.custom_function"><code class="xref py py-obj docutils literal notranslate"><span class="pre">custom_function</span></code></a></p></td>
<td><p>Set up a function for custom gradient and vmap definitions.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.disable_compile.html#mlx.core.disable_compile" title="mlx.core.disable_compile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">disable_compile</span></code></a>()</p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.disable_compile.html#mlx.core.disable_compile" title="mlx.core.disable_compile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">disable_compile</span></code></a>()</p></td>
<td><p>Globally disable compilation.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.enable_compile.html#mlx.core.enable_compile" title="mlx.core.enable_compile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">enable_compile</span></code></a>()</p></td>
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.enable_compile.html#mlx.core.enable_compile" title="mlx.core.enable_compile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">enable_compile</span></code></a>()</p></td>
<td><p>Globally enable compilation.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.grad.html#mlx.core.grad" title="mlx.core.grad"><code class="xref py py-obj docutils literal notranslate"><span class="pre">grad</span></code></a>(fun[, argnums, argnames])</p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.grad.html#mlx.core.grad" title="mlx.core.grad"><code class="xref py py-obj docutils literal notranslate"><span class="pre">grad</span></code></a>(fun[, argnums, argnames])</p></td>
<td><p>Returns a function which computes the gradient of <code class="docutils literal notranslate"><span class="pre">fun</span></code>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.value_and_grad.html#mlx.core.value_and_grad" title="mlx.core.value_and_grad"><code class="xref py py-obj docutils literal notranslate"><span class="pre">value_and_grad</span></code></a>(fun[, argnums, argnames])</p></td>
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.value_and_grad.html#mlx.core.value_and_grad" title="mlx.core.value_and_grad"><code class="xref py py-obj docutils literal notranslate"><span class="pre">value_and_grad</span></code></a>(fun[, argnums, argnames])</p></td>
<td><p>Returns a function which computes the value and gradient of <code class="docutils literal notranslate"><span class="pre">fun</span></code>.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.jvp.html#mlx.core.jvp" title="mlx.core.jvp"><code class="xref py py-obj docutils literal notranslate"><span class="pre">jvp</span></code></a>(fun, primals, tangents)</p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.jvp.html#mlx.core.jvp" title="mlx.core.jvp"><code class="xref py py-obj docutils literal notranslate"><span class="pre">jvp</span></code></a>(fun, primals, tangents)</p></td>
<td><p>Compute the Jacobian-vector product.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.vjp.html#mlx.core.vjp" title="mlx.core.vjp"><code class="xref py py-obj docutils literal notranslate"><span class="pre">vjp</span></code></a>(fun, primals, cotangents)</p></td>
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.vjp.html#mlx.core.vjp" title="mlx.core.vjp"><code class="xref py py-obj docutils literal notranslate"><span class="pre">vjp</span></code></a>(fun, primals, cotangents)</p></td>
<td><p>Compute the vector-Jacobian product.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.vmap.html#mlx.core.vmap" title="mlx.core.vmap"><code class="xref py py-obj docutils literal notranslate"><span class="pre">vmap</span></code></a>(fun[, in_axes, out_axes])</p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.vmap.html#mlx.core.vmap" title="mlx.core.vmap"><code class="xref py py-obj docutils literal notranslate"><span class="pre">vmap</span></code></a>(fun[, in_axes, out_axes])</p></td>
<td><p>Returns a vectorized version of <code class="docutils literal notranslate"><span class="pre">fun</span></code>.</p></td>
</tr>
</tbody>