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

docs update

Browse Source
This commit is contained in:
Awni Hannun
2024-08-23 12:14:53 -07:00
committed by CircleCI Docs
parent f5dcb1c2b9
commit 9da49a07a4
697 changed files with 15867 additions and 8594 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/build/html/common_2reduce_8h_source.html vendored
View File

@@ -140,7 +140,7 @@ $(function() { codefold.init(0); });
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span>};</div>
</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#a1555dc378c5254e79199421761f26f2b"> 52</a></span><a class="code hl_struct" href="structmlx_1_1core_1_1_reduction_plan.html">ReductionPlan</a> <a class="code hl_function" href="namespacemlx_1_1core.html#a1555dc378c5254e79199421761f26f2b">get_reduction_plan</a>(<span class="keyword">const</span> <a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a>&amp; x, <span class="keyword">const</span> std::vector&lt;int&gt; axes);</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#ac97b5a6f009ca3d99854ce9512c20dba"> 52</a></span><a class="code hl_struct" href="structmlx_1_1core_1_1_reduction_plan.html">ReductionPlan</a> <a class="code hl_function" href="namespacemlx_1_1core.html#ac97b5a6f009ca3d99854ce9512c20dba">get_reduction_plan</a>(<span class="keyword">const</span> <a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a>&amp; x, <span class="keyword">const</span> std::vector&lt;int&gt;&amp; axes);</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="comment">// Helper for the ndimensional strided loop</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="comment">// Should this be in utils?</span></div>
@@ -204,7 +204,7 @@ $(function() { codefold.init(0); });
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> OpC opc,</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> Op <a class="code hl_variable" href="common_2binary_8h.html#a70228731d29946574b238d21fb4b360c">op</a>) {</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> out.<a class="code hl_function" href="classmlx_1_1core_1_1array.html#a631acd8e318189640b8338f9ae1a554d">set_data</a>(<a class="code hl_function" href="namespacemlx_1_1core_1_1allocator.html#a86ac0a11ff78f21e717f641716c34abc">allocator::malloc_or_wait</a>(out.<a class="code hl_function" href="classmlx_1_1core_1_1array.html#a387b67cd3ef5cfc1e749c371766c4a05">nbytes</a>()));</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> <a class="code hl_struct" href="structmlx_1_1core_1_1_reduction_plan.html">ReductionPlan</a> plan = <a class="code hl_function" href="namespacemlx_1_1core.html#a1555dc378c5254e79199421761f26f2b">get_reduction_plan</a>(x, axes);</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> <a class="code hl_struct" href="structmlx_1_1core_1_1_reduction_plan.html">ReductionPlan</a> plan = <a class="code hl_function" href="namespacemlx_1_1core.html#ac97b5a6f009ca3d99854ce9512c20dba">get_reduction_plan</a>(x, axes);</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> </div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> <span class="keywordflow">if</span> (plan.<a class="code hl_variable" href="structmlx_1_1core_1_1_reduction_plan.html#a24e407f13d4d02156380ecc1a6748a76">type</a> == <a class="code hl_enumvalue" href="namespacemlx_1_1core.html#a12412984a1cabfe1189942c898f8fe65ae4e34c7154eb8dc47aa8503209730424">ContiguousAllReduce</a>) {</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> U* out_ptr = out.<a class="code hl_function" href="classmlx_1_1core_1_1array.html#a72e3ce6c03fefe272cadf214bd127b95">data</a>&lt;U&gt;();</div>
@@ -357,11 +357,11 @@ $(function() { codefold.init(0); });
<div class="ttc" id="anamespacemlx_1_1core_html_a12412984a1cabfe1189942c898f8fe65ad2547f25dffe8d8936dbec25601cfc84"><div class="ttname"><a href="namespacemlx_1_1core.html#a12412984a1cabfe1189942c898f8fe65ad2547f25dffe8d8936dbec25601cfc84">mlx::core::ContiguousReduce</a></div><div class="ttdeci">@ ContiguousReduce</div><div class="ttdef"><b>Definition</b> reduce.h:15</div></div>
<div class="ttc" id="anamespacemlx_1_1core_html_a12412984a1cabfe1189942c898f8fe65ad999b1a8ae1d7436efb5ffdfafb1dd3d"><div class="ttname"><a href="namespacemlx_1_1core.html#a12412984a1cabfe1189942c898f8fe65ad999b1a8ae1d7436efb5ffdfafb1dd3d">mlx::core::GeneralStridedReduce</a></div><div class="ttdeci">@ GeneralStridedReduce</div><div class="ttdef"><b>Definition</b> reduce.h:30</div></div>
<div class="ttc" id="anamespacemlx_1_1core_html_a12412984a1cabfe1189942c898f8fe65ae4e34c7154eb8dc47aa8503209730424"><div class="ttname"><a href="namespacemlx_1_1core.html#a12412984a1cabfe1189942c898f8fe65ae4e34c7154eb8dc47aa8503209730424">mlx::core::ContiguousAllReduce</a></div><div class="ttdeci">@ ContiguousAllReduce</div><div class="ttdef"><b>Definition</b> reduce.h:11</div></div>
<div class="ttc" id="anamespacemlx_1_1core_html_a1555dc378c5254e79199421761f26f2b"><div class="ttname"><a href="namespacemlx_1_1core.html#a1555dc378c5254e79199421761f26f2b">mlx::core::get_reduction_plan</a></div><div class="ttdeci">ReductionPlan get_reduction_plan(const array &amp;x, const std::vector&lt; int &gt; axes)</div></div>
<div class="ttc" id="anamespacemlx_1_1core_html_a44c3ea6db6553c3f6552b9ba64a69494"><div class="ttname"><a href="namespacemlx_1_1core.html#a44c3ea6db6553c3f6552b9ba64a69494">mlx::core::shapes_without_reduction_axes</a></div><div class="ttdeci">std::pair&lt; std::vector&lt; int &gt;, std::vector&lt; size_t &gt; &gt; shapes_without_reduction_axes(const array &amp;x, const std::vector&lt; int &gt; &amp;axes)</div></div>
<div class="ttc" id="anamespacemlx_1_1core_html_a4950c3248e70280b406a4f1430a85880"><div class="ttname"><a href="namespacemlx_1_1core.html#a4950c3248e70280b406a4f1430a85880">mlx::core::elem_to_loc</a></div><div class="ttdeci">stride_t elem_to_loc(int elem, const std::vector&lt; int &gt; &amp;shape, const std::vector&lt; stride_t &gt; &amp;strides)</div><div class="ttdef"><b>Definition</b> utils.h:12</div></div>
<div class="ttc" id="anamespacemlx_1_1core_html_a9a9254ce9975ec247a2718bc02d6f201"><div class="ttname"><a href="namespacemlx_1_1core.html#a9a9254ce9975ec247a2718bc02d6f201">mlx::core::nd_loop</a></div><div class="ttdeci">void nd_loop(std::function&lt; void(int)&gt; callback, const std::vector&lt; int &gt; &amp;shape, const std::vector&lt; size_t &gt; &amp;strides)</div></div>
<div class="ttc" id="anamespacemlx_1_1core_html_aa08ffc1e8f2c58afb2d463496f827ef0"><div class="ttname"><a href="namespacemlx_1_1core.html#aa08ffc1e8f2c58afb2d463496f827ef0">mlx::core::reduction_op</a></div><div class="ttdeci">void reduction_op(const array &amp;x, array &amp;out, const std::vector&lt; int &gt; &amp;axes, U init, OpS ops, OpC opc, Op op)</div><div class="ttdef"><b>Definition</b> reduce.h:98</div></div>
<div class="ttc" id="anamespacemlx_1_1core_html_ac97b5a6f009ca3d99854ce9512c20dba"><div class="ttname"><a href="namespacemlx_1_1core.html#ac97b5a6f009ca3d99854ce9512c20dba">mlx::core::get_reduction_plan</a></div><div class="ttdeci">ReductionPlan get_reduction_plan(const array &amp;x, const std::vector&lt; int &gt; &amp;axes)</div></div>
<div class="ttc" id="astructmlx_1_1core_1_1_default_contiguous_reduce_html"><div class="ttname"><a href="structmlx_1_1core_1_1_default_contiguous_reduce.html">mlx::core::DefaultContiguousReduce</a></div><div class="ttdef"><b>Definition</b> reduce.h:84</div></div>
<div class="ttc" id="astructmlx_1_1core_1_1_default_contiguous_reduce_html_a08144c7a3cdf10af5e47f4575da3694f"><div class="ttname"><a href="structmlx_1_1core_1_1_default_contiguous_reduce.html#a08144c7a3cdf10af5e47f4575da3694f">mlx::core::DefaultContiguousReduce::operator()</a></div><div class="ttdeci">void operator()(const T *x, U *accumulator, int size)</div><div class="ttdef"><b>Definition</b> reduce.h:89</div></div>
<div class="ttc" id="astructmlx_1_1core_1_1_default_contiguous_reduce_html_a1928f07db988715cc177999e386f4830"><div class="ttname"><a href="structmlx_1_1core_1_1_default_contiguous_reduce.html#a1928f07db988715cc177999e386f4830">mlx::core::DefaultContiguousReduce::op</a></div><div class="ttdeci">Op op</div><div class="ttdef"><b>Definition</b> reduce.h:85</div></div>