This commit is contained in:
Awni Hannun
2024-01-10 14:14:38 -08:00
committed by CircleCI Docs
parent 2aeb6df29c
commit 7534da7269
314 changed files with 11870 additions and 691 deletions

View File

@@ -145,9 +145,12 @@
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Usage</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="usage/quick_start.html">Quick Start Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage/lazy_evaluation.html">Lazy Evaluation</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage/unified_memory.html">Unified Memory</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage/using_streams.html">Using Streams</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage/indexing.html">Indexing Arrays</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage/saving_and_loading.html">Saving and Loading Arrays</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage/numpy.html">Conversion to NumPy and Other Frameworks</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage/using_streams.html">Using Streams</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Examples</span></p>
<ul class="nav bd-sidenav">
@@ -235,6 +238,7 @@
<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.dequantize.html">mlx.core.dequantize</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.divide.html">mlx.core.divide</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.divmod.html">mlx.core.divmod</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.equal.html">mlx.core.equal</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.erf.html">mlx.core.erf</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.erfinv.html">mlx.core.erfinv</a></li>
@@ -248,6 +252,7 @@
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.greater.html">mlx.core.greater</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.greater_equal.html">mlx.core.greater_equal</a></li>
<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.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>
@@ -258,6 +263,8 @@
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.log1p.html">mlx.core.log1p</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.logaddexp.html">mlx.core.logaddexp</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.logical_not.html">mlx.core.logical_not</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.logical_and.html">mlx.core.logical_and</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.logical_or.html">mlx.core.logical_or</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.logsumexp.html">mlx.core.logsumexp</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.matmul.html">mlx.core.matmul</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.max.html">mlx.core.max</a></li>
@@ -270,6 +277,7 @@
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.negative.html">mlx.core.negative</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.ones.html">mlx.core.ones</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.ones_like.html">mlx.core.ones_like</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.outer.html">mlx.core.outer</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.partition.html">mlx.core.partition</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.pad.html">mlx.core.pad</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.prod.html">mlx.core.prod</a></li>
@@ -283,6 +291,7 @@
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.save.html">mlx.core.save</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.savez.html">mlx.core.savez</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.savez_compressed.html">mlx.core.savez_compressed</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.save_gguf.html">mlx.core.save_gguf</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.save_safetensors.html">mlx.core.save_safetensors</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.sigmoid.html">mlx.core.sigmoid</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.sign.html">mlx.core.sign</a></li>
@@ -432,6 +441,7 @@
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary_functions/mlx.nn.losses.hinge_loss.html">mlx.nn.losses.hinge_loss</a></li>
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary_functions/mlx.nn.losses.huber_loss.html">mlx.nn.losses.huber_loss</a></li>
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary_functions/mlx.nn.losses.log_cosh_loss.html">mlx.nn.losses.log_cosh_loss</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>
</ul>
</li>
</ul>
@@ -625,6 +635,12 @@ document.write(`
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="python/nn/_autosummary/mlx.nn.RoPE.html#mlx.nn.RoPE._cos_sin_theta_key">_cos_sin_theta_key (mlx.nn.RoPE attribute)</a>
</li>
<li><a href="python/nn/_autosummary/mlx.nn.RoPE.html#mlx.nn.RoPE._cos_sin_theta_value">_cos_sin_theta_value (mlx.nn.RoPE attribute)</a>
</li>
</ul></td>
</tr></table>
<h2 id="A">A</h2>
@@ -757,6 +773,8 @@ document.write(`
</li>
</ul></li>
<li><a href="python/_autosummary/mlx.core.cosh.html#mlx.core.cosh">cosh() (in module mlx.core)</a>
</li>
<li><a href="python/nn/_autosummary_functions/mlx.nn.losses.cosine_similarity_loss.html#mlx.nn.losses.cosine_similarity_loss">cosine_similarity_loss (class in mlx.nn.losses)</a>
</li>
<li><a href="python/nn/_autosummary_functions/mlx.nn.losses.cross_entropy.html#mlx.nn.losses.cross_entropy">cross_entropy (class in mlx.nn.losses)</a>
</li>
@@ -778,6 +796,8 @@ document.write(`
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="python/_autosummary/mlx.core.divmod.html#mlx.core.divmod">divmod() (in module mlx.core)</a>
</li>
<li><a href="python/nn/_autosummary/mlx.nn.Dropout.html#mlx.nn.Dropout">Dropout (class in mlx.nn)</a>
</li>
<li><a href="python/nn/_autosummary/mlx.nn.Dropout2d.html#mlx.nn.Dropout2d">Dropout2d (class in mlx.nn)</a>
@@ -897,6 +917,8 @@ document.write(`
<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>
<li><a href="python/_autosummary/mlx.core.inner.html#mlx.core.inner">inner() (in module mlx.core)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
@@ -956,14 +978,14 @@ document.write(`
</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>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<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>
@@ -977,8 +999,12 @@ document.write(`
<li><a href="python/nn/_autosummary_functions/mlx.nn.losses.log_cosh_loss.html#mlx.nn.losses.log_cosh_loss">log_cosh_loss (class in mlx.nn.losses)</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_and.html#mlx.core.logical_and">logical_and() (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.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>
@@ -1071,6 +1097,8 @@ document.write(`
<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>
<li><a href="python/_autosummary/mlx.core.outer.html#mlx.core.outer">outer() (in module mlx.core)</a>
</li>
</ul></td>
</tr></table>
@@ -1169,6 +1197,8 @@ document.write(`
<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/_autosummary/mlx.core.save_gguf.html#mlx.core.save_gguf">save_gguf() (in module mlx.core)</a>
</li>
<li><a href="python/_autosummary/mlx.core.save_safetensors.html#mlx.core.save_safetensors">save_safetensors() (in module mlx.core)</a>
</li>
@@ -1211,11 +1241,11 @@ document.write(`
</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>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<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>
<li><a href="python/nn/_autosummary_functions/mlx.nn.losses.smooth_l1_loss.html#mlx.nn.losses.smooth_l1_loss">smooth_l1_loss (class in mlx.nn.losses)</a>