This commit is contained in:
Awni Hannun
2024-09-17 12:06:14 -07:00
committed by CircleCI Docs
parent 9da49a07a4
commit d44f06ae79
739 changed files with 28107 additions and 8524 deletions

View File

@@ -119,32 +119,12 @@ $(function() { codefold.init(0); });
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core_1_1distributed.html#a33633c058c7ec82cca4f237243c6810d"> 51</a></span><a class="code hl_struct" href="structmlx_1_1core_1_1distributed_1_1_group.html">Group</a> <a class="code hl_function" href="namespacemlx_1_1core_1_1distributed.html#a33633c058c7ec82cca4f237243c6810d">init</a>(<span class="keywordtype">bool</span> strict = <span class="keyword">false</span>);</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> </div>
<div class="foldopen" id="foldopen00053" data-start="{" data-end="}">
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core_1_1distributed_1_1detail.html"> 53</a></span><span class="keyword">namespace </span>detail {</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="comment">/* Return the communication stream. */</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core_1_1distributed_1_1detail.html#ac3612edf0e0e18c1e4ba0ce7c6e35cd6"> 56</a></span><a class="code hl_struct" href="structmlx_1_1core_1_1_stream.html">Stream</a> <a class="code hl_function" href="namespacemlx_1_1core_1_1distributed_1_1detail.html#ac3612edf0e0e18c1e4ba0ce7c6e35cd6">communication_stream</a>();</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="comment">/* Perform an all reduce sum operation */</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core_1_1distributed_1_1detail.html#aa1d225b25f7b6426c48c5e35860ee960"> 59</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="namespacemlx_1_1core_1_1distributed_1_1detail.html#aa1d225b25f7b6426c48c5e35860ee960">all_sum</a>(<a class="code hl_struct" href="structmlx_1_1core_1_1distributed_1_1_group.html">Group</a> group, <span class="keyword">const</span> <a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a>&amp; input, <a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a>&amp; output);</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="comment">/* Perform an all reduce sum operation */</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core_1_1distributed_1_1detail.html#aeb5a1726358213bc75756506f7b54d04"> 62</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="namespacemlx_1_1core_1_1distributed_1_1detail.html#aeb5a1726358213bc75756506f7b54d04">all_gather</a>(<a class="code hl_struct" href="structmlx_1_1core_1_1distributed_1_1_group.html">Group</a> group, <span class="keyword">const</span> <a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a>&amp; input, <a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a>&amp; output);</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span>} <span class="comment">// namespace detail</span></div>
</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> </div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span>} <span class="comment">// namespace mlx::core::distributed</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span>} <span class="comment">// namespace mlx::core::distributed</span></div>
</div>
<div class="ttc" id="aarray_8h_html"><div class="ttname"><a href="array_8h.html">array.h</a></div></div>
<div class="ttc" id="aclassmlx_1_1core_1_1array_html"><div class="ttname"><a href="classmlx_1_1core_1_1array.html">mlx::core::array</a></div><div class="ttdef"><b>Definition</b> array.h:20</div></div>
<div class="ttc" id="anamespacemlx_1_1core_1_1distributed_1_1detail_html_aa1d225b25f7b6426c48c5e35860ee960"><div class="ttname"><a href="namespacemlx_1_1core_1_1distributed_1_1detail.html#aa1d225b25f7b6426c48c5e35860ee960">mlx::core::distributed::detail::all_sum</a></div><div class="ttdeci">void all_sum(Group group, const array &amp;input, array &amp;output)</div></div>
<div class="ttc" id="anamespacemlx_1_1core_1_1distributed_1_1detail_html_ac3612edf0e0e18c1e4ba0ce7c6e35cd6"><div class="ttname"><a href="namespacemlx_1_1core_1_1distributed_1_1detail.html#ac3612edf0e0e18c1e4ba0ce7c6e35cd6">mlx::core::distributed::detail::communication_stream</a></div><div class="ttdeci">Stream communication_stream()</div></div>
<div class="ttc" id="anamespacemlx_1_1core_1_1distributed_1_1detail_html_aeb5a1726358213bc75756506f7b54d04"><div class="ttname"><a href="namespacemlx_1_1core_1_1distributed_1_1detail.html#aeb5a1726358213bc75756506f7b54d04">mlx::core::distributed::detail::all_gather</a></div><div class="ttdeci">void all_gather(Group group, const array &amp;input, array &amp;output)</div></div>
<div class="ttc" id="anamespacemlx_1_1core_1_1distributed_html"><div class="ttname"><a href="namespacemlx_1_1core_1_1distributed.html">mlx::core::distributed</a></div><div class="ttdef"><b>Definition</b> distributed.h:9</div></div>
<div class="ttc" id="anamespacemlx_1_1core_1_1distributed_html_a33633c058c7ec82cca4f237243c6810d"><div class="ttname"><a href="namespacemlx_1_1core_1_1distributed.html#a33633c058c7ec82cca4f237243c6810d">mlx::core::distributed::init</a></div><div class="ttdeci">Group init(bool strict=false)</div><div class="ttdoc">Initialize the distributed backend and return the group containing all discoverable processes.</div></div>
<div class="ttc" id="anamespacemlx_1_1core_1_1distributed_html_a95655473cd0032c06e5fe3fca85aeef3"><div class="ttname"><a href="namespacemlx_1_1core_1_1distributed.html#a95655473cd0032c06e5fe3fca85aeef3">mlx::core::distributed::is_available</a></div><div class="ttdeci">bool is_available()</div></div>
<div class="ttc" id="astructmlx_1_1core_1_1_stream_html"><div class="ttname"><a href="structmlx_1_1core_1_1_stream.html">mlx::core::Stream</a></div><div class="ttdef"><b>Definition</b> stream.h:9</div></div>
<div class="ttc" id="astructmlx_1_1core_1_1distributed_1_1_group_html"><div class="ttname"><a href="structmlx_1_1core_1_1distributed_1_1_group.html">mlx::core::distributed::Group</a></div><div class="ttdoc">A distributed::Group represents a group of independent mlx processes that can communicate.</div><div class="ttdef"><b>Definition</b> distributed.h:19</div></div>
<div class="ttc" id="astructmlx_1_1core_1_1distributed_1_1_group_html_a3285b94851cf145a2a472f60b7f7ca36"><div class="ttname"><a href="structmlx_1_1core_1_1distributed_1_1_group.html#a3285b94851cf145a2a472f60b7f7ca36">mlx::core::distributed::Group::raw_group</a></div><div class="ttdeci">const std::shared_ptr&lt; void &gt; &amp; raw_group()</div><div class="ttdef"><b>Definition</b> distributed.h:35</div></div>
<div class="ttc" id="astructmlx_1_1core_1_1distributed_1_1_group_html_a6f84accc8d6734989b2757bf6cdd0152"><div class="ttname"><a href="structmlx_1_1core_1_1distributed_1_1_group.html#a6f84accc8d6734989b2757bf6cdd0152">mlx::core::distributed::Group::Group</a></div><div class="ttdeci">Group(std::shared_ptr&lt; void &gt; group)</div><div class="ttdef"><b>Definition</b> distributed.h:20</div></div>