rebase
This commit is contained in:
Awni Hannun
committed by
CircleCI Docs
CircleCI Docs
parent
9acc86b81b
commit
6555eafe7b
Vendored
+49
-4
@@ -8,7 +8,7 @@
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>Operations — MLX 0.18.0 documentation</title>
|
||||
<title>Operations — MLX 0.18.1 documentation</title>
|
||||
|
||||
|
||||
|
||||
@@ -36,7 +36,7 @@
|
||||
<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 src="../_static/documentation_options.js?v=4033e70d"></script>
|
||||
<script src="../_static/documentation_options.js?v=fbcf6510"></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>
|
||||
@@ -131,8 +131,8 @@
|
||||
|
||||
|
||||
|
||||
<img src="../_static/mlx_logo.png" class="logo__image only-light" alt="MLX 0.18.0 documentation - Home"/>
|
||||
<script>document.write(`<img src="../_static/mlx_logo_dark.png" class="logo__image only-dark" alt="MLX 0.18.0 documentation - Home"/>`);</script>
|
||||
<img src="../_static/mlx_logo.png" class="logo__image only-light" alt="MLX 0.18.1 documentation - Home"/>
|
||||
<script>document.write(`<img src="../_static/mlx_logo_dark.png" class="logo__image only-dark" alt="MLX 0.18.1 documentation - Home"/>`);</script>
|
||||
|
||||
|
||||
</a></div>
|
||||
@@ -370,6 +370,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="../python/_autosummary/mlx.core.repeat.html">mlx.core.repeat</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.right_shift.html">mlx.core.right_shift</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../python/_autosummary/mlx.core.roll.html">mlx.core.roll</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>
|
||||
@@ -425,6 +426,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="../python/_autosummary/mlx.core.random.truncated_normal.html">mlx.core.random.truncated_normal</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../python/_autosummary/mlx.core.random.uniform.html">mlx.core.random.uniform</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../python/_autosummary/mlx.core.random.laplace.html">mlx.core.random.laplace</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../python/_autosummary/mlx.core.random.permutation.html">mlx.core.random.permutation</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-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>
|
||||
@@ -1155,6 +1157,12 @@ document.write(`
|
||||
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv411right_shiftRK5arrayRK5array14StreamOrDevice"><code class="docutils literal notranslate"><span class="pre">right_shift()</span></code></a></li>
|
||||
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4rsRK5arrayRK5array"><code class="docutils literal notranslate"><span class="pre">operator>>()</span></code></a></li>
|
||||
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv44viewRK5arrayRK5Dtype14StreamOrDevice"><code class="docutils literal notranslate"><span class="pre">view()</span></code></a></li>
|
||||
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv44rollRK5arrayi14StreamOrDevice"><code class="docutils literal notranslate"><span class="pre">roll()</span></code></a></li>
|
||||
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv44rollRK5arrayRKNSt6vectorIiEE14StreamOrDevice"><code class="docutils literal notranslate"><span class="pre">roll()</span></code></a></li>
|
||||
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv44rollRK5arrayii14StreamOrDevice"><code class="docutils literal notranslate"><span class="pre">roll()</span></code></a></li>
|
||||
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv44rollRK5arrayiRKNSt6vectorIiEE14StreamOrDevice"><code class="docutils literal notranslate"><span class="pre">roll()</span></code></a></li>
|
||||
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv44rollRK5arrayRKNSt6vectorIiEEi14StreamOrDevice"><code class="docutils literal notranslate"><span class="pre">roll()</span></code></a></li>
|
||||
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv44rollRK5arrayRKNSt6vectorIiEERKNSt6vectorIiEE14StreamOrDevice"><code class="docutils literal notranslate"><span class="pre">roll()</span></code></a></li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
@@ -2923,6 +2931,37 @@ document.write(`
|
||||
<span id="_CPPv34viewRK5arrayRK5Dtype14StreamOrDevice"></span><span id="_CPPv24viewRK5arrayRK5Dtype14StreamOrDevice"></span><span id="view__arrayCR.DtypeCR.StreamOrDevice"></span><span class="target" id="group__ops_1ga3602aa91b7b124a0b41ec1b2137a1b02"></span><span class="n"><span class="pre">array</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">view</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">array</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">a</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">Dtype</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">dtype</span></span>, <span class="n"><span class="pre">StreamOrDevice</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">s</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="p"><span class="pre">{</span></span><span class="p"><span class="pre">}</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv44viewRK5arrayRK5Dtype14StreamOrDevice" title="Link to this definition">#</a><br /></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="cpp function">
|
||||
<dt class="sig sig-object cpp" id="_CPPv44rollRK5arrayi14StreamOrDevice">
|
||||
<span id="_CPPv34rollRK5arrayi14StreamOrDevice"></span><span id="_CPPv24rollRK5arrayi14StreamOrDevice"></span><span id="roll__arrayCR.i.StreamOrDevice"></span><span class="target" id="group__ops_1gac40e48c69f9c715a767912c30836e75c"></span><span class="n"><span class="pre">array</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">roll</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">array</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">a</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">shift</span></span>, <span class="n"><span class="pre">StreamOrDevice</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">s</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="p"><span class="pre">{</span></span><span class="p"><span class="pre">}</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv44rollRK5arrayi14StreamOrDevice" title="Link to this definition">#</a><br /></dt>
|
||||
<dd><p>Roll elements along an axis and introduce them on the other side. </p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="cpp function">
|
||||
<dt class="sig sig-object cpp" id="_CPPv44rollRK5arrayRKNSt6vectorIiEE14StreamOrDevice">
|
||||
<span id="_CPPv34rollRK5arrayRKNSt6vectorIiEE14StreamOrDevice"></span><span id="_CPPv24rollRK5arrayRKNSt6vectorIiEE14StreamOrDevice"></span><span id="roll__arrayCR.std::vector:i:CR.StreamOrDevice"></span><span class="target" id="group__ops_1gab30fb942bb6ee00bb50da04033f949a9"></span><span class="n"><span class="pre">array</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">roll</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">array</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">a</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4StRK5arraybi14StreamOrDevice" title="std"><span class="n"><span class="pre">std</span></span></a><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="kt"><span class="pre">int</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">shift</span></span>, <span class="n"><span class="pre">StreamOrDevice</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">s</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="p"><span class="pre">{</span></span><span class="p"><span class="pre">}</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv44rollRK5arrayRKNSt6vectorIiEE14StreamOrDevice" title="Link to this definition">#</a><br /></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="cpp function">
|
||||
<dt class="sig sig-object cpp" id="_CPPv44rollRK5arrayii14StreamOrDevice">
|
||||
<span id="_CPPv34rollRK5arrayii14StreamOrDevice"></span><span id="_CPPv24rollRK5arrayii14StreamOrDevice"></span><span id="roll__arrayCR.i.i.StreamOrDevice"></span><span class="target" id="group__ops_1ga8694ec137165752cb6d8a36a6b7c3436"></span><span class="n"><span class="pre">array</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">roll</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">array</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">a</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">shift</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">axis</span></span>, <span class="n"><span class="pre">StreamOrDevice</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">s</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="p"><span class="pre">{</span></span><span class="p"><span class="pre">}</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv44rollRK5arrayii14StreamOrDevice" title="Link to this definition">#</a><br /></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="cpp function">
|
||||
<dt class="sig sig-object cpp" id="_CPPv44rollRK5arrayiRKNSt6vectorIiEE14StreamOrDevice">
|
||||
<span id="_CPPv34rollRK5arrayiRKNSt6vectorIiEE14StreamOrDevice"></span><span id="_CPPv24rollRK5arrayiRKNSt6vectorIiEE14StreamOrDevice"></span><span id="roll__arrayCR.i.std::vector:i:CR.StreamOrDevice"></span><span class="target" id="group__ops_1ga665f502ecc96f1f4467556b784abf9ae"></span><span class="n"><span class="pre">array</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">roll</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">array</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">a</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">shift</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4StRK5arraybi14StreamOrDevice" title="std"><span class="n"><span class="pre">std</span></span></a><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="kt"><span class="pre">int</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">axes</span></span>, <span class="n"><span class="pre">StreamOrDevice</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">s</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="p"><span class="pre">{</span></span><span class="p"><span class="pre">}</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv44rollRK5arrayiRKNSt6vectorIiEE14StreamOrDevice" title="Link to this definition">#</a><br /></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="cpp function">
|
||||
<dt class="sig sig-object cpp" id="_CPPv44rollRK5arrayRKNSt6vectorIiEEi14StreamOrDevice">
|
||||
<span id="_CPPv34rollRK5arrayRKNSt6vectorIiEEi14StreamOrDevice"></span><span id="_CPPv24rollRK5arrayRKNSt6vectorIiEEi14StreamOrDevice"></span><span id="roll__arrayCR.std::vector:i:CR.i.StreamOrDevice"></span><span class="target" id="group__ops_1ga4c335f86ff2a05daf8dd8aedc628aa59"></span><span class="n"><span class="pre">array</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">roll</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">array</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">a</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4StRK5arraybi14StreamOrDevice" title="std"><span class="n"><span class="pre">std</span></span></a><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="kt"><span class="pre">int</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">shift</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">axis</span></span>, <span class="n"><span class="pre">StreamOrDevice</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">s</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="p"><span class="pre">{</span></span><span class="p"><span class="pre">}</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv44rollRK5arrayRKNSt6vectorIiEEi14StreamOrDevice" title="Link to this definition">#</a><br /></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="cpp function">
|
||||
<dt class="sig sig-object cpp" id="_CPPv44rollRK5arrayRKNSt6vectorIiEERKNSt6vectorIiEE14StreamOrDevice">
|
||||
<span id="_CPPv34rollRK5arrayRKNSt6vectorIiEERKNSt6vectorIiEE14StreamOrDevice"></span><span id="_CPPv24rollRK5arrayRKNSt6vectorIiEERKNSt6vectorIiEE14StreamOrDevice"></span><span id="roll__arrayCR.std::vector:i:CR.std::vector:i:CR.StreamOrDevice"></span><span class="target" id="group__ops_1ga6c6fe942a8f7c573a1cb2342566f74d2"></span><span class="n"><span class="pre">array</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">roll</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">array</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">a</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4StRK5arraybi14StreamOrDevice" title="std"><span class="n"><span class="pre">std</span></span></a><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="kt"><span class="pre">int</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">shift</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4StRK5arraybi14StreamOrDevice" title="std"><span class="n"><span class="pre">std</span></span></a><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="kt"><span class="pre">int</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">axes</span></span>, <span class="n"><span class="pre">StreamOrDevice</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">s</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="p"><span class="pre">{</span></span><span class="p"><span class="pre">}</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv44rollRK5arrayRKNSt6vectorIiEERKNSt6vectorIiEE14StreamOrDevice" title="Link to this definition">#</a><br /></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
@@ -3269,6 +3308,12 @@ document.write(`
|
||||
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv411right_shiftRK5arrayRK5array14StreamOrDevice"><code class="docutils literal notranslate"><span class="pre">right_shift()</span></code></a></li>
|
||||
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4rsRK5arrayRK5array"><code class="docutils literal notranslate"><span class="pre">operator>>()</span></code></a></li>
|
||||
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv44viewRK5arrayRK5Dtype14StreamOrDevice"><code class="docutils literal notranslate"><span class="pre">view()</span></code></a></li>
|
||||
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv44rollRK5arrayi14StreamOrDevice"><code class="docutils literal notranslate"><span class="pre">roll()</span></code></a></li>
|
||||
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv44rollRK5arrayRKNSt6vectorIiEE14StreamOrDevice"><code class="docutils literal notranslate"><span class="pre">roll()</span></code></a></li>
|
||||
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv44rollRK5arrayii14StreamOrDevice"><code class="docutils literal notranslate"><span class="pre">roll()</span></code></a></li>
|
||||
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv44rollRK5arrayiRKNSt6vectorIiEE14StreamOrDevice"><code class="docutils literal notranslate"><span class="pre">roll()</span></code></a></li>
|
||||
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv44rollRK5arrayRKNSt6vectorIiEEi14StreamOrDevice"><code class="docutils literal notranslate"><span class="pre">roll()</span></code></a></li>
|
||||
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv44rollRK5arrayRKNSt6vectorIiEERKNSt6vectorIiEE14StreamOrDevice"><code class="docutils literal notranslate"><span class="pre">roll()</span></code></a></li>
|
||||
</ul>
|
||||
</nav></div>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user