2024-10-15 23:12:17 +08:00
<!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" / >
2025-02-07 04:16:29 +08:00
< meta name = "generator" content = "Doxygen 1.13.2" / >
2024-10-15 23:12:17 +08:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
< title > MLX: mlx/distributed/distributed.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" / >
2025-01-10 05:56:20 +08:00
< script type = "text/javascript" src = "navtreedata.js" > < / script >
< script type = "text/javascript" src = "navtree.js" > < / script >
2024-10-15 23:12:17 +08:00
< 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 >
2025-01-10 05:56:20 +08:00
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
$(function() { init_search(); });
/* @license-end */
< / script >
2024-10-15 23:12:17 +08:00
< 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 >
2025-01-10 05:56:20 +08:00
< 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 >
2024-10-15 23:12:17 +08:00
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
2025-02-07 04:16:29 +08:00
<!-- Generated by Doxygen 1.13.2 -->
2024-10-15 23:12:17 +08:00
< 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 >
2025-01-10 05:56:20 +08:00
< / 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 >
2024-10-15 23:12:17 +08:00
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
2025-01-10 05:56:20 +08:00
$(function(){initNavTree('distributed_8h_source.html',''); initResizable(true); });
2024-10-15 23:12:17 +08:00
/* @license-end */
< / script >
2025-01-10 05:56:20 +08:00
< div id = "doc-content" >
2024-10-15 23:12:17 +08:00
<!-- 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" > distributed.h< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< a href = "distributed_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 < memory> < / 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 = "array_8h.html" > mlx/array.h< / a > " < / span > < / div >
< div class = "line" > < a id = "l00008" name = "l00008" > < / a > < span class = "lineno" > 8< / span > < / div >
< div class = "foldopen" id = "foldopen00009" data-start = "{" data-end = "}" >
< div class = "line" > < a id = "l00009" name = "l00009" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core_1_1distributed.html" > 9< / a > < / 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 >
2025-01-10 05:56:20 +08:00
< div class = "line" > < a id = "l00011" name = "l00011" > < / a > < span class = "lineno" > 11< / span > < span class = "comment" > // Forward declaration of the base group implementation.< / 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 = "namespacemlx_1_1core_1_1distributed_1_1detail.html" > 12< / a > < / span > < span class = "keyword" > namespace < / span > < a class = "code hl_namespace" href = "namespacemlx_1_1core_1_1distributed_1_1detail.html" > detail< / a > {< / div >
< div class = "line" > < a id = "l00013" name = "l00013" > < / a > < span class = "lineno" > 13< / span > < span class = "keyword" > class < / span > < a class = "code hl_class" href = "classmlx_1_1core_1_1distributed_1_1detail_1_1_group_impl.html" > GroupImpl< / a > ;< / div >
< div class = "line" > < a id = "l00014" name = "l00014" > < / a > < span class = "lineno" > 14< / span > };< / div >
2024-10-15 23:12:17 +08:00
< / div >
2025-01-10 05:56:20 +08:00
< div class = "line" > < a id = "l00015" name = "l00015" > < / a > < span class = "lineno" > 15< / span > < / div >
< div class = "line" > < a id = "l00016" name = "l00016" > < / a > < span class = "lineno" > 16< / span > < span class = "comment" > /* Check if a communication backend is available */< / span > < / div >
< div class = "line" > < a id = "l00017" name = "l00017" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core_1_1distributed.html#a95655473cd0032c06e5fe3fca85aeef3" > 17< / a > < / span > < span class = "keywordtype" > bool< / span > < a class = "code hl_function" href = "namespacemlx_1_1core_1_1distributed.html#a95655473cd0032c06e5fe3fca85aeef3" > is_available< / a > ();< / div >
< div class = "line" > < a id = "l00018" name = "l00018" > < / a > < span class = "lineno" > 18< / span > < / div >
< div class = "foldopen" id = "foldopen00024" data-start = "{" data-end = "};" >
< div class = "line" > < a id = "l00024" name = "l00024" > < / a > < span class = "lineno" > < a class = "line" href = "structmlx_1_1core_1_1distributed_1_1_group.html" > 24< / a > < / span > < span class = "keyword" > struct < / span > < a class = "code hl_function" href = "structmlx_1_1core_1_1distributed_1_1_group.html#a32e6e085a427b41ca3529c5e5db30a1b" > Group< / a > {< / div >
< div class = "line" > < a id = "l00025" name = "l00025" > < / a > < span class = "lineno" > < a class = "line" href = "structmlx_1_1core_1_1distributed_1_1_group.html#a32e6e085a427b41ca3529c5e5db30a1b" > 25< / a > < / span > < a class = "code hl_function" href = "structmlx_1_1core_1_1distributed_1_1_group.html#a32e6e085a427b41ca3529c5e5db30a1b" > Group< / a > (std::shared_ptr< detail::GroupImpl> group) : group_(< a class = "code hl_function" href = "group__ops.html#ga2a466024f8061febc0a64be557644cb0" > std< / a > ::move(group)) {}< / div >
< div class = "line" > < a id = "l00026" name = "l00026" > < / a > < span class = "lineno" > 26< / span > < / div >
< div class = "line" > < a id = "l00027" name = "l00027" > < / a > < span class = "lineno" > < a class = "line" href = "structmlx_1_1core_1_1distributed_1_1_group.html#a94b676c55c9a0f9d6e75ddf80644f18d" > 27< / a > < / span > < span class = "keywordtype" > int< / span > < a class = "code hl_function" href = "structmlx_1_1core_1_1distributed_1_1_group.html#a94b676c55c9a0f9d6e75ddf80644f18d" > rank< / a > () < span class = "keyword" > const< / span > ;< / div >
< div class = "line" > < a id = "l00028" name = "l00028" > < / a > < span class = "lineno" > < a class = "line" href = "structmlx_1_1core_1_1distributed_1_1_group.html#ac0a5a1e463a9330355e8bfe09c0feaf2" > 28< / a > < / span > < span class = "keywordtype" > int< / span > < a class = "code hl_function" href = "structmlx_1_1core_1_1distributed_1_1_group.html#ac0a5a1e463a9330355e8bfe09c0feaf2" > size< / a > () < span class = "keyword" > const< / span > ;< / div >
< div class = "line" > < a id = "l00029" name = "l00029" > < / a > < span class = "lineno" > 29< / span > < / div >
< div class = "line" > < a id = "l00038" name = "l00038" > < / a > < span class = "lineno" > < a class = "line" href = "structmlx_1_1core_1_1distributed_1_1_group.html#ad3682f4dc85bfe7e5464b87f6f0fd931" > 38< / a > < / span > < a class = "code hl_function" href = "structmlx_1_1core_1_1distributed_1_1_group.html#a32e6e085a427b41ca3529c5e5db30a1b" > Group< / a > < a class = "code hl_function" href = "structmlx_1_1core_1_1distributed_1_1_group.html#ad3682f4dc85bfe7e5464b87f6f0fd931" > split< / a > (< span class = "keywordtype" > int< / span > color, < span class = "keywordtype" > int< / span > key = -1) < span class = "keyword" > const< / span > ;< / div >
< div class = "line" > < a id = "l00039" name = "l00039" > < / a > < span class = "lineno" > 39< / span > < / div >
< div class = "foldopen" id = "foldopen00040" data-start = "{" data-end = "}" >
< div class = "line" > < a id = "l00040" name = "l00040" > < / a > < span class = "lineno" > < a class = "line" href = "structmlx_1_1core_1_1distributed_1_1_group.html#aea20bbd3a1c46a3d19da9923885720bf" > 40< / a > < / span > < span class = "keyword" > const< / span > std::shared_ptr< detail::GroupImpl> & < a class = "code hl_function" href = "structmlx_1_1core_1_1distributed_1_1_group.html#aea20bbd3a1c46a3d19da9923885720bf" > raw_group< / a > ()< span class = "keyword" > const < / span > {< / div >
< div class = "line" > < a id = "l00041" name = "l00041" > < / a > < span class = "lineno" > 41< / span > < span class = "keywordflow" > return< / span > group_;< / div >
< div class = "line" > < a id = "l00042" name = "l00042" > < / a > < span class = "lineno" > 42< / span > }< / div >
2024-10-15 23:12:17 +08:00
< / div >
2025-01-10 05:56:20 +08:00
< div class = "line" > < a id = "l00043" name = "l00043" > < / a > < span class = "lineno" > 43< / span > < / div >
< div class = "line" > < a id = "l00044" name = "l00044" > < / a > < span class = "lineno" > 44< / span > < span class = "keyword" > private< / span > :< / div >
< div class = "line" > < a id = "l00045" name = "l00045" > < / a > < span class = "lineno" > 45< / span > std::shared_ptr< detail::GroupImpl> group_{< span class = "keyword" > nullptr< / span > };< / div >
< div class = "line" > < a id = "l00046" name = "l00046" > < / a > < span class = "lineno" > 46< / span > };< / div >
< / div >
< div class = "line" > < a id = "l00047" name = "l00047" > < / a > < span class = "lineno" > 47< / span > < / div >
2025-02-07 04:16:29 +08:00
< div class = "line" > < a id = "l00056" name = "l00056" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core_1_1distributed.html#a24cdcd2aa23a3410a8973753ade3f772" > 56< / 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#a24cdcd2aa23a3410a8973753ade3f772" > init< / a > (< span class = "keywordtype" > bool< / span > strict = < span class = "keyword" > false< / span > , < span class = "keyword" > const< / span > std::string& bk = < span class = "stringliteral" > " any" < / span > );< / div >
2025-01-10 05:56:20 +08:00
< 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" > // namespace mlx::core::distributed< / span > < / div >
2024-10-15 23:12:17 +08:00
< / div >
< div class = "ttc" id = "aarray_8h_html" > < div class = "ttname" > < a href = "array_8h.html" > array.h< / a > < / div > < / div >
2025-01-10 05:56:20 +08:00
< 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 = "agroup__ops_html_ga2a466024f8061febc0a64be557644cb0" > < div class = "ttname" > < a href = "group__ops.html#ga2a466024f8061febc0a64be557644cb0" > mlx::core::std< / a > < / div > < div class = "ttdeci" > array std(const array & a, bool keepdims, int ddof=0, StreamOrDevice s={})< / div > < div class = "ttdoc" > Computes the standard deviation of the elements of an array.< / div > < / div >
< div class = "ttc" id = "anamespacemlx_1_1core_1_1distributed_1_1detail_html" > < div class = "ttname" > < a href = "namespacemlx_1_1core_1_1distributed_1_1detail.html" > mlx::core::distributed::detail< / a > < / div > < div class = "ttdef" > < b > Definition< / b > distributed.h:12< / div > < / div >
2024-10-15 23:12:17 +08:00
< 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 >
2025-02-07 04:16:29 +08:00
< div class = "ttc" id = "anamespacemlx_1_1core_1_1distributed_html_a24cdcd2aa23a3410a8973753ade3f772" > < div class = "ttname" > < a href = "namespacemlx_1_1core_1_1distributed.html#a24cdcd2aa23a3410a8973753ade3f772" > mlx::core::distributed::init< / a > < / div > < div class = "ttdeci" > Group init(bool strict=false, const std::string & bk=" any" )< / div > < div class = "ttdoc" > Initialize the distributed backend and return the group containing all discoverable processes.< / div > < / div >
2024-10-15 23:12:17 +08:00
< 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 >
2025-01-10 05:56:20 +08:00
< 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:24< / div > < / div >
< div class = "ttc" id = "astructmlx_1_1core_1_1distributed_1_1_group_html_a32e6e085a427b41ca3529c5e5db30a1b" > < div class = "ttname" > < a href = "structmlx_1_1core_1_1distributed_1_1_group.html#a32e6e085a427b41ca3529c5e5db30a1b" > mlx::core::distributed::Group::Group< / a > < / div > < div class = "ttdeci" > Group(std::shared_ptr< detail::GroupImpl > group)< / div > < div class = "ttdef" > < b > Definition< / b > distributed.h:25< / div > < / div >
< div class = "ttc" id = "astructmlx_1_1core_1_1distributed_1_1_group_html_a94b676c55c9a0f9d6e75ddf80644f18d" > < div class = "ttname" > < a href = "structmlx_1_1core_1_1distributed_1_1_group.html#a94b676c55c9a0f9d6e75ddf80644f18d" > mlx::core::distributed::Group::rank< / a > < / div > < div class = "ttdeci" > int rank() const< / div > < / div >
< div class = "ttc" id = "astructmlx_1_1core_1_1distributed_1_1_group_html_ac0a5a1e463a9330355e8bfe09c0feaf2" > < div class = "ttname" > < a href = "structmlx_1_1core_1_1distributed_1_1_group.html#ac0a5a1e463a9330355e8bfe09c0feaf2" > mlx::core::distributed::Group::size< / a > < / div > < div class = "ttdeci" > int size() const< / div > < / div >
< div class = "ttc" id = "astructmlx_1_1core_1_1distributed_1_1_group_html_ad3682f4dc85bfe7e5464b87f6f0fd931" > < div class = "ttname" > < a href = "structmlx_1_1core_1_1distributed_1_1_group.html#ad3682f4dc85bfe7e5464b87f6f0fd931" > mlx::core::distributed::Group::split< / a > < / div > < div class = "ttdeci" > Group split(int color, int key=-1) const< / div > < div class = "ttdoc" > Split the group according to the provided color.< / div > < / div >
< div class = "ttc" id = "astructmlx_1_1core_1_1distributed_1_1_group_html_aea20bbd3a1c46a3d19da9923885720bf" > < div class = "ttname" > < a href = "structmlx_1_1core_1_1distributed_1_1_group.html#aea20bbd3a1c46a3d19da9923885720bf" > mlx::core::distributed::Group::raw_group< / a > < / div > < div class = "ttdeci" > const std::shared_ptr< detail::GroupImpl > & raw_group() const< / div > < div class = "ttdef" > < b > Definition< / b > distributed.h:40< / div > < / div >
2024-10-15 23:12:17 +08:00
< / div > <!-- fragment --> < / div > <!-- contents -->
< / div > <!-- doc - content -->
2025-01-10 05:56:20 +08:00
<!-- 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 = "distributed_8h.html" > distributed.h< / a > < / li >
2025-02-07 04:16:29 +08:00
< 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.2 < / li >
2025-01-10 05:56:20 +08:00
< / ul >
< / div >
2024-10-15 23:12:17 +08:00
< / body >
< / html >
