mirror of
https://github.com/ml-explore/mlx.git
synced 2025-09-17 01:08:12 +08:00
docs
This commit is contained in:
Awni Hannun
committed by
CircleCI Docs
CircleCI Docs
parent
0250e203f6
commit
8bea0a4eb8
69
docs/build/html/genindex.html
vendored
69
docs/build/html/genindex.html
vendored
@@ -8,7 +8,7 @@
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Index — MLX 0.0.5 documentation</title>
|
||||
<title>Index — MLX 0.0.6 documentation</title>
|
||||
|
||||
|
||||
|
||||
@@ -131,8 +131,8 @@
|
||||
|
||||
|
||||
|
||||
<img src="_static/mlx_logo.png" class="logo__image only-light" alt="MLX 0.0.5 documentation - Home"/>
|
||||
<script>document.write(`<img src="_static/mlx_logo.png" class="logo__image only-dark" alt="MLX 0.0.5 documentation - Home"/>`);</script>
|
||||
<img src="_static/mlx_logo.png" class="logo__image only-light" alt="MLX 0.0.6 documentation - Home"/>
|
||||
<script>document.write(`<img src="_static/mlx_logo.png" class="logo__image only-dark" alt="MLX 0.0.6 documentation - Home"/>`);</script>
|
||||
|
||||
|
||||
</a></div>
|
||||
@@ -183,6 +183,7 @@
|
||||
<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>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.round.html">mlx.core.array.round</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.rsqrt.html">mlx.core.array.rsqrt</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.sin.html">mlx.core.array.sin</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array.split.html">mlx.core.array.split</a></li>
|
||||
@@ -224,12 +225,14 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.array_equal.html">mlx.core.array_equal</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.broadcast_to.html">mlx.core.broadcast_to</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.ceil.html">mlx.core.ceil</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.clip.html">mlx.core.clip</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.concatenate.html">mlx.core.concatenate</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.convolve.html">mlx.core.convolve</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.conv1d.html">mlx.core.conv1d</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.conv2d.html">mlx.core.conv2d</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.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.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>
|
||||
@@ -237,14 +240,16 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.exp.html">mlx.core.exp</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.expand_dims.html">mlx.core.expand_dims</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.eye.html">mlx.core.eye</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.floor.html">mlx.core.floor</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.flatten.html">mlx.core.flatten</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.floor.html">mlx.core.floor</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.floor_divide.html">mlx.core.floor_divide</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.full.html">mlx.core.full</a></li>
|
||||
<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.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>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.load.html">mlx.core.load</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.log.html">mlx.core.log</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.log2.html">mlx.core.log2</a></li>
|
||||
@@ -267,8 +272,11 @@
|
||||
<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>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.quantize.html">mlx.core.quantize</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.quantized_matmul.html">mlx.core.quantized_matmul</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.reciprocal.html">mlx.core.reciprocal</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.reshape.html">mlx.core.reshape</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.round.html">mlx.core.round</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.rsqrt.html">mlx.core.rsqrt</a></li>
|
||||
<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>
|
||||
@@ -361,6 +369,7 @@
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.RoPE.html">mlx.nn.RoPE</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.MultiHeadAttention.html">mlx.nn.MultiHeadAttention</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.Sequential.html">mlx.nn.Sequential</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary/mlx.nn.QuantizedLinear.html">mlx.nn.QuantizedLinear</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-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>
|
||||
@@ -376,12 +385,14 @@
|
||||
</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-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-l3"><a class="reference internal" href="python/nn/_autosummary_functions/mlx.nn.losses.cross_entropy.html">mlx.nn.losses.cross_entropy</a></li>
|
||||
<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.cross_entropy.html">mlx.nn.losses.cross_entropy</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary_functions/mlx.nn.losses.kl_div_loss.html">mlx.nn.losses.kl_div_loss</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary_functions/mlx.nn.losses.l1_loss.html">mlx.nn.losses.l1_loss</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary_functions/mlx.nn.losses.mse_loss.html">mlx.nn.losses.mse_loss</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary_functions/mlx.nn.losses.nll_loss.html">mlx.nn.losses.nll_loss</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary_functions/mlx.nn.losses.kl_div_loss.html">mlx.nn.losses.kl_div_loss</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="python/nn/_autosummary_functions/mlx.nn.losses.smooth_l1_loss.html">mlx.nn.losses.smooth_l1_loss</a></li>
|
||||
<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>
|
||||
</ul>
|
||||
@@ -396,6 +407,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.optimizers.Adam.html">mlx.optimizers.Adam</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.optimizers.AdamW.html">mlx.optimizers.AdamW</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.optimizers.Adamax.html">mlx.optimizers.Adamax</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.optimizers.Lion.html">mlx.optimizers.Lion</a></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-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>
|
||||
@@ -549,6 +561,7 @@ document.write(`
|
||||
| <a href="#N"><strong>N</strong></a>
|
||||
| <a href="#O"><strong>O</strong></a>
|
||||
| <a href="#P"><strong>P</strong></a>
|
||||
| <a href="#Q"><strong>Q</strong></a>
|
||||
| <a href="#R"><strong>R</strong></a>
|
||||
| <a href="#S"><strong>S</strong></a>
|
||||
| <a href="#T"><strong>T</strong></a>
|
||||
@@ -672,17 +685,19 @@ document.write(`
|
||||
<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/_autosummary/mlx.core.ceil.html#mlx.core.ceil">ceil() (in module mlx.core)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.clip.html#mlx.core.clip">clip() (in module mlx.core)</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/nn/_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>
|
||||
<li><a href="python/nn/_autosummary/mlx.nn.Conv2d.html#mlx.nn.Conv2d">Conv2d (class in mlx.nn)</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>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.convolve.html#mlx.core.convolve">convolve() (in module mlx.core)</a>
|
||||
@@ -707,10 +722,12 @@ document.write(`
|
||||
</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><a href="python/_autosummary/mlx.core.dequantize.html#mlx.core.dequantize">dequantize() (in module mlx.core)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<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.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>
|
||||
@@ -762,6 +779,8 @@ document.write(`
|
||||
<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/_autosummary/mlx.core.full.html#mlx.core.full">full() (in module mlx.core)</a>
|
||||
</li>
|
||||
@@ -850,6 +869,10 @@ document.write(`
|
||||
<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/nn/_autosummary/mlx.nn.Linear.html#mlx.nn.Linear">Linear (class in mlx.nn)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.linspace.html#mlx.core.linspace">linspace() (in module mlx.core)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.optimizers.Lion.html#mlx.optimizers.Lion">Lion (class in mlx.optimizers)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.load.html#mlx.core.load">load() (in module mlx.core)</a>
|
||||
</li>
|
||||
@@ -986,6 +1009,20 @@ document.write(`
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="Q">Q</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="python/_autosummary/mlx.core.quantize.html#mlx.core.quantize">quantize() (in module mlx.core)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="python/_autosummary/mlx.core.quantized_matmul.html#mlx.core.quantized_matmul">quantized_matmul() (in module mlx.core)</a>
|
||||
</li>
|
||||
<li><a href="python/nn/_autosummary/mlx.nn.QuantizedLinear.html#mlx.nn.QuantizedLinear">QuantizedLinear (class in mlx.nn)</a>
|
||||
</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>
|
||||
@@ -1007,10 +1044,10 @@ document.write(`
|
||||
<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>
|
||||
</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>
|
||||
<li><a href="python/_autosummary/mlx.core.fft.rfftn.html#mlx.core.fft.rfftn">rfftn() (in module mlx.core.fft)</a>
|
||||
@@ -1021,6 +1058,12 @@ 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>
|
||||
|
||||
<ul>
|
||||
<li><a href="python/_autosummary/mlx.core.array.round.html#mlx.core.array.round">(mlx.core.array method)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="python/_autosummary/mlx.core.rsqrt.html#mlx.core.rsqrt">rsqrt() (in module mlx.core)</a>
|
||||
|
||||
<ul>
|
||||
@@ -1077,6 +1120,8 @@ document.write(`
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<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>
|
||||
</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>
|
||||
@@ -1160,6 +1205,8 @@ document.write(`
|
||||
<li><a href="python/_autosummary/mlx.core.tri.html#mlx.core.tri">tri() (in module mlx.core)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.tril.html#mlx.core.tril">tril() (in module mlx.core)</a>
|
||||
</li>
|
||||
<li><a href="python/nn/_autosummary_functions/mlx.nn.losses.triplet_loss.html#mlx.nn.losses.triplet_loss">triplet_loss (class in mlx.nn.losses)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.triu.html#mlx.core.triu">triu() (in module mlx.core)</a>
|
||||
</li>
|
||||
|
||||
Reference in New Issue
Block a user