zhangyiss/mlx
1
0
Fork 0
mirror of https://github.com/ml-explore/mlx.git synced 2025-09-18 18:28:12 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs update

Browse Source
This commit is contained in:
Awni Hannun
2024-07-11 15:32:08 -07:00
committed by CircleCI Docs
parent ba4eff9520
commit 0e688cbd0f
754 changed files with 24043 additions and 13535 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/build/html/transforms_8h.html vendored
View File

@@ -83,7 +83,8 @@ $(function() {
<div class="headertitle"><div class="title">transforms.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="array_8h_source.html">mlx/array.h</a>&quot;</code><br />
<div class="textblock"><code>#include &lt;optional&gt;</code><br />
<code>#include &quot;<a class="el" href="array_8h_source.html">mlx/array.h</a>&quot;</code><br />
</div>
<p><a href="transforms_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
@@ -156,8 +157,11 @@ Variables</h2></td></tr>
<tr class="memitem:a933289d4688479e1c4d8ba04332c406b" id="r_a933289d4688479e1c4d8ba04332c406b"><td class="memItemLeft" align="right" valign="top">std::function&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a>(const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;)&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a933289d4688479e1c4d8ba04332c406b">mlx::core::vmap</a> )(const std::function&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a>(const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;)&gt; &amp;fun, int in_axis=0, int out_axis=0)</td></tr>
<tr class="memdesc:a933289d4688479e1c4d8ba04332c406b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Automatically vectorize a unary function over the requested axes. <br /></td></tr>
<tr class="separator:a933289d4688479e1c4d8ba04332c406b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58c5b448f357b48e86599eb8eeea141d" id="r_a58c5b448f357b48e86599eb8eeea141d"><td class="memItemLeft" align="right" valign="top">std::function&lt; std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt;(const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;)&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a58c5b448f357b48e86599eb8eeea141d">mlx::core::custom_function</a> )(std::function&lt; std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt;(const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;)&gt; fun, std::optional&lt; std::function&lt; std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt;(const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;, const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;, const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;)&gt; &gt; fun_vjp=std::nullopt, std::optional&lt; std::function&lt; std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt;(const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;, const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;, const std::vector&lt; int &gt; &amp;)&gt; &gt; fun_jvp=std::nullopt, std::optional&lt; std::function&lt; std::pair&lt; std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt;, std::vector&lt; int &gt; &gt;(const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;, const std::vector&lt; int &gt; &amp;)&gt; &gt; fun_vmap=std::nullopt)</td></tr>
<tr class="memdesc:a58c5b448f357b48e86599eb8eeea141d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Redefine the transformations of <code>fun</code> according to the provided functions. <br /></td></tr>
<tr class="separator:a58c5b448f357b48e86599eb8eeea141d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3fa1f0ad360f3e16c146384276b1c467" id="r_a3fa1f0ad360f3e16c146384276b1c467"><td class="memItemLeft" align="right" valign="top">std::function&lt; std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt;(const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;)&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a3fa1f0ad360f3e16c146384276b1c467">mlx::core::custom_vjp</a> )(std::function&lt; std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt;(const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;)&gt; fun, std::function&lt; std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt;(const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;, const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;, const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;)&gt; fun_vjp)</td></tr>
<tr class="memdesc:a3fa1f0ad360f3e16c146384276b1c467"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the results of calling fun with args but if their vjp is computed it will be computed by fun_vjp. <br /></td></tr>
<tr class="memdesc:a3fa1f0ad360f3e16c146384276b1c467"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a function that behaves exactly like <code>fun</code> but if the vjp of the results is computed <code>fun_vjp</code> will be used instead of <code>vjp(fun, ...)</code> . <br /></td></tr>
<tr class="separator:a3fa1f0ad360f3e16c146384276b1c467"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a26127b71b2ec65c51d7627e71847083d" id="r_a26127b71b2ec65c51d7627e71847083d"><td class="memItemLeft" align="right" valign="top">std::function&lt; std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt;(const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;)&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a26127b71b2ec65c51d7627e71847083d">mlx::core::checkpoint</a> )(std::function&lt; std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt;(const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;)&gt; fun)</td></tr>
<tr class="memdesc:a26127b71b2ec65c51d7627e71847083d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checkpoint the gradient of a function. <br /></td></tr>