mirror of
https://github.com/ml-explore/mlx.git
synced 2025-06-26 02:33:21 +08:00
788 lines
35 KiB
HTML
788 lines
35 KiB
HTML
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" >
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title>Index — MLX 0.0.0 documentation</title>
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
|
<!--[if lt IE 9]>
|
|
<script src="_static/js/html5shiv.min.js"></script>
|
|
<![endif]-->
|
|
|
|
<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/js/theme.js"></script>
|
|
<link rel="index" title="Index" href="#" />
|
|
<link rel="search" title="Search" href="search.html" />
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav">
|
|
<div class="wy-grid-for-nav">
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search" >
|
|
|
|
|
|
|
|
<a href="index.html" class="icon icon-home">
|
|
MLX
|
|
</a>
|
|
<div class="version">
|
|
0.0.0
|
|
</div>
|
|
<div role="search">
|
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<p class="caption" role="heading"><span class="caption-text">Install</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="install.html">Build and Install</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Usage</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="quick_start.html">Quick Start Guide</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="using_streams.html">Using Streams</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Examples</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="examples/linear_regression.html">Linear Regression</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="examples/mlp.html">Multi-Layer Perceptron</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="examples/llama-inference.html">LLM inference</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Python API Reference</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="python/array.html">Array</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="python/devices_and_streams.html">Devices and Streams</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="python/ops.html">Operations</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="python/random.html">Random</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="python/transforms.html">Transforms</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="python/fft.html">FFT</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="python/nn.html">Neural Networks</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="python/optimizers.html">Optimizers</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="python/tree_utils.html">Tree Utils</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">C++ API Reference</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="cpp/ops.html">Operations</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Further Reading</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="dev/extensions.html">Developer Documentation</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="index.html">MLX</a>
|
|
</nav>
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
<div role="navigation" aria-label="Page navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
|
<li class="breadcrumb-item active">Index</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div itemprop="articleBody">
|
|
|
|
|
|
<h1 id="index">Index</h1>
|
|
|
|
<div class="genindex-jumpbox">
|
|
<a href="#_"><strong>_</strong></a>
|
|
| <a href="#A"><strong>A</strong></a>
|
|
| <a href="#B"><strong>B</strong></a>
|
|
| <a href="#C"><strong>C</strong></a>
|
|
| <a href="#D"><strong>D</strong></a>
|
|
| <a href="#E"><strong>E</strong></a>
|
|
| <a href="#F"><strong>F</strong></a>
|
|
| <a href="#G"><strong>G</strong></a>
|
|
| <a href="#I"><strong>I</strong></a>
|
|
| <a href="#J"><strong>J</strong></a>
|
|
| <a href="#K"><strong>K</strong></a>
|
|
| <a href="#L"><strong>L</strong></a>
|
|
| <a href="#M"><strong>M</strong></a>
|
|
| <a href="#N"><strong>N</strong></a>
|
|
| <a href="#O"><strong>O</strong></a>
|
|
| <a href="#P"><strong>P</strong></a>
|
|
| <a href="#R"><strong>R</strong></a>
|
|
| <a href="#S"><strong>S</strong></a>
|
|
| <a href="#T"><strong>T</strong></a>
|
|
| <a href="#U"><strong>U</strong></a>
|
|
| <a href="#V"><strong>V</strong></a>
|
|
| <a href="#W"><strong>W</strong></a>
|
|
| <a href="#Z"><strong>Z</strong></a>
|
|
|
|
</div>
|
|
<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>
|
|
|
|
<ul>
|
|
<li><a href="python/_autosummary/mlx.core.Device.html#mlx.core.Device.__init__">(mlx.core.Device method)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.Dtype.html#mlx.core.Dtype.__init__">(mlx.core.Dtype method)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.Stream.html#mlx.core.Stream.__init__">(mlx.core.Stream method)</a>
|
|
</li>
|
|
</ul></li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<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>
|
|
|
|
<ul>
|
|
<li><a href="python/_autosummary/mlx.core.array.abs.html#mlx.core.array.abs">(mlx.core.array method)</a>
|
|
</li>
|
|
</ul></li>
|
|
<li><a href="python/_autosummary/mlx.optimizers.Adam.html#mlx.optimizers.Adam">Adam (class in mlx.optimizers)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.add.html#mlx.core.add">add() (in module mlx.core)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.all.html#mlx.core.all">all() (in module mlx.core)</a>
|
|
|
|
<ul>
|
|
<li><a href="python/_autosummary/mlx.core.array.all.html#mlx.core.array.all">(mlx.core.array method)</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>
|
|
|
|
<ul>
|
|
<li><a href="python/_autosummary/mlx.core.array.any.html#mlx.core.array.any">(mlx.core.array method)</a>
|
|
</li>
|
|
</ul></li>
|
|
<li><a href="python/nn/module.html#mlx.nn.Module.apply">apply() (mlx.nn.Module method)</a>
|
|
</li>
|
|
<li><a href="python/nn/module.html#mlx.nn.Module.apply_to_modules">apply_to_modules() (mlx.nn.Module method)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.arange.html#mlx.core.arange">arange() (in module mlx.core)</a>
|
|
</li>
|
|
<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>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.arcsinh.html#mlx.core.arcsinh">arcsinh() (in module mlx.core)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.arctan.html#mlx.core.arctan">arctan() (in module mlx.core)</a>
|
|
</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>
|
|
|
|
<ul>
|
|
<li><a href="python/_autosummary/mlx.core.array.argmax.html#mlx.core.array.argmax">(mlx.core.array method)</a>
|
|
</li>
|
|
</ul></li>
|
|
<li><a href="python/_autosummary/mlx.core.argmin.html#mlx.core.argmin">argmin() (in module mlx.core)</a>
|
|
|
|
<ul>
|
|
<li><a href="python/_autosummary/mlx.core.array.argmin.html#mlx.core.array.argmin">(mlx.core.array method)</a>
|
|
</li>
|
|
</ul></li>
|
|
<li><a href="python/_autosummary/mlx.core.argpartition.html#mlx.core.argpartition">argpartition() (in module mlx.core)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.argsort.html#mlx.core.argsort">argsort() (in module mlx.core)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.array.html#mlx.core.array">array (class in mlx.core)</a>
|
|
</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>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="B">B</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="python/_autosummary/mlx.core.random.bernoulli.html#mlx.core.random.bernoulli">bernoulli() (in module mlx.core.random)</a>
|
|
</li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="python/_autosummary/mlx.core.broadcast_to.html#mlx.core.broadcast_to">broadcast_to() (in module mlx.core)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="C">C</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="python/_autosummary/mlx.core.random.categorical.html#mlx.core.random.categorical">categorical() (in module mlx.core.random)</a>
|
|
</li>
|
|
<li><a href="python/nn/module.html#mlx.nn.Module.children">children() (mlx.nn.Module method)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.concatenate.html#mlx.core.concatenate">concatenate() (in module mlx.core)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.nn.Conv1d.html#mlx.nn.Conv1d">Conv1d (class in mlx.nn)</a>
|
|
</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/_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>
|
|
</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>
|
|
<li><a href="python/_autosummary/mlx.core.array.cos.html#mlx.core.array.cos">(mlx.core.array method)</a>
|
|
</li>
|
|
</ul></li>
|
|
<li><a href="python/_autosummary/mlx.core.cosh.html#mlx.core.cosh">cosh() (in module mlx.core)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="D">D</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="python/_autosummary/mlx.core.default_device.html#mlx.core.default_device">default_device() (in module mlx.core)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.default_stream.html#mlx.core.default_stream">default_stream() (in module mlx.core)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.Device.html#mlx.core.Device">Device (class in mlx.core)</a>
|
|
</li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<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.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>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="E">E</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="python/_autosummary/mlx.nn.Embedding.html#mlx.nn.Embedding">Embedding (class in mlx.nn)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.equal.html#mlx.core.equal">equal() (in module mlx.core)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.erf.html#mlx.core.erf">erf() (in module mlx.core)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.erfinv.html#mlx.core.erfinv">erfinv() (in module mlx.core)</a>
|
|
</li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="python/_autosummary/mlx.core.eval.html#mlx.core.eval">eval() (in module mlx.core)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.exp.html#mlx.core.exp">exp() (in module mlx.core)</a>
|
|
|
|
<ul>
|
|
<li><a href="python/_autosummary/mlx.core.array.exp.html#mlx.core.array.exp">(mlx.core.array method)</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>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="F">F</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="python/_autosummary/mlx.core.fft.fft.html#mlx.core.fft.fft">fft() (in module mlx.core.fft)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.fft.fft2.html#mlx.core.fft.fft2">fft2() (in module mlx.core.fft)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.fft.fftn.html#mlx.core.fft.fftn">fftn() (in module mlx.core.fft)</a>
|
|
</li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="python/nn/module.html#mlx.nn.Module.filter_and_map">filter_and_map() (mlx.nn.Module method)</a>
|
|
</li>
|
|
<li><a href="python/nn/module.html#mlx.nn.Module.freeze">freeze() (mlx.nn.Module method)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.full.html#mlx.core.full">full() (in module mlx.core)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="G">G</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="python/_autosummary/mlx.nn.GELU.html#mlx.nn.GELU">GELU (class in mlx.nn)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary_functions/mlx.nn.gelu.html#mlx.nn.gelu">gelu (class in mlx.nn)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary_functions/mlx.nn.gelu_approx.html#mlx.nn.gelu_approx">gelu_approx (class in mlx.nn)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary_functions/mlx.nn.gelu_fast_approx.html#mlx.nn.gelu_fast_approx">gelu_fast_approx (class in mlx.nn)</a>
|
|
</li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="python/_autosummary/mlx.core.grad.html#mlx.core.grad">grad() (in module mlx.core)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.greater.html#mlx.core.greater">greater() (in module mlx.core)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.greater_equal.html#mlx.core.greater_equal">greater_equal() (in module mlx.core)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.nn.GroupNorm.html#mlx.nn.GroupNorm">GroupNorm (class in mlx.nn)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.random.gumbel.html#mlx.core.random.gumbel">gumbel() (in module mlx.core.random)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="I">I</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="python/_autosummary/mlx.core.fft.ifft.html#mlx.core.fft.ifft">ifft() (in module mlx.core.fft)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.fft.ifft2.html#mlx.core.fft.ifft2">ifft2() (in module mlx.core.fft)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.fft.ifftn.html#mlx.core.fft.ifftn">ifftn() (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.irfft.html#mlx.core.fft.irfft">irfft() (in module mlx.core.fft)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.fft.irfft2.html#mlx.core.fft.irfft2">irfft2() (in module mlx.core.fft)</a>
|
|
</li>
|
|
<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.array.item.html#mlx.core.array.item">item() (mlx.core.array method)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="J">J</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="python/_autosummary/mlx.core.jvp.html#mlx.core.jvp">jvp() (in module mlx.core)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="K">K</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="python/_autosummary/mlx.core.random.key.html#mlx.core.random.key">key() (in module mlx.core.random)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="L">L</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="python/_autosummary/mlx.nn.LayerNorm.html#mlx.nn.LayerNorm">LayerNorm (class in mlx.nn)</a>
|
|
</li>
|
|
<li><a href="python/nn/module.html#mlx.nn.Module.leaf_modules">leaf_modules() (mlx.nn.Module method)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.less.html#mlx.core.less">less() (in module mlx.core)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.less_equal.html#mlx.core.less_equal">less_equal() (in module mlx.core)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.nn.Linear.html#mlx.nn.Linear">Linear (class in mlx.nn)</a>
|
|
</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/module.html#mlx.nn.Module.load_weights">load_weights() (mlx.nn.Module method)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.log.html#mlx.core.log">log() (in module mlx.core)</a>
|
|
|
|
<ul>
|
|
<li><a href="python/_autosummary/mlx.core.array.log.html#mlx.core.array.log">(mlx.core.array method)</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>
|
|
|
|
<ul>
|
|
<li><a href="python/_autosummary/mlx.core.array.log1p.html#mlx.core.array.log1p">(mlx.core.array method)</a>
|
|
</li>
|
|
</ul></li>
|
|
<li><a href="python/_autosummary/mlx.core.log2.html#mlx.core.log2">log2() (in module mlx.core)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.logaddexp.html#mlx.core.logaddexp">logaddexp() (in module mlx.core)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.logical_not.html#mlx.core.logical_not">logical_not() (in module mlx.core)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.logsumexp.html#mlx.core.logsumexp">logsumexp() (in module mlx.core)</a>
|
|
|
|
<ul>
|
|
<li><a href="python/_autosummary/mlx.core.array.logsumexp.html#mlx.core.array.logsumexp">(mlx.core.array method)</a>
|
|
</li>
|
|
</ul></li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="M">M</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<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>
|
|
|
|
<ul>
|
|
<li><a href="python/_autosummary/mlx.core.array.max.html#mlx.core.array.max">(mlx.core.array method)</a>
|
|
</li>
|
|
</ul></li>
|
|
<li><a href="python/_autosummary/mlx.core.maximum.html#mlx.core.maximum">maximum() (in module mlx.core)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.mean.html#mlx.core.mean">mean() (in module mlx.core)</a>
|
|
|
|
<ul>
|
|
<li><a href="python/_autosummary/mlx.core.array.mean.html#mlx.core.array.mean">(mlx.core.array method)</a>
|
|
</li>
|
|
</ul></li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="python/_autosummary/mlx.core.min.html#mlx.core.min">min() (in module mlx.core)</a>
|
|
|
|
<ul>
|
|
<li><a href="python/_autosummary/mlx.core.array.min.html#mlx.core.array.min">(mlx.core.array method)</a>
|
|
</li>
|
|
</ul></li>
|
|
<li><a href="python/_autosummary/mlx.core.minimum.html#mlx.core.minimum">minimum() (in module mlx.core)</a>
|
|
</li>
|
|
<li><a href="python/nn/module.html#mlx.nn.Module">Module (class in mlx.nn)</a>
|
|
</li>
|
|
<li><a href="python/nn/module.html#mlx.nn.Module.modules">modules() (mlx.nn.Module method)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.nn.MultiHeadAttention.html#mlx.nn.MultiHeadAttention">MultiHeadAttention (class in mlx.nn)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.multiply.html#mlx.core.multiply">multiply() (in module mlx.core)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<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/module.html#mlx.nn.Module.named_modules">named_modules() (mlx.nn.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>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<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>
|
|
<li><a href="python/_autosummary/mlx.core.random.normal.html#mlx.core.random.normal">normal() (in module mlx.core.random)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="O">O</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="python/_autosummary/mlx.core.ones.html#mlx.core.ones">ones() (in module mlx.core)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.ones_like.html#mlx.core.ones_like">ones_like() (in module mlx.core)</a>
|
|
</li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="python/_autosummary/mlx.optimizers.Optimizer.html#mlx.optimizers.Optimizer">Optimizer (class in mlx.optimizers)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.optimizers.OptimizerState.html#mlx.optimizers.OptimizerState">OptimizerState (class in mlx.optimizers)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="P">P</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<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/module.html#mlx.nn.Module.parameters">parameters() (mlx.nn.Module method)</a>
|
|
</li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="python/_autosummary/mlx.core.partition.html#mlx.core.partition">partition() (in module mlx.core)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.prod.html#mlx.core.prod">prod() (in module mlx.core)</a>
|
|
|
|
<ul>
|
|
<li><a href="python/_autosummary/mlx.core.array.prod.html#mlx.core.array.prod">(mlx.core.array method)</a>
|
|
</li>
|
|
</ul></li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="R">R</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<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>
|
|
|
|
<ul>
|
|
<li><a href="python/_autosummary/mlx.core.array.reciprocal.html#mlx.core.array.reciprocal">(mlx.core.array method)</a>
|
|
</li>
|
|
</ul></li>
|
|
<li><a href="python/_autosummary/mlx.nn.ReLU.html#mlx.nn.ReLU">ReLU (class in mlx.nn)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary_functions/mlx.nn.relu.html#mlx.nn.relu">relu (class in mlx.nn)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.reshape.html#mlx.core.reshape">reshape() (in module mlx.core)</a>
|
|
|
|
<ul>
|
|
<li><a href="python/_autosummary/mlx.core.array.reshape.html#mlx.core.array.reshape">(mlx.core.array method)</a>
|
|
</li>
|
|
</ul></li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="python/_autosummary/mlx.core.fft.rfft.html#mlx.core.fft.rfft">rfft() (in module mlx.core.fft)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.fft.rfft2.html#mlx.core.fft.rfft2">rfft2() (in module mlx.core.fft)</a>
|
|
</li>
|
|
<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.nn.RMSNorm.html#mlx.nn.RMSNorm">RMSNorm (class in mlx.nn)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.nn.RoPE.html#mlx.nn.RoPE">RoPE (class in mlx.nn)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.rsqrt.html#mlx.core.rsqrt">rsqrt() (in module mlx.core)</a>
|
|
|
|
<ul>
|
|
<li><a href="python/_autosummary/mlx.core.array.rsqrt.html#mlx.core.array.rsqrt">(mlx.core.array method)</a>
|
|
</li>
|
|
</ul></li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="S">S</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="python/_autosummary/mlx.core.save.html#mlx.core.save">save() (in module mlx.core)</a>
|
|
</li>
|
|
<li><a href="python/nn/module.html#mlx.nn.Module.save_weights">save_weights() (mlx.nn.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.random.seed.html#mlx.core.random.seed">seed() (in module mlx.core.random)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.nn.Sequential.html#mlx.nn.Sequential">Sequential (class in mlx.nn)</a>
|
|
</li>
|
|
<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/_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>
|
|
<li><a href="python/_autosummary/mlx.core.sigmoid.html#mlx.core.sigmoid">sigmoid() (in module mlx.core)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.sign.html#mlx.core.sign">sign() (in module mlx.core)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.nn.SiLU.html#mlx.nn.SiLU">SiLU (class in mlx.nn)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary_functions/mlx.nn.silu.html#mlx.nn.silu">silu (class in mlx.nn)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.sin.html#mlx.core.sin">sin() (in module mlx.core)</a>
|
|
|
|
<ul>
|
|
<li><a href="python/_autosummary/mlx.core.array.sin.html#mlx.core.array.sin">(mlx.core.array method)</a>
|
|
</li>
|
|
</ul></li>
|
|
<li><a href="python/_autosummary/mlx.core.sinh.html#mlx.core.sinh">sinh() (in module mlx.core)</a>
|
|
</li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="python/_autosummary/mlx.core.array.size.html#mlx.core.array.size">size (mlx.core.array property)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.softmax.html#mlx.core.softmax">softmax() (in module mlx.core)</a>
|
|
</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>
|
|
|
|
<ul>
|
|
<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>
|
|
|
|
<ul>
|
|
<li><a href="python/_autosummary/mlx.core.array.sqrt.html#mlx.core.array.sqrt">(mlx.core.array method)</a>
|
|
</li>
|
|
</ul></li>
|
|
<li><a href="python/_autosummary/mlx.core.square.html#mlx.core.square">square() (in module mlx.core)</a>
|
|
|
|
<ul>
|
|
<li><a href="python/_autosummary/mlx.core.array.square.html#mlx.core.array.square">(mlx.core.array method)</a>
|
|
</li>
|
|
</ul></li>
|
|
<li><a href="python/_autosummary/mlx.core.squeeze.html#mlx.core.squeeze">squeeze() (in module mlx.core)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.optimizers.Optimizer.html#mlx.optimizers.Optimizer.state">state (mlx.optimizers.Optimizer attribute)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.stop_gradient.html#mlx.core.stop_gradient">stop_gradient() (in module mlx.core)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.Stream.html#mlx.core.Stream">Stream (class in mlx.core)</a>
|
|
</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>
|
|
|
|
<ul>
|
|
<li><a href="python/_autosummary/mlx.core.array.sum.html#mlx.core.array.sum">(mlx.core.array method)</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>
|
|
<li><a href="python/_autosummary/mlx.core.take.html#mlx.core.take">take() (in module mlx.core)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.take_along_axis.html#mlx.core.take_along_axis">take_along_axis() (in module mlx.core)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.tan.html#mlx.core.tan">tan() (in module mlx.core)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.tanh.html#mlx.core.tanh">tanh() (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>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="python/nn/module.html#mlx.nn.Module.trainable_parameters">trainable_parameters() (mlx.nn.Module method)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.transpose.html#mlx.core.transpose">transpose() (in module mlx.core)</a>
|
|
|
|
<ul>
|
|
<li><a href="python/_autosummary/mlx.core.array.transpose.html#mlx.core.array.transpose">(mlx.core.array method)</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>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.utils.tree_map.html#mlx.utils.tree_map">tree_map() (in module mlx.utils)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.utils.tree_unflatten.html#mlx.utils.tree_unflatten">tree_unflatten() (in module mlx.utils)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.random.truncated_normal.html#mlx.core.random.truncated_normal">truncated_normal() (in module mlx.core.random)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<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/module.html#mlx.nn.Module.unfreeze">unfreeze() (mlx.nn.Module method)</a>
|
|
</li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="python/_autosummary/mlx.core.random.uniform.html#mlx.core.random.uniform">uniform() (in module mlx.core.random)</a>
|
|
</li>
|
|
<li><a href="python/nn/module.html#mlx.nn.Module.update">update() (mlx.nn.Module method)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="V">V</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="python/_autosummary/mlx.core.value_and_grad.html#mlx.core.value_and_grad">value_and_grad() (in module mlx.core)</a>
|
|
|
|
<ul>
|
|
<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>
|
|
|
|
<ul>
|
|
<li><a href="python/_autosummary/mlx.core.array.var.html#mlx.core.array.var">(mlx.core.array method)</a>
|
|
</li>
|
|
</ul></li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="python/_autosummary/mlx.core.vjp.html#mlx.core.vjp">vjp() (in module mlx.core)</a>
|
|
</li>
|
|
<li><a href="python/_autosummary/mlx.core.vmap.html#mlx.core.vmap">vmap() (in module mlx.core)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="W">W</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="python/_autosummary/mlx.core.where.html#mlx.core.where">where() (in module mlx.core)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
<h2 id="Z">Z</h2>
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="python/_autosummary/mlx.core.zeros.html#mlx.core.zeros">zeros() (in module mlx.core)</a>
|
|
</li>
|
|
</ul></td>
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
<li><a href="python/_autosummary/mlx.core.zeros_like.html#mlx.core.zeros_like">zeros_like() (in module mlx.core)</a>
|
|
</li>
|
|
</ul></td>
|
|
</tr></table>
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>© Copyright 2023, MLX Contributors.</p>
|
|
</div>
|
|
|
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
|
|
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
<script>
|
|
jQuery(function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
});
|
|
</script>
|
|
|
|
</body>
|
|
</html> |