| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.6"/> |
| <title>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/search.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(function() { searchBox.OnSelectItem(0); }); |
| </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 style="padding-left: 0.5em;"> |
| <div id="projectname">mxnet |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.6 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <div id="navrow1" class="tabs"> |
| <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 id="MSearchBox" class="MSearchBoxInactive"> |
| <span class="left"> |
| <img id="MSearchSelect" src="search/mag_sel.png" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| alt=""/> |
| <input type="text" id="MSearchField" value="Search" accesskey="S" |
| onfocus="searchBox.OnSearchFieldFocus(true)" |
| onblur="searchBox.OnSearchFieldFocus(false)" |
| onkeyup="searchBox.OnSearchFieldChange(event)"/> |
| </span><span class="right"> |
| <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> |
| </span> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div id="navrow2" class="tabs2"> |
| <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" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a></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="kvstore_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> </div> |
| <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#ifndef MXNET_KVSTORE_H_</span></div> |
| <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor"></span><span class="preprocessor">#define MXNET_KVSTORE_H_</span></div> |
| <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor"></span><span class="preprocessor">#include <dmlc/io.h></span></div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include <vector></span></div> |
| <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include <unordered_map></span></div> |
| <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include <string></span></div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include <functional></span></div> |
| <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <atomic></span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include "<a class="code" href="ndarray_8h.html">./ndarray.h</a>"</span></div> |
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#if MXNET_USE_DIST_KVSTORE</span></div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor"></span><span class="preprocessor">#include "ps/ps.h"</span></div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#endif // MXNET_USE_DIST_KVSTORE</span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">namespace </span>mxnet {</div> |
| <div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html"> 26</a></span> <span class="keyword">class </span><a class="code" href="classmxnet_1_1KVStore.html">KVStore</a> {</div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a02e23071eb46464b58f2e2bf5654d6d6"> 29</a></span>  <span class="keyword">virtual</span> <a class="code" href="classmxnet_1_1KVStore.html#a02e23071eb46464b58f2e2bf5654d6d6">~KVStore</a>() {}</div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</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="l00042"></a><span class="lineno"> 42</span> </div> |
| <div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a722b2150dbf50d528fce62307809f949"> 46</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="l00047"></a><span class="lineno"> 47</span> </div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</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="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">const</span> std::vector<NDArray>& values) = 0;</div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</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="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">const</span> std::vector<NDArray>& values) = 0;</div> |
| <div class="line"><a name="l00109"></a><span class="lineno"> 109</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="l00110"></a><span class="lineno"> 110</span>  <span class="keyword">const</span> std::vector<NDArray>& values,</div> |
| <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keywordtype">int</span> priority = 0) = 0;</div> |
| <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div> |
| <div class="line"><a name="l00119"></a><span class="lineno"> 119</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="l00120"></a><span class="lineno"> 120</span>  <span class="keyword">const</span> std::vector<NDArray>& values,</div> |
| <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keywordtype">int</span> priority = 0) = 0;</div> |
| <div class="line"><a name="l00145"></a><span class="lineno"> 145</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="l00146"></a><span class="lineno"> 146</span>  <span class="keyword">const</span> std::vector<NDArray*>& values,</div> |
| <div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <span class="keywordtype">int</span> priority = 0) = 0;</div> |
| <div class="line"><a name="l00154"></a><span class="lineno"> 154</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="l00155"></a><span class="lineno"> 155</span>  <span class="keyword">const</span> std::vector<NDArray*>& values,</div> |
| <div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="keywordtype">int</span> priority = 0) = 0;</div> |
| <div class="line"><a name="l00157"></a><span class="lineno"> 157</span> </div> |
| <div class="line"><a name="l00158"></a><span class="lineno"> 158</span> </div> |
| <div class="line"><a name="l00162"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a6e4a76bd57f185349c58a5a658c32a64"> 162</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="l00172"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a352ef7eae04211eca1ed47401a6d15d5"> 172</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="l00173"></a><span class="lineno"> 173</span>  CHECK(updater) << <span class="stringliteral">"invalid updater"</span>;</div> |
| <div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  <a class="code" href="classmxnet_1_1KVStore.html#a01befb768a81a8e7a366708240ee6d06">updater_</a> = updater;</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="l00177"></a><span class="lineno"> 177</span>  <span class="comment">/******************************************************</span></div> |
| <div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment"> * the following are used for multi-machines.</span></div> |
| <div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment"> ******************************************************/</span></div> |
| <div class="line"><a name="l00180"></a><span class="lineno"> 180</span> </div> |
| <div class="line"><a name="l00185"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a5d919a7a4c9495e9a569c8d733d6325f"> 185</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="l00186"></a><span class="lineno"> 186</span> <span class="preprocessor">#if MXNET_USE_DIST_KVSTORE</span></div> |
| <div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="preprocessor"></span> ps::Environment::Init(envs);</div> |
| <div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="preprocessor">#else</span></div> |
| <div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="preprocessor"></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="l00190"></a><span class="lineno"> 190</span> <span class="preprocessor">#endif // MXNET_USE_DIST_KVSTORE</span></div> |
| <div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="preprocessor"></span> }</div> |
| <div class="line"><a name="l00192"></a><span class="lineno"> 192</span> </div> |
| <div class="line"><a name="l00198"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#ab216fb292fa77e843e95f474fa671a20"> 198</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="l00199"></a><span class="lineno"> 199</span> <span class="preprocessor">#if MXNET_USE_DIST_KVSTORE</span></div> |
| <div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="preprocessor"></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="l00201"></a><span class="lineno"> 201</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="l00202"></a><span class="lineno"> 202</span> <span class="preprocessor">#else</span></div> |
| <div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="preprocessor"></span> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div> |
| <div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="preprocessor">#endif // MXNET_USE_DIST_KVSTORE</span></div> |
| <div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="preprocessor"></span> }</div> |
| <div class="line"><a name="l00206"></a><span class="lineno"> 206</span> </div> |
| <div class="line"><a name="l00212"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a101178924ce1d635b0c8c2a5bce0ceaf"> 212</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="l00213"></a><span class="lineno"> 213</span> <span class="preprocessor">#if MXNET_USE_DIST_KVSTORE</span></div> |
| <div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="preprocessor"></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="l00215"></a><span class="lineno"> 215</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="l00216"></a><span class="lineno"> 216</span> <span class="preprocessor">#else</span></div> |
| <div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="preprocessor"></span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div> |
| <div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="preprocessor">#endif // MXNET_USE_DIST_KVSTORE</span></div> |
| <div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="preprocessor"></span> }</div> |
| <div class="line"><a name="l00220"></a><span class="lineno"> 220</span> </div> |
| <div class="line"><a name="l00221"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#afa87753d90fc7e75234229834ea23abb"> 221</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="l00222"></a><span class="lineno"> 222</span> <span class="preprocessor">#if MXNET_USE_DIST_KVSTORE</span></div> |
| <div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="preprocessor"></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="l00224"></a><span class="lineno"> 224</span>  barrier_before_exit_ = barrier_before_exit;</div> |
| <div class="line"><a name="l00225"></a><span class="lineno"> 225</span> <span class="preprocessor">#else</span></div> |
| <div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="preprocessor"></span> LOG(FATAL) << <span class="stringliteral">"compile with USE_DIST_KVSTORE=1 to enable barrier"</span>;</div> |
| <div class="line"><a name="l00227"></a><span class="lineno"> 227</span> <span class="preprocessor">#endif</span></div> |
| <div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="preprocessor"></span> }</div> |
| <div class="line"><a name="l00229"></a><span class="lineno"> 229</span> </div> |
| <div class="line"><a name="l00235"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a41113b9dfeab6c705ba064cc3f010fb4"> 235</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="l00236"></a><span class="lineno"> 236</span> <span class="preprocessor">#if MXNET_USE_DIST_KVSTORE</span></div> |
| <div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="preprocessor"></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="l00238"></a><span class="lineno"> 238</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="l00239"></a><span class="lineno"> 239</span> <span class="preprocessor">#else</span></div> |
| <div class="line"><a name="l00240"></a><span class="lineno"> 240</span> <span class="preprocessor"></span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div> |
| <div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="preprocessor">#endif // MXNET_USE_DIST_KVSTORE</span></div> |
| <div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <span class="preprocessor"></span> }</div> |
| <div class="line"><a name="l00243"></a><span class="lineno"> 243</span> </div> |
| <div class="line"><a name="l00250"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a262ef45340106fdb5c2a296c3cb711b1"> 250</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="l00251"></a><span class="lineno"> 251</span>  <span class="keywordflow">return</span> 0;</div> |
| <div class="line"><a name="l00252"></a><span class="lineno"> 252</span>  }</div> |
| <div class="line"><a name="l00253"></a><span class="lineno"> 253</span> </div> |
| <div class="line"><a name="l00257"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a1fd19b2a123b6069b35e1e8b7fad9dc3"> 257</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="l00258"></a><span class="lineno"> 258</span>  <span class="keywordflow">return</span> 1;</div> |
| <div class="line"><a name="l00259"></a><span class="lineno"> 259</span>  }</div> |
| <div class="line"><a name="l00260"></a><span class="lineno"> 260</span> </div> |
| <div class="line"><a name="l00269"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#af5c48df3aade761a547a1dc6f7b8702d"> 269</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="l00270"></a><span class="lineno"> 270</span>  <span class="keywordflow">return</span> 0;</div> |
| <div class="line"><a name="l00271"></a><span class="lineno"> 271</span>  }</div> |
| <div class="line"><a name="l00272"></a><span class="lineno"> 272</span> </div> |
| <div class="line"><a name="l00280"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a4f9275fb7a11589fae1dcc5a8a3354ac"> 280</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="l00281"></a><span class="lineno"> 281</span> </div> |
| <div class="line"><a name="l00293"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a4ff4ca05f3c519ebbc2e46264e8b63dd"> 293</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="l00294"></a><span class="lineno"> 294</span> </div> |
| <div class="line"><a name="l00298"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a50db5cb1a140fb84c8e31def54270ae3"> 298</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="l00299"></a><span class="lineno"> 299</span> </div> |
| <div class="line"><a name="l00313"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#ae137ab8b5407060529c18a8084946d0b"> 313</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="l00314"></a><span class="lineno"> 314</span> </div> |
| <div class="line"><a name="l00315"></a><span class="lineno"> 315</span>  <span class="keyword">protected</span>:</div> |
| <div class="line"><a name="l00319"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a01befb768a81a8e7a366708240ee6d06"> 319</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="l00320"></a><span class="lineno"> 320</span> </div> |
| <div class="line"><a name="l00324"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#ad1023ca677c6e87ccc7d92c4df48bd40"> 324</a></span>  std::string <a class="code" href="classmxnet_1_1KVStore.html#ad1023ca677c6e87ccc7d92c4df48bd40">type_</a>;</div> |
| <div class="line"><a name="l00325"></a><span class="lineno"> 325</span> </div> |
| <div class="line"><a name="l00329"></a><span class="lineno"><a class="line" href="classmxnet_1_1KVStore.html#a265215cd3de11dd36d9e79330a535615"> 329</a></span>  std::atomic<bool> barrier_before_exit_{<span class="keyword">true</span>};</div> |
| <div class="line"><a name="l00330"></a><span class="lineno"> 330</span> };</div> |
| <div class="line"><a name="l00331"></a><span class="lineno"> 331</span> </div> |
| <div class="line"><a name="l00332"></a><span class="lineno"> 332</span> } <span class="comment">// namespace mxnet</span></div> |
| <div class="line"><a name="l00333"></a><span class="lineno"> 333</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:26</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:162</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:250</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:319</div></div> |
| <div class="ttc" id="ndarray_8h_html"><div class="ttname"><a href="ndarray_8h.html">ndarray.h</a></div><div class="ttdoc">NDArray interface that handles array arithematics. </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:46</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:235</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:280</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:185</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:198</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:29</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:221</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:269</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:313</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:293</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:324</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:298</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:172</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:257</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:212</div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Sun Aug 6 2017 07:14:31 for mxnet by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.6 |
| </small></address> |
| </body> |
| </html> |
