mirror of
https://github.com/ml-explore/mlx.git
synced 2025-09-18 18:28:12 +08:00
docs update
This commit is contained in:
Awni Hannun
committed by
CircleCI Docs
CircleCI Docs
parent
ba4eff9520
commit
0e688cbd0f
29
docs/build/html/python/transforms.html
vendored
29
docs/build/html/python/transforms.html
vendored
@@ -8,7 +8,7 @@
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>Transforms — MLX 0.15.0 documentation</title>
|
||||
<title>Transforms — MLX 0.16.0 documentation</title>
|
||||
|
||||
|
||||
|
||||
@@ -36,7 +36,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=7276bfb7"></script>
|
||||
<script src="../_static/documentation_options.js?v=ac69e7c2"></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>
|
||||
@@ -131,8 +131,8 @@
|
||||
|
||||
|
||||
|
||||
<img src="../_static/mlx_logo.png" class="logo__image only-light" alt="MLX 0.15.0 documentation - Home"/>
|
||||
<script>document.write(`<img src="../_static/mlx_logo_dark.png" class="logo__image only-dark" alt="MLX 0.15.0 documentation - Home"/>`);</script>
|
||||
<img src="../_static/mlx_logo.png" class="logo__image only-light" alt="MLX 0.16.0 documentation - Home"/>
|
||||
<script>document.write(`<img src="../_static/mlx_logo_dark.png" class="logo__image only-dark" alt="MLX 0.16.0 documentation - Home"/>`);</script>
|
||||
|
||||
|
||||
</a></div>
|
||||
@@ -191,6 +191,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.array.any.html">mlx.core.array.any</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.array.argmax.html">mlx.core.array.argmax</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.array.argmin.html">mlx.core.array.argmin</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.array.conj.html">mlx.core.array.conj</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.array.cos.html">mlx.core.array.cos</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.array.cummax.html">mlx.core.array.cummax</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.array.cummin.html">mlx.core.array.cummin</a></li>
|
||||
@@ -224,6 +225,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.array.transpose.html">mlx.core.array.transpose</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.array.T.html">mlx.core.array.T</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.array.var.html">mlx.core.array.var</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.array.view.html">mlx.core.array.view</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="data_types.html">Data Types</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul>
|
||||
@@ -309,6 +311,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.gather_qmm.html">mlx.core.gather_qmm</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.greater.html">mlx.core.greater</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.greater_equal.html">mlx.core.greater_equal</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.hadamard_transform.html">mlx.core.hadamard_transform</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.identity.html">mlx.core.identity</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.inner.html">mlx.core.inner</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.isclose.html">mlx.core.isclose</a></li>
|
||||
@@ -416,6 +419,7 @@
|
||||
<li class="toctree-l1 current active has-children"><a class="current reference internal" href="#">Transforms</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-6"><i class="fa-solid fa-chevron-down"></i></label><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.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>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.enable_compile.html">mlx.core.enable_compile</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.grad.html">mlx.core.grad</a></li>
|
||||
@@ -834,25 +838,28 @@ document.write(`
|
||||
<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>
|
||||
<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.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.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>
|
||||
<td><p>Globally disable compilation.</p></td>
|
||||
</tr>
|
||||
<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>
|
||||
<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>
|
||||
<td><p>Globally enable compilation.</p></td>
|
||||
</tr>
|
||||
<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>
|
||||
<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>
|
||||
<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-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>
|
||||
<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>
|
||||
<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-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>
|
||||
<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>
|
||||
<td><p>Compute the Jacobian-vector product.</p></td>
|
||||
</tr>
|
||||
<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>
|
||||
<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>
|
||||
<td><p>Compute the vector-Jacobian product.</p></td>
|
||||
</tr>
|
||||
<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>
|
||||
<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>
|
||||
<td><p>Returns a vectorized version of <code class="docutils literal notranslate"><span class="pre">fun</span></code>.</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
Reference in New Issue
Block a user