mirror of
				https://github.com/ml-explore/mlx.git
				synced 2025-11-04 02:28:13 +08:00 
			
		
		
		
	
		
			
				
	
	
		
			240 lines
		
	
	
		
			39 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
			
		
		
	
	
			240 lines
		
	
	
		
			39 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 | 
						|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
 | 
						|
<head>
 | 
						|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 | 
						|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
 | 
						|
<meta name="generator" content="Doxygen 1.10.0"/>
 | 
						|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
 | 
						|
<title>MLX: mlx/distributed/primitives.h Source File</title>
 | 
						|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
 | 
						|
<script type="text/javascript" src="jquery.js"></script>
 | 
						|
<script type="text/javascript" src="dynsections.js"></script>
 | 
						|
<script type="text/javascript" src="clipboard.js"></script>
 | 
						|
<script type="text/javascript" src="cookie.js"></script>
 | 
						|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
 | 
						|
<script type="text/javascript" src="search/searchdata.js"></script>
 | 
						|
<script type="text/javascript" src="search/search.js"></script>
 | 
						|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
 | 
						|
</head>
 | 
						|
<body>
 | 
						|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
 | 
						|
<div id="titlearea">
 | 
						|
<table cellspacing="0" cellpadding="0">
 | 
						|
 <tbody>
 | 
						|
 <tr id="projectrow">
 | 
						|
  <td id="projectalign">
 | 
						|
   <div id="projectname">MLX
 | 
						|
   </div>
 | 
						|
  </td>
 | 
						|
 </tr>
 | 
						|
 </tbody>
 | 
						|
</table>
 | 
						|
</div>
 | 
						|
<!-- end header part -->
 | 
						|
<!-- Generated by Doxygen 1.10.0 -->
 | 
						|
<script type="text/javascript">
 | 
						|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
 | 
						|
var searchBox = new SearchBox("searchBox", "search/",'.html');
 | 
						|
/* @license-end */
 | 
						|
</script>
 | 
						|
<script type="text/javascript" src="menudata.js"></script>
 | 
						|
<script type="text/javascript" src="menu.js"></script>
 | 
						|
<script type="text/javascript">
 | 
						|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
 | 
						|
$(function() {
 | 
						|
  initMenu('',true,false,'search.php','Search');
 | 
						|
  $(function() { init_search(); });
 | 
						|
});
 | 
						|
/* @license-end */
 | 
						|
</script>
 | 
						|
<div id="main-nav"></div>
 | 
						|
<script type="text/javascript">
 | 
						|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
 | 
						|
$(function() { codefold.init(0); });
 | 
						|
/* @license-end */
 | 
						|
</script>
 | 
						|
<!-- window showing the filter options -->
 | 
						|
<div id="MSearchSelectWindow"
 | 
						|
     onmouseover="return searchBox.OnSearchSelectShow()"
 | 
						|
     onmouseout="return searchBox.OnSearchSelectHide()"
 | 
						|
     onkeydown="return searchBox.OnSearchSelectKey(event)">
 | 
						|
</div>
 | 
						|
 | 
						|
<!-- iframe showing the search results (closed by default) -->
 | 
						|
<div id="MSearchResultsWindow">
 | 
						|
<div id="MSearchResults">
 | 
						|
<div class="SRPage">
 | 
						|
<div id="SRIndex">
 | 
						|
<div id="SRResults"></div>
 | 
						|
<div class="SRStatus" id="Loading">Loading...</div>
 | 
						|
<div class="SRStatus" id="Searching">Searching...</div>
 | 
						|
<div class="SRStatus" id="NoMatches">No Matches</div>
 | 
						|
</div>
 | 
						|
</div>
 | 
						|
</div>
 | 
						|
</div>
 | 
						|
 | 
						|
<div id="nav-path" class="navpath">
 | 
						|
  <ul>
 | 
						|
<li class="navelem"><a class="el" href="dir_938ab0ecf10b8b860ff766c820f665fd.html">mlx</a></li><li class="navelem"><a class="el" href="dir_23833761034051b43bb6c170b56e2cce.html">distributed</a></li>  </ul>
 | 
						|
</div>
 | 
						|
</div><!-- top -->
 | 
						|
<div class="header">
 | 
						|
  <div class="headertitle"><div class="title">primitives.h</div></div>
 | 
						|
</div><!--header-->
 | 
						|
<div class="contents">
 | 
						|
<a href="distributed_2primitives_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">// Copyright © 2024 Apple Inc.</span></div>
 | 
						|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span> </div>
 | 
						|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="preprocessor">#pragma once</span></div>
 | 
						|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span> </div>
 | 
						|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="preprocessor">#include "<a class="code" href="distributed_8h.html">mlx/distributed/distributed.h</a>"</span></div>
 | 
						|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="preprocessor">#include "<a class="code" href="primitives_8h.html">mlx/primitives.h</a>"</span></div>
 | 
						|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span> </div>
 | 
						|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</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="l00009" name="l00009"></a><span class="lineno">    9</span> </div>
 | 
						|
<div class="foldopen" id="foldopen00010" data-start="{" data-end="};">
 | 
						|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"><a class="line" href="classmlx_1_1core_1_1distributed_1_1_dist_primitive.html">   10</a></span><span class="keyword">class </span><a class="code hl_class" href="classmlx_1_1core_1_1distributed_1_1_dist_primitive.html">DistPrimitive</a> : <span class="keyword">public</span> <a class="code hl_class" href="classmlx_1_1core_1_1_primitive.html">Primitive</a> {</div>
 | 
						|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span> <span class="keyword">public</span>:</div>
 | 
						|
<div class="foldopen" id="foldopen00012" data-start="{" data-end="}">
 | 
						|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="classmlx_1_1core_1_1distributed_1_1_dist_primitive.html#a9e4b0b92776aca0c1331450ae4955cef">   12</a></span>  <a class="code hl_function" href="classmlx_1_1core_1_1distributed_1_1_dist_primitive.html#a9e4b0b92776aca0c1331450ae4955cef">DistPrimitive</a>(<a class="code hl_struct" href="structmlx_1_1core_1_1distributed_1_1_group.html">Group</a> <a class="code hl_function" href="classmlx_1_1core_1_1distributed_1_1_dist_primitive.html#a8831cb61ac633431b78b5fb99c0ea9ff">group</a>)</div>
 | 
						|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span>      : <a class="code hl_class" href="classmlx_1_1core_1_1_primitive.html">Primitive</a>(detail::communication_stream()), group_(<a class="code hl_function" href="classmlx_1_1core_1_1distributed_1_1_dist_primitive.html#a8831cb61ac633431b78b5fb99c0ea9ff">group</a>) {}</div>
 | 
						|
</div>
 | 
						|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span> </div>
 | 
						|
<div class="foldopen" id="foldopen00015" data-start="{" data-end="}">
 | 
						|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="classmlx_1_1core_1_1distributed_1_1_dist_primitive.html#a611ac8dfd9b4f49617ee8976ff3e15e9">   15</a></span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classmlx_1_1core_1_1distributed_1_1_dist_primitive.html#a611ac8dfd9b4f49617ee8976ff3e15e9">eval_gpu</a>(<span class="keyword">const</span> std::vector<array>& inputs, std::vector<array>& outputs)<span class="keyword"></span></div>
 | 
						|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="keyword">      override </span>{</div>
 | 
						|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span>    <span class="keywordflow">throw</span> std::runtime_error(</div>
 | 
						|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span>        <span class="stringliteral">"Communication primitives cannot be run on the GPU"</span>);</div>
 | 
						|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span>  }</div>
 | 
						|
</div>
 | 
						|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span> </div>
 | 
						|
<div class="foldopen" id="foldopen00021" data-start="{" data-end="}">
 | 
						|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="classmlx_1_1core_1_1distributed_1_1_dist_primitive.html#a8831cb61ac633431b78b5fb99c0ea9ff">   21</a></span>  <span class="keyword">const</span> <a class="code hl_struct" href="structmlx_1_1core_1_1distributed_1_1_group.html">Group</a>& <a class="code hl_function" href="classmlx_1_1core_1_1distributed_1_1_dist_primitive.html#a8831cb61ac633431b78b5fb99c0ea9ff">group</a>()<span class="keyword"> const </span>{</div>
 | 
						|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span>    <span class="keywordflow">return</span> group_;</div>
 | 
						|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span>  }</div>
 | 
						|
</div>
 | 
						|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span> </div>
 | 
						|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span> <span class="keyword">private</span>:</div>
 | 
						|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span>  <a class="code hl_struct" href="structmlx_1_1core_1_1distributed_1_1_group.html">Group</a> group_;</div>
 | 
						|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span>};</div>
 | 
						|
</div>
 | 
						|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span> </div>
 | 
						|
<div class="foldopen" id="foldopen00029" data-start="{" data-end="};">
 | 
						|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html">   29</a></span><span class="keyword">class </span><a class="code hl_class" href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html">AllReduce</a> : <span class="keyword">public</span> <a class="code hl_class" href="classmlx_1_1core_1_1distributed_1_1_dist_primitive.html">DistPrimitive</a> {</div>
 | 
						|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span> <span class="keyword">public</span>:</div>
 | 
						|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#abb4560980e5d01aed14175ce8f6fc924aba3b7fb927f6b6c8b198a9cdc3dd9e02">   31</a></span>  <span class="keyword">enum</span> <a class="code hl_enumeration" href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#abb4560980e5d01aed14175ce8f6fc924">ReduceType</a> { <a class="code hl_enumvalue" href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#abb4560980e5d01aed14175ce8f6fc924aba3b7fb927f6b6c8b198a9cdc3dd9e02">And</a>, <a class="code hl_enumvalue" href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#abb4560980e5d01aed14175ce8f6fc924a7a959bb7b33f410a03b3c887173fd7ed">Or</a>, <a class="code hl_enumvalue" href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#abb4560980e5d01aed14175ce8f6fc924a1fc7c1f09c80650ab0497e2d6781d65f">Sum</a>, <a class="code hl_enumvalue" href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#abb4560980e5d01aed14175ce8f6fc924acdd1ec09a2fd99c81c561b5c63a4b482">Prod</a>, <a class="code hl_enumvalue" href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#abb4560980e5d01aed14175ce8f6fc924a4f685dcd48e6614d6bb2ccda4f2686ef">Min</a>, <a class="code hl_struct" href="struct_max.html">Max</a> };</div>
 | 
						|
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span> </div>
 | 
						|
<div class="foldopen" id="foldopen00033" data-start="{" data-end="}">
 | 
						|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#a936b320f7b0a435f96e018c25f35e7ed">   33</a></span>  <a class="code hl_function" href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#a936b320f7b0a435f96e018c25f35e7ed">AllReduce</a>(<a class="code hl_struct" href="structmlx_1_1core_1_1distributed_1_1_group.html">Group</a> <a class="code hl_function" href="classmlx_1_1core_1_1distributed_1_1_dist_primitive.html#a8831cb61ac633431b78b5fb99c0ea9ff">group</a>, <a class="code hl_enumeration" href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#abb4560980e5d01aed14175ce8f6fc924">ReduceType</a> reduce_type)</div>
 | 
						|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span>      : <a class="code hl_class" href="classmlx_1_1core_1_1distributed_1_1_dist_primitive.html">DistPrimitive</a>(<a class="code hl_function" href="classmlx_1_1core_1_1distributed_1_1_dist_primitive.html#a8831cb61ac633431b78b5fb99c0ea9ff">group</a>), reduce_type_(reduce_type) {}</div>
 | 
						|
</div>
 | 
						|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span> </div>
 | 
						|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#acdc1965ad64ee9ee6328fe150a97902e">   36</a></span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#acdc1965ad64ee9ee6328fe150a97902e">eval_cpu</a>(<span class="keyword">const</span> std::vector<array>& inputs, std::vector<array>& outputs)</div>
 | 
						|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span>      <span class="keyword">override</span>;</div>
 | 
						|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#a3f2dc71859847ca675ec4bfbe125035a">   38</a></span>  std::pair<std::vector<array>, std::vector<int>> <a class="code hl_function" href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#a3f2dc71859847ca675ec4bfbe125035a">vmap</a>(</div>
 | 
						|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span>      <span class="keyword">const</span> std::vector<array>& inputs,</div>
 | 
						|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span>      <span class="keyword">const</span> std::vector<int>& axes) <span class="keyword">override</span>;</div>
 | 
						|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#aeaf6f2b5955e7417cd1e36db42c45a80">   41</a></span>  std::vector<array> <a class="code hl_function" href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#aeaf6f2b5955e7417cd1e36db42c45a80">jvp</a>(</div>
 | 
						|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span>      <span class="keyword">const</span> std::vector<array>& primals,</div>
 | 
						|
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span>      <span class="keyword">const</span> std::vector<array>& tangents,</div>
 | 
						|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span>      <span class="keyword">const</span> std::vector<int>& argnums) <span class="keyword">override</span>;</div>
 | 
						|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#abbf6d1d63dcda207ad7d9eeb4fc36225">   45</a></span>  std::vector<array> <a class="code hl_function" href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#abbf6d1d63dcda207ad7d9eeb4fc36225">vjp</a>(</div>
 | 
						|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span>      <span class="keyword">const</span> std::vector<array>& primals,</div>
 | 
						|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span>      <span class="keyword">const</span> std::vector<array>& cotangents,</div>
 | 
						|
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span>      <span class="keyword">const</span> std::vector<int>& argnums,</div>
 | 
						|
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span>      <span class="keyword">const</span> std::vector<array>& outputs) <span class="keyword">override</span>;</div>
 | 
						|
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span> </div>
 | 
						|
<div class="foldopen" id="foldopen00051" data-start="{" data-end="}">
 | 
						|
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#a6814f9008a683c6911d5b8991ef770ab">   51</a></span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#a6814f9008a683c6911d5b8991ef770ab">print</a>(std::ostream& os)<span class="keyword"> override </span>{</div>
 | 
						|
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span>    <span class="keywordflow">switch</span> (reduce_type_) {</div>
 | 
						|
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span>      <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#abb4560980e5d01aed14175ce8f6fc924aba3b7fb927f6b6c8b198a9cdc3dd9e02">And</a>:</div>
 | 
						|
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span>        os << <span class="stringliteral">"And"</span>;</div>
 | 
						|
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span>      <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#abb4560980e5d01aed14175ce8f6fc924a7a959bb7b33f410a03b3c887173fd7ed">Or</a>:</div>
 | 
						|
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span>        os << <span class="stringliteral">"And"</span>;</div>
 | 
						|
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span>        <span class="keywordflow">break</span>;</div>
 | 
						|
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span>      <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#abb4560980e5d01aed14175ce8f6fc924a1fc7c1f09c80650ab0497e2d6781d65f">Sum</a>:</div>
 | 
						|
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span>        os << <span class="stringliteral">"Sum"</span>;</div>
 | 
						|
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span>        <span class="keywordflow">break</span>;</div>
 | 
						|
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span>      <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#abb4560980e5d01aed14175ce8f6fc924acdd1ec09a2fd99c81c561b5c63a4b482">Prod</a>:</div>
 | 
						|
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span>        os << <span class="stringliteral">"Prod"</span>;</div>
 | 
						|
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span>        <span class="keywordflow">break</span>;</div>
 | 
						|
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span>      <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#abb4560980e5d01aed14175ce8f6fc924a4f685dcd48e6614d6bb2ccda4f2686ef">Min</a>:</div>
 | 
						|
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span>        os << <span class="stringliteral">"Min"</span>;</div>
 | 
						|
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span>        <span class="keywordflow">break</span>;</div>
 | 
						|
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span>      <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#abb4560980e5d01aed14175ce8f6fc924ac00cf69bbba24f7ab08d3ad618705988">Max</a>:</div>
 | 
						|
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span>        os << <span class="stringliteral">"Max"</span>;</div>
 | 
						|
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span>        <span class="keywordflow">break</span>;</div>
 | 
						|
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span>    }</div>
 | 
						|
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span>    os << <span class="stringliteral">" AllReduce"</span>;</div>
 | 
						|
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span>  }</div>
 | 
						|
</div>
 | 
						|
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span> </div>
 | 
						|
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span> <span class="keyword">private</span>:</div>
 | 
						|
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span>  <a class="code hl_enumeration" href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#abb4560980e5d01aed14175ce8f6fc924">ReduceType</a> reduce_type_;</div>
 | 
						|
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span>};</div>
 | 
						|
</div>
 | 
						|
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span> </div>
 | 
						|
<div class="foldopen" id="foldopen00078" data-start="{" data-end="};">
 | 
						|
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"><a class="line" href="classmlx_1_1core_1_1distributed_1_1_all_gather.html">   78</a></span><span class="keyword">class </span><a class="code hl_class" href="classmlx_1_1core_1_1distributed_1_1_all_gather.html">AllGather</a> : <span class="keyword">public</span> <a class="code hl_class" href="classmlx_1_1core_1_1distributed_1_1_dist_primitive.html">DistPrimitive</a> {</div>
 | 
						|
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span> <span class="keyword">public</span>:</div>
 | 
						|
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"><a class="line" href="classmlx_1_1core_1_1distributed_1_1_all_gather.html#ac9d0f1ba0d9602fa22e8f2b60f1231e0">   80</a></span>  <a class="code hl_function" href="classmlx_1_1core_1_1distributed_1_1_all_gather.html#ac9d0f1ba0d9602fa22e8f2b60f1231e0">AllGather</a>(<a class="code hl_struct" href="structmlx_1_1core_1_1distributed_1_1_group.html">Group</a> <a class="code hl_function" href="classmlx_1_1core_1_1distributed_1_1_dist_primitive.html#a8831cb61ac633431b78b5fb99c0ea9ff">group</a>) : <a class="code hl_class" href="classmlx_1_1core_1_1distributed_1_1_dist_primitive.html">DistPrimitive</a>(<a class="code hl_function" href="classmlx_1_1core_1_1distributed_1_1_dist_primitive.html#a8831cb61ac633431b78b5fb99c0ea9ff">group</a>) {}</div>
 | 
						|
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span> </div>
 | 
						|
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"><a class="line" href="classmlx_1_1core_1_1distributed_1_1_all_gather.html#ab721fe0072fffbddbc3c4334dd033ba5">   82</a></span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classmlx_1_1core_1_1distributed_1_1_all_gather.html#ab721fe0072fffbddbc3c4334dd033ba5">eval_cpu</a>(<span class="keyword">const</span> std::vector<array>& inputs, std::vector<array>& outputs)</div>
 | 
						|
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span>      <span class="keyword">override</span>;</div>
 | 
						|
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"><a class="line" href="classmlx_1_1core_1_1distributed_1_1_all_gather.html#ad532d1d51f089dec3c84799b724ea031">   84</a></span>  std::pair<std::vector<array>, std::vector<int>> <a class="code hl_function" href="classmlx_1_1core_1_1distributed_1_1_all_gather.html#ad532d1d51f089dec3c84799b724ea031">vmap</a>(</div>
 | 
						|
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span>      <span class="keyword">const</span> std::vector<array>& inputs,</div>
 | 
						|
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span>      <span class="keyword">const</span> std::vector<int>& axes) <span class="keyword">override</span>;</div>
 | 
						|
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"><a class="line" href="classmlx_1_1core_1_1distributed_1_1_all_gather.html#a96f08a4ea8453d0b4b737c7b07972913">   87</a></span>  std::vector<array> <a class="code hl_function" href="classmlx_1_1core_1_1distributed_1_1_all_gather.html#a96f08a4ea8453d0b4b737c7b07972913">jvp</a>(</div>
 | 
						|
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span>      <span class="keyword">const</span> std::vector<array>& primals,</div>
 | 
						|
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span>      <span class="keyword">const</span> std::vector<array>& tangents,</div>
 | 
						|
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span>      <span class="keyword">const</span> std::vector<int>& argnums) <span class="keyword">override</span>;</div>
 | 
						|
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"><a class="line" href="classmlx_1_1core_1_1distributed_1_1_all_gather.html#aa5eff6fc128b71220899aab8ab9116fb">   91</a></span>  std::vector<array> <a class="code hl_function" href="classmlx_1_1core_1_1distributed_1_1_all_gather.html#aa5eff6fc128b71220899aab8ab9116fb">vjp</a>(</div>
 | 
						|
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span>      <span class="keyword">const</span> std::vector<array>& primals,</div>
 | 
						|
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span>      <span class="keyword">const</span> std::vector<array>& cotangents,</div>
 | 
						|
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span>      <span class="keyword">const</span> std::vector<int>& argnums,</div>
 | 
						|
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span>      <span class="keyword">const</span> std::vector<array>& outputs) <span class="keyword">override</span>;</div>
 | 
						|
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span> </div>
 | 
						|
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"><a class="line" href="classmlx_1_1core_1_1distributed_1_1_all_gather.html#a8af1e90d4aa56f31ec40ad152ebd2421">   97</a></span>  <a class="code hl_function" href="classmlx_1_1core_1_1distributed_1_1_all_gather.html#a8af1e90d4aa56f31ec40ad152ebd2421">DEFINE_PRINT</a>(<a class="code hl_class" href="classmlx_1_1core_1_1distributed_1_1_all_gather.html">AllGather</a>);</div>
 | 
						|
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span>};</div>
 | 
						|
</div>
 | 
						|
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span> </div>
 | 
						|
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span>} <span class="comment">// namespace mlx::core::distributed</span></div>
 | 
						|
<div class="ttc" id="aclassmlx_1_1core_1_1_primitive_html"><div class="ttname"><a href="classmlx_1_1core_1_1_primitive.html">mlx::core::Primitive</a></div><div class="ttdef"><b>Definition</b> primitives.h:48</div></div>
 | 
						|
<div class="ttc" id="aclassmlx_1_1core_1_1distributed_1_1_all_gather_html"><div class="ttname"><a href="classmlx_1_1core_1_1distributed_1_1_all_gather.html">mlx::core::distributed::AllGather</a></div><div class="ttdef"><b>Definition</b> primitives.h:78</div></div>
 | 
						|
<div class="ttc" id="aclassmlx_1_1core_1_1distributed_1_1_all_gather_html_a8af1e90d4aa56f31ec40ad152ebd2421"><div class="ttname"><a href="classmlx_1_1core_1_1distributed_1_1_all_gather.html#a8af1e90d4aa56f31ec40ad152ebd2421">mlx::core::distributed::AllGather::DEFINE_PRINT</a></div><div class="ttdeci">DEFINE_PRINT(AllGather)</div></div>
 | 
						|
<div class="ttc" id="aclassmlx_1_1core_1_1distributed_1_1_all_gather_html_a96f08a4ea8453d0b4b737c7b07972913"><div class="ttname"><a href="classmlx_1_1core_1_1distributed_1_1_all_gather.html#a96f08a4ea8453d0b4b737c7b07972913">mlx::core::distributed::AllGather::jvp</a></div><div class="ttdeci">std::vector< array > jvp(const std::vector< array > &primals, const std::vector< array > &tangents, const std::vector< int > &argnums) override</div><div class="ttdoc">The Jacobian-vector product.</div></div>
 | 
						|
<div class="ttc" id="aclassmlx_1_1core_1_1distributed_1_1_all_gather_html_aa5eff6fc128b71220899aab8ab9116fb"><div class="ttname"><a href="classmlx_1_1core_1_1distributed_1_1_all_gather.html#aa5eff6fc128b71220899aab8ab9116fb">mlx::core::distributed::AllGather::vjp</a></div><div class="ttdeci">std::vector< array > vjp(const std::vector< array > &primals, const std::vector< array > &cotangents, const std::vector< int > &argnums, const std::vector< array > &outputs) override</div><div class="ttdoc">The vector-Jacobian product.</div></div>
 | 
						|
<div class="ttc" id="aclassmlx_1_1core_1_1distributed_1_1_all_gather_html_ab721fe0072fffbddbc3c4334dd033ba5"><div class="ttname"><a href="classmlx_1_1core_1_1distributed_1_1_all_gather.html#ab721fe0072fffbddbc3c4334dd033ba5">mlx::core::distributed::AllGather::eval_cpu</a></div><div class="ttdeci">void eval_cpu(const std::vector< array > &inputs, std::vector< array > &outputs) override</div><div class="ttdoc">A primitive must know how to evaluate itself on the CPU/GPU for the given inputs and populate the out...</div></div>
 | 
						|
<div class="ttc" id="aclassmlx_1_1core_1_1distributed_1_1_all_gather_html_ac9d0f1ba0d9602fa22e8f2b60f1231e0"><div class="ttname"><a href="classmlx_1_1core_1_1distributed_1_1_all_gather.html#ac9d0f1ba0d9602fa22e8f2b60f1231e0">mlx::core::distributed::AllGather::AllGather</a></div><div class="ttdeci">AllGather(Group group)</div><div class="ttdef"><b>Definition</b> primitives.h:80</div></div>
 | 
						|
<div class="ttc" id="aclassmlx_1_1core_1_1distributed_1_1_all_gather_html_ad532d1d51f089dec3c84799b724ea031"><div class="ttname"><a href="classmlx_1_1core_1_1distributed_1_1_all_gather.html#ad532d1d51f089dec3c84799b724ea031">mlx::core::distributed::AllGather::vmap</a></div><div class="ttdeci">std::pair< std::vector< array >, std::vector< int > > vmap(const std::vector< array > &inputs, const std::vector< int > &axes) override</div><div class="ttdoc">The primitive must know how to vectorize itself across the given axes.</div></div>
 | 
						|
<div class="ttc" id="aclassmlx_1_1core_1_1distributed_1_1_all_reduce_html"><div class="ttname"><a href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html">mlx::core::distributed::AllReduce</a></div><div class="ttdef"><b>Definition</b> primitives.h:29</div></div>
 | 
						|
<div class="ttc" id="aclassmlx_1_1core_1_1distributed_1_1_all_reduce_html_a3f2dc71859847ca675ec4bfbe125035a"><div class="ttname"><a href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#a3f2dc71859847ca675ec4bfbe125035a">mlx::core::distributed::AllReduce::vmap</a></div><div class="ttdeci">std::pair< std::vector< array >, std::vector< int > > vmap(const std::vector< array > &inputs, const std::vector< int > &axes) override</div><div class="ttdoc">The primitive must know how to vectorize itself across the given axes.</div></div>
 | 
						|
<div class="ttc" id="aclassmlx_1_1core_1_1distributed_1_1_all_reduce_html_a6814f9008a683c6911d5b8991ef770ab"><div class="ttname"><a href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#a6814f9008a683c6911d5b8991ef770ab">mlx::core::distributed::AllReduce::print</a></div><div class="ttdeci">void print(std::ostream &os) override</div><div class="ttdoc">Print the primitive.</div><div class="ttdef"><b>Definition</b> primitives.h:51</div></div>
 | 
						|
<div class="ttc" id="aclassmlx_1_1core_1_1distributed_1_1_all_reduce_html_a936b320f7b0a435f96e018c25f35e7ed"><div class="ttname"><a href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#a936b320f7b0a435f96e018c25f35e7ed">mlx::core::distributed::AllReduce::AllReduce</a></div><div class="ttdeci">AllReduce(Group group, ReduceType reduce_type)</div><div class="ttdef"><b>Definition</b> primitives.h:33</div></div>
 | 
						|
<div class="ttc" id="aclassmlx_1_1core_1_1distributed_1_1_all_reduce_html_abb4560980e5d01aed14175ce8f6fc924"><div class="ttname"><a href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#abb4560980e5d01aed14175ce8f6fc924">mlx::core::distributed::AllReduce::ReduceType</a></div><div class="ttdeci">ReduceType</div><div class="ttdef"><b>Definition</b> primitives.h:31</div></div>
 | 
						|
<div class="ttc" id="aclassmlx_1_1core_1_1distributed_1_1_all_reduce_html_abb4560980e5d01aed14175ce8f6fc924a1fc7c1f09c80650ab0497e2d6781d65f"><div class="ttname"><a href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#abb4560980e5d01aed14175ce8f6fc924a1fc7c1f09c80650ab0497e2d6781d65f">mlx::core::distributed::AllReduce::Sum</a></div><div class="ttdeci">@ Sum</div><div class="ttdef"><b>Definition</b> primitives.h:31</div></div>
 | 
						|
<div class="ttc" id="aclassmlx_1_1core_1_1distributed_1_1_all_reduce_html_abb4560980e5d01aed14175ce8f6fc924a4f685dcd48e6614d6bb2ccda4f2686ef"><div class="ttname"><a href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#abb4560980e5d01aed14175ce8f6fc924a4f685dcd48e6614d6bb2ccda4f2686ef">mlx::core::distributed::AllReduce::Min</a></div><div class="ttdeci">@ Min</div><div class="ttdef"><b>Definition</b> primitives.h:31</div></div>
 | 
						|
<div class="ttc" id="aclassmlx_1_1core_1_1distributed_1_1_all_reduce_html_abb4560980e5d01aed14175ce8f6fc924a7a959bb7b33f410a03b3c887173fd7ed"><div class="ttname"><a href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#abb4560980e5d01aed14175ce8f6fc924a7a959bb7b33f410a03b3c887173fd7ed">mlx::core::distributed::AllReduce::Or</a></div><div class="ttdeci">@ Or</div><div class="ttdef"><b>Definition</b> primitives.h:31</div></div>
 | 
						|
<div class="ttc" id="aclassmlx_1_1core_1_1distributed_1_1_all_reduce_html_abb4560980e5d01aed14175ce8f6fc924aba3b7fb927f6b6c8b198a9cdc3dd9e02"><div class="ttname"><a href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#abb4560980e5d01aed14175ce8f6fc924aba3b7fb927f6b6c8b198a9cdc3dd9e02">mlx::core::distributed::AllReduce::And</a></div><div class="ttdeci">@ And</div><div class="ttdef"><b>Definition</b> primitives.h:31</div></div>
 | 
						|
<div class="ttc" id="aclassmlx_1_1core_1_1distributed_1_1_all_reduce_html_abb4560980e5d01aed14175ce8f6fc924ac00cf69bbba24f7ab08d3ad618705988"><div class="ttname"><a href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#abb4560980e5d01aed14175ce8f6fc924ac00cf69bbba24f7ab08d3ad618705988">mlx::core::distributed::AllReduce::Max</a></div><div class="ttdeci">@ Max</div><div class="ttdef"><b>Definition</b> primitives.h:31</div></div>
 | 
						|
<div class="ttc" id="aclassmlx_1_1core_1_1distributed_1_1_all_reduce_html_abb4560980e5d01aed14175ce8f6fc924acdd1ec09a2fd99c81c561b5c63a4b482"><div class="ttname"><a href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#abb4560980e5d01aed14175ce8f6fc924acdd1ec09a2fd99c81c561b5c63a4b482">mlx::core::distributed::AllReduce::Prod</a></div><div class="ttdeci">@ Prod</div><div class="ttdef"><b>Definition</b> primitives.h:31</div></div>
 | 
						|
<div class="ttc" id="aclassmlx_1_1core_1_1distributed_1_1_all_reduce_html_abbf6d1d63dcda207ad7d9eeb4fc36225"><div class="ttname"><a href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#abbf6d1d63dcda207ad7d9eeb4fc36225">mlx::core::distributed::AllReduce::vjp</a></div><div class="ttdeci">std::vector< array > vjp(const std::vector< array > &primals, const std::vector< array > &cotangents, const std::vector< int > &argnums, const std::vector< array > &outputs) override</div><div class="ttdoc">The vector-Jacobian product.</div></div>
 | 
						|
<div class="ttc" id="aclassmlx_1_1core_1_1distributed_1_1_all_reduce_html_acdc1965ad64ee9ee6328fe150a97902e"><div class="ttname"><a href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#acdc1965ad64ee9ee6328fe150a97902e">mlx::core::distributed::AllReduce::eval_cpu</a></div><div class="ttdeci">void eval_cpu(const std::vector< array > &inputs, std::vector< array > &outputs) override</div><div class="ttdoc">A primitive must know how to evaluate itself on the CPU/GPU for the given inputs and populate the out...</div></div>
 | 
						|
<div class="ttc" id="aclassmlx_1_1core_1_1distributed_1_1_all_reduce_html_aeaf6f2b5955e7417cd1e36db42c45a80"><div class="ttname"><a href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#aeaf6f2b5955e7417cd1e36db42c45a80">mlx::core::distributed::AllReduce::jvp</a></div><div class="ttdeci">std::vector< array > jvp(const std::vector< array > &primals, const std::vector< array > &tangents, const std::vector< int > &argnums) override</div><div class="ttdoc">The Jacobian-vector product.</div></div>
 | 
						|
<div class="ttc" id="aclassmlx_1_1core_1_1distributed_1_1_dist_primitive_html"><div class="ttname"><a href="classmlx_1_1core_1_1distributed_1_1_dist_primitive.html">mlx::core::distributed::DistPrimitive</a></div><div class="ttdef"><b>Definition</b> primitives.h:10</div></div>
 | 
						|
<div class="ttc" id="aclassmlx_1_1core_1_1distributed_1_1_dist_primitive_html_a611ac8dfd9b4f49617ee8976ff3e15e9"><div class="ttname"><a href="classmlx_1_1core_1_1distributed_1_1_dist_primitive.html#a611ac8dfd9b4f49617ee8976ff3e15e9">mlx::core::distributed::DistPrimitive::eval_gpu</a></div><div class="ttdeci">void eval_gpu(const std::vector< array > &inputs, std::vector< array > &outputs) override</div><div class="ttdef"><b>Definition</b> primitives.h:15</div></div>
 | 
						|
<div class="ttc" id="aclassmlx_1_1core_1_1distributed_1_1_dist_primitive_html_a8831cb61ac633431b78b5fb99c0ea9ff"><div class="ttname"><a href="classmlx_1_1core_1_1distributed_1_1_dist_primitive.html#a8831cb61ac633431b78b5fb99c0ea9ff">mlx::core::distributed::DistPrimitive::group</a></div><div class="ttdeci">const Group & group() const</div><div class="ttdef"><b>Definition</b> primitives.h:21</div></div>
 | 
						|
<div class="ttc" id="aclassmlx_1_1core_1_1distributed_1_1_dist_primitive_html_a9e4b0b92776aca0c1331450ae4955cef"><div class="ttname"><a href="classmlx_1_1core_1_1distributed_1_1_dist_primitive.html#a9e4b0b92776aca0c1331450ae4955cef">mlx::core::distributed::DistPrimitive::DistPrimitive</a></div><div class="ttdeci">DistPrimitive(Group group)</div><div class="ttdef"><b>Definition</b> primitives.h:12</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="aprimitives_8h_html"><div class="ttname"><a href="primitives_8h.html">primitives.h</a></div></div>
 | 
						|
<div class="ttc" id="astruct_max_html"><div class="ttname"><a href="struct_max.html">Max</a></div><div class="ttdef"><b>Definition</b> ops.h:159</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><!-- fragment --></div><!-- contents -->
 | 
						|
<!-- start footer part -->
 | 
						|
<hr class="footer"/><address class="footer"><small>
 | 
						|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
 | 
						|
</small></address>
 | 
						|
</body>
 | 
						|
</html>
 |