mirror of
https://github.com/ml-explore/mlx.git
synced 2025-06-26 02:33:21 +08:00
139 lines
9.5 KiB
HTML
139 lines
9.5 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.13.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>MLX: mlx/distributed/mpi/mpi.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>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript" src="resize.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>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { init_search(); });
|
|
/* @license-end */
|
|
</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>
|
|
<td> <div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </span>
|
|
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.13.1 -->
|
|
<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">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { codefold.init(0); });
|
|
/* @license-end */
|
|
</script>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function(){initNavTree('mpi_8h_source.html',''); initResizable(true); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- 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 class="header">
|
|
<div class="headertitle"><div class="title">mpi.h</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="mpi_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">#include "<a class="code" href="distributed_8h.html">mlx/distributed/distributed.h</a>"</span></div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
|
|
<div class="foldopen" id="foldopen00005" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core_1_1distributed_1_1mpi.html"> 5</a></span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacemlx_1_1core_1_1distributed_1_1mpi.html">mlx::core::distributed::mpi</a> {</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"><a class="line" href="namespacemlx_1_1core_1_1distributed_1_1mpi.html#ab9a91276b3c84ea63f1d1831ef4079dd"> 7</a></span><span class="keyword">using </span><a class="code hl_typedef" href="namespacemlx_1_1core_1_1distributed_1_1mpi.html#ab9a91276b3c84ea63f1d1831ef4079dd">GroupImpl</a> = <a class="code hl_class" href="classmlx_1_1core_1_1distributed_1_1detail_1_1_group_impl.html">mlx::core::distributed::detail::GroupImpl</a>;</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"><a class="line" href="namespacemlx_1_1core_1_1distributed_1_1mpi.html#a86d8a52e75b15bae8fb0992b418a41c7"> 9</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="namespacemlx_1_1core_1_1distributed_1_1mpi.html#a86d8a52e75b15bae8fb0992b418a41c7">is_available</a>();</div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core_1_1distributed_1_1mpi.html#ab40a34a8837956e24fb9b9661104c8f9"> 10</a></span>std::shared_ptr<GroupImpl> <a class="code hl_function" href="namespacemlx_1_1core_1_1distributed_1_1mpi.html#ab40a34a8837956e24fb9b9661104c8f9">init</a>(<span class="keywordtype">bool</span> strict = <span class="keyword">false</span>);</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"> 12</span>} <span class="comment">// namespace mlx::core::distributed::mpi</span></div>
|
|
</div>
|
|
<div class="ttc" id="aclassmlx_1_1core_1_1distributed_1_1detail_1_1_group_impl_html"><div class="ttname"><a href="classmlx_1_1core_1_1distributed_1_1detail_1_1_group_impl.html">mlx::core::distributed::detail::GroupImpl</a></div><div class="ttdoc">Abstract base class of a distributed group implementation.</div><div class="ttdef"><b>Definition</b> distributed_impl.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_1_1mpi_html"><div class="ttname"><a href="namespacemlx_1_1core_1_1distributed_1_1mpi.html">mlx::core::distributed::mpi</a></div><div class="ttdef"><b>Definition</b> mpi.h:5</div></div>
|
|
<div class="ttc" id="anamespacemlx_1_1core_1_1distributed_1_1mpi_html_a86d8a52e75b15bae8fb0992b418a41c7"><div class="ttname"><a href="namespacemlx_1_1core_1_1distributed_1_1mpi.html#a86d8a52e75b15bae8fb0992b418a41c7">mlx::core::distributed::mpi::is_available</a></div><div class="ttdeci">bool is_available()</div></div>
|
|
<div class="ttc" id="anamespacemlx_1_1core_1_1distributed_1_1mpi_html_ab40a34a8837956e24fb9b9661104c8f9"><div class="ttname"><a href="namespacemlx_1_1core_1_1distributed_1_1mpi.html#ab40a34a8837956e24fb9b9661104c8f9">mlx::core::distributed::mpi::init</a></div><div class="ttdeci">std::shared_ptr< GroupImpl > init(bool strict=false)</div></div>
|
|
<div class="ttc" id="anamespacemlx_1_1core_1_1distributed_1_1mpi_html_ab9a91276b3c84ea63f1d1831ef4079dd"><div class="ttname"><a href="namespacemlx_1_1core_1_1distributed_1_1mpi.html#ab9a91276b3c84ea63f1d1831ef4079dd">mlx::core::distributed::mpi::GroupImpl</a></div><div class="ttdeci">mlx::core::distributed::detail::GroupImpl GroupImpl</div><div class="ttdef"><b>Definition</b> mpi.h:7</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<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><li class="navelem"><a class="el" href="dir_fef8157d08ab8bc47d26a7b4e218df82.html">mpi</a></li><li class="navelem"><a class="el" href="mpi_8h.html">mpi.h</a></li>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.1 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|