| <!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"> |
| <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.17"/> |
| <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.17 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</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> <span class="comment">/*</span></div> |
| <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <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> <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> <span class="comment"> * distributed with this work for additional information</span></div> |
| <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <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> <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> <span class="comment"> * "License"); you may not use this file except in compliance</span></div> |
| <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <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> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <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> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <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> <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> <span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div> |
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <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> <span class="comment"> * specific language governing permissions and limitations</span></div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * under the License.</span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> */</span></div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#ifndef MXNET_KVSTORE_H_</span></div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#define MXNET_KVSTORE_H_</span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <<a class="code" href="3rdparty_2dmlc-core_2include_2dmlc_2io_8h.html">dmlc/io.h</a>></span></div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <vector></span></div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <utility></span></div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <unordered_map></span></div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include <string></span></div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include <functional></span></div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include <atomic></span></div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include "../../src/kvstore/gradient_compression.h"</span></div> |
| <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#include "<a class="code" href="include_2mxnet_2ndarray_8h.html">./ndarray.h</a>"</span></div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#if MXNET_USE_DIST_KVSTORE</span></div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#include "ps/ps.h"</span></div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#endif // MXNET_USE_DIST_KVSTORE</span></div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  </div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <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>  </div> |
| <div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="namespacemxnet.html#a691b662ef3ae22904fc7d7d63db4c14e"> 48</a></span> <span class="keyword">enum class</span> <a class="code" href="namespacemxnet.html#a691b662ef3ae22904fc7d7d63db4c14e">KVStoreServerProfilerCommand</a> { <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="l00049"></a><span class="lineno"> 49</span>  </div> |
| <div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html"> 56</a></span> <span class="keyword">class </span><a class="code" href="classmxnet_1_1KVStore.html">KVStore</a> {</div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a02e23071eb46464b58f2e2bf5654d6d6"> 59</a></span>  <span class="keyword">virtual</span> <a class="code" href="classmxnet_1_1KVStore.html#a02e23071eb46464b58f2e2bf5654d6d6">~KVStore</a>() {}</div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  </div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">static</span> <a class="code" href="classmxnet_1_1KVStore.html">KVStore</a>* <a class="code" href="classmxnet_1_1KVStore.html#a6d54b075d3b43577f8339b25000a0c82">Create</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classmxnet_1_1KVStore.html#a722b2150dbf50d528fce62307809f949">type</a> = <span class="stringliteral">"local"</span>);</div> |
| <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  </div> |
| <div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a722b2150dbf50d528fce62307809f949"> 76</a></span>  <span class="keyword">inline</span> <span class="keyword">const</span> std::string& <a class="code" href="classmxnet_1_1KVStore.html#a722b2150dbf50d528fce62307809f949">type</a>() {</div> |
| <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordflow">return</span> <a class="code" href="classmxnet_1_1KVStore.html#ad1023ca677c6e87ccc7d92c4df48bd40">type_</a>;</div> |
| <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  }</div> |
| <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  </div> |
| <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1KVStore.html#a3aae0b1cb7229501974607869ae0f50a">SetGradientCompression</a>(</div> |
| <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keyword">const</span> std::vector<std::pair<std::string, std::string>>& kwargs) = 0;</div> |
| <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  </div> |
| <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1KVStore.html#af4e56c1f2b90bdd02e2c4e7d2abf6265">Init</a>(<span class="keyword">const</span> std::vector<int>& keys, <span class="keyword">const</span> std::vector<NDArray>& values) = 0;</div> |
| <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1KVStore.html#af4e56c1f2b90bdd02e2c4e7d2abf6265">Init</a>(<span class="keyword">const</span> std::vector<std::string>& str_keys,</div> |
| <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keyword">const</span> std::vector<NDArray>& values) = 0;</div> |
| <div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1KVStore.html#a56a3b6d687700f7c71310cd47ab5a54c">Push</a>(<span class="keyword">const</span> std::vector<int>& keys,</div> |
| <div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="keyword">const</span> std::vector<NDArray>& values,</div> |
| <div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <span class="keywordtype">int</span> priority = 0) = 0;</div> |
| <div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  </div> |
| <div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1KVStore.html#a56a3b6d687700f7c71310cd47ab5a54c">Push</a>(<span class="keyword">const</span> std::vector<std::string>& str_keys,</div> |
| <div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <span class="keyword">const</span> std::vector<NDArray>& values,</div> |
| <div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <span class="keywordtype">int</span> priority = 0) = 0;</div> |
| <div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1KVStore.html#a92c899827e29d647dab3498bbd4d2f1f">Pull</a>(<span class="keyword">const</span> std::vector<int>& keys,</div> |
| <div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  <span class="keyword">const</span> std::vector<NDArray*>& values,</div> |
| <div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  <span class="keywordtype">int</span> priority = 0,</div> |
| <div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  <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>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1KVStore.html#a92c899827e29d647dab3498bbd4d2f1f">Pull</a>(<span class="keyword">const</span> std::vector<std::string>& str_keys,</div> |
| <div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  <span class="keyword">const</span> std::vector<NDArray*>& values,</div> |
| <div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  <span class="keywordtype">int</span> priority = 0,</div> |
| <div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  <span class="keywordtype">bool</span> ignore_sparse = <span class="keyword">true</span>) = 0;</div> |
| <div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  </div> |
| <div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1KVStore.html#a16555138777c6e82cb2a2e6279a759c8">Broadcast</a>(<span class="keyword">const</span> std::vector<int>& vkeys,</div> |
| <div class="line"><a name="l00210"></a><span class="lineno"> 210</span>  <span class="keyword">const</span> std::vector<int>& okeys,</div> |
| <div class="line"><a name="l00211"></a><span class="lineno"> 211</span>  <span class="keyword">const</span> std::vector<NDArray>& values,</div> |
| <div class="line"><a name="l00212"></a><span class="lineno"> 212</span>  <span class="keyword">const</span> std::vector<NDArray*>& outs,</div> |
| <div class="line"><a name="l00213"></a><span class="lineno"> 213</span>  <span class="keywordtype">int</span> priority = 0) = 0;</div> |
| <div class="line"><a name="l00214"></a><span class="lineno"> 214</span>  </div> |
| <div class="line"><a name="l00224"></a><span class="lineno"> 224</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1KVStore.html#a16555138777c6e82cb2a2e6279a759c8">Broadcast</a>(<span class="keyword">const</span> std::vector<std::string>& str_vkeys,</div> |
| <div class="line"><a name="l00225"></a><span class="lineno"> 225</span>  <span class="keyword">const</span> std::vector<std::string>& str_okeys,</div> |
| <div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  <span class="keyword">const</span> std::vector<NDArray>& values,</div> |
| <div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  <span class="keyword">const</span> std::vector<NDArray*>& outs,</div> |
| <div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  <span class="keywordtype">int</span> priority = 0) = 0;</div> |
| <div class="line"><a name="l00229"></a><span class="lineno"> 229</span>  </div> |
| <div class="line"><a name="l00238"></a><span class="lineno"> 238</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1KVStore.html#a2e477197e8e9c3484370317315bb6648">PushPull</a>(<span class="keyword">const</span> std::vector<int>& vkeys,</div> |
| <div class="line"><a name="l00239"></a><span class="lineno"> 239</span>  <span class="keyword">const</span> std::vector<int>& okeys,</div> |
| <div class="line"><a name="l00240"></a><span class="lineno"> 240</span>  <span class="keyword">const</span> std::vector<NDArray>& values,</div> |
| <div class="line"><a name="l00241"></a><span class="lineno"> 241</span>  <span class="keyword">const</span> std::vector<NDArray*>& outs,</div> |
| <div class="line"><a name="l00242"></a><span class="lineno"> 242</span>  <span class="keywordtype">int</span> priority = 0) = 0;</div> |
| <div class="line"><a name="l00243"></a><span class="lineno"> 243</span>  </div> |
| <div class="line"><a name="l00253"></a><span class="lineno"> 253</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1KVStore.html#a2e477197e8e9c3484370317315bb6648">PushPull</a>(<span class="keyword">const</span> std::vector<std::string>& str_vkeys,</div> |
| <div class="line"><a name="l00254"></a><span class="lineno"> 254</span>  <span class="keyword">const</span> std::vector<std::string>& str_okeys,</div> |
| <div class="line"><a name="l00255"></a><span class="lineno"> 255</span>  <span class="keyword">const</span> std::vector<NDArray>& values,</div> |
| <div class="line"><a name="l00256"></a><span class="lineno"> 256</span>  <span class="keyword">const</span> std::vector<NDArray*>& outs,</div> |
| <div class="line"><a name="l00257"></a><span class="lineno"> 257</span>  <span class="keywordtype">int</span> priority = 0) = 0;</div> |
| <div class="line"><a name="l00266"></a><span class="lineno"> 266</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1KVStore.html#ade6175a35ee3c660b7d254953d1a0070">PullRowSparse</a>(<span class="keyword">const</span> std::vector<int>& str_keys,</div> |
| <div class="line"><a name="l00267"></a><span class="lineno"> 267</span>  <span class="keyword">const</span> std::vector<std::pair<NDArray*, NDArray>>& val_rowids,</div> |
| <div class="line"><a name="l00268"></a><span class="lineno"> 268</span>  <span class="keywordtype">int</span> priority = 0) = 0;</div> |
| <div class="line"><a name="l00269"></a><span class="lineno"> 269</span>  </div> |
| <div class="line"><a name="l00278"></a><span class="lineno"> 278</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1KVStore.html#ade6175a35ee3c660b7d254953d1a0070">PullRowSparse</a>(<span class="keyword">const</span> std::vector<std::string>& str_keys,</div> |
| <div class="line"><a name="l00279"></a><span class="lineno"> 279</span>  <span class="keyword">const</span> std::vector<std::pair<NDArray*, NDArray>>& val_rowids,</div> |
| <div class="line"><a name="l00280"></a><span class="lineno"> 280</span>  <span class="keywordtype">int</span> priority = 0) = 0;</div> |
| <div class="line"><a name="l00281"></a><span class="lineno"> 281</span>  </div> |
| <div class="line"><a name="l00285"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a6e4a76bd57f185349c58a5a658c32a64"> 285</a></span>  <span class="keyword">typedef</span> std::function<void(<span class="keywordtype">int</span>, <span class="keyword">const</span> <a class="code" href="classmxnet_1_1NDArray.html">NDArray</a>&, <a class="code" href="classmxnet_1_1NDArray.html">NDArray</a>*)> <a class="code" href="classmxnet_1_1KVStore.html#a6e4a76bd57f185349c58a5a658c32a64">Updater</a>;</div> |
| <div class="line"><a name="l00289"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#abe6963a386cc6dc579029349a447d1cb"> 289</a></span>  <span class="keyword">typedef</span> std::function<void(<span class="keyword">const</span> std::string&, <span class="keyword">const</span> <a class="code" href="classmxnet_1_1NDArray.html">NDArray</a>&, <a class="code" href="classmxnet_1_1NDArray.html">NDArray</a>*)> <a class="code" href="classmxnet_1_1KVStore.html#abe6963a386cc6dc579029349a447d1cb">StrUpdater</a>;</div> |
| <div class="line"><a name="l00299"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a352ef7eae04211eca1ed47401a6d15d5"> 299</a></span>  <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> <a class="code" href="classmxnet_1_1KVStore.html#a6e4a76bd57f185349c58a5a658c32a64">Updater</a>& updater) {</div> |
| <div class="line"><a name="l00300"></a><span class="lineno"> 300</span>  CHECK(updater) << <span class="stringliteral">"invalid updater"</span>;</div> |
| <div class="line"><a name="l00301"></a><span class="lineno"> 301</span>  <a class="code" href="classmxnet_1_1KVStore.html#a01befb768a81a8e7a366708240ee6d06">updater_</a> = updater;</div> |
| <div class="line"><a name="l00302"></a><span class="lineno"> 302</span>  }</div> |
| <div class="line"><a name="l00303"></a><span class="lineno"> 303</span>  </div> |
| <div class="line"><a name="l00313"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a777f1de6348bba9ef62b56064a6e0c46"> 313</a></span>  <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> <a class="code" href="classmxnet_1_1KVStore.html#abe6963a386cc6dc579029349a447d1cb">StrUpdater</a>& updater) {</div> |
| <div class="line"><a name="l00314"></a><span class="lineno"> 314</span>  CHECK(updater) << <span class="stringliteral">"invalid updater"</span>;</div> |
| <div class="line"><a name="l00315"></a><span class="lineno"> 315</span>  <a class="code" href="classmxnet_1_1KVStore.html#abf0f494ba57dd7b035ece0d96eb5575f">str_updater_</a> = updater;</div> |
| <div class="line"><a name="l00316"></a><span class="lineno"> 316</span>  }</div> |
| <div class="line"><a name="l00317"></a><span class="lineno"> 317</span>  </div> |
| <div class="line"><a name="l00318"></a><span class="lineno"> 318</span> <span class="comment"> /******************************************************</span></div> |
| <div class="line"><a name="l00319"></a><span class="lineno"> 319</span> <span class="comment"> * the following are used for multi-machines.</span></div> |
| <div class="line"><a name="l00320"></a><span class="lineno"> 320</span> <span class="comment"> ******************************************************/</span></div> |
| <div class="line"><a name="l00321"></a><span class="lineno"> 321</span>  </div> |
| <div class="line"><a name="l00326"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a5d919a7a4c9495e9a569c8d733d6325f"> 326</a></span>  <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<std::string, std::string>& envs) {</div> |
| <div class="line"><a name="l00327"></a><span class="lineno"> 327</span> <span class="preprocessor">#if MXNET_USE_DIST_KVSTORE</span></div> |
| <div class="line"><a name="l00328"></a><span class="lineno"> 328</span>  ps::Environment::Init(envs);</div> |
| <div class="line"><a name="l00329"></a><span class="lineno"> 329</span> <span class="preprocessor">#else</span></div> |
| <div class="line"><a name="l00330"></a><span class="lineno"> 330</span>  LOG(FATAL) << <span class="stringliteral">"compile with USE_DIST_KVSTORE=1 to init parameter server's environment"</span>;</div> |
| <div class="line"><a name="l00331"></a><span class="lineno"> 331</span> <span class="preprocessor">#endif // MXNET_USE_DIST_KVSTORE</span></div> |
| <div class="line"><a name="l00332"></a><span class="lineno"> 332</span>  }</div> |
| <div class="line"><a name="l00333"></a><span class="lineno"> 333</span>  </div> |
| <div class="line"><a name="l00339"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#ab216fb292fa77e843e95f474fa671a20"> 339</a></span>  <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="l00340"></a><span class="lineno"> 340</span> <span class="preprocessor">#if MXNET_USE_DIST_KVSTORE</span></div> |
| <div class="line"><a name="l00341"></a><span class="lineno"> 341</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* role_str = ps::Environment::Get()->find(<span class="stringliteral">"DMLC_ROLE"</span>);</div> |
| <div class="line"><a name="l00342"></a><span class="lineno"> 342</span>  <span class="keywordflow">return</span> (role_str == <span class="keyword">nullptr</span>) || (!strcmp(role_str, <span class="stringliteral">"worker"</span>));</div> |
| <div class="line"><a name="l00343"></a><span class="lineno"> 343</span> <span class="preprocessor">#else</span></div> |
| <div class="line"><a name="l00344"></a><span class="lineno"> 344</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div> |
| <div class="line"><a name="l00345"></a><span class="lineno"> 345</span> <span class="preprocessor">#endif // MXNET_USE_DIST_KVSTORE</span></div> |
| <div class="line"><a name="l00346"></a><span class="lineno"> 346</span>  }</div> |
| <div class="line"><a name="l00347"></a><span class="lineno"> 347</span>  </div> |
| <div class="line"><a name="l00353"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a101178924ce1d635b0c8c2a5bce0ceaf"> 353</a></span>  <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="l00354"></a><span class="lineno"> 354</span> <span class="preprocessor">#if MXNET_USE_DIST_KVSTORE</span></div> |
| <div class="line"><a name="l00355"></a><span class="lineno"> 355</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* role_str = ps::Environment::Get()->find(<span class="stringliteral">"DMLC_ROLE"</span>);</div> |
| <div class="line"><a name="l00356"></a><span class="lineno"> 356</span>  <span class="keywordflow">return</span> (role_str != <span class="keyword">nullptr</span>) && (!strcmp(role_str, <span class="stringliteral">"server"</span>));</div> |
| <div class="line"><a name="l00357"></a><span class="lineno"> 357</span> <span class="preprocessor">#else</span></div> |
| <div class="line"><a name="l00358"></a><span class="lineno"> 358</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div> |
| <div class="line"><a name="l00359"></a><span class="lineno"> 359</span> <span class="preprocessor">#endif // MXNET_USE_DIST_KVSTORE</span></div> |
| <div class="line"><a name="l00360"></a><span class="lineno"> 360</span>  }</div> |
| <div class="line"><a name="l00361"></a><span class="lineno"> 361</span>  </div> |
| <div class="line"><a name="l00362"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#afa87753d90fc7e75234229834ea23abb"> 362</a></span>  <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="l00363"></a><span class="lineno"> 363</span> <span class="preprocessor">#if MXNET_USE_DIST_KVSTORE</span></div> |
| <div class="line"><a name="l00364"></a><span class="lineno"> 364</span>  <span class="keywordflow">if</span> (!<a class="code" href="classmxnet_1_1KVStore.html#ab216fb292fa77e843e95f474fa671a20">IsWorkerNode</a>())</div> |
| <div class="line"><a name="l00365"></a><span class="lineno"> 365</span>  LOG(FATAL) << <span class="stringliteral">"barrier_before_exit takes effect only on worker nodes"</span>;</div> |
| <div class="line"><a name="l00366"></a><span class="lineno"> 366</span>  <a class="code" href="classmxnet_1_1KVStore.html#aa8ba7abf8334326cab19eb568cb31cfa">barrier_before_exit_</a> = barrier_before_exit;</div> |
| <div class="line"><a name="l00367"></a><span class="lineno"> 367</span> <span class="preprocessor">#else</span></div> |
| <div class="line"><a name="l00368"></a><span class="lineno"> 368</span>  LOG(FATAL) << <span class="stringliteral">"compile with USE_DIST_KVSTORE=1 to enable barrier"</span>;</div> |
| <div class="line"><a name="l00369"></a><span class="lineno"> 369</span> <span class="preprocessor">#endif</span></div> |
| <div class="line"><a name="l00370"></a><span class="lineno"> 370</span>  }</div> |
| <div class="line"><a name="l00371"></a><span class="lineno"> 371</span>  </div> |
| <div class="line"><a name="l00377"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a41113b9dfeab6c705ba064cc3f010fb4"> 377</a></span>  <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="l00378"></a><span class="lineno"> 378</span> <span class="preprocessor">#if MXNET_USE_DIST_KVSTORE</span></div> |
| <div class="line"><a name="l00379"></a><span class="lineno"> 379</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* role_str = ps::Environment::Get()->find(<span class="stringliteral">"DMLC_ROLE"</span>);</div> |
| <div class="line"><a name="l00380"></a><span class="lineno"> 380</span>  <span class="keywordflow">return</span> (role_str != <span class="keyword">nullptr</span>) && (!strcmp(role_str, <span class="stringliteral">"scheduler"</span>));</div> |
| <div class="line"><a name="l00381"></a><span class="lineno"> 381</span> <span class="preprocessor">#else</span></div> |
| <div class="line"><a name="l00382"></a><span class="lineno"> 382</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div> |
| <div class="line"><a name="l00383"></a><span class="lineno"> 383</span> <span class="preprocessor">#endif // MXNET_USE_DIST_KVSTORE</span></div> |
| <div class="line"><a name="l00384"></a><span class="lineno"> 384</span>  }</div> |
| <div class="line"><a name="l00385"></a><span class="lineno"> 385</span>  </div> |
| <div class="line"><a name="l00392"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#afa281ae77e3ca58beaee6f3a5feafbc1"> 392</a></span>  <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="l00393"></a><span class="lineno"> 393</span>  <span class="keywordflow">return</span> 0;</div> |
| <div class="line"><a name="l00394"></a><span class="lineno"> 394</span>  }</div> |
| <div class="line"><a name="l00395"></a><span class="lineno"> 395</span>  </div> |
| <div class="line"><a name="l00399"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a2314122405a7f3ed5f9df55cb6a66f2a"> 399</a></span>  <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="l00400"></a><span class="lineno"> 400</span>  <span class="keywordflow">return</span> 1;</div> |
| <div class="line"><a name="l00401"></a><span class="lineno"> 401</span>  }</div> |
| <div class="line"><a name="l00402"></a><span class="lineno"> 402</span>  </div> |
| <div class="line"><a name="l00411"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a9bbe72794d75a2d8d804124ee686c01c"> 411</a></span>  <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="l00412"></a><span class="lineno"> 412</span>  <span class="keywordflow">return</span> 0;</div> |
| <div class="line"><a name="l00413"></a><span class="lineno"> 413</span>  }</div> |
| <div class="line"><a name="l00414"></a><span class="lineno"> 414</span>  </div> |
| <div class="line"><a name="l00422"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a4f9275fb7a11589fae1dcc5a8a3354ac"> 422</a></span>  <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="l00423"></a><span class="lineno"> 423</span>  </div> |
| <div class="line"><a name="l00435"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a4ff4ca05f3c519ebbc2e46264e8b63dd"> 435</a></span>  <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& cmd_body) {}</div> |
| <div class="line"><a name="l00436"></a><span class="lineno"> 436</span>  </div> |
| <div class="line"><a name="l00443"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a9e11acc2968464f907633a1c72e4d545"> 443</a></span>  <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> <a class="code" href="classmxnet_1_1KVStore.html#a722b2150dbf50d528fce62307809f949">type</a>,</div> |
| <div class="line"><a name="l00444"></a><span class="lineno"> 444</span>  <span class="keyword">const</span> std::string& params) {</div> |
| <div class="line"><a name="l00445"></a><span class="lineno"> 445</span>  LOG(INFO) << <span class="stringliteral">"Unable to pass server the profiler command. If you are using "</span></div> |
| <div class="line"><a name="l00446"></a><span class="lineno"> 446</span>  << <span class="stringliteral">"distributed kvstore, you need to compile with USE_DIST_KVSTORE=1."</span></div> |
| <div class="line"><a name="l00447"></a><span class="lineno"> 447</span>  << <span class="stringliteral">"If you are training on single machine, then there is no server process"</span></div> |
| <div class="line"><a name="l00448"></a><span class="lineno"> 448</span>  << <span class="stringliteral">"to profile. Please profile the worker process instead."</span>;</div> |
| <div class="line"><a name="l00449"></a><span class="lineno"> 449</span>  }</div> |
| <div class="line"><a name="l00450"></a><span class="lineno"> 450</span>  </div> |
| <div class="line"><a name="l00454"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a50db5cb1a140fb84c8e31def54270ae3"> 454</a></span>  <span class="keyword">typedef</span> std::function<void(<span class="keywordtype">int</span>, <span class="keyword">const</span> std::string&)> <a class="code" href="classmxnet_1_1KVStore.html#a50db5cb1a140fb84c8e31def54270ae3">Controller</a>;</div> |
| <div class="line"><a name="l00455"></a><span class="lineno"> 455</span>  </div> |
| <div class="line"><a name="l00469"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#ae137ab8b5407060529c18a8084946d0b"> 469</a></span>  <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> <a class="code" href="classmxnet_1_1KVStore.html#a50db5cb1a140fb84c8e31def54270ae3">Controller</a>& controller) {}</div> |
| <div class="line"><a name="l00470"></a><span class="lineno"> 470</span>  </div> |
| <div class="line"><a name="l00471"></a><span class="lineno"> 471</span>  <span class="keyword">protected</span>:</div> |
| <div class="line"><a name="l00475"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a01befb768a81a8e7a366708240ee6d06"> 475</a></span>  <a class="code" href="classmxnet_1_1KVStore.html#a6e4a76bd57f185349c58a5a658c32a64">Updater</a> <a class="code" href="classmxnet_1_1KVStore.html#a01befb768a81a8e7a366708240ee6d06">updater_</a>;</div> |
| <div class="line"><a name="l00476"></a><span class="lineno"> 476</span>  </div> |
| <div class="line"><a name="l00480"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#abf0f494ba57dd7b035ece0d96eb5575f"> 480</a></span>  <a class="code" href="classmxnet_1_1KVStore.html#abe6963a386cc6dc579029349a447d1cb">StrUpdater</a> <a class="code" href="classmxnet_1_1KVStore.html#abf0f494ba57dd7b035ece0d96eb5575f">str_updater_</a>;</div> |
| <div class="line"><a name="l00481"></a><span class="lineno"> 481</span>  </div> |
| <div class="line"><a name="l00485"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#ad1023ca677c6e87ccc7d92c4df48bd40"> 485</a></span>  std::string <a class="code" href="classmxnet_1_1KVStore.html#ad1023ca677c6e87ccc7d92c4df48bd40">type_</a>;</div> |
| <div class="line"><a name="l00486"></a><span class="lineno"> 486</span>  </div> |
| <div class="line"><a name="l00491"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a4131e7db30b5e7be34997abcf75741a6"> 491</a></span>  std::shared_ptr<kvstore::GradientCompression> <a class="code" href="classmxnet_1_1KVStore.html#a4131e7db30b5e7be34997abcf75741a6">gradient_compression_</a>;</div> |
| <div class="line"><a name="l00492"></a><span class="lineno"> 492</span>  </div> |
| <div class="line"><a name="l00496"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#aa8ba7abf8334326cab19eb568cb31cfa"> 496</a></span>  std::atomic<bool> <a class="code" href="classmxnet_1_1KVStore.html#aa8ba7abf8334326cab19eb568cb31cfa">barrier_before_exit_</a>{<span class="keyword">true</span>};</div> |
| <div class="line"><a name="l00497"></a><span class="lineno"> 497</span> };</div> |
| <div class="line"><a name="l00498"></a><span class="lineno"> 498</span>  </div> |
| <div class="line"><a name="l00499"></a><span class="lineno"> 499</span> } <span class="comment">// namespace mxnet</span></div> |
| <div class="line"><a name="l00500"></a><span class="lineno"> 500</span> <span class="preprocessor">#endif // MXNET_KVSTORE_H_</span></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <div class="ttc" id="aclassmxnet_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 &updater)</div><div class="ttdoc">set an updater with string keys</div><div class="ttdef"><b>Definition:</b> kvstore.h:313</div></div> |
| <div class="ttc" id="anamespacemxnet_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="aclassmxnet_1_1KVStore_html_ade6175a35ee3c660b7d254953d1a0070"><div class="ttname"><a href="classmxnet_1_1KVStore.html#ade6175a35ee3c660b7d254953d1a0070">mxnet::KVStore::PullRowSparse</a></div><div class="ttdeci">virtual void PullRowSparse(const std::vector< int > &str_keys, const std::vector< std::pair< NDArray *, NDArray >> &val_rowids, int priority=0)=0</div><div class="ttdoc">pull a list of key-value pairs from the store. The NDArray pulled back will be in row_sparse storage ...</div></div> |
| <div class="ttc" id="aclassmxnet_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 &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:443</div></div> |
| <div class="ttc" id="aclassmxnet_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:362</div></div> |
| <div class="ttc" id="aclassmxnet_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:59</div></div> |
| <div class="ttc" id="aclassmxnet_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< std::string, std::string > &envs)</div><div class="ttdoc">initalize ps-lite environment variables</div><div class="ttdef"><b>Definition:</b> kvstore.h:326</div></div> |
| <div class="ttc" id="aclassmxnet_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:480</div></div> |
| <div class="ttc" id="aclassmxnet_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:339</div></div> |
| <div class="ttc" id="aclassmxnet_1_1KVStore_html_a3aae0b1cb7229501974607869ae0f50a"><div class="ttname"><a href="classmxnet_1_1KVStore.html#a3aae0b1cb7229501974607869ae0f50a">mxnet::KVStore::SetGradientCompression</a></div><div class="ttdeci">virtual void SetGradientCompression(const std::vector< std::pair< std::string, std::string >> &kwargs)=0</div><div class="ttdoc">Set parameters to use low-bit compressed gradients.</div></div> |
| <div class="ttc" id="aclassmxnet_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 & type()</div><div class="ttdoc">return the type</div><div class="ttdef"><b>Definition:</b> kvstore.h:76</div></div> |
| <div class="ttc" id="aclassmxnet_1_1KVStore_html_a92c899827e29d647dab3498bbd4d2f1f"><div class="ttname"><a href="classmxnet_1_1KVStore.html#a92c899827e29d647dab3498bbd4d2f1f">mxnet::KVStore::Pull</a></div><div class="ttdeci">virtual void Pull(const std::vector< int > &keys, const std::vector< NDArray * > &values, int priority=0, bool ignore_sparse=true)=0</div><div class="ttdoc">pull a list of key-value pairs from the store</div></div> |
| <div class="ttc" id="aclassmxnet_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 &cmd_body)</div><div class="ttdoc">Send a command to all server nodes.</div><div class="ttdef"><b>Definition:</b> kvstore.h:435</div></div> |
| <div class="ttc" id="aclassmxnet_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:475</div></div> |
| <div class="ttc" id="aclassmxnet_1_1KVStore_html_abe6963a386cc6dc579029349a447d1cb"><div class="ttname"><a href="classmxnet_1_1KVStore.html#abe6963a386cc6dc579029349a447d1cb">mxnet::KVStore::StrUpdater</a></div><div class="ttdeci">std::function< void(const std::string &, const NDArray &, NDArray *)> StrUpdater</div><div class="ttdoc">the prototype of user-defined updater with string keys</div><div class="ttdef"><b>Definition:</b> kvstore.h:289</div></div> |
| <div class="ttc" id="aclassmxnet_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:485</div></div> |
| <div class="ttc" id="aclassmxnet_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:353</div></div> |
| <div class="ttc" id="anamespacemxnet_html_a691b662ef3ae22904fc7d7d63db4c14eac01ffbc8ad7ddf59499b096d62edcdff"><div class="ttname"><a href="namespacemxnet.html#a691b662ef3ae22904fc7d7d63db4c14eac01ffbc8ad7ddf59499b096d62edcdff">mxnet::KVStoreServerProfilerCommand::kSetConfig</a></div><div class="ttdeci">@ kSetConfig</div></div> |
| <div class="ttc" id="aclassmxnet_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:411</div></div> |
| <div class="ttc" id="anamespacemxnet_html_a691b662ef3ae22904fc7d7d63db4c14ea583e1d2af95bc205bafe3341b26ea286"><div class="ttname"><a href="namespacemxnet.html#a691b662ef3ae22904fc7d7d63db4c14ea583e1d2af95bc205bafe3341b26ea286">mxnet::KVStoreServerProfilerCommand::kPause</a></div><div class="ttdeci">@ kPause</div></div> |
| <div class="ttc" id="aclassmxnet_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< kvstore::GradientCompression > 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:491</div></div> |
| <div class="ttc" id="aclassmxnet_1_1KVStore_html_a6d54b075d3b43577f8339b25000a0c82"><div class="ttname"><a href="classmxnet_1_1KVStore.html#a6d54b075d3b43577f8339b25000a0c82">mxnet::KVStore::Create</a></div><div class="ttdeci">static KVStore * Create(const char *type="local")</div><div class="ttdoc">Factory function to create a new KVStore.</div></div> |
| <div class="ttc" id="aclassmxnet_1_1KVStore_html_a50db5cb1a140fb84c8e31def54270ae3"><div class="ttname"><a href="classmxnet_1_1KVStore.html#a50db5cb1a140fb84c8e31def54270ae3">mxnet::KVStore::Controller</a></div><div class="ttdeci">std::function< void(int, const std::string &)> Controller</div><div class="ttdoc">the prototype of a server controller</div><div class="ttdef"><b>Definition:</b> kvstore.h:454</div></div> |
| <div class="ttc" id="aclassmxnet_1_1KVStore_html_aa8ba7abf8334326cab19eb568cb31cfa"><div class="ttname"><a href="classmxnet_1_1KVStore.html#aa8ba7abf8334326cab19eb568cb31cfa">mxnet::KVStore::barrier_before_exit_</a></div><div class="ttdeci">std::atomic< bool > barrier_before_exit_</div><div class="ttdoc">whether to do barrier when finalize</div><div class="ttdef"><b>Definition:</b> kvstore.h:496</div></div> |
| <div class="ttc" id="aclassmxnet_1_1NDArray_html"><div class="ttname"><a href="classmxnet_1_1NDArray.html">mxnet::NDArray</a></div><div class="ttdoc">ndarray interface</div><div class="ttdef"><b>Definition:</b> ndarray.h:82</div></div> |
| <div class="ttc" id="aclassmxnet_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:56</div></div> |
| <div class="ttc" id="aclassmxnet_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:392</div></div> |
| <div class="ttc" id="aclassmxnet_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 &controller)</div><div class="ttdoc">Run as server (or scheduler)</div><div class="ttdef"><b>Definition:</b> kvstore.h:469</div></div> |
| <div class="ttc" id="anamespacemxnet_html_a691b662ef3ae22904fc7d7d63db4c14eaafd8bac1c90d2b1e9ad1ea7d74c46618"><div class="ttname"><a href="namespacemxnet.html#a691b662ef3ae22904fc7d7d63db4c14eaafd8bac1c90d2b1e9ad1ea7d74c46618">mxnet::KVStoreServerProfilerCommand::kState</a></div><div class="ttdeci">@ kState</div></div> |
| <div class="ttc" id="a3rdparty_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 class="ttdoc">defines serializable interface of dmlc</div></div> |
| <div class="ttc" id="aclassmxnet_1_1KVStore_html_a56a3b6d687700f7c71310cd47ab5a54c"><div class="ttname"><a href="classmxnet_1_1KVStore.html#a56a3b6d687700f7c71310cd47ab5a54c">mxnet::KVStore::Push</a></div><div class="ttdeci">virtual void Push(const std::vector< int > &keys, const std::vector< NDArray > &values, int priority=0)=0</div><div class="ttdoc">push a list of key-value pairs into the store</div></div> |
| <div class="ttc" id="aclassmxnet_1_1KVStore_html_a6e4a76bd57f185349c58a5a658c32a64"><div class="ttname"><a href="classmxnet_1_1KVStore.html#a6e4a76bd57f185349c58a5a658c32a64">mxnet::KVStore::Updater</a></div><div class="ttdeci">std::function< void(int, const NDArray &, NDArray *)> Updater</div><div class="ttdoc">the prototype of user-defined updater</div><div class="ttdef"><b>Definition:</b> kvstore.h:285</div></div> |
| <div class="ttc" id="aclassmxnet_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 &updater)</div><div class="ttdoc">set an updater</div><div class="ttdef"><b>Definition:</b> kvstore.h:299</div></div> |
| <div class="ttc" id="aclassmxnet_1_1KVStore_html_af4e56c1f2b90bdd02e2c4e7d2abf6265"><div class="ttname"><a href="classmxnet_1_1KVStore.html#af4e56c1f2b90bdd02e2c4e7d2abf6265">mxnet::KVStore::Init</a></div><div class="ttdeci">virtual void Init(const std::vector< int > &keys, const std::vector< NDArray > &values)=0</div><div class="ttdoc">Initialize a list of key-value pair to the store.</div></div> |
| <div class="ttc" id="aclassmxnet_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:399</div></div> |
| <div class="ttc" id="aclassmxnet_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:422</div></div> |
| <div class="ttc" id="aclassmxnet_1_1KVStore_html_a2e477197e8e9c3484370317315bb6648"><div class="ttname"><a href="classmxnet_1_1KVStore.html#a2e477197e8e9c3484370317315bb6648">mxnet::KVStore::PushPull</a></div><div class="ttdeci">virtual void PushPull(const std::vector< int > &vkeys, const std::vector< int > &okeys, const std::vector< NDArray > &values, const std::vector< NDArray * > &outs, int priority=0)=0</div><div class="ttdoc">push and pull a list of key-value pairs from the store</div></div> |
| <div class="ttc" id="anamespacemxnet_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="anamespacemxnet_html_a691b662ef3ae22904fc7d7d63db4c14ea0193ec3ba4814ec4c6c0714a97f1bcac"><div class="ttname"><a href="namespacemxnet.html#a691b662ef3ae22904fc7d7d63db4c14ea0193ec3ba4814ec4c6c0714a97f1bcac">mxnet::KVStoreServerProfilerCommand::kDump</a></div><div class="ttdeci">@ kDump</div></div> |
| <div class="ttc" id="ainclude_2mxnet_2ndarray_8h_html"><div class="ttname"><a href="include_2mxnet_2ndarray_8h.html">ndarray.h</a></div><div class="ttdoc">NDArray interface that handles array arithematics.</div></div> |
| <div class="ttc" id="aclassmxnet_1_1KVStore_html_a16555138777c6e82cb2a2e6279a759c8"><div class="ttname"><a href="classmxnet_1_1KVStore.html#a16555138777c6e82cb2a2e6279a759c8">mxnet::KVStore::Broadcast</a></div><div class="ttdeci">virtual void Broadcast(const std::vector< int > &vkeys, const std::vector< int > &okeys, const std::vector< NDArray > &values, const std::vector< NDArray * > &outs, int priority=0)=0</div><div class="ttdoc">broadcast a list of key-value pairs from the store</div></div> |
| <div class="ttc" id="aclassmxnet_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:377</div></div> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 5 2023 03:47:39 for mxnet by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.17 |
| </small></address> |
| </body> |
| </html> |
