mirror of
https://github.com/ml-explore/mlx.git
synced 2025-09-16 16:58:17 +08:00
update docs
This commit is contained in:
Awni Hannun
committed by
CircleCI Docs
CircleCI Docs
parent
af2c3689fe
commit
f75712551d
70
docs/build/html/genindex.html
vendored
70
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.4 documentation</title>
|
||||
<title>Index — MLX 0.0.5 documentation</title>
|
||||
|
||||
|
||||
|
||||
@@ -131,8 +131,8 @@
|
||||
|
||||
|
||||
|
||||
<img src="_static/mlx_logo.png" class="logo__image only-light" alt="MLX 0.0.4 documentation - Home"/>
|
||||
<script>document.write(`<img src="_static/mlx_logo.png" class="logo__image only-dark" alt="MLX 0.0.4 documentation - Home"/>`);</script>
|
||||
<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>
|
||||
|
||||
|
||||
</a></div>
|
||||
@@ -235,9 +235,11 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.core.erfinv.html">mlx.core.erfinv</a></li>
|
||||
<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.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.load.html">mlx.core.load</a></li>
|
||||
@@ -332,8 +334,12 @@
|
||||
<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"><a class="reference internal" href="python/_autosummary/mlx.nn.Embedding.html">mlx.nn.Embedding</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.nn.ReLU.html">mlx.nn.ReLU</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.nn.PReLU.html">mlx.nn.PReLU</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.nn.GELU.html">mlx.nn.GELU</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.nn.SiLU.html">mlx.nn.SiLU</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.nn.Step.html">mlx.nn.Step</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.nn.SELU.html">mlx.nn.SELU</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.nn.Mish.html">mlx.nn.Mish</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.nn.Linear.html">mlx.nn.Linear</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.nn.Conv1d.html">mlx.nn.Conv1d</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary/mlx.nn.Conv2d.html">mlx.nn.Conv2d</a></li>
|
||||
@@ -347,7 +353,17 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary_functions/mlx.nn.gelu_approx.html">mlx.nn.gelu_approx</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary_functions/mlx.nn.gelu_fast_approx.html">mlx.nn.gelu_fast_approx</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary_functions/mlx.nn.relu.html">mlx.nn.relu</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary_functions/mlx.nn.prelu.html">mlx.nn.prelu</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary_functions/mlx.nn.silu.html">mlx.nn.silu</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary_functions/mlx.nn.step.html">mlx.nn.step</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary_functions/mlx.nn.selu.html">mlx.nn.selu</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary_functions/mlx.nn.mish.html">mlx.nn.mish</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary_functions/mlx.nn.losses.cross_entropy.html">mlx.nn.losses.cross_entropy</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary_functions/mlx.nn.losses.binary_cross_entropy.html">mlx.nn.losses.binary_cross_entropy</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary_functions/mlx.nn.losses.l1_loss.html">mlx.nn.losses.l1_loss</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary_functions/mlx.nn.losses.mse_loss.html">mlx.nn.losses.mse_loss</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary_functions/mlx.nn.losses.nll_loss.html">mlx.nn.losses.nll_loss</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="python/_autosummary_functions/mlx.nn.losses.kl_div_loss.html">mlx.nn.losses.kl_div_loss</a></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-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>
|
||||
@@ -612,6 +628,8 @@ document.write(`
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="python/_autosummary_functions/mlx.nn.losses.binary_cross_entropy.html#mlx.nn.losses.binary_cross_entropy">binary_cross_entropy (class in mlx.nn.losses)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.broadcast_to.html#mlx.core.broadcast_to">broadcast_to() (in module mlx.core)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
@@ -630,10 +648,10 @@ 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/_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/_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>
|
||||
@@ -645,6 +663,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/_autosummary_functions/mlx.nn.losses.cross_entropy.html#mlx.nn.losses.cross_entropy">cross_entropy (class in mlx.nn.losses)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
@@ -691,6 +711,8 @@ document.write(`
|
||||
</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>
|
||||
<li><a href="python/_autosummary/mlx.core.eye.html#mlx.core.eye">eye() (in module mlx.core)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
@@ -744,6 +766,8 @@ document.write(`
|
||||
<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.identity.html#mlx.core.identity">identity() (in module mlx.core)</a>
|
||||
</li>
|
||||
<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>
|
||||
@@ -775,6 +799,10 @@ 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.random.key.html#mlx.core.random.key">key() (in module mlx.core.random)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="python/_autosummary_functions/mlx.nn.losses.kl_div_loss.html#mlx.nn.losses.kl_div_loss">kl_div_loss (class in mlx.nn.losses)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
@@ -782,6 +810,8 @@ document.write(`
|
||||
<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_functions/mlx.nn.losses.l1_loss.html#mlx.nn.losses.l1_loss">l1_loss (class in mlx.nn.losses)</a>
|
||||
</li>
|
||||
<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>
|
||||
@@ -846,19 +876,25 @@ document.write(`
|
||||
<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>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="python/_autosummary/mlx.core.minimum.html#mlx.core.minimum">minimum() (in module mlx.core)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.nn.Mish.html#mlx.nn.Mish">Mish (class in mlx.nn)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary_functions/mlx.nn.mish.html#mlx.nn.mish">mish (class in mlx.nn)</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_functions/mlx.nn.losses.mse_loss.html#mlx.nn.losses.mse_loss">mse_loss (class in mlx.nn.losses)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.nn.MultiHeadAttention.html#mlx.nn.MultiHeadAttention">MultiHeadAttention (class in mlx.nn)</a>
|
||||
</li>
|
||||
@@ -874,11 +910,13 @@ document.write(`
|
||||
</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>
|
||||
</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/_autosummary_functions/mlx.nn.losses.nll_loss.html#mlx.nn.losses.nll_loss">nll_loss (class in mlx.nn.losses)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.random.normal.html#mlx.core.random.normal">normal() (in module mlx.core.random)</a>
|
||||
</li>
|
||||
@@ -907,10 +945,14 @@ document.write(`
|
||||
<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>
|
||||
<li><a href="python/_autosummary/mlx.core.partition.html#mlx.core.partition">partition() (in module mlx.core)</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><a href="python/_autosummary/mlx.nn.PReLU.html#mlx.nn.PReLU">PReLU (class in mlx.nn)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary_functions/mlx.nn.prelu.html#mlx.nn.prelu">prelu (class in mlx.nn)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.prod.html#mlx.core.prod">prod() (in module mlx.core)</a>
|
||||
|
||||
@@ -975,6 +1017,10 @@ document.write(`
|
||||
<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.SELU.html#mlx.nn.SELU">SELU (class in mlx.nn)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary_functions/mlx.nn.selu.html#mlx.nn.selu">selu (class in mlx.nn)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.nn.Sequential.html#mlx.nn.Sequential">Sequential (class in mlx.nn)</a>
|
||||
</li>
|
||||
@@ -1033,6 +1079,10 @@ document.write(`
|
||||
<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.nn.Step.html#mlx.nn.Step">Step (class in mlx.nn)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary_functions/mlx.nn.step.html#mlx.nn.step">step (class in mlx.nn)</a>
|
||||
</li>
|
||||
<li><a href="python/_autosummary/mlx.core.stop_gradient.html#mlx.core.stop_gradient">stop_gradient() (in module mlx.core)</a>
|
||||
</li>
|
||||
|
||||
Reference in New Issue
Block a user