Google Git
Sign in
apache / mxnet-site / d5c5a235eef72f64ccaf224b834a20ef3287469b / . / versions / 1.9.1 / api / cpp / docs / api / include_2mxnet_2kvstore_8h_source.html
blob: cd8c9877ae2979e1bbe1ee6fd13a225a7cbc5067 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mxnet: /work/mxnet/include/mxnet/kvstore.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>
<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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">mxnet
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_1143c7affb9ebd026cb6818dd282def7.html">mxnet</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">kvstore.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="include_2mxnet_2kvstore_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * distributed with this work for additional information</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * &quot;License&quot;); you may not use this file except in compliance</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * software distributed under the License is distributed on an</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * KIND, either express or implied. See the License for the</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> * specific language governing permissions and limitations</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> * under the License.</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#ifndef MXNET_KVSTORE_H_</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#define MXNET_KVSTORE_H_</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="3rdparty_2dmlc-core_2include_2dmlc_2io_8h.html">dmlc/io.h</a>&gt;</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#include &lt;utility&gt;</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#include &lt;unordered_map&gt;</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="preprocessor">#include &lt;functional&gt;</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#include &lt;atomic&gt;</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#include &quot;../../src/kvstore/gradient_compression.h&quot;</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="include_2mxnet_2ndarray_8h.html">./ndarray.h</a>&quot;</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="preprocessor">#if MXNET_USE_DIST_KVSTORE</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="preprocessor">#include &quot;ps/ps.h&quot;</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="preprocessor">#endif // MXNET_USE_DIST_KVSTORE</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacemxnet.html">mxnet</a> {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="namespacemxnet.html#a691b662ef3ae22904fc7d7d63db4c14e"> 48</a></span>&#160;<span class="keyword">enum class</span> <a class="code" href="namespacemxnet.html#a691b662ef3ae22904fc7d7d63db4c14e">KVStoreServerProfilerCommand</a> {</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <a class="code" href="namespacemxnet.html#a691b662ef3ae22904fc7d7d63db4c14eac01ffbc8ad7ddf59499b096d62edcdff">kSetConfig</a>, <a class="code" href="namespacemxnet.html#a691b662ef3ae22904fc7d7d63db4c14eaafd8bac1c90d2b1e9ad1ea7d74c46618">kState</a>, <a class="code" href="namespacemxnet.html#a691b662ef3ae22904fc7d7d63db4c14ea583e1d2af95bc205bafe3341b26ea286">kPause</a>, <a class="code" href="namespacemxnet.html#a691b662ef3ae22904fc7d7d63db4c14ea0193ec3ba4814ec4c6c0714a97f1bcac">kDump</a></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;};</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div><div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html"> 58</a></span>&#160;<span class="keyword">class </span><a class="code" href="classmxnet_1_1KVStore.html">KVStore</a> {</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a02e23071eb46464b58f2e2bf5654d6d6"> 61</a></span>&#160; <span class="keyword">virtual</span> <a class="code" href="classmxnet_1_1KVStore.html#a02e23071eb46464b58f2e2bf5654d6d6">~KVStore</a>() {}</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keyword">static</span> <a class="code" href="classmxnet_1_1KVStore.html">KVStore</a> *Create(<span class="keyword">const</span> <span class="keywordtype">char</span> *type = <span class="stringliteral">&quot;local&quot;</span>);</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;</div><div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a722b2150dbf50d528fce62307809f949"> 78</a></span>&#160; <span class="keyword">inline</span> <span class="keyword">const</span> std::string&amp; <a class="code" href="classmxnet_1_1KVStore.html#a722b2150dbf50d528fce62307809f949">type</a>() { <span class="keywordflow">return</span> type_; }</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetGradientCompression(<span class="keyword">const</span> std::vector&lt;std::pair&lt;std::string, std::string&gt; &gt;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; &amp; kwargs) = 0;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> Init(<span class="keyword">const</span> std::vector&lt;int&gt;&amp; keys,</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; <span class="keyword">const</span> std::vector&lt;NDArray&gt;&amp; values) = 0;</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> Init(<span class="keyword">const</span> std::vector&lt;std::string&gt;&amp; str_keys,</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; <span class="keyword">const</span> std::vector&lt;NDArray&gt;&amp; values) = 0;</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> Push(<span class="keyword">const</span> std::vector&lt;int&gt;&amp; keys,</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160; <span class="keyword">const</span> std::vector&lt;NDArray&gt;&amp; values,</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160; <span class="keywordtype">int</span> priority = 0) = 0;</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160;</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> Push(<span class="keyword">const</span> std::vector&lt;std::string&gt;&amp; str_keys,</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160; <span class="keyword">const</span> std::vector&lt;NDArray&gt;&amp; values,</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160; <span class="keywordtype">int</span> priority = 0) = 0;</div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> Pull(<span class="keyword">const</span> std::vector&lt;int&gt;&amp; keys,</div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span>&#160; <span class="keyword">const</span> std::vector&lt;NDArray*&gt;&amp; values,</div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160; <span class="keywordtype">int</span> priority = 0, <span class="keywordtype">bool</span> ignore_sparse = <span class="keyword">true</span>) = 0;</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> Pull(<span class="keyword">const</span> std::vector&lt;std::string&gt;&amp; str_keys,</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span>&#160; <span class="keyword">const</span> std::vector&lt;NDArray*&gt;&amp; values,</div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span>&#160; <span class="keywordtype">int</span> priority = 0, <span class="keywordtype">bool</span> ignore_sparse = <span class="keyword">true</span>) = 0;</div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span>&#160;</div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> Broadcast(<span class="keyword">const</span> std::vector&lt;int&gt;&amp; vkeys,</div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span>&#160; <span class="keyword">const</span> std::vector&lt;int&gt;&amp; okeys,</div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span>&#160; <span class="keyword">const</span> std::vector&lt;NDArray&gt;&amp; values,</div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span>&#160; <span class="keyword">const</span> std::vector&lt;NDArray*&gt;&amp; outs,</div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span>&#160; <span class="keywordtype">int</span> priority = 0) = 0;</div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span>&#160;</div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> Broadcast(<span class="keyword">const</span> std::vector&lt;std::string&gt;&amp; str_vkeys,</div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span>&#160; <span class="keyword">const</span> std::vector&lt;std::string&gt;&amp; str_okeys,</div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span>&#160; <span class="keyword">const</span> std::vector&lt;NDArray&gt;&amp; values,</div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span>&#160; <span class="keyword">const</span> std::vector&lt;NDArray*&gt;&amp; outs,</div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span>&#160; <span class="keywordtype">int</span> priority = 0) = 0;</div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span>&#160;</div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> PushPull(<span class="keyword">const</span> std::vector&lt;int&gt;&amp; vkeys,</div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span>&#160; <span class="keyword">const</span> std::vector&lt;int&gt;&amp; okeys,</div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span>&#160; <span class="keyword">const</span> std::vector&lt;NDArray&gt;&amp; values,</div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span>&#160; <span class="keyword">const</span> std::vector&lt;NDArray*&gt;&amp; outs,</div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span>&#160; <span class="keywordtype">int</span> priority = 0) = 0;</div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span>&#160;</div><div class="line"><a name="l00250"></a><span class="lineno"> 250</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> PushPull(<span class="keyword">const</span> std::vector&lt;std::string&gt;&amp; str_vkeys,</div><div class="line"><a name="l00251"></a><span class="lineno"> 251</span>&#160; <span class="keyword">const</span> std::vector&lt;std::string&gt;&amp; str_okeys,</div><div class="line"><a name="l00252"></a><span class="lineno"> 252</span>&#160; <span class="keyword">const</span> std::vector&lt;NDArray&gt;&amp; values,</div><div class="line"><a name="l00253"></a><span class="lineno"> 253</span>&#160; <span class="keyword">const</span> std::vector&lt;NDArray*&gt;&amp; outs,</div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span>&#160; <span class="keywordtype">int</span> priority = 0) = 0;</div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> PullRowSparse(<span class="keyword">const</span> std::vector&lt;int&gt;&amp; str_keys,</div><div class="line"><a name="l00264"></a><span class="lineno"> 264</span>&#160; <span class="keyword">const</span> std::vector&lt;std::pair&lt;NDArray*, NDArray&gt;&gt;&amp; val_rowids,</div><div class="line"><a name="l00265"></a><span class="lineno"> 265</span>&#160; <span class="keywordtype">int</span> priority = 0) = 0;</div><div class="line"><a name="l00266"></a><span class="lineno"> 266</span>&#160;</div><div class="line"><a name="l00275"></a><span class="lineno"> 275</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> PullRowSparse(<span class="keyword">const</span> std::vector&lt;std::string&gt;&amp; str_keys,</div><div class="line"><a name="l00276"></a><span class="lineno"> 276</span>&#160; <span class="keyword">const</span> std::vector&lt;std::pair&lt;NDArray*, NDArray&gt;&gt;&amp; val_rowids,</div><div class="line"><a name="l00277"></a><span class="lineno"> 277</span>&#160; <span class="keywordtype">int</span> priority = 0) = 0;</div><div class="line"><a name="l00278"></a><span class="lineno"> 278</span>&#160;</div><div class="line"><a name="l00282"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a6e4a76bd57f185349c58a5a658c32a64"> 282</a></span>&#160; <span class="keyword">typedef</span> std::function&lt;void(int, const NDArray&amp;, NDArray*)&gt; <a class="code" href="classmxnet_1_1KVStore.html#a6e4a76bd57f185349c58a5a658c32a64">Updater</a>;</div><div class="line"><a name="l00286"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#abe6963a386cc6dc579029349a447d1cb"> 286</a></span>&#160; <span class="keyword">typedef</span> std::function&lt;void(const std::string&amp;, const NDArray&amp;, NDArray*)&gt; <a class="code" href="classmxnet_1_1KVStore.html#abe6963a386cc6dc579029349a447d1cb">StrUpdater</a>;</div><div class="line"><a name="l00296"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a352ef7eae04211eca1ed47401a6d15d5"> 296</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1KVStore.html#a352ef7eae04211eca1ed47401a6d15d5">set_updater</a>(<span class="keyword">const</span> Updater&amp; updater) {</div><div class="line"><a name="l00297"></a><span class="lineno"> 297</span>&#160; CHECK(updater) &lt;&lt; <span class="stringliteral">&quot;invalid updater&quot;</span>;</div><div class="line"><a name="l00298"></a><span class="lineno"> 298</span>&#160; updater_ = updater;</div><div class="line"><a name="l00299"></a><span class="lineno"> 299</span>&#160; }</div><div class="line"><a name="l00300"></a><span class="lineno"> 300</span>&#160;</div><div class="line"><a name="l00310"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a777f1de6348bba9ef62b56064a6e0c46"> 310</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1KVStore.html#a777f1de6348bba9ef62b56064a6e0c46">set_updater</a>(<span class="keyword">const</span> StrUpdater&amp; updater) {</div><div class="line"><a name="l00311"></a><span class="lineno"> 311</span>&#160; CHECK(updater) &lt;&lt; <span class="stringliteral">&quot;invalid updater&quot;</span>;</div><div class="line"><a name="l00312"></a><span class="lineno"> 312</span>&#160; str_updater_ = updater;</div><div class="line"><a name="l00313"></a><span class="lineno"> 313</span>&#160; }</div><div class="line"><a name="l00314"></a><span class="lineno"> 314</span>&#160;</div><div class="line"><a name="l00315"></a><span class="lineno"> 315</span>&#160; <span class="comment">/******************************************************</span></div><div class="line"><a name="l00316"></a><span class="lineno"> 316</span>&#160;<span class="comment"> * the following are used for multi-machines.</span></div><div class="line"><a name="l00317"></a><span class="lineno"> 317</span>&#160;<span class="comment"> ******************************************************/</span></div><div class="line"><a name="l00318"></a><span class="lineno"> 318</span>&#160;</div><div class="line"><a name="l00323"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a5d919a7a4c9495e9a569c8d733d6325f"> 323</a></span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1KVStore.html#a5d919a7a4c9495e9a569c8d733d6325f">InitPSEnv</a>(<span class="keyword">const</span> std::unordered_map&lt;std::string, std::string&gt;&amp; envs) {</div><div class="line"><a name="l00324"></a><span class="lineno"> 324</span>&#160;<span class="preprocessor">#if MXNET_USE_DIST_KVSTORE</span></div><div class="line"><a name="l00325"></a><span class="lineno"> 325</span>&#160; ps::Environment::Init(envs);</div><div class="line"><a name="l00326"></a><span class="lineno"> 326</span>&#160;<span class="preprocessor">#else</span></div><div class="line"><a name="l00327"></a><span class="lineno"> 327</span>&#160; LOG(FATAL) &lt;&lt; <span class="stringliteral">&quot;compile with USE_DIST_KVSTORE=1 to init parameter server&#39;s environment&quot;</span>;</div><div class="line"><a name="l00328"></a><span class="lineno"> 328</span>&#160;<span class="preprocessor">#endif // MXNET_USE_DIST_KVSTORE</span></div><div class="line"><a name="l00329"></a><span class="lineno"> 329</span>&#160; }</div><div class="line"><a name="l00330"></a><span class="lineno"> 330</span>&#160;</div><div class="line"><a name="l00336"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#ab216fb292fa77e843e95f474fa671a20"> 336</a></span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classmxnet_1_1KVStore.html#ab216fb292fa77e843e95f474fa671a20">IsWorkerNode</a>() {</div><div class="line"><a name="l00337"></a><span class="lineno"> 337</span>&#160;<span class="preprocessor">#if MXNET_USE_DIST_KVSTORE</span></div><div class="line"><a name="l00338"></a><span class="lineno"> 338</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* role_str = ps::Environment::Get()-&gt;find(<span class="stringliteral">&quot;DMLC_ROLE&quot;</span>);</div><div class="line"><a name="l00339"></a><span class="lineno"> 339</span>&#160; <span class="keywordflow">return</span> (role_str == <span class="keyword">nullptr</span>) || (!strcmp(role_str, <span class="stringliteral">&quot;worker&quot;</span>));</div><div class="line"><a name="l00340"></a><span class="lineno"> 340</span>&#160;<span class="preprocessor">#else</span></div><div class="line"><a name="l00341"></a><span class="lineno"> 341</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div><div class="line"><a name="l00342"></a><span class="lineno"> 342</span>&#160;<span class="preprocessor">#endif // MXNET_USE_DIST_KVSTORE</span></div><div class="line"><a name="l00343"></a><span class="lineno"> 343</span>&#160; }</div><div class="line"><a name="l00344"></a><span class="lineno"> 344</span>&#160;</div><div class="line"><a name="l00350"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a101178924ce1d635b0c8c2a5bce0ceaf"> 350</a></span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classmxnet_1_1KVStore.html#a101178924ce1d635b0c8c2a5bce0ceaf">IsServerNode</a>() {</div><div class="line"><a name="l00351"></a><span class="lineno"> 351</span>&#160;<span class="preprocessor">#if MXNET_USE_DIST_KVSTORE</span></div><div class="line"><a name="l00352"></a><span class="lineno"> 352</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* role_str = ps::Environment::Get()-&gt;find(<span class="stringliteral">&quot;DMLC_ROLE&quot;</span>);</div><div class="line"><a name="l00353"></a><span class="lineno"> 353</span>&#160; <span class="keywordflow">return</span> (role_str != <span class="keyword">nullptr</span>) &amp;&amp; (!strcmp(role_str, <span class="stringliteral">&quot;server&quot;</span>));</div><div class="line"><a name="l00354"></a><span class="lineno"> 354</span>&#160;<span class="preprocessor">#else</span></div><div class="line"><a name="l00355"></a><span class="lineno"> 355</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div><div class="line"><a name="l00356"></a><span class="lineno"> 356</span>&#160;<span class="preprocessor">#endif // MXNET_USE_DIST_KVSTORE</span></div><div class="line"><a name="l00357"></a><span class="lineno"> 357</span>&#160; }</div><div class="line"><a name="l00358"></a><span class="lineno"> 358</span>&#160;</div><div class="line"><a name="l00359"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#afa87753d90fc7e75234229834ea23abb"> 359</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1KVStore.html#afa87753d90fc7e75234229834ea23abb">set_barrier_before_exit</a>(<span class="keyword">const</span> <span class="keywordtype">bool</span> barrier_before_exit) {</div><div class="line"><a name="l00360"></a><span class="lineno"> 360</span>&#160;<span class="preprocessor">#if MXNET_USE_DIST_KVSTORE</span></div><div class="line"><a name="l00361"></a><span class="lineno"> 361</span>&#160; <span class="keywordflow">if</span> (!IsWorkerNode()) LOG(FATAL) &lt;&lt; <span class="stringliteral">&quot;barrier_before_exit takes effect only on worker nodes&quot;</span>;</div><div class="line"><a name="l00362"></a><span class="lineno"> 362</span>&#160; barrier_before_exit_ = barrier_before_exit;</div><div class="line"><a name="l00363"></a><span class="lineno"> 363</span>&#160;<span class="preprocessor">#else</span></div><div class="line"><a name="l00364"></a><span class="lineno"> 364</span>&#160; LOG(FATAL) &lt;&lt; <span class="stringliteral">&quot;compile with USE_DIST_KVSTORE=1 to enable barrier&quot;</span>;</div><div class="line"><a name="l00365"></a><span class="lineno"> 365</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00366"></a><span class="lineno"> 366</span>&#160; }</div><div class="line"><a name="l00367"></a><span class="lineno"> 367</span>&#160;</div><div class="line"><a name="l00373"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a41113b9dfeab6c705ba064cc3f010fb4"> 373</a></span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classmxnet_1_1KVStore.html#a41113b9dfeab6c705ba064cc3f010fb4">IsSchedulerNode</a>() {</div><div class="line"><a name="l00374"></a><span class="lineno"> 374</span>&#160;<span class="preprocessor">#if MXNET_USE_DIST_KVSTORE</span></div><div class="line"><a name="l00375"></a><span class="lineno"> 375</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* role_str = ps::Environment::Get()-&gt;find(<span class="stringliteral">&quot;DMLC_ROLE&quot;</span>);</div><div class="line"><a name="l00376"></a><span class="lineno"> 376</span>&#160; <span class="keywordflow">return</span> (role_str != <span class="keyword">nullptr</span>) &amp;&amp; (!strcmp(role_str, <span class="stringliteral">&quot;scheduler&quot;</span>));</div><div class="line"><a name="l00377"></a><span class="lineno"> 377</span>&#160;<span class="preprocessor">#else</span></div><div class="line"><a name="l00378"></a><span class="lineno"> 378</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div><div class="line"><a name="l00379"></a><span class="lineno"> 379</span>&#160;<span class="preprocessor">#endif // MXNET_USE_DIST_KVSTORE</span></div><div class="line"><a name="l00380"></a><span class="lineno"> 380</span>&#160; }</div><div class="line"><a name="l00381"></a><span class="lineno"> 381</span>&#160;</div><div class="line"><a name="l00388"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#afa281ae77e3ca58beaee6f3a5feafbc1"> 388</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classmxnet_1_1KVStore.html#afa281ae77e3ca58beaee6f3a5feafbc1">get_rank</a>()<span class="keyword"> const </span>{</div><div class="line"><a name="l00389"></a><span class="lineno"> 389</span>&#160; <span class="keywordflow">return</span> 0;</div><div class="line"><a name="l00390"></a><span class="lineno"> 390</span>&#160; }</div><div class="line"><a name="l00391"></a><span class="lineno"> 391</span>&#160;</div><div class="line"><a name="l00395"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a2314122405a7f3ed5f9df55cb6a66f2a"> 395</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classmxnet_1_1KVStore.html#a2314122405a7f3ed5f9df55cb6a66f2a">get_group_size</a>()<span class="keyword"> const </span>{</div><div class="line"><a name="l00396"></a><span class="lineno"> 396</span>&#160; <span class="keywordflow">return</span> 1;</div><div class="line"><a name="l00397"></a><span class="lineno"> 397</span>&#160; }</div><div class="line"><a name="l00398"></a><span class="lineno"> 398</span>&#160;</div><div class="line"><a name="l00407"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a9bbe72794d75a2d8d804124ee686c01c"> 407</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classmxnet_1_1KVStore.html#a9bbe72794d75a2d8d804124ee686c01c">get_num_dead_node</a>(<span class="keywordtype">int</span> node_id, <span class="keywordtype">int</span> timeout = 60)<span class="keyword"> const </span>{</div><div class="line"><a name="l00408"></a><span class="lineno"> 408</span>&#160; <span class="keywordflow">return</span> 0;</div><div class="line"><a name="l00409"></a><span class="lineno"> 409</span>&#160; }</div><div class="line"><a name="l00410"></a><span class="lineno"> 410</span>&#160;</div><div class="line"><a name="l00418"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a4f9275fb7a11589fae1dcc5a8a3354ac"> 418</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1KVStore.html#a4f9275fb7a11589fae1dcc5a8a3354ac">Barrier</a>() { }</div><div class="line"><a name="l00419"></a><span class="lineno"> 419</span>&#160;</div><div class="line"><a name="l00431"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a4ff4ca05f3c519ebbc2e46264e8b63dd"> 431</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1KVStore.html#a4ff4ca05f3c519ebbc2e46264e8b63dd">SendCommandToServers</a>(<span class="keywordtype">int</span> cmd_id, <span class="keyword">const</span> std::string&amp; cmd_body) { }</div><div class="line"><a name="l00432"></a><span class="lineno"> 432</span>&#160;</div><div class="line"><a name="l00439"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a9e11acc2968464f907633a1c72e4d545"> 439</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1KVStore.html#a9e11acc2968464f907633a1c72e4d545">SetServerProfilerCommand</a>(<span class="keyword">const</span> <a class="code" href="namespacemxnet.html#a691b662ef3ae22904fc7d7d63db4c14e">KVStoreServerProfilerCommand</a> type,</div><div class="line"><a name="l00440"></a><span class="lineno"> 440</span>&#160; <span class="keyword">const</span> std::string&amp; params) {</div><div class="line"><a name="l00441"></a><span class="lineno"> 441</span>&#160; LOG(INFO) &lt;&lt; <span class="stringliteral">&quot;Unable to pass server the profiler command. If you are using &quot;</span></div><div class="line"><a name="l00442"></a><span class="lineno"> 442</span>&#160; &lt;&lt; <span class="stringliteral">&quot;distributed kvstore, you need to compile with USE_DIST_KVSTORE=1.&quot;</span></div><div class="line"><a name="l00443"></a><span class="lineno"> 443</span>&#160; &lt;&lt; <span class="stringliteral">&quot;If you are training on single machine, then there is no server process&quot;</span></div><div class="line"><a name="l00444"></a><span class="lineno"> 444</span>&#160; &lt;&lt; <span class="stringliteral">&quot;to profile. Please profile the worker process instead.&quot;</span>;</div><div class="line"><a name="l00445"></a><span class="lineno"> 445</span>&#160; }</div><div class="line"><a name="l00446"></a><span class="lineno"> 446</span>&#160;</div><div class="line"><a name="l00450"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a50db5cb1a140fb84c8e31def54270ae3"> 450</a></span>&#160; <span class="keyword">typedef</span> std::function&lt;void(int, const std::string&amp;)&gt; <a class="code" href="classmxnet_1_1KVStore.html#a50db5cb1a140fb84c8e31def54270ae3">Controller</a>;</div><div class="line"><a name="l00451"></a><span class="lineno"> 451</span>&#160;</div><div class="line"><a name="l00465"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#ae137ab8b5407060529c18a8084946d0b"> 465</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1KVStore.html#ae137ab8b5407060529c18a8084946d0b">RunServer</a>(<span class="keyword">const</span> Controller&amp; controller) { }</div><div class="line"><a name="l00466"></a><span class="lineno"> 466</span>&#160;</div><div class="line"><a name="l00467"></a><span class="lineno"> 467</span>&#160; <span class="keyword">protected</span>:</div><div class="line"><a name="l00471"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a01befb768a81a8e7a366708240ee6d06"> 471</a></span>&#160; Updater <a class="code" href="classmxnet_1_1KVStore.html#a01befb768a81a8e7a366708240ee6d06">updater_</a>;</div><div class="line"><a name="l00472"></a><span class="lineno"> 472</span>&#160;</div><div class="line"><a name="l00476"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#abf0f494ba57dd7b035ece0d96eb5575f"> 476</a></span>&#160; StrUpdater <a class="code" href="classmxnet_1_1KVStore.html#abf0f494ba57dd7b035ece0d96eb5575f">str_updater_</a>;</div><div class="line"><a name="l00477"></a><span class="lineno"> 477</span>&#160;</div><div class="line"><a name="l00481"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#ad1023ca677c6e87ccc7d92c4df48bd40"> 481</a></span>&#160; std::string <a class="code" href="classmxnet_1_1KVStore.html#ad1023ca677c6e87ccc7d92c4df48bd40">type_</a>;</div><div class="line"><a name="l00482"></a><span class="lineno"> 482</span>&#160;</div><div class="line"><a name="l00487"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a4131e7db30b5e7be34997abcf75741a6"> 487</a></span>&#160; std::shared_ptr&lt;kvstore::GradientCompression&gt; <a class="code" href="classmxnet_1_1KVStore.html#a4131e7db30b5e7be34997abcf75741a6">gradient_compression_</a>;</div><div class="line"><a name="l00488"></a><span class="lineno"> 488</span>&#160;</div><div class="line"><a name="l00492"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#aa8ba7abf8334326cab19eb568cb31cfa"> 492</a></span>&#160; std::atomic&lt;bool&gt; barrier_before_exit_{<span class="keyword">true</span>};</div><div class="line"><a name="l00493"></a><span class="lineno"> 493</span>&#160;};</div><div class="line"><a name="l00494"></a><span class="lineno"> 494</span>&#160;</div><div class="line"><a name="l00495"></a><span class="lineno"> 495</span>&#160;} <span class="comment">// namespace mxnet</span></div><div class="line"><a name="l00496"></a><span class="lineno"> 496</span>&#160;<span class="preprocessor">#endif // MXNET_KVSTORE_H_</span></div><div class="ttc" id="classmxnet_1_1KVStore_html"><div class="ttname"><a href="classmxnet_1_1KVStore.html">mxnet::KVStore</a></div><div class="ttdoc">distributed key-value store </div><div class="ttdef"><b>Definition:</b> kvstore.h:58</div></div>
<div class="ttc" id="namespacemxnet_html_a691b662ef3ae22904fc7d7d63db4c14eac01ffbc8ad7ddf59499b096d62edcdff"><div class="ttname"><a href="namespacemxnet.html#a691b662ef3ae22904fc7d7d63db4c14eac01ffbc8ad7ddf59499b096d62edcdff">mxnet::KVStoreServerProfilerCommand::kSetConfig</a></div></div>
<div class="ttc" id="classmxnet_1_1KVStore_html_a6e4a76bd57f185349c58a5a658c32a64"><div class="ttname"><a href="classmxnet_1_1KVStore.html#a6e4a76bd57f185349c58a5a658c32a64">mxnet::KVStore::Updater</a></div><div class="ttdeci">std::function&lt; void(int, const NDArray &amp;, NDArray *)&gt; Updater</div><div class="ttdoc">the prototype of user-defined updater </div><div class="ttdef"><b>Definition:</b> kvstore.h:282</div></div>
<div class="ttc" id="namespacemxnet_html"><div class="ttname"><a href="namespacemxnet.html">mxnet</a></div><div class="ttdoc">namespace of mxnet </div><div class="ttdef"><b>Definition:</b> api_registry.h:33</div></div>
<div class="ttc" id="classmxnet_1_1KVStore_html_a2314122405a7f3ed5f9df55cb6a66f2a"><div class="ttname"><a href="classmxnet_1_1KVStore.html#a2314122405a7f3ed5f9df55cb6a66f2a">mxnet::KVStore::get_group_size</a></div><div class="ttdeci">virtual int get_group_size() const</div><div class="ttdef"><b>Definition:</b> kvstore.h:395</div></div>
<div class="ttc" id="classmxnet_1_1KVStore_html_a777f1de6348bba9ef62b56064a6e0c46"><div class="ttname"><a href="classmxnet_1_1KVStore.html#a777f1de6348bba9ef62b56064a6e0c46">mxnet::KVStore::set_updater</a></div><div class="ttdeci">virtual void set_updater(const StrUpdater &amp;updater)</div><div class="ttdoc">set an updater with string keys </div><div class="ttdef"><b>Definition:</b> kvstore.h:310</div></div>
<div class="ttc" id="classmxnet_1_1KVStore_html_a01befb768a81a8e7a366708240ee6d06"><div class="ttname"><a href="classmxnet_1_1KVStore.html#a01befb768a81a8e7a366708240ee6d06">mxnet::KVStore::updater_</a></div><div class="ttdeci">Updater updater_</div><div class="ttdoc">the user-defined updater </div><div class="ttdef"><b>Definition:</b> kvstore.h:471</div></div>
<div class="ttc" id="classmxnet_1_1KVStore_html_a722b2150dbf50d528fce62307809f949"><div class="ttname"><a href="classmxnet_1_1KVStore.html#a722b2150dbf50d528fce62307809f949">mxnet::KVStore::type</a></div><div class="ttdeci">const std::string &amp; type()</div><div class="ttdoc">return the type </div><div class="ttdef"><b>Definition:</b> kvstore.h:78</div></div>
<div class="ttc" id="classmxnet_1_1KVStore_html_a41113b9dfeab6c705ba064cc3f010fb4"><div class="ttname"><a href="classmxnet_1_1KVStore.html#a41113b9dfeab6c705ba064cc3f010fb4">mxnet::KVStore::IsSchedulerNode</a></div><div class="ttdeci">static bool IsSchedulerNode()</div><div class="ttdef"><b>Definition:</b> kvstore.h:373</div></div>
<div class="ttc" id="classmxnet_1_1KVStore_html_a4f9275fb7a11589fae1dcc5a8a3354ac"><div class="ttname"><a href="classmxnet_1_1KVStore.html#a4f9275fb7a11589fae1dcc5a8a3354ac">mxnet::KVStore::Barrier</a></div><div class="ttdeci">virtual void Barrier()</div><div class="ttdoc">global barrier among all worker machines </div><div class="ttdef"><b>Definition:</b> kvstore.h:418</div></div>
<div class="ttc" id="classmxnet_1_1KVStore_html_a5d919a7a4c9495e9a569c8d733d6325f"><div class="ttname"><a href="classmxnet_1_1KVStore.html#a5d919a7a4c9495e9a569c8d733d6325f">mxnet::KVStore::InitPSEnv</a></div><div class="ttdeci">static void InitPSEnv(const std::unordered_map&lt; std::string, std::string &gt; &amp;envs)</div><div class="ttdoc">initalize ps-lite environment variables </div><div class="ttdef"><b>Definition:</b> kvstore.h:323</div></div>
<div class="ttc" id="namespacemxnet_html_a691b662ef3ae22904fc7d7d63db4c14eaafd8bac1c90d2b1e9ad1ea7d74c46618"><div class="ttname"><a href="namespacemxnet.html#a691b662ef3ae22904fc7d7d63db4c14eaafd8bac1c90d2b1e9ad1ea7d74c46618">mxnet::KVStoreServerProfilerCommand::kState</a></div></div>
<div class="ttc" id="3rdparty_2dmlc-core_2include_2dmlc_2io_8h_html"><div class="ttname"><a href="3rdparty_2dmlc-core_2include_2dmlc_2io_8h.html">io.h</a></div></div>
<div class="ttc" id="classmxnet_1_1KVStore_html_ab216fb292fa77e843e95f474fa671a20"><div class="ttname"><a href="classmxnet_1_1KVStore.html#ab216fb292fa77e843e95f474fa671a20">mxnet::KVStore::IsWorkerNode</a></div><div class="ttdeci">static bool IsWorkerNode()</div><div class="ttdef"><b>Definition:</b> kvstore.h:336</div></div>
<div class="ttc" id="classmxnet_1_1KVStore_html_a02e23071eb46464b58f2e2bf5654d6d6"><div class="ttname"><a href="classmxnet_1_1KVStore.html#a02e23071eb46464b58f2e2bf5654d6d6">mxnet::KVStore::~KVStore</a></div><div class="ttdeci">virtual ~KVStore()</div><div class="ttdoc">virtual destructor </div><div class="ttdef"><b>Definition:</b> kvstore.h:61</div></div>
<div class="ttc" id="classmxnet_1_1KVStore_html_afa87753d90fc7e75234229834ea23abb"><div class="ttname"><a href="classmxnet_1_1KVStore.html#afa87753d90fc7e75234229834ea23abb">mxnet::KVStore::set_barrier_before_exit</a></div><div class="ttdeci">void set_barrier_before_exit(const bool barrier_before_exit)</div><div class="ttdef"><b>Definition:</b> kvstore.h:359</div></div>
<div class="ttc" id="classmxnet_1_1KVStore_html_a9e11acc2968464f907633a1c72e4d545"><div class="ttname"><a href="classmxnet_1_1KVStore.html#a9e11acc2968464f907633a1c72e4d545">mxnet::KVStore::SetServerProfilerCommand</a></div><div class="ttdeci">virtual void SetServerProfilerCommand(const KVStoreServerProfilerCommand type, const std::string &amp;params)</div><div class="ttdoc">Sends server profiler commands to all server nodes Only the worker with rank=0 sends the command whic...</div><div class="ttdef"><b>Definition:</b> kvstore.h:439</div></div>
<div class="ttc" id="namespacemxnet_html_a691b662ef3ae22904fc7d7d63db4c14ea0193ec3ba4814ec4c6c0714a97f1bcac"><div class="ttname"><a href="namespacemxnet.html#a691b662ef3ae22904fc7d7d63db4c14ea0193ec3ba4814ec4c6c0714a97f1bcac">mxnet::KVStoreServerProfilerCommand::kDump</a></div></div>
<div class="ttc" id="classmxnet_1_1KVStore_html_abf0f494ba57dd7b035ece0d96eb5575f"><div class="ttname"><a href="classmxnet_1_1KVStore.html#abf0f494ba57dd7b035ece0d96eb5575f">mxnet::KVStore::str_updater_</a></div><div class="ttdeci">StrUpdater str_updater_</div><div class="ttdoc">the user-defined updater with string keys </div><div class="ttdef"><b>Definition:</b> kvstore.h:476</div></div>
<div class="ttc" id="classmxnet_1_1KVStore_html_a9bbe72794d75a2d8d804124ee686c01c"><div class="ttname"><a href="classmxnet_1_1KVStore.html#a9bbe72794d75a2d8d804124ee686c01c">mxnet::KVStore::get_num_dead_node</a></div><div class="ttdeci">virtual int get_num_dead_node(int node_id, int timeout=60) const</div><div class="ttdef"><b>Definition:</b> kvstore.h:407</div></div>
<div class="ttc" id="classmxnet_1_1KVStore_html_a4131e7db30b5e7be34997abcf75741a6"><div class="ttname"><a href="classmxnet_1_1KVStore.html#a4131e7db30b5e7be34997abcf75741a6">mxnet::KVStore::gradient_compression_</a></div><div class="ttdeci">std::shared_ptr&lt; kvstore::GradientCompression &gt; gradient_compression_</div><div class="ttdoc">Gradient compression object starts with GC_NONE mode Used if SetGradientCompression sets the type...</div><div class="ttdef"><b>Definition:</b> kvstore.h:487</div></div>
<div class="ttc" id="classmxnet_1_1KVStore_html_ae137ab8b5407060529c18a8084946d0b"><div class="ttname"><a href="classmxnet_1_1KVStore.html#ae137ab8b5407060529c18a8084946d0b">mxnet::KVStore::RunServer</a></div><div class="ttdeci">virtual void RunServer(const Controller &amp;controller)</div><div class="ttdoc">Run as server (or scheduler) </div><div class="ttdef"><b>Definition:</b> kvstore.h:465</div></div>
<div class="ttc" id="classmxnet_1_1KVStore_html_abe6963a386cc6dc579029349a447d1cb"><div class="ttname"><a href="classmxnet_1_1KVStore.html#abe6963a386cc6dc579029349a447d1cb">mxnet::KVStore::StrUpdater</a></div><div class="ttdeci">std::function&lt; void(const std::string &amp;, const NDArray &amp;, NDArray *)&gt; StrUpdater</div><div class="ttdoc">the prototype of user-defined updater with string keys </div><div class="ttdef"><b>Definition:</b> kvstore.h:286</div></div>
<div class="ttc" id="classmxnet_1_1KVStore_html_afa281ae77e3ca58beaee6f3a5feafbc1"><div class="ttname"><a href="classmxnet_1_1KVStore.html#afa281ae77e3ca58beaee6f3a5feafbc1">mxnet::KVStore::get_rank</a></div><div class="ttdeci">virtual int get_rank() const</div><div class="ttdef"><b>Definition:</b> kvstore.h:388</div></div>
<div class="ttc" id="namespacemxnet_html_a691b662ef3ae22904fc7d7d63db4c14ea583e1d2af95bc205bafe3341b26ea286"><div class="ttname"><a href="namespacemxnet.html#a691b662ef3ae22904fc7d7d63db4c14ea583e1d2af95bc205bafe3341b26ea286">mxnet::KVStoreServerProfilerCommand::kPause</a></div></div>
<div class="ttc" id="classmxnet_1_1KVStore_html_a4ff4ca05f3c519ebbc2e46264e8b63dd"><div class="ttname"><a href="classmxnet_1_1KVStore.html#a4ff4ca05f3c519ebbc2e46264e8b63dd">mxnet::KVStore::SendCommandToServers</a></div><div class="ttdeci">virtual void SendCommandToServers(int cmd_id, const std::string &amp;cmd_body)</div><div class="ttdoc">Send a command to all server nodes. </div><div class="ttdef"><b>Definition:</b> kvstore.h:431</div></div>
<div class="ttc" id="classmxnet_1_1KVStore_html_ad1023ca677c6e87ccc7d92c4df48bd40"><div class="ttname"><a href="classmxnet_1_1KVStore.html#ad1023ca677c6e87ccc7d92c4df48bd40">mxnet::KVStore::type_</a></div><div class="ttdeci">std::string type_</div><div class="ttdoc">the kvstore type </div><div class="ttdef"><b>Definition:</b> kvstore.h:481</div></div>
<div class="ttc" id="include_2mxnet_2ndarray_8h_html"><div class="ttname"><a href="include_2mxnet_2ndarray_8h.html">ndarray.h</a></div></div>
<div class="ttc" id="classmxnet_1_1KVStore_html_a50db5cb1a140fb84c8e31def54270ae3"><div class="ttname"><a href="classmxnet_1_1KVStore.html#a50db5cb1a140fb84c8e31def54270ae3">mxnet::KVStore::Controller</a></div><div class="ttdeci">std::function&lt; void(int, const std::string &amp;)&gt; Controller</div><div class="ttdoc">the prototype of a server controller </div><div class="ttdef"><b>Definition:</b> kvstore.h:450</div></div>
<div class="ttc" id="classmxnet_1_1KVStore_html_a352ef7eae04211eca1ed47401a6d15d5"><div class="ttname"><a href="classmxnet_1_1KVStore.html#a352ef7eae04211eca1ed47401a6d15d5">mxnet::KVStore::set_updater</a></div><div class="ttdeci">virtual void set_updater(const Updater &amp;updater)</div><div class="ttdoc">set an updater </div><div class="ttdef"><b>Definition:</b> kvstore.h:296</div></div>
<div class="ttc" id="namespacemxnet_html_a691b662ef3ae22904fc7d7d63db4c14e"><div class="ttname"><a href="namespacemxnet.html#a691b662ef3ae22904fc7d7d63db4c14e">mxnet::KVStoreServerProfilerCommand</a></div><div class="ttdeci">KVStoreServerProfilerCommand</div><div class="ttdoc">enum to denote types of commands kvstore sends to server regarding profiler kSetConfig sets profiler ...</div><div class="ttdef"><b>Definition:</b> kvstore.h:48</div></div>
<div class="ttc" id="classmxnet_1_1KVStore_html_a101178924ce1d635b0c8c2a5bce0ceaf"><div class="ttname"><a href="classmxnet_1_1KVStore.html#a101178924ce1d635b0c8c2a5bce0ceaf">mxnet::KVStore::IsServerNode</a></div><div class="ttdeci">static bool IsServerNode()</div><div class="ttdef"><b>Definition:</b> kvstore.h:350</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 5 2023 00:58:42 for mxnet by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>