docs update

This commit is contained in:
Awni Hannun
2024-03-30 17:32:20 -07:00
committed by CircleCI Docs
parent e1f3a7b14d
commit 8b5550f9f8
487 changed files with 65737 additions and 17370 deletions

View File

@@ -1,14 +1,13 @@
<!DOCTYPE html>
<html lang="en" data-content_root="" >
<html lang="en" data-content_root="./" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Index &#8212; MLX 0.7.0 documentation</title>
<title>Index &#8212; MLX 0.9.0 documentation</title>
@@ -28,20 +27,18 @@
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.woff2" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" href="_static/styles/sphinx-book-theme.css?digest=14f4ca6b54d191a8c7657f6c759bf11a5fb86285" type="text/css" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/styles/sphinx-book-theme.css?v=384b581d" />
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=5b4479735964841361fd" />
<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 data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/scripts/sphinx-book-theme.js?digest=5a5c038af52cf7bc1a1ec88eea08e6366ee68824"></script>
<script src="_static/documentation_options.js?v=2a76c96f"></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>
<script>DOCUMENTATION_OPTIONS.pagename = 'genindex';</script>
<link rel="index" title="Index" href="#" />
<link rel="search" title="Search" href="search.html" />
@@ -131,12 +128,23 @@
<img src="_static/mlx_logo.png" class="logo__image only-light" alt="MLX 0.7.0 documentation - Home"/>
<script>document.write(`<img src="_static/mlx_logo_dark.png" class="logo__image only-dark" alt="MLX 0.7.0 documentation - Home"/>`);</script>
<img src="_static/mlx_logo.png" class="logo__image only-light" alt="MLX 0.9.0 documentation - Home"/>
<script>document.write(`<img src="_static/mlx_logo_dark.png" class="logo__image only-dark" alt="MLX 0.9.0 documentation - Home"/>`);</script>
</a></div>
<div class="sidebar-primary-item"><nav class="bd-links" id="bd-docs-nav" aria-label="Main">
<div class="sidebar-primary-item">
<script>
document.write(`
<button class="btn navbar-btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
`);
</script></div>
<div class="sidebar-primary-item"><nav class="bd-links bd-docs-nav" aria-label="Main">
<div class="bd-toc-item navbar-nav active">
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Install</span></p>
<ul class="nav bd-sidenav">
@@ -165,27 +173,38 @@
<li class="toctree-l1 has-children"><a class="reference internal" href="python/array.html">Array</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.html">mlx.core.array</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.astype.html">mlx.core.array.astype</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.at.html">mlx.core.array.at</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.item.html">mlx.core.array.item</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.tolist.html">mlx.core.array.tolist</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.dtype.html">mlx.core.array.dtype</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.itemsize.html">mlx.core.array.itemsize</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.nbytes.html">mlx.core.array.nbytes</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.ndim.html">mlx.core.array.ndim</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.shape.html">mlx.core.array.shape</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.size.html">mlx.core.array.size</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.Dtype.html">mlx.core.Dtype</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.abs.html">mlx.core.array.abs</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.all.html">mlx.core.array.all</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.any.html">mlx.core.array.any</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.argmax.html">mlx.core.array.argmax</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.argmin.html">mlx.core.array.argmin</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.cos.html">mlx.core.array.cos</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.dtype.html">mlx.core.array.dtype</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.cummax.html">mlx.core.array.cummax</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.cummin.html">mlx.core.array.cummin</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.cumprod.html">mlx.core.array.cumprod</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.cumsum.html">mlx.core.array.cumsum</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.diag.html">mlx.core.array.diag</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.diagonal.html">mlx.core.array.diagonal</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.exp.html">mlx.core.array.exp</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.flatten.html">mlx.core.array.flatten</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.log.html">mlx.core.array.log</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.log10.html">mlx.core.array.log10</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.log1p.html">mlx.core.array.log1p</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.log2.html">mlx.core.array.log2</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.logsumexp.html">mlx.core.array.logsumexp</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.max.html">mlx.core.array.max</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.mean.html">mlx.core.array.mean</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.min.html">mlx.core.array.min</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.moveaxis.html">mlx.core.array.moveaxis</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.prod.html">mlx.core.array.prod</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.reciprocal.html">mlx.core.array.reciprocal</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.reshape.html">mlx.core.array.reshape</a></li>
@@ -195,13 +214,21 @@
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.split.html">mlx.core.array.split</a></li>
<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.sum.html">mlx.core.array.sum</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>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="python/devices_and_streams.html">Devices and Streams</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>
<li class="toctree-l1 has-children"><a class="reference internal" href="python/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>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.Dtype.html">mlx.core.Dtype</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.DtypeCategory.html">mlx.core.DtypeCategory</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.issubdtype.html">mlx.core.issubdtype</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="python/devices_and_streams.html">Devices and Streams</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.Device.html">mlx.core.Device</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/stream_class.html">mlx.core.Stream</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.default_device.html">mlx.core.default_device</a></li>
@@ -212,7 +239,7 @@
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.stream.html">mlx.core.stream</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="python/ops.html">Operations</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l1 has-children"><a class="reference internal" href="python/ops.html">Operations</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-4"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.abs.html">mlx.core.abs</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.add.html">mlx.core.add</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.all.html">mlx.core.all</a></li>
@@ -243,6 +270,10 @@
<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>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.cummax.html">mlx.core.cummax</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.cummin.html">mlx.core.cummin</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.cumprod.html">mlx.core.cumprod</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.cumsum.html">mlx.core.cumsum</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.dequantize.html">mlx.core.dequantize</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.diag.html">mlx.core.diag</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.diagonal.html">mlx.core.diagonal</a></li>
@@ -263,10 +294,10 @@
<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.isclose.html">mlx.core.isclose</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.isnan.html">mlx.core.isnan</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.isposinf.html">mlx.core.isposinf</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.isneginf.html">mlx.core.isneginf</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>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.isneginf.html">mlx.core.isneginf</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.isposinf.html">mlx.core.isposinf</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.less.html">mlx.core.less</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.less_equal.html">mlx.core.less_equal</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.linspace.html">mlx.core.linspace</a></li>
@@ -339,7 +370,7 @@
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.zeros_like.html">mlx.core.zeros_like</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="python/random.html">Random</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-4"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l1 has-children"><a class="reference internal" href="python/random.html">Random</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-5"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.random.bernoulli.html">mlx.core.random.bernoulli</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.random.categorical.html">mlx.core.random.categorical</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.random.gumbel.html">mlx.core.random.gumbel</a></li>
@@ -352,7 +383,7 @@
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.random.uniform.html">mlx.core.random.uniform</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="python/transforms.html">Transforms</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-5"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l1 has-children"><a class="reference internal" href="python/transforms.html">Transforms</a><input 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="python/_autosummary/mlx.core.eval.html">mlx.core.eval</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.compile.html">mlx.core.compile</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.disable_compile.html">mlx.core.disable_compile</a></li>
@@ -364,7 +395,14 @@
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.vmap.html">mlx.core.vmap</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="python/fft.html">FFT</a><input 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-l1 has-children"><a class="reference internal" href="python/fast.html">Fast</a><input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-7"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.fast.rms_norm.html">mlx.core.fast.rms_norm</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.fast.layer_norm.html">mlx.core.fast.layer_norm</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.fast.rope.html">mlx.core.fast.rope</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.fast.scaled_dot_product_attention.html">mlx.core.fast.scaled_dot_product_attention</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="python/fft.html">FFT</a><input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-8"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.fft.fft.html">mlx.core.fft.fft</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.fft.ifft.html">mlx.core.fft.ifft</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.fft.fft2.html">mlx.core.fft.fft2</a></li>
@@ -379,12 +417,12 @@
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.fft.irfftn.html">mlx.core.fft.irfftn</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="python/linalg.html">Linear Algebra</a><input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-7"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l1 has-children"><a class="reference internal" href="python/linalg.html">Linear Algebra</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-9"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.linalg.norm.html">mlx.core.linalg.norm</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.linalg.qr.html">mlx.core.linalg.qr</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="python/metal.html">Metal</a><input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-8"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l1 has-children"><a class="reference internal" href="python/metal.html">Metal</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-10"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.metal.is_available.html">mlx.core.metal.is_available</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.metal.get_active_memory.html">mlx.core.metal.get_active_memory</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.metal.get_peak_memory.html">mlx.core.metal.get_peak_memory</a></li>
@@ -393,9 +431,9 @@
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.metal.set_cache_limit.html">mlx.core.metal.set_cache_limit</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="python/nn.html">Neural Networks</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-9"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l1 has-children"><a class="reference internal" href="python/nn.html">Neural Networks</a><input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-11"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.nn.value_and_grad.html">mlx.nn.value_and_grad</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="python/nn/module.html">Module</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-10"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2 has-children"><a class="reference internal" href="python/nn/module.html">Module</a><input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-12"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.Module.training.html">mlx.nn.Module.training</a></li>
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.Module.state.html">mlx.nn.Module.state</a></li>
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.Module.apply.html">mlx.nn.Module.apply</a></li>
@@ -410,6 +448,7 @@
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.Module.named_modules.html">mlx.nn.Module.named_modules</a></li>
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.Module.parameters.html">mlx.nn.Module.parameters</a></li>
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.Module.save_weights.html">mlx.nn.Module.save_weights</a></li>
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.Module.set_dtype.html">mlx.nn.Module.set_dtype</a></li>
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.Module.train.html">mlx.nn.Module.train</a></li>
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.Module.trainable_parameters.html">mlx.nn.Module.trainable_parameters</a></li>
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.Module.unfreeze.html">mlx.nn.Module.unfreeze</a></li>
@@ -417,7 +456,7 @@
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.Module.update_modules.html">mlx.nn.Module.update_modules</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="python/nn/layers.html">Layers</a><input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-11"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2 has-children"><a class="reference internal" href="python/nn/layers.html">Layers</a><input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-13"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.ALiBi.html">mlx.nn.ALiBi</a></li>
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.AvgPool1d.html">mlx.nn.AvgPool1d</a></li>
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.AvgPool2d.html">mlx.nn.AvgPool2d</a></li>
@@ -455,7 +494,7 @@
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.Upsample.html">mlx.nn.Upsample</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="python/nn/functions.html">Functions</a><input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-12"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2 has-children"><a class="reference internal" href="python/nn/functions.html">Functions</a><input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-14"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary_functions/mlx.nn.elu.html">mlx.nn.elu</a></li>
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary_functions/mlx.nn.gelu.html">mlx.nn.gelu</a></li>
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary_functions/mlx.nn.gelu_approx.html">mlx.nn.gelu_approx</a></li>
@@ -479,7 +518,7 @@
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary_functions/mlx.nn.tanh.html">mlx.nn.tanh</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="python/nn/losses.html">Loss Functions</a><input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-13"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2 has-children"><a class="reference internal" href="python/nn/losses.html">Loss Functions</a><input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-15"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary_functions/mlx.nn.losses.binary_cross_entropy.html">mlx.nn.losses.binary_cross_entropy</a></li>
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary_functions/mlx.nn.losses.cosine_similarity_loss.html">mlx.nn.losses.cosine_similarity_loss</a></li>
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary_functions/mlx.nn.losses.cross_entropy.html">mlx.nn.losses.cross_entropy</a></li>
@@ -496,7 +535,7 @@
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary_functions/mlx.nn.losses.triplet_loss.html">mlx.nn.losses.triplet_loss</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="python/nn/init.html">Initializers</a><input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-14"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2 has-children"><a class="reference internal" href="python/nn/init.html">Initializers</a><input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-16"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.init.constant.html">mlx.nn.init.constant</a></li>
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.init.normal.html">mlx.nn.init.normal</a></li>
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.init.uniform.html">mlx.nn.init.uniform</a></li>
@@ -509,15 +548,15 @@
</li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="python/optimizers.html">Optimizers</a><input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-15"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2 has-children"><a class="reference internal" href="python/optimizers/optimizer.html">Optimizer</a><input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-16"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l1 has-children"><a class="reference internal" href="python/optimizers.html">Optimizers</a><input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-17"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2 has-children"><a class="reference internal" href="python/optimizers/optimizer.html">Optimizer</a><input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-18"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="python/optimizers/_autosummary/mlx.optimizers.Optimizer.state.html">mlx.optimizers.Optimizer.state</a></li>
<li class="toctree-l3"><a class="reference internal" href="python/optimizers/_autosummary/mlx.optimizers.Optimizer.apply_gradients.html">mlx.optimizers.Optimizer.apply_gradients</a></li>
<li class="toctree-l3"><a class="reference internal" href="python/optimizers/_autosummary/mlx.optimizers.Optimizer.init.html">mlx.optimizers.Optimizer.init</a></li>
<li class="toctree-l3"><a class="reference internal" href="python/optimizers/_autosummary/mlx.optimizers.Optimizer.update.html">mlx.optimizers.Optimizer.update</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="python/optimizers/common_optimizers.html">Common Optimizers</a><input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-17"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2 has-children"><a class="reference internal" href="python/optimizers/common_optimizers.html">Common Optimizers</a><input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-19"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="python/optimizers/_autosummary/mlx.optimizers.SGD.html">mlx.optimizers.SGD</a></li>
<li class="toctree-l3"><a class="reference internal" href="python/optimizers/_autosummary/mlx.optimizers.RMSprop.html">mlx.optimizers.RMSprop</a></li>
<li class="toctree-l3"><a class="reference internal" href="python/optimizers/_autosummary/mlx.optimizers.Adagrad.html">mlx.optimizers.Adagrad</a></li>
@@ -529,7 +568,7 @@
<li class="toctree-l3"><a class="reference internal" href="python/optimizers/_autosummary/mlx.optimizers.Lion.html">mlx.optimizers.Lion</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="python/optimizers/schedulers.html">Schedulers</a><input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-18"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2 has-children"><a class="reference internal" href="python/optimizers/schedulers.html">Schedulers</a><input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-20"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="python/optimizers/_autosummary/mlx.optimizers.cosine_decay.html">mlx.optimizers.cosine_decay</a></li>
<li class="toctree-l3"><a class="reference internal" href="python/optimizers/_autosummary/mlx.optimizers.exponential_decay.html">mlx.optimizers.exponential_decay</a></li>
<li class="toctree-l3"><a class="reference internal" href="python/optimizers/_autosummary/mlx.optimizers.join_schedules.html">mlx.optimizers.join_schedules</a></li>
@@ -539,7 +578,7 @@
</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-19" name="toctree-checkbox-19" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-19"><i class="fa-solid fa-chevron-down"></i></label><ul>
<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-21" name="toctree-checkbox-21" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-21"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.utils.tree_flatten.html">mlx.utils.tree_flatten</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.utils.tree_unflatten.html">mlx.utils.tree_unflatten</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.utils.tree_map.html">mlx.utils.tree_map</a></li>
@@ -553,6 +592,7 @@
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Further Reading</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="dev/extensions.html">Developer Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="dev/metal_debugger.html">Metal Debugger</a></li>
</ul>
</div>
@@ -704,14 +744,16 @@ document.write(`
<h2 id="_">_</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="python/_autosummary/mlx.core.array.html#mlx.core.array.__init__">__init__() (mlx.core.array method)</a>
<li><a href="python/_autosummary/mlx.core.array.html#mlx.core.array.__init__">__init__() (array method)</a>
<ul>
<li><a href="python/_autosummary/mlx.core.Device.html#mlx.core.Device.__init__">(mlx.core.Device method)</a>
<li><a href="python/_autosummary/mlx.core.Device.html#mlx.core.Device.__init__">(Device method)</a>
</li>
<li><a href="python/_autosummary/mlx.core.Dtype.html#mlx.core.Dtype.__init__">(mlx.core.Dtype method)</a>
<li><a href="python/_autosummary/mlx.core.Dtype.html#mlx.core.Dtype.__init__">(Dtype method)</a>
</li>
<li><a href="python/_autosummary/stream_class.html#mlx.core.Stream.__init__">(mlx.core.Stream method)</a>
<li><a href="python/_autosummary/mlx.core.DtypeCategory.html#mlx.core.DtypeCategory.__init__">(DtypeCategory method)</a>
</li>
<li><a href="python/_autosummary/stream_class.html#mlx.core.Stream.__init__">(Stream method)</a>
</li>
</ul></li>
</ul></td>
@@ -720,10 +762,10 @@ document.write(`
<h2 id="A">A</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="python/_autosummary/mlx.core.abs.html#mlx.core.abs">abs() (in module mlx.core)</a>
<li><a href="python/_autosummary/mlx.core.array.abs.html#mlx.core.array.abs">abs() (array method)</a>
<ul>
<li><a href="python/_autosummary/mlx.core.array.abs.html#mlx.core.array.abs">(mlx.core.array method)</a>
<li><a href="python/_autosummary/mlx.core.abs.html#mlx.core.abs">(in module mlx.core)</a>
</li>
</ul></li>
<li><a href="python/optimizers/_autosummary/mlx.optimizers.AdaDelta.html#mlx.optimizers.AdaDelta">AdaDelta (class in mlx.optimizers)</a>
@@ -742,32 +784,32 @@ document.write(`
</li>
<li><a href="python/nn/_autosummary/mlx.nn.ALiBi.html#mlx.nn.ALiBi">ALiBi (class in mlx.nn)</a>
</li>
<li><a href="python/_autosummary/mlx.core.all.html#mlx.core.all">all() (in module mlx.core)</a>
<li><a href="python/_autosummary/mlx.core.array.all.html#mlx.core.array.all">all() (array method)</a>
<ul>
<li><a href="python/_autosummary/mlx.core.array.all.html#mlx.core.array.all">(mlx.core.array method)</a>
<li><a href="python/_autosummary/mlx.core.all.html#mlx.core.all">(in module mlx.core)</a>
</li>
</ul></li>
<li><a href="python/_autosummary/mlx.core.allclose.html#mlx.core.allclose">allclose() (in module mlx.core)</a>
</li>
<li><a href="python/_autosummary/mlx.core.any.html#mlx.core.any">any() (in module mlx.core)</a>
<li><a href="python/_autosummary/mlx.core.array.any.html#mlx.core.array.any">any() (array method)</a>
<ul>
<li><a href="python/_autosummary/mlx.core.array.any.html#mlx.core.array.any">(mlx.core.array method)</a>
<li><a href="python/_autosummary/mlx.core.any.html#mlx.core.any">(in module mlx.core)</a>
</li>
</ul></li>
<li><a href="python/nn/_autosummary/mlx.nn.Module.apply.html#mlx.nn.Module.apply">apply() (mlx.nn.Module method)</a>
<li><a href="python/nn/_autosummary/mlx.nn.Module.apply.html#mlx.nn.Module.apply">apply() (Module method)</a>
</li>
<li><a href="python/optimizers/_autosummary/mlx.optimizers.Optimizer.apply_gradients.html#mlx.optimizers.Optimizer.apply_gradients">apply_gradients() (mlx.optimizers.Optimizer method)</a>
<li><a href="python/optimizers/_autosummary/mlx.optimizers.Optimizer.apply_gradients.html#mlx.optimizers.Optimizer.apply_gradients">apply_gradients() (Optimizer method)</a>
</li>
<li><a href="python/nn/_autosummary/mlx.nn.Module.apply_to_modules.html#mlx.nn.Module.apply_to_modules">apply_to_modules() (mlx.nn.Module method)</a>
<li><a href="python/nn/_autosummary/mlx.nn.Module.apply_to_modules.html#mlx.nn.Module.apply_to_modules">apply_to_modules() (Module method)</a>
</li>
<li><a href="python/_autosummary/mlx.core.arange.html#mlx.core.arange">arange() (in module mlx.core)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="python/_autosummary/mlx.core.arccos.html#mlx.core.arccos">arccos() (in module mlx.core)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="python/_autosummary/mlx.core.arccosh.html#mlx.core.arccosh">arccosh() (in module mlx.core)</a>
</li>
<li><a href="python/_autosummary/mlx.core.arcsin.html#mlx.core.arcsin">arcsin() (in module mlx.core)</a>
@@ -778,16 +820,16 @@ document.write(`
</li>
<li><a href="python/_autosummary/mlx.core.arctanh.html#mlx.core.arctanh">arctanh() (in module mlx.core)</a>
</li>
<li><a href="python/_autosummary/mlx.core.argmax.html#mlx.core.argmax">argmax() (in module mlx.core)</a>
<li><a href="python/_autosummary/mlx.core.array.argmax.html#mlx.core.array.argmax">argmax() (array method)</a>
<ul>
<li><a href="python/_autosummary/mlx.core.array.argmax.html#mlx.core.array.argmax">(mlx.core.array method)</a>
<li><a href="python/_autosummary/mlx.core.argmax.html#mlx.core.argmax">(in module mlx.core)</a>
</li>
</ul></li>
<li><a href="python/_autosummary/mlx.core.argmin.html#mlx.core.argmin">argmin() (in module mlx.core)</a>
<li><a href="python/_autosummary/mlx.core.array.argmin.html#mlx.core.array.argmin">argmin() (array method)</a>
<ul>
<li><a href="python/_autosummary/mlx.core.array.argmin.html#mlx.core.array.argmin">(mlx.core.array method)</a>
<li><a href="python/_autosummary/mlx.core.argmin.html#mlx.core.argmin">(in module mlx.core)</a>
</li>
</ul></li>
<li><a href="python/_autosummary/mlx.core.argpartition.html#mlx.core.argpartition">argpartition() (in module mlx.core)</a>
@@ -798,7 +840,9 @@ document.write(`
</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="python/_autosummary/mlx.core.array.astype.html#mlx.core.array.astype">astype() (mlx.core.array method)</a>
<li><a href="python/_autosummary/mlx.core.array.astype.html#mlx.core.array.astype">astype() (array method)</a>
</li>
<li><a href="python/_autosummary/mlx.core.array.at.html#mlx.core.array.at">at (array property)</a>
</li>
<li><a href="python/_autosummary/mlx.core.atleast_1d.html#mlx.core.atleast_1d">atleast_1d() (in module mlx.core)</a>
</li>
@@ -836,7 +880,7 @@ document.write(`
</li>
<li><a href="python/_autosummary/mlx.core.ceil.html#mlx.core.ceil">ceil() (in module mlx.core)</a>
</li>
<li><a href="python/nn/_autosummary/mlx.nn.Module.children.html#mlx.nn.Module.children">children() (mlx.nn.Module method)</a>
<li><a href="python/nn/_autosummary/mlx.nn.Module.children.html#mlx.nn.Module.children">children() (Module method)</a>
</li>
<li><a href="python/_autosummary/mlx.core.clip.html#mlx.core.clip">clip() (in module mlx.core)</a>
</li>
@@ -850,8 +894,6 @@ document.write(`
</li>
<li><a href="python/_autosummary/mlx.core.conv1d.html#mlx.core.conv1d">conv1d() (in module mlx.core)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="python/nn/_autosummary/mlx.nn.Conv2d.html#mlx.nn.Conv2d">Conv2d (class in mlx.nn)</a>
</li>
<li><a href="python/_autosummary/mlx.core.conv2d.html#mlx.core.conv2d">conv2d() (in module mlx.core)</a>
@@ -860,10 +902,12 @@ document.write(`
</li>
<li><a href="python/_autosummary/mlx.core.convolve.html#mlx.core.convolve">convolve() (in module mlx.core)</a>
</li>
<li><a href="python/_autosummary/mlx.core.cos.html#mlx.core.cos">cos() (in module mlx.core)</a>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="python/_autosummary/mlx.core.array.cos.html#mlx.core.array.cos">cos() (array method)</a>
<ul>
<li><a href="python/_autosummary/mlx.core.array.cos.html#mlx.core.array.cos">(mlx.core.array method)</a>
<li><a href="python/_autosummary/mlx.core.cos.html#mlx.core.cos">(in module mlx.core)</a>
</li>
</ul></li>
<li><a href="python/_autosummary/mlx.core.cosh.html#mlx.core.cosh">cosh() (in module mlx.core)</a>
@@ -874,6 +918,30 @@ document.write(`
</li>
<li><a href="python/nn/_autosummary_functions/mlx.nn.losses.cross_entropy.html#mlx.nn.losses.cross_entropy">cross_entropy() (in module mlx.nn.losses)</a>
</li>
<li><a href="python/_autosummary/mlx.core.array.cummax.html#mlx.core.array.cummax">cummax() (array method)</a>
<ul>
<li><a href="python/_autosummary/mlx.core.cummax.html#mlx.core.cummax">(in module mlx.core)</a>
</li>
</ul></li>
<li><a href="python/_autosummary/mlx.core.array.cummin.html#mlx.core.array.cummin">cummin() (array method)</a>
<ul>
<li><a href="python/_autosummary/mlx.core.cummin.html#mlx.core.cummin">(in module mlx.core)</a>
</li>
</ul></li>
<li><a href="python/_autosummary/mlx.core.array.cumprod.html#mlx.core.array.cumprod">cumprod() (array method)</a>
<ul>
<li><a href="python/_autosummary/mlx.core.cumprod.html#mlx.core.cumprod">(in module mlx.core)</a>
</li>
</ul></li>
<li><a href="python/_autosummary/mlx.core.array.cumsum.html#mlx.core.array.cumsum">cumsum() (array method)</a>
<ul>
<li><a href="python/_autosummary/mlx.core.cumsum.html#mlx.core.cumsum">(in module mlx.core)</a>
</li>
</ul></li>
</ul></td>
</tr></table>
@@ -888,14 +956,22 @@ document.write(`
</li>
<li><a href="python/_autosummary/mlx.core.Device.html#mlx.core.Device">Device (class in mlx.core)</a>
</li>
<li><a href="python/_autosummary/mlx.core.diag.html#mlx.core.diag">diag() (in module mlx.core)</a>
<li><a href="python/_autosummary/mlx.core.array.diag.html#mlx.core.array.diag">diag() (array method)</a>
<ul>
<li><a href="python/_autosummary/mlx.core.diag.html#mlx.core.diag">(in module mlx.core)</a>
</li>
<li><a href="python/_autosummary/mlx.core.diagonal.html#mlx.core.diagonal">diagonal() (in module mlx.core)</a>
</li>
<li><a href="python/_autosummary/mlx.core.disable_compile.html#mlx.core.disable_compile">disable_compile() (in module mlx.core)</a>
</ul></li>
<li><a href="python/_autosummary/mlx.core.array.diagonal.html#mlx.core.array.diagonal">diagonal() (array method)</a>
<ul>
<li><a href="python/_autosummary/mlx.core.diagonal.html#mlx.core.diagonal">(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.disable_compile.html#mlx.core.disable_compile">disable_compile() (in module mlx.core)</a>
</li>
<li><a href="python/_autosummary/mlx.core.divide.html#mlx.core.divide">divide() (in module mlx.core)</a>
</li>
<li><a href="python/_autosummary/mlx.core.divmod.html#mlx.core.divmod">divmod() (in module mlx.core)</a>
@@ -905,10 +981,12 @@ document.write(`
<li><a href="python/nn/_autosummary/mlx.nn.Dropout2d.html#mlx.nn.Dropout2d">Dropout2d (class in mlx.nn)</a>
</li>
<li><a href="python/nn/_autosummary/mlx.nn.Dropout3d.html#mlx.nn.Dropout3d">Dropout3d (class in mlx.nn)</a>
</li>
<li><a href="python/_autosummary/mlx.core.array.dtype.html#mlx.core.array.dtype">dtype (array property)</a>
</li>
<li><a href="python/_autosummary/mlx.core.Dtype.html#mlx.core.Dtype">Dtype (class in mlx.core)</a>
</li>
<li><a href="python/_autosummary/mlx.core.array.dtype.html#mlx.core.array.dtype">dtype (mlx.core.array property)</a>
<li><a href="python/_autosummary/mlx.core.DtypeCategory.html#mlx.core.DtypeCategory">DtypeCategory (class in mlx.core)</a>
</li>
</ul></td>
</tr></table>
@@ -933,13 +1011,13 @@ document.write(`
<li><a href="python/_autosummary/mlx.core.eval.html#mlx.core.eval">eval() (in module mlx.core)</a>
<ul>
<li><a href="python/nn/_autosummary/mlx.nn.Module.eval.html#mlx.nn.Module.eval">(mlx.nn.Module method)</a>
<li><a href="python/nn/_autosummary/mlx.nn.Module.eval.html#mlx.nn.Module.eval">(Module method)</a>
</li>
</ul></li>
<li><a href="python/_autosummary/mlx.core.exp.html#mlx.core.exp">exp() (in module mlx.core)</a>
<li><a href="python/_autosummary/mlx.core.array.exp.html#mlx.core.array.exp">exp() (array method)</a>
<ul>
<li><a href="python/_autosummary/mlx.core.array.exp.html#mlx.core.array.exp">(mlx.core.array method)</a>
<li><a href="python/_autosummary/mlx.core.exp.html#mlx.core.exp">(in module mlx.core)</a>
</li>
</ul></li>
<li><a href="python/_autosummary/mlx.core.expand_dims.html#mlx.core.expand_dims">expand_dims() (in module mlx.core)</a>
@@ -960,17 +1038,21 @@ document.write(`
</li>
<li><a href="python/_autosummary/mlx.core.fft.fftn.html#mlx.core.fft.fftn">fftn() (in module mlx.core.fft)</a>
</li>
<li><a href="python/nn/_autosummary/mlx.nn.Module.filter_and_map.html#mlx.nn.Module.filter_and_map">filter_and_map() (mlx.nn.Module method)</a>
<li><a href="python/nn/_autosummary/mlx.nn.Module.filter_and_map.html#mlx.nn.Module.filter_and_map">filter_and_map() (Module method)</a>
</li>
<li><a href="python/_autosummary/mlx.core.array.flatten.html#mlx.core.array.flatten">flatten() (array method)</a>
<ul>
<li><a href="python/_autosummary/mlx.core.flatten.html#mlx.core.flatten">(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.flatten.html#mlx.core.flatten">flatten() (in module mlx.core)</a>
</li>
<li><a href="python/_autosummary/mlx.core.floor.html#mlx.core.floor">floor() (in module mlx.core)</a>
</li>
<li><a href="python/_autosummary/mlx.core.floor_divide.html#mlx.core.floor_divide">floor_divide() (in module mlx.core)</a>
</li>
<li><a href="python/nn/_autosummary/mlx.nn.Module.freeze.html#mlx.nn.Module.freeze">freeze() (mlx.nn.Module method)</a>
<li><a href="python/nn/_autosummary/mlx.nn.Module.freeze.html#mlx.nn.Module.freeze">freeze() (Module method)</a>
</li>
<li><a href="python/_autosummary/mlx.core.full.html#mlx.core.full">full() (in module mlx.core)</a>
</li>
@@ -1052,7 +1134,7 @@ document.write(`
</li>
<li><a href="python/_autosummary/mlx.core.fft.ifftn.html#mlx.core.fft.ifftn">ifftn() (in module mlx.core.fft)</a>
</li>
<li><a href="python/optimizers/_autosummary/mlx.optimizers.Optimizer.init.html#mlx.optimizers.Optimizer.init">init() (mlx.optimizers.Optimizer method)</a>
<li><a href="python/optimizers/_autosummary/mlx.optimizers.Optimizer.init.html#mlx.optimizers.Optimizer.init">init() (Optimizer method)</a>
</li>
<li><a href="python/_autosummary/mlx.core.inner.html#mlx.core.inner">inner() (in module mlx.core)</a>
</li>
@@ -1060,10 +1142,10 @@ document.write(`
</li>
<li><a href="python/_autosummary/mlx.core.fft.irfft.html#mlx.core.fft.irfft">irfft() (in module mlx.core.fft)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="python/_autosummary/mlx.core.fft.irfft2.html#mlx.core.fft.irfft2">irfft2() (in module mlx.core.fft)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="python/_autosummary/mlx.core.fft.irfftn.html#mlx.core.fft.irfftn">irfftn() (in module mlx.core.fft)</a>
</li>
<li><a href="python/_autosummary/mlx.core.metal.is_available.html#mlx.core.metal.is_available">is_available() (in module mlx.core.metal)</a>
@@ -1078,7 +1160,11 @@ document.write(`
</li>
<li><a href="python/_autosummary/mlx.core.isposinf.html#mlx.core.isposinf">isposinf() (in module mlx.core)</a>
</li>
<li><a href="python/_autosummary/mlx.core.array.item.html#mlx.core.array.item">item() (mlx.core.array method)</a>
<li><a href="python/_autosummary/mlx.core.issubdtype.html#mlx.core.issubdtype">issubdtype() (in module mlx.core)</a>
</li>
<li><a href="python/_autosummary/mlx.core.array.item.html#mlx.core.array.item">item() (array method)</a>
</li>
<li><a href="python/_autosummary/mlx.core.array.itemsize.html#mlx.core.array.itemsize">itemsize (array property)</a>
</li>
</ul></td>
</tr></table>
@@ -1111,10 +1197,12 @@ document.write(`
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="python/nn/_autosummary_functions/mlx.nn.losses.l1_loss.html#mlx.nn.losses.l1_loss">l1_loss() (in module mlx.nn.losses)</a>
</li>
<li><a href="python/_autosummary/mlx.core.fast.layer_norm.html#mlx.core.fast.layer_norm">layer_norm() (in module mlx.core.fast)</a>
</li>
<li><a href="python/nn/_autosummary/mlx.nn.LayerNorm.html#mlx.nn.LayerNorm">LayerNorm (class in mlx.nn)</a>
</li>
<li><a href="python/nn/_autosummary/mlx.nn.Module.leaf_modules.html#mlx.nn.Module.leaf_modules">leaf_modules() (mlx.nn.Module method)</a>
<li><a href="python/nn/_autosummary/mlx.nn.Module.leaf_modules.html#mlx.nn.Module.leaf_modules">leaf_modules() (Module method)</a>
</li>
<li><a href="python/nn/_autosummary_functions/mlx.nn.leaky_relu.html#mlx.nn.leaky_relu">leaky_relu() (in module mlx.nn)</a>
</li>
@@ -1132,26 +1220,34 @@ document.write(`
</li>
<li><a href="python/_autosummary/mlx.core.load.html#mlx.core.load">load() (in module mlx.core)</a>
</li>
<li><a href="python/nn/_autosummary/mlx.nn.Module.load_weights.html#mlx.nn.Module.load_weights">load_weights() (mlx.nn.Module method)</a>
<li><a href="python/nn/_autosummary/mlx.nn.Module.load_weights.html#mlx.nn.Module.load_weights">load_weights() (Module method)</a>
</li>
<li><a href="python/_autosummary/mlx.core.log.html#mlx.core.log">log() (in module mlx.core)</a>
<li><a href="python/_autosummary/mlx.core.array.log.html#mlx.core.array.log">log() (array method)</a>
<ul>
<li><a href="python/_autosummary/mlx.core.array.log.html#mlx.core.array.log">(mlx.core.array method)</a>
<li><a href="python/_autosummary/mlx.core.log.html#mlx.core.log">(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.log10.html#mlx.core.log10">log10() (in module mlx.core)</a>
</li>
<li><a href="python/_autosummary/mlx.core.log1p.html#mlx.core.log1p">log1p() (in module mlx.core)</a>
<li><a href="python/_autosummary/mlx.core.array.log10.html#mlx.core.array.log10">log10() (array method)</a>
<ul>
<li><a href="python/_autosummary/mlx.core.array.log1p.html#mlx.core.array.log1p">(mlx.core.array method)</a>
<li><a href="python/_autosummary/mlx.core.log10.html#mlx.core.log10">(in module mlx.core)</a>
</li>
</ul></li>
<li><a href="python/_autosummary/mlx.core.log2.html#mlx.core.log2">log2() (in module mlx.core)</a>
<li><a href="python/_autosummary/mlx.core.array.log1p.html#mlx.core.array.log1p">log1p() (array method)</a>
<ul>
<li><a href="python/_autosummary/mlx.core.log1p.html#mlx.core.log1p">(in module mlx.core)</a>
</li>
</ul></li>
<li><a href="python/_autosummary/mlx.core.array.log2.html#mlx.core.array.log2">log2() (array method)</a>
<ul>
<li><a href="python/_autosummary/mlx.core.log2.html#mlx.core.log2">(in module mlx.core)</a>
</li>
</ul></li>
<li><a href="python/nn/_autosummary_functions/mlx.nn.losses.log_cosh_loss.html#mlx.nn.losses.log_cosh_loss">log_cosh_loss() (in module mlx.nn.losses)</a>
</li>
<li><a href="python/nn/_autosummary_functions/mlx.nn.log_sigmoid.html#mlx.nn.log_sigmoid">log_sigmoid() (in module mlx.nn)</a>
@@ -1166,10 +1262,10 @@ document.write(`
</li>
<li><a href="python/_autosummary/mlx.core.logical_or.html#mlx.core.logical_or">logical_or() (in module mlx.core)</a>
</li>
<li><a href="python/_autosummary/mlx.core.logsumexp.html#mlx.core.logsumexp">logsumexp() (in module mlx.core)</a>
<li><a href="python/_autosummary/mlx.core.array.logsumexp.html#mlx.core.array.logsumexp">logsumexp() (array method)</a>
<ul>
<li><a href="python/_autosummary/mlx.core.array.logsumexp.html#mlx.core.array.logsumexp">(mlx.core.array method)</a>
<li><a href="python/_autosummary/mlx.core.logsumexp.html#mlx.core.logsumexp">(in module mlx.core)</a>
</li>
</ul></li>
<li><a href="python/nn/_autosummary/mlx.nn.LSTM.html#mlx.nn.LSTM">LSTM (class in mlx.nn)</a>
@@ -1184,10 +1280,10 @@ document.write(`
</li>
<li><a href="python/_autosummary/mlx.core.matmul.html#mlx.core.matmul">matmul() (in module mlx.core)</a>
</li>
<li><a href="python/_autosummary/mlx.core.max.html#mlx.core.max">max() (in module mlx.core)</a>
<li><a href="python/_autosummary/mlx.core.array.max.html#mlx.core.array.max">max() (array method)</a>
<ul>
<li><a href="python/_autosummary/mlx.core.array.max.html#mlx.core.array.max">(mlx.core.array method)</a>
<li><a href="python/_autosummary/mlx.core.max.html#mlx.core.max">(in module mlx.core)</a>
</li>
</ul></li>
<li><a href="python/_autosummary/mlx.core.maximum.html#mlx.core.maximum">maximum() (in module mlx.core)</a>
@@ -1196,16 +1292,16 @@ document.write(`
</li>
<li><a href="python/nn/_autosummary/mlx.nn.MaxPool2d.html#mlx.nn.MaxPool2d">MaxPool2d (class in mlx.nn)</a>
</li>
<li><a href="python/_autosummary/mlx.core.mean.html#mlx.core.mean">mean() (in module mlx.core)</a>
<li><a href="python/_autosummary/mlx.core.array.mean.html#mlx.core.array.mean">mean() (array method)</a>
<ul>
<li><a href="python/_autosummary/mlx.core.array.mean.html#mlx.core.array.mean">(mlx.core.array method)</a>
<li><a href="python/_autosummary/mlx.core.mean.html#mlx.core.mean">(in module mlx.core)</a>
</li>
</ul></li>
<li><a href="python/_autosummary/mlx.core.min.html#mlx.core.min">min() (in module mlx.core)</a>
<li><a href="python/_autosummary/mlx.core.array.min.html#mlx.core.array.min">min() (array method)</a>
<ul>
<li><a href="python/_autosummary/mlx.core.array.min.html#mlx.core.array.min">(mlx.core.array method)</a>
<li><a href="python/_autosummary/mlx.core.min.html#mlx.core.min">(in module mlx.core)</a>
</li>
</ul></li>
</ul></td>
@@ -1218,10 +1314,14 @@ document.write(`
</li>
<li><a href="python/nn/module.html#mlx.nn.Module">Module (class in mlx.nn)</a>
</li>
<li><a href="python/nn/_autosummary/mlx.nn.Module.modules.html#mlx.nn.Module.modules">modules() (mlx.nn.Module method)</a>
<li><a href="python/nn/_autosummary/mlx.nn.Module.modules.html#mlx.nn.Module.modules">modules() (Module method)</a>
</li>
<li><a href="python/_autosummary/mlx.core.moveaxis.html#mlx.core.moveaxis">moveaxis() (in module mlx.core)</a>
<li><a href="python/_autosummary/mlx.core.array.moveaxis.html#mlx.core.array.moveaxis">moveaxis() (array method)</a>
<ul>
<li><a href="python/_autosummary/mlx.core.moveaxis.html#mlx.core.moveaxis">(in module mlx.core)</a>
</li>
</ul></li>
<li><a href="python/nn/_autosummary_functions/mlx.nn.losses.mse_loss.html#mlx.nn.losses.mse_loss">mse_loss() (in module mlx.nn.losses)</a>
</li>
<li><a href="python/nn/_autosummary/mlx.nn.MultiHeadAttention.html#mlx.nn.MultiHeadAttention">MultiHeadAttention (class in mlx.nn)</a>
@@ -1234,16 +1334,18 @@ document.write(`
<h2 id="N">N</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<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() (mlx.nn.Module method)</a>
<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="python/_autosummary/mlx.core.array.ndim.html#mlx.core.array.ndim">ndim (mlx.core.array property)</a>
<li><a href="python/_autosummary/mlx.core.array.nbytes.html#mlx.core.array.nbytes">nbytes (array property)</a>
</li>
<li><a href="python/_autosummary/mlx.core.array.ndim.html#mlx.core.array.ndim">ndim (array property)</a>
</li>
<li><a href="python/_autosummary/mlx.core.negative.html#mlx.core.negative">negative() (in module mlx.core)</a>
</li>
<li><a href="python/_autosummary/mlx.core.new_stream.html#mlx.core.new_stream">new_stream() (in module mlx.core)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="python/_autosummary/mlx.core.new_stream.html#mlx.core.new_stream">new_stream() (in module mlx.core)</a>
</li>
<li><a href="python/nn/_autosummary_functions/mlx.nn.losses.nll_loss.html#mlx.nn.losses.nll_loss">nll_loss() (in module mlx.nn.losses)</a>
</li>
<li><a href="python/_autosummary/mlx.core.linalg.norm.html#mlx.core.linalg.norm">norm() (in module mlx.core.linalg)</a>
@@ -1278,7 +1380,7 @@ document.write(`
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="python/_autosummary/mlx.core.pad.html#mlx.core.pad">pad() (in module mlx.core)</a>
</li>
<li><a href="python/nn/_autosummary/mlx.nn.Module.parameters.html#mlx.nn.Module.parameters">parameters() (mlx.nn.Module method)</a>
<li><a href="python/nn/_autosummary/mlx.nn.Module.parameters.html#mlx.nn.Module.parameters">parameters() (Module method)</a>
</li>
<li><a href="python/_autosummary/mlx.core.partition.html#mlx.core.partition">partition() (in module mlx.core)</a>
</li>
@@ -1288,10 +1390,10 @@ document.write(`
</li>
<li><a href="python/nn/_autosummary_functions/mlx.nn.prelu.html#mlx.nn.prelu">prelu() (in module mlx.nn)</a>
</li>
<li><a href="python/_autosummary/mlx.core.prod.html#mlx.core.prod">prod() (in module mlx.core)</a>
<li><a href="python/_autosummary/mlx.core.array.prod.html#mlx.core.array.prod">prod() (array method)</a>
<ul>
<li><a href="python/_autosummary/mlx.core.array.prod.html#mlx.core.array.prod">(mlx.core.array method)</a>
<li><a href="python/_autosummary/mlx.core.prod.html#mlx.core.prod">(in module mlx.core)</a>
</li>
</ul></li>
</ul></td>
@@ -1318,10 +1420,10 @@ document.write(`
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="python/_autosummary/mlx.core.random.randint.html#mlx.core.random.randint">randint() (in module mlx.core.random)</a>
</li>
<li><a href="python/_autosummary/mlx.core.reciprocal.html#mlx.core.reciprocal">reciprocal() (in module mlx.core)</a>
<li><a href="python/_autosummary/mlx.core.array.reciprocal.html#mlx.core.array.reciprocal">reciprocal() (array method)</a>
<ul>
<li><a href="python/_autosummary/mlx.core.array.reciprocal.html#mlx.core.array.reciprocal">(mlx.core.array method)</a>
<li><a href="python/_autosummary/mlx.core.reciprocal.html#mlx.core.reciprocal">(in module mlx.core)</a>
</li>
</ul></li>
<li><a href="python/nn/_autosummary/mlx.nn.ReLU.html#mlx.nn.ReLU">ReLU (class in mlx.nn)</a>
@@ -1332,19 +1434,21 @@ document.write(`
</li>
<li><a href="python/_autosummary/mlx.core.repeat.html#mlx.core.repeat">repeat() (in module mlx.core)</a>
</li>
<li><a href="python/_autosummary/mlx.core.reshape.html#mlx.core.reshape">reshape() (in module mlx.core)</a>
<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.array.reshape.html#mlx.core.array.reshape">(mlx.core.array method)</a>
<li><a href="python/_autosummary/mlx.core.reshape.html#mlx.core.reshape">(in module mlx.core)</a>
</li>
</ul></li>
<li><a href="python/_autosummary/mlx.core.fft.rfft.html#mlx.core.fft.rfft">rfft() (in module mlx.core.fft)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="python/_autosummary/mlx.core.fft.rfft2.html#mlx.core.fft.rfft2">rfft2() (in module mlx.core.fft)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="python/_autosummary/mlx.core.fft.rfftn.html#mlx.core.fft.rfftn">rfftn() (in module mlx.core.fft)</a>
</li>
<li><a href="python/_autosummary/mlx.core.fast.rms_norm.html#mlx.core.fast.rms_norm">rms_norm() (in module mlx.core.fast)</a>
</li>
<li><a href="python/nn/_autosummary/mlx.nn.RMSNorm.html#mlx.nn.RMSNorm">RMSNorm (class in mlx.nn)</a>
</li>
@@ -1354,16 +1458,18 @@ document.write(`
</li>
<li><a href="python/nn/_autosummary/mlx.nn.RoPE.html#mlx.nn.RoPE">RoPE (class in mlx.nn)</a>
</li>
<li><a href="python/_autosummary/mlx.core.round.html#mlx.core.round">round() (in module mlx.core)</a>
<li><a href="python/_autosummary/mlx.core.fast.rope.html#mlx.core.fast.rope">rope() (in module mlx.core.fast)</a>
</li>
<li><a href="python/_autosummary/mlx.core.array.round.html#mlx.core.array.round">round() (array method)</a>
<ul>
<li><a href="python/_autosummary/mlx.core.array.round.html#mlx.core.array.round">(mlx.core.array method)</a>
<li><a href="python/_autosummary/mlx.core.round.html#mlx.core.round">(in module mlx.core)</a>
</li>
</ul></li>
<li><a href="python/_autosummary/mlx.core.rsqrt.html#mlx.core.rsqrt">rsqrt() (in module mlx.core)</a>
<li><a href="python/_autosummary/mlx.core.array.rsqrt.html#mlx.core.array.rsqrt">rsqrt() (array method)</a>
<ul>
<li><a href="python/_autosummary/mlx.core.array.rsqrt.html#mlx.core.array.rsqrt">(mlx.core.array method)</a>
<li><a href="python/_autosummary/mlx.core.rsqrt.html#mlx.core.rsqrt">(in module mlx.core)</a>
</li>
</ul></li>
</ul></td>
@@ -1378,11 +1484,13 @@ document.write(`
</li>
<li><a href="python/_autosummary/mlx.core.save_safetensors.html#mlx.core.save_safetensors">save_safetensors() (in module mlx.core)</a>
</li>
<li><a href="python/nn/_autosummary/mlx.nn.Module.save_weights.html#mlx.nn.Module.save_weights">save_weights() (mlx.nn.Module method)</a>
<li><a href="python/nn/_autosummary/mlx.nn.Module.save_weights.html#mlx.nn.Module.save_weights">save_weights() (Module method)</a>
</li>
<li><a href="python/_autosummary/mlx.core.savez.html#mlx.core.savez">savez() (in module mlx.core)</a>
</li>
<li><a href="python/_autosummary/mlx.core.savez_compressed.html#mlx.core.savez_compressed">savez_compressed() (in module mlx.core)</a>
</li>
<li><a href="python/_autosummary/mlx.core.fast.scaled_dot_product_attention.html#mlx.core.fast.scaled_dot_product_attention">scaled_dot_product_attention() (in module mlx.core.fast)</a>
</li>
<li><a href="python/_autosummary/mlx.core.random.seed.html#mlx.core.random.seed">seed() (in module mlx.core.random)</a>
</li>
@@ -1397,12 +1505,14 @@ document.write(`
<li><a href="python/_autosummary/mlx.core.set_default_device.html#mlx.core.set_default_device">set_default_device() (in module mlx.core)</a>
</li>
<li><a href="python/_autosummary/mlx.core.set_default_stream.html#mlx.core.set_default_stream">set_default_stream() (in module mlx.core)</a>
</li>
<li><a href="python/nn/_autosummary/mlx.nn.Module.set_dtype.html#mlx.nn.Module.set_dtype">set_dtype() (Module method)</a>
</li>
<li><a href="python/_autosummary/mlx.core.metal.set_memory_limit.html#mlx.core.metal.set_memory_limit">set_memory_limit() (in module mlx.core.metal)</a>
</li>
<li><a href="python/optimizers/_autosummary/mlx.optimizers.SGD.html#mlx.optimizers.SGD">SGD (class in mlx.optimizers)</a>
</li>
<li><a href="python/_autosummary/mlx.core.array.shape.html#mlx.core.array.shape">shape (mlx.core.array property)</a>
<li><a href="python/_autosummary/mlx.core.array.shape.html#mlx.core.array.shape">shape (array property)</a>
</li>
<li><a href="python/_autosummary/mlx.core.sigmoid.html#mlx.core.sigmoid">sigmoid() (in module mlx.core)</a>
@@ -1416,17 +1526,17 @@ document.write(`
</li>
<li><a href="python/nn/_autosummary_functions/mlx.nn.silu.html#mlx.nn.silu">silu() (in module mlx.nn)</a>
</li>
<li><a href="python/_autosummary/mlx.core.sin.html#mlx.core.sin">sin() (in module mlx.core)</a>
<li><a href="python/_autosummary/mlx.core.array.sin.html#mlx.core.array.sin">sin() (array method)</a>
<ul>
<li><a href="python/_autosummary/mlx.core.array.sin.html#mlx.core.array.sin">(mlx.core.array method)</a>
<li><a href="python/_autosummary/mlx.core.sin.html#mlx.core.sin">(in module mlx.core)</a>
</li>
</ul></li>
<li><a href="python/_autosummary/mlx.core.sinh.html#mlx.core.sinh">sinh() (in module mlx.core)</a>
</li>
<li><a href="python/nn/_autosummary/mlx.nn.SinusoidalPositionalEncoding.html#mlx.nn.SinusoidalPositionalEncoding">SinusoidalPositionalEncoding (class in mlx.nn)</a>
</li>
<li><a href="python/_autosummary/mlx.core.array.size.html#mlx.core.array.size">size (mlx.core.array property)</a>
<li><a href="python/_autosummary/mlx.core.array.size.html#mlx.core.array.size">size (array property)</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() (in module mlx.nn.losses)</a>
</li>
@@ -1446,34 +1556,38 @@ document.write(`
</li>
<li><a href="python/_autosummary/mlx.core.sort.html#mlx.core.sort">sort() (in module mlx.core)</a>
</li>
<li><a href="python/_autosummary/mlx.core.split.html#mlx.core.split">split() (in module mlx.core)</a>
<li><a href="python/_autosummary/mlx.core.array.split.html#mlx.core.array.split">split() (array method)</a>
<ul>
<li><a href="python/_autosummary/mlx.core.split.html#mlx.core.split">(in module mlx.core)</a>
</li>
<li><a href="python/_autosummary/mlx.core.random.split.html#mlx.core.random.split">(in module mlx.core.random)</a>
</li>
<li><a href="python/_autosummary/mlx.core.array.split.html#mlx.core.array.split">(mlx.core.array method)</a>
</li>
</ul></li>
<li><a href="python/_autosummary/mlx.core.sqrt.html#mlx.core.sqrt">sqrt() (in module mlx.core)</a>
<li><a href="python/_autosummary/mlx.core.array.sqrt.html#mlx.core.array.sqrt">sqrt() (array method)</a>
<ul>
<li><a href="python/_autosummary/mlx.core.array.sqrt.html#mlx.core.array.sqrt">(mlx.core.array method)</a>
<li><a href="python/_autosummary/mlx.core.sqrt.html#mlx.core.sqrt">(in module mlx.core)</a>
</li>
</ul></li>
<li><a href="python/_autosummary/mlx.core.square.html#mlx.core.square">square() (in module mlx.core)</a>
<li><a href="python/_autosummary/mlx.core.array.square.html#mlx.core.array.square">square() (array method)</a>
<ul>
<li><a href="python/_autosummary/mlx.core.array.square.html#mlx.core.array.square">(mlx.core.array method)</a>
<li><a href="python/_autosummary/mlx.core.square.html#mlx.core.square">(in module mlx.core)</a>
</li>
</ul></li>
<li><a href="python/_autosummary/mlx.core.squeeze.html#mlx.core.squeeze">squeeze() (in module mlx.core)</a>
<li><a href="python/_autosummary/mlx.core.array.squeeze.html#mlx.core.array.squeeze">squeeze() (array method)</a>
<ul>
<li><a href="python/_autosummary/mlx.core.squeeze.html#mlx.core.squeeze">(in module mlx.core)</a>
</li>
</ul></li>
<li><a href="python/_autosummary/mlx.core.stack.html#mlx.core.stack">stack() (in module mlx.core)</a>
</li>
<li><a href="python/nn/_autosummary/mlx.nn.Module.state.html#mlx.nn.Module.state">state (mlx.nn.Module property)</a>
<li><a href="python/nn/_autosummary/mlx.nn.Module.state.html#mlx.nn.Module.state">state (Module property)</a>
<ul>
<li><a href="python/optimizers/_autosummary/mlx.optimizers.Optimizer.state.html#mlx.optimizers.Optimizer.state">(mlx.optimizers.Optimizer property)</a>
<li><a href="python/optimizers/_autosummary/mlx.optimizers.Optimizer.state.html#mlx.optimizers.Optimizer.state">(Optimizer property)</a>
</li>
</ul></li>
<li><a href="python/nn/_autosummary/mlx.nn.Step.html#mlx.nn.Step">Step (class in mlx.nn)</a>
@@ -1490,21 +1604,25 @@ document.write(`
</li>
<li><a href="python/_autosummary/mlx.core.subtract.html#mlx.core.subtract">subtract() (in module mlx.core)</a>
</li>
<li><a href="python/_autosummary/mlx.core.sum.html#mlx.core.sum">sum() (in module mlx.core)</a>
<li><a href="python/_autosummary/mlx.core.array.sum.html#mlx.core.array.sum">sum() (array method)</a>
<ul>
<li><a href="python/_autosummary/mlx.core.array.sum.html#mlx.core.array.sum">(mlx.core.array method)</a>
<li><a href="python/_autosummary/mlx.core.sum.html#mlx.core.sum">(in module mlx.core)</a>
</li>
</ul></li>
<li><a href="python/_autosummary/mlx.core.swapaxes.html#mlx.core.swapaxes">swapaxes() (in module mlx.core)</a>
<li><a href="python/_autosummary/mlx.core.array.swapaxes.html#mlx.core.array.swapaxes">swapaxes() (array method)</a>
<ul>
<li><a href="python/_autosummary/mlx.core.swapaxes.html#mlx.core.swapaxes">(in module mlx.core)</a>
</li>
</ul></li>
</ul></td>
</tr></table>
<h2 id="T">T</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="python/_autosummary/mlx.core.array.T.html#mlx.core.array.T">T (mlx.core.array property)</a>
<li><a href="python/_autosummary/mlx.core.array.T.html#mlx.core.array.T">T (array property)</a>
</li>
<li><a href="python/_autosummary/mlx.core.take.html#mlx.core.take">take() (in module mlx.core)</a>
</li>
@@ -1522,24 +1640,24 @@ document.write(`
</li>
<li><a href="python/_autosummary/mlx.core.tile.html#mlx.core.tile">tile() (in module mlx.core)</a>
</li>
<li><a href="python/_autosummary/mlx.core.array.tolist.html#mlx.core.array.tolist">tolist() (mlx.core.array method)</a>
<li><a href="python/_autosummary/mlx.core.array.tolist.html#mlx.core.array.tolist">tolist() (array method)</a>
</li>
<li><a href="python/_autosummary/mlx.core.topk.html#mlx.core.topk">topk() (in module mlx.core)</a>
</li>
<li><a href="python/nn/_autosummary/mlx.nn.Module.train.html#mlx.nn.Module.train">train() (mlx.nn.Module method)</a>
<li><a href="python/nn/_autosummary/mlx.nn.Module.train.html#mlx.nn.Module.train">train() (Module method)</a>
</li>
<li><a href="python/nn/_autosummary/mlx.nn.Module.trainable_parameters.html#mlx.nn.Module.trainable_parameters">trainable_parameters() (mlx.nn.Module method)</a>
<li><a href="python/nn/_autosummary/mlx.nn.Module.trainable_parameters.html#mlx.nn.Module.trainable_parameters">trainable_parameters() (Module method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="python/nn/_autosummary/mlx.nn.Module.training.html#mlx.nn.Module.training">training (mlx.nn.Module property)</a>
<li><a href="python/nn/_autosummary/mlx.nn.Module.training.html#mlx.nn.Module.training">training (Module property)</a>
</li>
<li><a href="python/nn/_autosummary/mlx.nn.Transformer.html#mlx.nn.Transformer">Transformer (class in mlx.nn)</a>
</li>
<li><a href="python/_autosummary/mlx.core.transpose.html#mlx.core.transpose">transpose() (in module mlx.core)</a>
<li><a href="python/_autosummary/mlx.core.array.transpose.html#mlx.core.array.transpose">transpose() (array method)</a>
<ul>
<li><a href="python/_autosummary/mlx.core.array.transpose.html#mlx.core.array.transpose">(mlx.core.array method)</a>
<li><a href="python/_autosummary/mlx.core.transpose.html#mlx.core.transpose">(in module mlx.core)</a>
</li>
</ul></li>
<li><a href="python/_autosummary/mlx.utils.tree_flatten.html#mlx.utils.tree_flatten">tree_flatten() (in module mlx.utils)</a>
@@ -1564,7 +1682,7 @@ document.write(`
<h2 id="U">U</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="python/nn/_autosummary/mlx.nn.Module.unfreeze.html#mlx.nn.Module.unfreeze">unfreeze() (mlx.nn.Module method)</a>
<li><a href="python/nn/_autosummary/mlx.nn.Module.unfreeze.html#mlx.nn.Module.unfreeze">unfreeze() (Module method)</a>
</li>
<li><a href="python/_autosummary/mlx.core.random.uniform.html#mlx.core.random.uniform">uniform() (in module mlx.core.random)</a>
@@ -1574,13 +1692,13 @@ document.write(`
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="python/nn/_autosummary/mlx.nn.Module.update.html#mlx.nn.Module.update">update() (mlx.nn.Module method)</a>
<li><a href="python/nn/_autosummary/mlx.nn.Module.update.html#mlx.nn.Module.update">update() (Module method)</a>
<ul>
<li><a href="python/optimizers/_autosummary/mlx.optimizers.Optimizer.update.html#mlx.optimizers.Optimizer.update">(mlx.optimizers.Optimizer method)</a>
<li><a href="python/optimizers/_autosummary/mlx.optimizers.Optimizer.update.html#mlx.optimizers.Optimizer.update">(Optimizer method)</a>
</li>
</ul></li>
<li><a href="python/nn/_autosummary/mlx.nn.Module.update_modules.html#mlx.nn.Module.update_modules">update_modules() (mlx.nn.Module method)</a>
<li><a href="python/nn/_autosummary/mlx.nn.Module.update_modules.html#mlx.nn.Module.update_modules">update_modules() (Module method)</a>
</li>
<li><a href="python/nn/_autosummary/mlx.nn.Upsample.html#mlx.nn.Upsample">Upsample (class in mlx.nn)</a>
</li>
@@ -1596,10 +1714,10 @@ document.write(`
<li><a href="python/_autosummary/mlx.nn.value_and_grad.html#mlx.nn.value_and_grad">(in module mlx.nn)</a>
</li>
</ul></li>
<li><a href="python/_autosummary/mlx.core.var.html#mlx.core.var">var() (in module mlx.core)</a>
<li><a href="python/_autosummary/mlx.core.array.var.html#mlx.core.array.var">var() (array method)</a>
<ul>
<li><a href="python/_autosummary/mlx.core.array.var.html#mlx.core.array.var">(mlx.core.array method)</a>
<li><a href="python/_autosummary/mlx.core.var.html#mlx.core.var">(in module mlx.core)</a>
</li>
</ul></li>
</ul></td>