| <!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 content="text/xhtml;charset=utf-8" http-equiv="Content-Type"/> |
| <meta content="IE=9" http-equiv="X-UA-Compatible"/> |
| <meta content="Doxygen 1.8.11" name="generator"/> |
| <title>mxnet: include/mxnet/kvstore.h Source File</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script src="jquery.js" type="text/javascript"></script> |
| <script src="dynsections.js" type="text/javascript"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script src="search/searchdata.js" type="text/javascript"></script> |
| <script src="search/search.js" type="text/javascript"></script> |
| <script type="text/javascript"> |
| $(document).ready(function() { init_search(); }); |
| </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 cellpadding="0" cellspacing="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.11 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <div class="tabs" id="navrow1"> |
| <ul class="tablist"> |
| <li><a href="index.html"><span>Main Page</span></a></li> |
| <li><a href="namespaces.html"><span>Namespaces</span></a></li> |
| <li><a href="annotated.html"><span>Classes</span></a></li> |
| <li class="current"><a href="files.html"><span>Files</span></a></li> |
| <li> |
| <div class="MSearchBoxInactive" id="MSearchBox"> |
| <span class="left"> |
| <img alt="" id="MSearchSelect" onmouseout="return searchBox.OnSearchSelectHide()" onmouseover="return searchBox.OnSearchSelectShow()" src="search/mag_sel.png"/> |
| <input accesskey="S" id="MSearchField" onblur="searchBox.OnSearchFieldFocus(false)" onfocus="searchBox.OnSearchFieldFocus(true)" onkeyup="searchBox.OnSearchFieldChange(event)" type="text" value="Search"/> |
| </span><span class="right"> |
| <a href="javascript:searchBox.CloseResultsWindow()" id="MSearchClose"><img alt="" border="0" id="MSearchCloseImg" src="search/close.png"/></a> |
| </span> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="tabs2" id="navrow2"> |
| <ul class="tablist"> |
| <li><a href="files.html"><span>File List</span></a></li> |
| <li><a href="globals.html"><span>File Members</span></a></li> |
| </ul> |
| </div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" onkeydown="return searchBox.OnSearchSelectKey(event)" onmouseout="return searchBox.OnSearchSelectHide()" onmouseover="return searchBox.OnSearchSelectShow()"> |
| </div> |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe frameborder="0" id="MSearchResults" name="MSearchResults" src="javascript:void(0)"> |
| </iframe> |
| </div> |
| <div class="navpath" id="nav-path"> |
| <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 <dmlc/io.h></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 <unordered_map></span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include <functional></span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include <atomic></span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include "<a class="code" href="include_2mxnet_2ndarray_8h.html">./ndarray.h</a>"</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#if MXNET_USE_DIST_KVSTORE</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#include "ps/ps.h"</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#endif // MXNET_USE_DIST_KVSTORE</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">namespace </span><a class="code" href="namespacemxnet.html">mxnet</a> {</div><div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html"> 44</a></span> <span class="keyword">class </span><a class="code" href="classmxnet_1_1KVStore.html">KVStore</a> {</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a02e23071eb46464b58f2e2bf5654d6d6"> 47</a></span> <span class="keyword">virtual</span> <a class="code" href="classmxnet_1_1KVStore.html#a02e23071eb46464b58f2e2bf5654d6d6">~KVStore</a>() {}</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</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="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a722b2150dbf50d528fce62307809f949"> 64</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>() { <span class="keywordflow">return</span> <a class="code" href="classmxnet_1_1KVStore.html#ad1023ca677c6e87ccc7d92c4df48bd40">type_</a>; }</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00082"></a><span class="lineno"> 82</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,</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="keyword">const</span> std::vector<NDArray>& values) = 0;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</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="l00090"></a><span class="lineno"> 90</span> <span class="keyword">const</span> std::vector<NDArray>& values) = 0;</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</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="l00128"></a><span class="lineno"> 128</span> <span class="keyword">const</span> std::vector<NDArray>& values,</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="keywordtype">int</span> priority = 0) = 0;</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div><div class="line"><a name="l00137"></a><span class="lineno"> 137</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="l00138"></a><span class="lineno"> 138</span> <span class="keyword">const</span> std::vector<NDArray>& values,</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="keywordtype">int</span> priority = 0) = 0;</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1KVStore.html#a98e041793c133337cecc441e441ed721">Pull</a>(<span class="keyword">const</span> std::vector<int>& keys,</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="keyword">const</span> std::vector<NDArray*>& values,</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="keywordtype">int</span> priority = 0) = 0;</div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1KVStore.html#a98e041793c133337cecc441e441ed721">Pull</a>(<span class="keyword">const</span> std::vector<std::string>& str_keys,</div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="keyword">const</span> std::vector<NDArray*>& values,</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="keywordtype">int</span> priority = 0) = 0;</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> </div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> </div><div class="line"><a name="l00180"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a6e4a76bd57f185349c58a5a658c32a64"> 180</a></span> <span class="keyword">typedef</span> std::function<void(int, const NDArray&, NDArray*)> <a class="code" href="classmxnet_1_1KVStore.html#a6e4a76bd57f185349c58a5a658c32a64">Updater</a>;</div><div class="line"><a name="l00190"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a352ef7eae04211eca1ed47401a6d15d5"> 190</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> Updater& updater) {</div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span> CHECK(updater) << <span class="stringliteral">"invalid updater"</span>;</div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <a class="code" href="classmxnet_1_1KVStore.html#a01befb768a81a8e7a366708240ee6d06">updater_</a> = updater;</div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span> }</div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span> </div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment">/******************************************************</span></div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment"> * the following are used for multi-machines.</span></div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment"> ******************************************************/</span></div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span> </div><div class="line"><a name="l00203"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a5d919a7a4c9495e9a569c8d733d6325f"> 203</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="l00204"></a><span class="lineno"> 204</span> <span class="preprocessor">#if MXNET_USE_DIST_KVSTORE</span></div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span> ps::Environment::Init(envs);</div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00207"></a><span class="lineno"> 207</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="l00208"></a><span class="lineno"> 208</span> <span class="preprocessor">#endif // MXNET_USE_DIST_KVSTORE</span></div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span> }</div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span> </div><div class="line"><a name="l00216"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#ab216fb292fa77e843e95f474fa671a20"> 216</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="l00217"></a><span class="lineno"> 217</span> <span class="preprocessor">#if MXNET_USE_DIST_KVSTORE</span></div><div class="line"><a name="l00218"></a><span class="lineno"> 218</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="l00219"></a><span class="lineno"> 219</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="l00220"></a><span class="lineno"> 220</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="preprocessor">#endif // MXNET_USE_DIST_KVSTORE</span></div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span> }</div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span> </div><div class="line"><a name="l00230"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a101178924ce1d635b0c8c2a5bce0ceaf"> 230</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="l00231"></a><span class="lineno"> 231</span> <span class="preprocessor">#if MXNET_USE_DIST_KVSTORE</span></div><div class="line"><a name="l00232"></a><span class="lineno"> 232</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="l00233"></a><span class="lineno"> 233</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="l00234"></a><span class="lineno"> 234</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="preprocessor">#endif // MXNET_USE_DIST_KVSTORE</span></div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span> }</div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span> </div><div class="line"><a name="l00239"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#afa87753d90fc7e75234229834ea23abb"> 239</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="l00240"></a><span class="lineno"> 240</span> <span class="preprocessor">#if MXNET_USE_DIST_KVSTORE</span></div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="keywordflow">if</span> (!<a class="code" href="classmxnet_1_1KVStore.html#ab216fb292fa77e843e95f474fa671a20">IsWorkerNode</a>()) LOG(FATAL) << <span class="stringliteral">"barrier_before_exit takes effect only on worker nodes"</span>;</div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <a class="code" href="classmxnet_1_1KVStore.html#aa8ba7abf8334326cab19eb568cb31cfa">barrier_before_exit_</a> = barrier_before_exit;</div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00244"></a><span class="lineno"> 244</span> LOG(FATAL) << <span class="stringliteral">"compile with USE_DIST_KVSTORE=1 to enable barrier"</span>;</div><div class="line"><a name="l00245"></a><span class="lineno"> 245</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00246"></a><span class="lineno"> 246</span> }</div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span> </div><div class="line"><a name="l00253"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a41113b9dfeab6c705ba064cc3f010fb4"> 253</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="l00254"></a><span class="lineno"> 254</span> <span class="preprocessor">#if MXNET_USE_DIST_KVSTORE</span></div><div class="line"><a name="l00255"></a><span class="lineno"> 255</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="l00256"></a><span class="lineno"> 256</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="l00257"></a><span class="lineno"> 257</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00258"></a><span class="lineno"> 258</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span> <span class="preprocessor">#endif // MXNET_USE_DIST_KVSTORE</span></div><div class="line"><a name="l00260"></a><span class="lineno"> 260</span> }</div><div class="line"><a name="l00261"></a><span class="lineno"> 261</span> </div><div class="line"><a name="l00268"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a262ef45340106fdb5c2a296c3cb711b1"> 268</a></span> <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classmxnet_1_1KVStore.html#a262ef45340106fdb5c2a296c3cb711b1">get_rank</a>()<span class="keyword"> const </span>{</div><div class="line"><a name="l00269"></a><span class="lineno"> 269</span> <span class="keywordflow">return</span> 0;</div><div class="line"><a name="l00270"></a><span class="lineno"> 270</span> }</div><div class="line"><a name="l00271"></a><span class="lineno"> 271</span> </div><div class="line"><a name="l00275"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a1fd19b2a123b6069b35e1e8b7fad9dc3"> 275</a></span> <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classmxnet_1_1KVStore.html#a1fd19b2a123b6069b35e1e8b7fad9dc3">get_group_size</a>()<span class="keyword"> const </span>{</div><div class="line"><a name="l00276"></a><span class="lineno"> 276</span> <span class="keywordflow">return</span> 1;</div><div class="line"><a name="l00277"></a><span class="lineno"> 277</span> }</div><div class="line"><a name="l00278"></a><span class="lineno"> 278</span> </div><div class="line"><a name="l00287"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#af5c48df3aade761a547a1dc6f7b8702d"> 287</a></span> <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classmxnet_1_1KVStore.html#af5c48df3aade761a547a1dc6f7b8702d">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="l00288"></a><span class="lineno"> 288</span> <span class="keywordflow">return</span> 0;</div><div class="line"><a name="l00289"></a><span class="lineno"> 289</span> }</div><div class="line"><a name="l00290"></a><span class="lineno"> 290</span> </div><div class="line"><a name="l00298"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a4f9275fb7a11589fae1dcc5a8a3354ac"> 298</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="l00299"></a><span class="lineno"> 299</span> </div><div class="line"><a name="l00311"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a4ff4ca05f3c519ebbc2e46264e8b63dd"> 311</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="l00312"></a><span class="lineno"> 312</span> </div><div class="line"><a name="l00316"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a50db5cb1a140fb84c8e31def54270ae3"> 316</a></span> <span class="keyword">typedef</span> std::function<void(int, const std::string&)> <a class="code" href="classmxnet_1_1KVStore.html#a50db5cb1a140fb84c8e31def54270ae3">Controller</a>;</div><div class="line"><a name="l00317"></a><span class="lineno"> 317</span> </div><div class="line"><a name="l00331"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#ae137ab8b5407060529c18a8084946d0b"> 331</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> Controller& controller) { }</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> <span class="keyword">protected</span>:</div><div class="line"><a name="l00337"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a01befb768a81a8e7a366708240ee6d06"> 337</a></span> Updater <a class="code" href="classmxnet_1_1KVStore.html#a01befb768a81a8e7a366708240ee6d06">updater_</a>;</div><div class="line"><a name="l00338"></a><span class="lineno"> 338</span> </div><div class="line"><a name="l00342"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#ad1023ca677c6e87ccc7d92c4df48bd40"> 342</a></span> std::string <a class="code" href="classmxnet_1_1KVStore.html#ad1023ca677c6e87ccc7d92c4df48bd40">type_</a>;</div><div class="line"><a name="l00343"></a><span class="lineno"> 343</span> </div><div class="line"><a name="l00347"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#aa8ba7abf8334326cab19eb568cb31cfa"> 347</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="l00348"></a><span class="lineno"> 348</span> };</div><div class="line"><a name="l00349"></a><span class="lineno"> 349</span> </div><div class="line"><a name="l00350"></a><span class="lineno"> 350</span> } <span class="comment">// namespace mxnet</span></div><div class="line"><a name="l00351"></a><span class="lineno"> 351</span> <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:44</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< 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:180</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> base.h:126</div></div> |
| <div class="ttc" id="classmxnet_1_1KVStore_html_a262ef45340106fdb5c2a296c3cb711b1"><div class="ttname"><a href="classmxnet_1_1KVStore.html#a262ef45340106fdb5c2a296c3cb711b1">mxnet::KVStore::get_rank</a></div><div class="ttdeci">virtual int get_rank() const </div><div class="ttdef"><b>Definition:</b> kvstore.h:268</div></div> |
| <div class="ttc" id="classmxnet_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="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:337</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 & type()</div><div class="ttdoc">return the type </div><div class="ttdef"><b>Definition:</b> kvstore.h:64</div></div> |
| <div class="ttc" id="classmxnet_1_1KVStore_html_a98e041793c133337cecc441e441ed721"><div class="ttname"><a href="classmxnet_1_1KVStore.html#a98e041793c133337cecc441e441ed721">mxnet::KVStore::Pull</a></div><div class="ttdeci">virtual void Pull(const std::vector< int > &keys, const std::vector< NDArray * > &values, int priority=0)=0</div><div class="ttdoc">pull a list of key-value pairs from the store </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:253</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:298</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< std::string, std::string > &envs)</div><div class="ttdoc">initalize ps-lite environment variables </div><div class="ttdef"><b>Definition:</b> kvstore.h:203</div></div> |
| <div class="ttc" id="classmxnet_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="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:216</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:47</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:239</div></div> |
| <div class="ttc" id="classmxnet_1_1KVStore_html_af5c48df3aade761a547a1dc6f7b8702d"><div class="ttname"><a href="classmxnet_1_1KVStore.html#af5c48df3aade761a547a1dc6f7b8702d">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:287</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 &controller)</div><div class="ttdoc">Run as server (or scheduler) </div><div class="ttdef"><b>Definition:</b> kvstore.h:331</div></div> |
| <div class="ttc" id="classmxnet_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="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 &cmd_body)</div><div class="ttdoc">Send a command to all server nodes. </div><div class="ttdef"><b>Definition:</b> kvstore.h:311</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:342</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< 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:316</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 &updater)</div><div class="ttdoc">set an updater </div><div class="ttdef"><b>Definition:</b> kvstore.h:190</div></div> |
| <div class="ttc" id="classmxnet_1_1KVStore_html_a1fd19b2a123b6069b35e1e8b7fad9dc3"><div class="ttname"><a href="classmxnet_1_1KVStore.html#a1fd19b2a123b6069b35e1e8b7fad9dc3">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:275</div></div> |
| <div class="ttc" id="classmxnet_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:347</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:230</div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Sep 19 2019 13:11:20 for mxnet by <a href="http://www.doxygen.org/index.html"> |
| <img alt="doxygen" class="footer" src="doxygen.png"/> |
| </a> 1.8.11 |
| </small></address> |
| </body> |
| </html> |
