mirror of
https://github.com/ml-explore/mlx.git
synced 2025-09-20 12:08:14 +08:00
docs up
This commit is contained in:
Awni Hannun
committed by
CircleCI Docs
CircleCI Docs
parent
9da49a07a4
commit
d44f06ae79
103
docs/build/html/python/ops.html
vendored
103
docs/build/html/python/ops.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>Operations — MLX 0.17.0 documentation</title>
|
||||
<title>Operations — MLX 0.17.3 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=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>
|
||||
@@ -131,8 +131,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>
|
||||
@@ -220,8 +220,9 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.array.sqrt.html">mlx.core.array.sqrt</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.array.square.html">mlx.core.array.square</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.array.squeeze.html">mlx.core.array.squeeze</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.array.swapaxes.html">mlx.core.array.swapaxes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.array.std.html">mlx.core.array.std</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.array.sum.html">mlx.core.array.sum</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.array.swapaxes.html">mlx.core.array.swapaxes</a></li>
|
||||
<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>
|
||||
@@ -284,6 +285,9 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.conv1d.html">mlx.core.conv1d</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.conv2d.html">mlx.core.conv2d</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.conv3d.html">mlx.core.conv3d</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.conv_transpose1d.html">mlx.core.conv_transpose1d</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.conv_transpose2d.html">mlx.core.conv_transpose2d</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.conv_transpose3d.html">mlx.core.conv_transpose3d</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.conv_general.html">mlx.core.conv_general</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.cos.html">mlx.core.cos</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.cosh.html">mlx.core.cosh</a></li>
|
||||
@@ -317,6 +321,7 @@
|
||||
<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.isfinite.html">mlx.core.isfinite</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.isclose.html">mlx.core.isclose</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.isinf.html">mlx.core.isinf</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.isnan.html">mlx.core.isnan</a></li>
|
||||
@@ -516,6 +521,9 @@
|
||||
<li class="toctree-l3"><a class="reference internal" href="nn/_autosummary/mlx.nn.Conv1d.html">mlx.nn.Conv1d</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="nn/_autosummary/mlx.nn.Conv2d.html">mlx.nn.Conv2d</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="nn/_autosummary/mlx.nn.Conv3d.html">mlx.nn.Conv3d</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="nn/_autosummary/mlx.nn.ConvTranspose1d.html">mlx.nn.ConvTranspose1d</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="nn/_autosummary/mlx.nn.ConvTranspose2d.html">mlx.nn.ConvTranspose2d</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="nn/_autosummary/mlx.nn.ConvTranspose3d.html">mlx.nn.ConvTranspose3d</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="nn/_autosummary/mlx.nn.Dropout.html">mlx.nn.Dropout</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="nn/_autosummary/mlx.nn.Dropout2d.html">mlx.nn.Dropout2d</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="nn/_autosummary/mlx.nn.Dropout3d.html">mlx.nn.Dropout3d</a></li>
|
||||
@@ -653,6 +661,9 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.distributed.init.html">mlx.core.distributed.init</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.distributed.all_sum.html">mlx.core.distributed.all_sum</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.distributed.all_gather.html">mlx.core.distributed.all_gather</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.distributed.send.html">mlx.core.distributed.send</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autosummary/mlx.core.distributed.recv.html">mlx.core.distributed.recv</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_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="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>
|
||||
@@ -920,7 +931,7 @@ document.write(`
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.bitwise_xor.html#mlx.core.bitwise_xor" title="mlx.core.bitwise_xor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">bitwise_xor</span></code></a>(a, b[, stream])</p></td>
|
||||
<td><p>Element-wise bitwise xor.</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.block_masked_mm.html#mlx.core.block_masked_mm" title="mlx.core.block_masked_mm"><code class="xref py py-obj docutils literal notranslate"><span class="pre">block_masked_mm</span></code></a>(a, b, /, block_size, ...)</p></td>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.block_masked_mm.html#mlx.core.block_masked_mm" title="mlx.core.block_masked_mm"><code class="xref py py-obj docutils literal notranslate"><span class="pre">block_masked_mm</span></code></a>(a, b, /[, block_size, ...])</p></td>
|
||||
<td><p>Matrix multiplication with block masking.</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.broadcast_to.html#mlx.core.broadcast_to" title="mlx.core.broadcast_to"><code class="xref py py-obj docutils literal notranslate"><span class="pre">broadcast_to</span></code></a>(a, /, shape, *[, stream])</p></td>
|
||||
@@ -953,105 +964,117 @@ document.write(`
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.conv3d.html#mlx.core.conv3d" title="mlx.core.conv3d"><code class="xref py py-obj docutils literal notranslate"><span class="pre">conv3d</span></code></a>(input, weight, /[, stride, padding, ...])</p></td>
|
||||
<td><p>3D convolution over an input with several channels</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.conv_general.html#mlx.core.conv_general" title="mlx.core.conv_general"><code class="xref py py-obj docutils literal notranslate"><span class="pre">conv_general</span></code></a>(input, weight, /[, stride, ...])</p></td>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.conv_transpose1d.html#mlx.core.conv_transpose1d" title="mlx.core.conv_transpose1d"><code class="xref py py-obj docutils literal notranslate"><span class="pre">conv_transpose1d</span></code></a>(input, weight, /[, stride, ...])</p></td>
|
||||
<td><p>1D transposed convolution over an input with several channels</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.conv_transpose2d.html#mlx.core.conv_transpose2d" title="mlx.core.conv_transpose2d"><code class="xref py py-obj docutils literal notranslate"><span class="pre">conv_transpose2d</span></code></a>(input, weight, /[, stride, ...])</p></td>
|
||||
<td><p>2D transposed convolution over an input with several channels</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.conv_transpose3d.html#mlx.core.conv_transpose3d" title="mlx.core.conv_transpose3d"><code class="xref py py-obj docutils literal notranslate"><span class="pre">conv_transpose3d</span></code></a>(input, weight, /[, stride, ...])</p></td>
|
||||
<td><p>3D transposed convolution over an input with several channels</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.conv_general.html#mlx.core.conv_general" title="mlx.core.conv_general"><code class="xref py py-obj docutils literal notranslate"><span class="pre">conv_general</span></code></a>(input, weight, /[, stride, ...])</p></td>
|
||||
<td><p>General convolution over an input with several channels</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.cos.html#mlx.core.cos" title="mlx.core.cos"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cos</span></code></a>(a, /, *[, stream])</p></td>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.cos.html#mlx.core.cos" title="mlx.core.cos"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cos</span></code></a>(a, /, *[, stream])</p></td>
|
||||
<td><p>Element-wise cosine.</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.cosh.html#mlx.core.cosh" title="mlx.core.cosh"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cosh</span></code></a>(a, /, *[, stream])</p></td>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.cosh.html#mlx.core.cosh" title="mlx.core.cosh"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cosh</span></code></a>(a, /, *[, stream])</p></td>
|
||||
<td><p>Element-wise hyperbolic cosine.</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.cummax.html#mlx.core.cummax" title="mlx.core.cummax"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cummax</span></code></a>(a, /[, axis, reverse, inclusive, stream])</p></td>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.cummax.html#mlx.core.cummax" title="mlx.core.cummax"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cummax</span></code></a>(a, /[, axis, reverse, inclusive, stream])</p></td>
|
||||
<td><p>Return the cumulative maximum of the elements along the given axis.</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.cummin.html#mlx.core.cummin" title="mlx.core.cummin"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cummin</span></code></a>(a, /[, axis, reverse, inclusive, stream])</p></td>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.cummin.html#mlx.core.cummin" title="mlx.core.cummin"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cummin</span></code></a>(a, /[, axis, reverse, inclusive, stream])</p></td>
|
||||
<td><p>Return the cumulative minimum of the elements along the given axis.</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.cumprod.html#mlx.core.cumprod" title="mlx.core.cumprod"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cumprod</span></code></a>(a, /[, axis, reverse, inclusive, stream])</p></td>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.cumprod.html#mlx.core.cumprod" title="mlx.core.cumprod"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cumprod</span></code></a>(a, /[, axis, reverse, inclusive, stream])</p></td>
|
||||
<td><p>Return the cumulative product of the elements along the given axis.</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.cumsum.html#mlx.core.cumsum" title="mlx.core.cumsum"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cumsum</span></code></a>(a, /[, axis, reverse, inclusive, stream])</p></td>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.cumsum.html#mlx.core.cumsum" title="mlx.core.cumsum"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cumsum</span></code></a>(a, /[, axis, reverse, inclusive, stream])</p></td>
|
||||
<td><p>Return the cumulative sum of the elements along the given axis.</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.degrees.html#mlx.core.degrees" title="mlx.core.degrees"><code class="xref py py-obj docutils literal notranslate"><span class="pre">degrees</span></code></a>(a, /, *[, stream])</p></td>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.degrees.html#mlx.core.degrees" title="mlx.core.degrees"><code class="xref py py-obj docutils literal notranslate"><span class="pre">degrees</span></code></a>(a, /, *[, stream])</p></td>
|
||||
<td><p>Convert angles from radians to degrees.</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.dequantize.html#mlx.core.dequantize" title="mlx.core.dequantize"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dequantize</span></code></a>(w, /, scales, biases[, ...])</p></td>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.dequantize.html#mlx.core.dequantize" title="mlx.core.dequantize"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dequantize</span></code></a>(w, /, scales, biases[, ...])</p></td>
|
||||
<td><p>Dequantize the matrix <code class="docutils literal notranslate"><span class="pre">w</span></code> using the provided <code class="docutils literal notranslate"><span class="pre">scales</span></code> and <code class="docutils literal notranslate"><span class="pre">biases</span></code> and the <code class="docutils literal notranslate"><span class="pre">group_size</span></code> and <code class="docutils literal notranslate"><span class="pre">bits</span></code> configuration.</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.diag.html#mlx.core.diag" title="mlx.core.diag"><code class="xref py py-obj docutils literal notranslate"><span class="pre">diag</span></code></a>(a, /[, k, stream])</p></td>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.diag.html#mlx.core.diag" title="mlx.core.diag"><code class="xref py py-obj docutils literal notranslate"><span class="pre">diag</span></code></a>(a, /[, k, stream])</p></td>
|
||||
<td><p>Extract a diagonal or construct a diagonal matrix.</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.diagonal.html#mlx.core.diagonal" title="mlx.core.diagonal"><code class="xref py py-obj docutils literal notranslate"><span class="pre">diagonal</span></code></a>(a[, offset, axis1, axis2, stream])</p></td>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.diagonal.html#mlx.core.diagonal" title="mlx.core.diagonal"><code class="xref py py-obj docutils literal notranslate"><span class="pre">diagonal</span></code></a>(a[, offset, axis1, axis2, stream])</p></td>
|
||||
<td><p>Return specified diagonals.</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.divide.html#mlx.core.divide" title="mlx.core.divide"><code class="xref py py-obj docutils literal notranslate"><span class="pre">divide</span></code></a>(a, b[, stream])</p></td>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.divide.html#mlx.core.divide" title="mlx.core.divide"><code class="xref py py-obj docutils literal notranslate"><span class="pre">divide</span></code></a>(a, b[, stream])</p></td>
|
||||
<td><p>Element-wise division.</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.divmod.html#mlx.core.divmod" title="mlx.core.divmod"><code class="xref py py-obj docutils literal notranslate"><span class="pre">divmod</span></code></a>(a, b[, stream])</p></td>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.divmod.html#mlx.core.divmod" title="mlx.core.divmod"><code class="xref py py-obj docutils literal notranslate"><span class="pre">divmod</span></code></a>(a, b[, stream])</p></td>
|
||||
<td><p>Element-wise quotient and remainder.</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.einsum.html#mlx.core.einsum" title="mlx.core.einsum"><code class="xref py py-obj docutils literal notranslate"><span class="pre">einsum</span></code></a>(subscripts, *operands, *, stream, ...)</p></td>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.einsum.html#mlx.core.einsum" title="mlx.core.einsum"><code class="xref py py-obj docutils literal notranslate"><span class="pre">einsum</span></code></a>(subscripts, *operands[, stream])</p></td>
|
||||
<td><p>Perform the Einstein summation convention on the operands.</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.einsum_path.html#mlx.core.einsum_path" title="mlx.core.einsum_path"><code class="xref py py-obj docutils literal notranslate"><span class="pre">einsum_path</span></code></a>(subscripts, *operands)</p></td>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.einsum_path.html#mlx.core.einsum_path" title="mlx.core.einsum_path"><code class="xref py py-obj docutils literal notranslate"><span class="pre">einsum_path</span></code></a>(subscripts, *operands)</p></td>
|
||||
<td><p>Compute the contraction order for the given Einstein summation.</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.equal.html#mlx.core.equal" title="mlx.core.equal"><code class="xref py py-obj docutils literal notranslate"><span class="pre">equal</span></code></a>(a, b[, stream])</p></td>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.equal.html#mlx.core.equal" title="mlx.core.equal"><code class="xref py py-obj docutils literal notranslate"><span class="pre">equal</span></code></a>(a, b[, stream])</p></td>
|
||||
<td><p>Element-wise equality.</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.erf.html#mlx.core.erf" title="mlx.core.erf"><code class="xref py py-obj docutils literal notranslate"><span class="pre">erf</span></code></a>(a, /, *[, stream])</p></td>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.erf.html#mlx.core.erf" title="mlx.core.erf"><code class="xref py py-obj docutils literal notranslate"><span class="pre">erf</span></code></a>(a, /, *[, stream])</p></td>
|
||||
<td><p>Element-wise error function.</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.erfinv.html#mlx.core.erfinv" title="mlx.core.erfinv"><code class="xref py py-obj docutils literal notranslate"><span class="pre">erfinv</span></code></a>(a, /, *[, stream])</p></td>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.erfinv.html#mlx.core.erfinv" title="mlx.core.erfinv"><code class="xref py py-obj docutils literal notranslate"><span class="pre">erfinv</span></code></a>(a, /, *[, stream])</p></td>
|
||||
<td><p>Element-wise inverse of <a class="reference internal" href="_autosummary/mlx.core.erf.html#mlx.core.erf" title="mlx.core.erf"><code class="xref py py-func docutils literal notranslate"><span class="pre">erf()</span></code></a>.</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.exp.html#mlx.core.exp" title="mlx.core.exp"><code class="xref py py-obj docutils literal notranslate"><span class="pre">exp</span></code></a>(a, /, *[, stream])</p></td>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.exp.html#mlx.core.exp" title="mlx.core.exp"><code class="xref py py-obj docutils literal notranslate"><span class="pre">exp</span></code></a>(a, /, *[, stream])</p></td>
|
||||
<td><p>Element-wise exponential.</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.expm1.html#mlx.core.expm1" title="mlx.core.expm1"><code class="xref py py-obj docutils literal notranslate"><span class="pre">expm1</span></code></a>(a, /, *[, stream])</p></td>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.expm1.html#mlx.core.expm1" title="mlx.core.expm1"><code class="xref py py-obj docutils literal notranslate"><span class="pre">expm1</span></code></a>(a, /, *[, stream])</p></td>
|
||||
<td><p>Element-wise exponential minus 1.</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.expand_dims.html#mlx.core.expand_dims" title="mlx.core.expand_dims"><code class="xref py py-obj docutils literal notranslate"><span class="pre">expand_dims</span></code></a>(a, /, axis, *[, stream])</p></td>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.expand_dims.html#mlx.core.expand_dims" title="mlx.core.expand_dims"><code class="xref py py-obj docutils literal notranslate"><span class="pre">expand_dims</span></code></a>(a, /, axis, *[, stream])</p></td>
|
||||
<td><p>Add a size one dimension at the given axis.</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.eye.html#mlx.core.eye" title="mlx.core.eye"><code class="xref py py-obj docutils literal notranslate"><span class="pre">eye</span></code></a>(n[, m, k, dtype, stream])</p></td>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.eye.html#mlx.core.eye" title="mlx.core.eye"><code class="xref py py-obj docutils literal notranslate"><span class="pre">eye</span></code></a>(n[, m, k, dtype, stream])</p></td>
|
||||
<td><p>Create an identity matrix or a general diagonal matrix.</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.flatten.html#mlx.core.flatten" title="mlx.core.flatten"><code class="xref py py-obj docutils literal notranslate"><span class="pre">flatten</span></code></a>(a, /[, start_axis, end_axis, stream])</p></td>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.flatten.html#mlx.core.flatten" title="mlx.core.flatten"><code class="xref py py-obj docutils literal notranslate"><span class="pre">flatten</span></code></a>(a, /[, start_axis, end_axis, stream])</p></td>
|
||||
<td><p>Flatten an array.</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.floor.html#mlx.core.floor" title="mlx.core.floor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">floor</span></code></a>(a, /, *[, stream])</p></td>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.floor.html#mlx.core.floor" title="mlx.core.floor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">floor</span></code></a>(a, /, *[, stream])</p></td>
|
||||
<td><p>Element-wise floor.</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.floor_divide.html#mlx.core.floor_divide" title="mlx.core.floor_divide"><code class="xref py py-obj docutils literal notranslate"><span class="pre">floor_divide</span></code></a>(a, b[, stream])</p></td>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.floor_divide.html#mlx.core.floor_divide" title="mlx.core.floor_divide"><code class="xref py py-obj docutils literal notranslate"><span class="pre">floor_divide</span></code></a>(a, b[, stream])</p></td>
|
||||
<td><p>Element-wise integer division.</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.full.html#mlx.core.full" title="mlx.core.full"><code class="xref py py-obj docutils literal notranslate"><span class="pre">full</span></code></a>(shape, vals[, dtype, stream])</p></td>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.full.html#mlx.core.full" title="mlx.core.full"><code class="xref py py-obj docutils literal notranslate"><span class="pre">full</span></code></a>(shape, vals[, dtype, stream])</p></td>
|
||||
<td><p>Construct an array with the given value.</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.gather_mm.html#mlx.core.gather_mm" title="mlx.core.gather_mm"><code class="xref py py-obj docutils literal notranslate"><span class="pre">gather_mm</span></code></a>(a, b, /, lhs_indices, rhs_indices, *)</p></td>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.gather_mm.html#mlx.core.gather_mm" title="mlx.core.gather_mm"><code class="xref py py-obj docutils literal notranslate"><span class="pre">gather_mm</span></code></a>(a, b, /, lhs_indices, rhs_indices, *)</p></td>
|
||||
<td><p>Matrix multiplication with matrix-level gather.</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.gather_qmm.html#mlx.core.gather_qmm" title="mlx.core.gather_qmm"><code class="xref py py-obj docutils literal notranslate"><span class="pre">gather_qmm</span></code></a>(x, w, /, scales, biases[, ...])</p></td>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.gather_qmm.html#mlx.core.gather_qmm" title="mlx.core.gather_qmm"><code class="xref py py-obj docutils literal notranslate"><span class="pre">gather_qmm</span></code></a>(x, w, /, scales, biases[, ...])</p></td>
|
||||
<td><p>Perform quantized matrix multiplication with matrix-level gather.</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.greater.html#mlx.core.greater" title="mlx.core.greater"><code class="xref py py-obj docutils literal notranslate"><span class="pre">greater</span></code></a>(a, b[, stream])</p></td>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.greater.html#mlx.core.greater" title="mlx.core.greater"><code class="xref py py-obj docutils literal notranslate"><span class="pre">greater</span></code></a>(a, b[, stream])</p></td>
|
||||
<td><p>Element-wise greater than.</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.greater_equal.html#mlx.core.greater_equal" title="mlx.core.greater_equal"><code class="xref py py-obj docutils literal notranslate"><span class="pre">greater_equal</span></code></a>(a, b[, stream])</p></td>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.greater_equal.html#mlx.core.greater_equal" title="mlx.core.greater_equal"><code class="xref py py-obj docutils literal notranslate"><span class="pre">greater_equal</span></code></a>(a, b[, stream])</p></td>
|
||||
<td><p>Element-wise greater or equal.</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.hadamard_transform.html#mlx.core.hadamard_transform" title="mlx.core.hadamard_transform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hadamard_transform</span></code></a>(a, ...)</p></td>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.hadamard_transform.html#mlx.core.hadamard_transform" title="mlx.core.hadamard_transform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hadamard_transform</span></code></a>(a[, scale, stream])</p></td>
|
||||
<td><p>Perform the Walsh-Hadamard transform along the final axis.</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.identity.html#mlx.core.identity" title="mlx.core.identity"><code class="xref py py-obj docutils literal notranslate"><span class="pre">identity</span></code></a>(n[, dtype, stream])</p></td>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.identity.html#mlx.core.identity" title="mlx.core.identity"><code class="xref py py-obj docutils literal notranslate"><span class="pre">identity</span></code></a>(n[, dtype, stream])</p></td>
|
||||
<td><p>Create a square identity matrix.</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.inner.html#mlx.core.inner" title="mlx.core.inner"><code class="xref py py-obj docutils literal notranslate"><span class="pre">inner</span></code></a>(a, b, /, *[, stream])</p></td>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.inner.html#mlx.core.inner" title="mlx.core.inner"><code class="xref py py-obj docutils literal notranslate"><span class="pre">inner</span></code></a>(a, b, /, *[, stream])</p></td>
|
||||
<td><p>Ordinary inner product of vectors for 1-D arrays, in higher dimensions a sum product over the last axes.</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.isfinite.html#mlx.core.isfinite" title="mlx.core.isfinite"><code class="xref py py-obj docutils literal notranslate"><span class="pre">isfinite</span></code></a>(a[, stream])</p></td>
|
||||
<td><p>Return a boolean array indicating which elements are finite.</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.isclose.html#mlx.core.isclose" title="mlx.core.isclose"><code class="xref py py-obj docutils literal notranslate"><span class="pre">isclose</span></code></a>(a, b, /[, rtol, atol, equal_nan, stream])</p></td>
|
||||
<td><p>Returns a boolean array where two arrays are element-wise equal within a tolerance.</p></td>
|
||||
</tr>
|
||||
@@ -1283,7 +1306,7 @@ document.write(`
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.topk.html#mlx.core.topk" title="mlx.core.topk"><code class="xref py py-obj docutils literal notranslate"><span class="pre">topk</span></code></a>(a, /, k[, axis, stream])</p></td>
|
||||
<td><p>Returns the <code class="docutils literal notranslate"><span class="pre">k</span></code> largest elements from the input along a given axis.</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.trace.html#mlx.core.trace" title="mlx.core.trace"><code class="xref py py-obj docutils literal notranslate"><span class="pre">trace</span></code></a>(a, /, offset, axis1, axis2[, dtype])</p></td>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/mlx.core.trace.html#mlx.core.trace" title="mlx.core.trace"><code class="xref py py-obj docutils literal notranslate"><span class="pre">trace</span></code></a>(a, /[, offset, axis1, axis2, dtype, ...])</p></td>
|
||||
<td><p>Return the sum along a specified diagonal in the given array.</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/mlx.core.transpose.html#mlx.core.transpose" title="mlx.core.transpose"><code class="xref py py-obj docutils literal notranslate"><span class="pre">transpose</span></code></a>(a, /[, axes, stream])</p></td>
|
||||
|
||||
Reference in New Issue
Block a user