mirror of
https://github.com/ml-explore/mlx.git
synced 2025-09-19 02:38:09 +08:00
docs up
This commit is contained in:
Awni Hannun
committed by
CircleCI Docs
CircleCI Docs
parent
9da49a07a4
commit
d44f06ae79
51
docs/build/html/distributed_2ops_8h_source.html
vendored
51
docs/build/html/distributed_2ops_8h_source.html
vendored
@@ -90,18 +90,51 @@ $(function() { codefold.init(0); });
|
||||
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include <optional></span></div>
|
||||
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
|
||||
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include "<a class="code" href="distributed_8h.html">mlx/distributed/distributed.h</a>"</span></div>
|
||||
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
|
||||
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacemlx_1_1core_1_1distributed.html">mlx::core::distributed</a> {</div>
|
||||
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
|
||||
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core_1_1distributed.html#ad1c6aa544781765060552cacfa845001"> 11</a></span><a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a> <a class="code hl_function" href="namespacemlx_1_1core_1_1distributed.html#ad1c6aa544781765060552cacfa845001">all_sum</a>(<span class="keyword">const</span> <a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a>& x, std::optional<Group> group = std::nullopt);</div>
|
||||
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core_1_1distributed.html#abf45499dd1209ba7162908f14634d2ba"> 12</a></span><a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a> <a class="code hl_function" href="namespacemlx_1_1core_1_1distributed.html#abf45499dd1209ba7162908f14634d2ba">all_gather</a>(<span class="keyword">const</span> <a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a>& x, std::optional<Group> group = std::nullopt);</div>
|
||||
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
|
||||
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span>} <span class="comment">// namespace mlx::core::distributed</span></div>
|
||||
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include "<a class="code" href="utils_8h.html">mlx/utils.h</a>"</span></div>
|
||||
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
|
||||
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacemlx_1_1core_1_1distributed.html">mlx::core::distributed</a> {</div>
|
||||
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
|
||||
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core_1_1distributed.html#a67ccb1a5445fc6f5db49dd36a15e5980"> 12</a></span><a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a> <a class="code hl_function" href="namespacemlx_1_1core_1_1distributed.html#a67ccb1a5445fc6f5db49dd36a15e5980">all_sum</a>(</div>
|
||||
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> <span class="keyword">const</span> <a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a>& x,</div>
|
||||
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> std::optional<Group> group = std::nullopt,</div>
|
||||
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> <a class="code hl_typedef" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> s = {});</div>
|
||||
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
|
||||
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core_1_1distributed.html#a82ef5e8cc7ac62cd228e51b1c1b77cb7"> 17</a></span><a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a> <a class="code hl_function" href="namespacemlx_1_1core_1_1distributed.html#a82ef5e8cc7ac62cd228e51b1c1b77cb7">all_gather</a>(</div>
|
||||
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">const</span> <a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a>& x,</div>
|
||||
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> std::optional<Group> group = std::nullopt,</div>
|
||||
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <a class="code hl_typedef" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> S = {});</div>
|
||||
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
|
||||
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core_1_1distributed.html#a5a8360edaa3a528a3927fce4d2cf1777"> 22</a></span><a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a> <a class="code hl_function" href="namespacemlx_1_1core_1_1distributed.html#a5a8360edaa3a528a3927fce4d2cf1777">send</a>(</div>
|
||||
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">const</span> <a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a>& x,</div>
|
||||
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <span class="keywordtype">int</span> dst,</div>
|
||||
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> std::optional<Group> group = std::nullopt,</div>
|
||||
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <a class="code hl_typedef" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> s = {});</div>
|
||||
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
|
||||
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core_1_1distributed.html#a10f9d39c02e6e5db600912c03de8b393"> 28</a></span><a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a> <a class="code hl_function" href="namespacemlx_1_1core_1_1distributed.html#a10f9d39c02e6e5db600912c03de8b393">recv</a>(</div>
|
||||
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> std::vector<int> shape,</div>
|
||||
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <a class="code hl_struct" href="structmlx_1_1core_1_1_dtype.html">Dtype</a> dtype,</div>
|
||||
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="keywordtype">int</span> src,</div>
|
||||
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> std::optional<Group> group = std::nullopt,</div>
|
||||
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <a class="code hl_typedef" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> s = {});</div>
|
||||
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
|
||||
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core_1_1distributed.html#a2822b78bce2c679e6ff940b2fca944f0"> 35</a></span><a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a> <a class="code hl_function" href="namespacemlx_1_1core_1_1distributed.html#a2822b78bce2c679e6ff940b2fca944f0">recv_like</a>(</div>
|
||||
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">const</span> <a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a>& x,</div>
|
||||
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keywordtype">int</span> src,</div>
|
||||
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> std::optional<Group> group = std::nullopt,</div>
|
||||
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <a class="code hl_typedef" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> s = {});</div>
|
||||
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
|
||||
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span>} <span class="comment">// namespace mlx::core::distributed</span></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="adistributed_8h_html"><div class="ttname"><a href="distributed_8h.html">distributed.h</a></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_abf45499dd1209ba7162908f14634d2ba"><div class="ttname"><a href="namespacemlx_1_1core_1_1distributed.html#abf45499dd1209ba7162908f14634d2ba">mlx::core::distributed::all_gather</a></div><div class="ttdeci">array all_gather(const array &x, std::optional< Group > group=std::nullopt)</div></div>
|
||||
<div class="ttc" id="anamespacemlx_1_1core_1_1distributed_html_ad1c6aa544781765060552cacfa845001"><div class="ttname"><a href="namespacemlx_1_1core_1_1distributed.html#ad1c6aa544781765060552cacfa845001">mlx::core::distributed::all_sum</a></div><div class="ttdeci">array all_sum(const array &x, std::optional< Group > group=std::nullopt)</div></div>
|
||||
<div class="ttc" id="anamespacemlx_1_1core_1_1distributed_html_a10f9d39c02e6e5db600912c03de8b393"><div class="ttname"><a href="namespacemlx_1_1core_1_1distributed.html#a10f9d39c02e6e5db600912c03de8b393">mlx::core::distributed::recv</a></div><div class="ttdeci">array recv(std::vector< int > shape, Dtype dtype, int src, std::optional< Group > group=std::nullopt, StreamOrDevice s={})</div></div>
|
||||
<div class="ttc" id="anamespacemlx_1_1core_1_1distributed_html_a2822b78bce2c679e6ff940b2fca944f0"><div class="ttname"><a href="namespacemlx_1_1core_1_1distributed.html#a2822b78bce2c679e6ff940b2fca944f0">mlx::core::distributed::recv_like</a></div><div class="ttdeci">array recv_like(const array &x, int src, std::optional< Group > group=std::nullopt, StreamOrDevice s={})</div></div>
|
||||
<div class="ttc" id="anamespacemlx_1_1core_1_1distributed_html_a5a8360edaa3a528a3927fce4d2cf1777"><div class="ttname"><a href="namespacemlx_1_1core_1_1distributed.html#a5a8360edaa3a528a3927fce4d2cf1777">mlx::core::distributed::send</a></div><div class="ttdeci">array send(const array &x, int dst, std::optional< Group > group=std::nullopt, StreamOrDevice s={})</div></div>
|
||||
<div class="ttc" id="anamespacemlx_1_1core_1_1distributed_html_a67ccb1a5445fc6f5db49dd36a15e5980"><div class="ttname"><a href="namespacemlx_1_1core_1_1distributed.html#a67ccb1a5445fc6f5db49dd36a15e5980">mlx::core::distributed::all_sum</a></div><div class="ttdeci">array all_sum(const array &x, std::optional< Group > group=std::nullopt, StreamOrDevice s={})</div></div>
|
||||
<div class="ttc" id="anamespacemlx_1_1core_1_1distributed_html_a82ef5e8cc7ac62cd228e51b1c1b77cb7"><div class="ttname"><a href="namespacemlx_1_1core_1_1distributed.html#a82ef5e8cc7ac62cd228e51b1c1b77cb7">mlx::core::distributed::all_gather</a></div><div class="ttdeci">array all_gather(const array &x, std::optional< Group > group=std::nullopt, StreamOrDevice S={})</div></div>
|
||||
<div class="ttc" id="anamespacemlx_1_1core_html_a95fc1013cc48fbfee0c54310711a5e58"><div class="ttname"><a href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">mlx::core::StreamOrDevice</a></div><div class="ttdeci">std::variant< std::monostate, Stream, Device > StreamOrDevice</div><div class="ttdef"><b>Definition</b> utils.h:14</div></div>
|
||||
<div class="ttc" id="astructmlx_1_1core_1_1_dtype_html"><div class="ttname"><a href="structmlx_1_1core_1_1_dtype.html">mlx::core::Dtype</a></div><div class="ttdef"><b>Definition</b> dtype.h:13</div></div>
|
||||
<div class="ttc" id="autils_8h_html"><div class="ttname"><a href="utils_8h.html">utils.h</a></div></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
|
||||
Reference in New Issue
Block a user