| <!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: cpp-package/include/mxnet-cpp/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_c9bbcf2f7c4ed40b1b23631ec8abffa6.html">cpp-package</a></li><li class="navelem"><a class="el" href="dir_eb07344824255b98f70969533c25e736.html">include</a></li><li class="navelem"><a class="el" href="dir_0327d24fd86e9ce22567ad8f859e5290.html">mxnet-cpp</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="cpp-package_2include_2mxnet-cpp_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="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#ifndef MXNET_CPP_KVSTORE_H_</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#define MXNET_CPP_KVSTORE_H_</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</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 <vector></span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "<a class="code" href="cpp-package_2include_2mxnet-cpp_2ndarray_8h.html">mxnet-cpp/ndarray.h</a>"</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">namespace </span><a class="code" href="namespacemxnet.html">mxnet</a> {</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">namespace </span>cpp {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1KVStore.html"> 36</a></span> <span class="keyword">class </span><a class="code" href="classmxnet_1_1cpp_1_1KVStore.html">KVStore</a> {</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1cpp_1_1KVStore.html#a9a78125d99e486dfe0dd9b29cbf81fff">SetType</a>(<span class="keyword">const</span> std::string& type);</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1cpp_1_1KVStore.html#a4e81352497b7df2277e491bebf88de9a">RunServer</a>();</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1cpp_1_1KVStore.html#a411bd548df87474ef805f6d8bad89692">Init</a>(<span class="keywordtype">int</span> key, <span class="keyword">const</span> <a class="code" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a>& val);</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1cpp_1_1KVStore.html#a411bd548df87474ef805f6d8bad89692">Init</a>(<span class="keyword">const</span> std::vector<int>& keys, <span class="keyword">const</span> std::vector<NDArray>& vals);</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1cpp_1_1KVStore.html#a9ba997cc97d81a10185f90628a859748">Push</a>(<span class="keywordtype">int</span> key, <span class="keyword">const</span> <a class="code" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a>& val, <span class="keywordtype">int</span> priority = 0);</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1cpp_1_1KVStore.html#a9ba997cc97d81a10185f90628a859748">Push</a>(<span class="keyword">const</span> std::vector<int>& keys,</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">const</span> std::vector<NDArray>& vals, <span class="keywordtype">int</span> priority = 0);</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1cpp_1_1KVStore.html#a19247df9277d196eadc8c692c95453d8">Pull</a>(<span class="keywordtype">int</span> key, <a class="code" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a>* out, <span class="keywordtype">int</span> priority = 0);</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1cpp_1_1KVStore.html#a19247df9277d196eadc8c692c95453d8">Pull</a>(<span class="keyword">const</span> std::vector<int>& keys, std::vector<NDArray>* outs, <span class="keywordtype">int</span> priority = 0);</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment">// TODO(lx): put lr in optimizer or not?</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1cpp_1_1KVStore.html#a12c16279d12dd9cccc545641b7bc72e5">SetOptimizer</a>(std::unique_ptr<Optimizer> optimizer, <span class="keywordtype">bool</span> local = <span class="keyword">false</span>);</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">static</span> std::string <a class="code" href="classmxnet_1_1cpp_1_1KVStore.html#a3b94db90d0d1070887cd3b13188a60d6">GetType</a>();</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="keyword">static</span> <span class="keywordtype">int</span> <a class="code" href="classmxnet_1_1cpp_1_1KVStore.html#a6a1586faccdea3d36088246b076d75b9">GetRank</a>();</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">static</span> <span class="keywordtype">int</span> <a class="code" href="classmxnet_1_1cpp_1_1KVStore.html#ad82f402e30cb187b3feac663c5933d92">GetNumWorkers</a>();</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1cpp_1_1KVStore.html#ad5878723105a9f8a69170e4942bec851">Barrier</a>();</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="keyword">static</span> std::string <a class="code" href="classmxnet_1_1cpp_1_1KVStore.html#ad946968681e5716d7d7fcf00ff24d423">GetRole</a>();</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <a class="code" href="classmxnet_1_1cpp_1_1KVStore.html">KVStore</a>();</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="keyword">static</span> <a class="code" href="c__api_8h.html#a0543f53696ffcf5a7a2f0f4403f87623">KVStoreHandle</a>& get_handle();</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="keyword">static</span> std::unique_ptr<Optimizer>& get_optimizer();</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="keyword">static</span> <a class="code" href="classmxnet_1_1cpp_1_1KVStore.html">KVStore</a>*& get_kvstore();</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="keyword">static</span> <span class="keywordtype">void</span> Controller(<span class="keywordtype">int</span> head, <span class="keyword">const</span> <span class="keywordtype">char</span>* body, <span class="keywordtype">void</span>* controller_handle);</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="keyword">static</span> <span class="keywordtype">void</span> Updater(<span class="keywordtype">int</span> key, <a class="code" href="c__api_8h.html#a99c2939783499d2a5ce0d76881dce9df">NDArrayHandle</a> recv, <a class="code" href="c__api_8h.html#a99c2939783499d2a5ce0d76881dce9df">NDArrayHandle</a> local, <span class="keywordtype">void</span>* handle_);</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> };</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> } <span class="comment">// namespace cpp</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> } <span class="comment">// namespace mxnet</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="preprocessor">#endif // MXNET_CPP_KVSTORE_H_</span></div><div class="ttc" id="classmxnet_1_1cpp_1_1KVStore_html_ad946968681e5716d7d7fcf00ff24d423"><div class="ttname"><a href="classmxnet_1_1cpp_1_1KVStore.html#ad946968681e5716d7d7fcf00ff24d423">mxnet::cpp::KVStore::GetRole</a></div><div class="ttdeci">static std::string GetRole()</div></div> |
| <div class="ttc" id="classmxnet_1_1cpp_1_1KVStore_html_a19247df9277d196eadc8c692c95453d8"><div class="ttname"><a href="classmxnet_1_1cpp_1_1KVStore.html#a19247df9277d196eadc8c692c95453d8">mxnet::cpp::KVStore::Pull</a></div><div class="ttdeci">static void Pull(int key, NDArray *out, int priority=0)</div></div> |
| <div class="ttc" id="classmxnet_1_1cpp_1_1KVStore_html_a411bd548df87474ef805f6d8bad89692"><div class="ttname"><a href="classmxnet_1_1cpp_1_1KVStore.html#a411bd548df87474ef805f6d8bad89692">mxnet::cpp::KVStore::Init</a></div><div class="ttdeci">static void Init(int key, const NDArray &val)</div></div> |
| <div class="ttc" id="classmxnet_1_1cpp_1_1KVStore_html_ad5878723105a9f8a69170e4942bec851"><div class="ttname"><a href="classmxnet_1_1cpp_1_1KVStore.html#ad5878723105a9f8a69170e4942bec851">mxnet::cpp::KVStore::Barrier</a></div><div class="ttdeci">static void Barrier()</div></div> |
| <div class="ttc" id="classmxnet_1_1cpp_1_1KVStore_html_a9a78125d99e486dfe0dd9b29cbf81fff"><div class="ttname"><a href="classmxnet_1_1cpp_1_1KVStore.html#a9a78125d99e486dfe0dd9b29cbf81fff">mxnet::cpp::KVStore::SetType</a></div><div class="ttdeci">static void SetType(const std::string &type)</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_1cpp_1_1KVStore_html_a12c16279d12dd9cccc545641b7bc72e5"><div class="ttname"><a href="classmxnet_1_1cpp_1_1KVStore.html#a12c16279d12dd9cccc545641b7bc72e5">mxnet::cpp::KVStore::SetOptimizer</a></div><div class="ttdeci">static void SetOptimizer(std::unique_ptr< Optimizer > optimizer, bool local=false)</div></div> |
| <div class="ttc" id="classmxnet_1_1cpp_1_1NDArray_html"><div class="ttname"><a href="classmxnet_1_1cpp_1_1NDArray.html">mxnet::cpp::NDArray</a></div><div class="ttdoc">NDArray interface. </div><div class="ttdef"><b>Definition:</b> ndarray.h:120</div></div> |
| <div class="ttc" id="classmxnet_1_1cpp_1_1KVStore_html_a9ba997cc97d81a10185f90628a859748"><div class="ttname"><a href="classmxnet_1_1cpp_1_1KVStore.html#a9ba997cc97d81a10185f90628a859748">mxnet::cpp::KVStore::Push</a></div><div class="ttdeci">static void Push(int key, const NDArray &val, int priority=0)</div></div> |
| <div class="ttc" id="c__api_8h_html_a0543f53696ffcf5a7a2f0f4403f87623"><div class="ttname"><a href="c__api_8h.html#a0543f53696ffcf5a7a2f0f4403f87623">KVStoreHandle</a></div><div class="ttdeci">void * KVStoreHandle</div><div class="ttdoc">handle to KVStore </div><div class="ttdef"><b>Definition:</b> c_api.h:82</div></div> |
| <div class="ttc" id="c__api_8h_html_a99c2939783499d2a5ce0d76881dce9df"><div class="ttname"><a href="c__api_8h.html#a99c2939783499d2a5ce0d76881dce9df">NDArrayHandle</a></div><div class="ttdeci">void * NDArrayHandle</div><div class="ttdoc">handle to NDArray </div><div class="ttdef"><b>Definition:</b> c_api.h:64</div></div> |
| <div class="ttc" id="classmxnet_1_1cpp_1_1KVStore_html_ad82f402e30cb187b3feac663c5933d92"><div class="ttname"><a href="classmxnet_1_1cpp_1_1KVStore.html#ad82f402e30cb187b3feac663c5933d92">mxnet::cpp::KVStore::GetNumWorkers</a></div><div class="ttdeci">static int GetNumWorkers()</div></div> |
| <div class="ttc" id="cpp-package_2include_2mxnet-cpp_2ndarray_8h_html"><div class="ttname"><a href="cpp-package_2include_2mxnet-cpp_2ndarray_8h.html">ndarray.h</a></div></div> |
| <div class="ttc" id="classmxnet_1_1cpp_1_1KVStore_html_a3b94db90d0d1070887cd3b13188a60d6"><div class="ttname"><a href="classmxnet_1_1cpp_1_1KVStore.html#a3b94db90d0d1070887cd3b13188a60d6">mxnet::cpp::KVStore::GetType</a></div><div class="ttdeci">static std::string GetType()</div></div> |
| <div class="ttc" id="classmxnet_1_1cpp_1_1KVStore_html_a6a1586faccdea3d36088246b076d75b9"><div class="ttname"><a href="classmxnet_1_1cpp_1_1KVStore.html#a6a1586faccdea3d36088246b076d75b9">mxnet::cpp::KVStore::GetRank</a></div><div class="ttdeci">static int GetRank()</div></div> |
| <div class="ttc" id="classmxnet_1_1cpp_1_1KVStore_html_a4e81352497b7df2277e491bebf88de9a"><div class="ttname"><a href="classmxnet_1_1cpp_1_1KVStore.html#a4e81352497b7df2277e491bebf88de9a">mxnet::cpp::KVStore::RunServer</a></div><div class="ttdeci">static void RunServer()</div></div> |
| <div class="ttc" id="classmxnet_1_1cpp_1_1KVStore_html"><div class="ttname"><a href="classmxnet_1_1cpp_1_1KVStore.html">mxnet::cpp::KVStore</a></div><div class="ttdef"><b>Definition:</b> kvstore.h:36</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> |