| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.13"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Apache Singa: /home/moaz/incubator-singa/include/singa/model/updater.h Source File</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">Apache Singa |
| </div> |
| <div id="projectbrief">A General Distributed Deep Learning Library</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.13 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| </script> |
| <div id="main-nav"></div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_14a988756d30161f7e1f48b05d03905d.html">singa</a></li><li class="navelem"><a class="el" href="dir_1ed15e94f94d348ba7de93ac6315cc91.html">model</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">updater.h</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#ifndef SINGA_MODEL_UPDATER_H_</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#define SINGA_MODEL_UPDATER_H_</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include "singa/model/optimizer.h"</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "singa/core/device.h"</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "singa/core/tensor.h"</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "singa/utils/logging.h"</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <mutex></span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include <condition_variable></span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include <utility></span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include <unordered_map></span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#include <atomic></span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">namespace </span><a class="code" href="namespacesinga.html">singa</a> {</div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classsinga_1_1Updater.html"> 39</a></span> <span class="keyword">class </span><a class="code" href="classsinga_1_1Updater.html">Updater</a> {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">explicit</span> <a class="code" href="classsinga_1_1Updater.html">Updater</a>(<a class="code" href="classsinga_1_1Optimizer.html">Optimizer</a>* opt) : opt_{opt} {}</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">virtual</span> ~<a class="code" href="classsinga_1_1Updater.html">Updater</a>() {}</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Updater.html#a6cc4fdac0b011f0500c0d7bf9ad78e1a">Setup</a>(<span class="keyword">const</span> OptimizerConf& conf);</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Updater.html#a279ada6bda1f42a420245f5258bba221">Register</a>(<span class="keyword">const</span> <span class="keywordtype">string</span>& name, <span class="keyword">const</span> ParamSpec& specs);</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Updater.html#ac07c0e7cd69b631244b7c2c4bb90c0ec">Apply</a>(<span class="keywordtype">int</span> step, <span class="keyword">const</span> <span class="keywordtype">string</span>& name, <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>& grad, <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>& value);</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="classsinga_1_1Optimizer.html">Optimizer</a>* GetOptimizer() { <span class="keywordflow">return</span> opt_; }</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="comment">// No copy allowed.</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <a class="code" href="classsinga_1_1Updater.html">Updater</a>(<span class="keyword">const</span> <a class="code" href="classsinga_1_1Updater.html">Updater</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">void</span> operator=(<span class="keyword">const</span> <a class="code" href="classsinga_1_1Updater.html">Updater</a>&) = <span class="keyword">delete</span>;</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">protected</span>:</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <a class="code" href="classsinga_1_1Optimizer.html">Optimizer</a>* opt_;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> };</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div><div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="classsinga_1_1LocalUpdater.html"> 61</a></span> <span class="keyword">class </span><a class="code" href="classsinga_1_1LocalUpdater.html">LocalUpdater</a> : <span class="keyword">public</span> <a class="code" href="classsinga_1_1Updater.html">Updater</a> {</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <a class="code" href="classsinga_1_1LocalUpdater.html">LocalUpdater</a>(<span class="keywordtype">int</span> total_num, <a class="code" href="classsinga_1_1Optimizer.html">Optimizer</a>* opt,</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  std::shared_ptr<Device> dev = <a class="code" href="namespacesinga.html#af5fd1cb4e1a4b5ae9bba1377b034eb8d">defaultDevice</a>)</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  : <a class="code" href="classsinga_1_1Updater.html">Updater</a>(opt), total_num_{total_num}, dev_(dev) {}</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keyword">virtual</span> ~<a class="code" href="classsinga_1_1LocalUpdater.html">LocalUpdater</a>()<span class="keyword"> override </span>{}</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Updater.html#a279ada6bda1f42a420245f5258bba221">Register</a>(<span class="keyword">const</span> <span class="keywordtype">string</span>& name, <span class="keyword">const</span> ParamSpec& specs) <span class="keyword">override</span>;</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Updater.html#ac07c0e7cd69b631244b7c2c4bb90c0ec">Apply</a>(<span class="keywordtype">int</span> step, <span class="keyword">const</span> <span class="keywordtype">string</span>& name, <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>& grad,</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>& value) <span class="keyword">override</span>;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> T1, <span class="keyword">typename</span> T2></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keyword">struct </span>key_hasher {</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordtype">size_t</span> operator() (<span class="keyword">const</span> std::pair<T1, T2>& p)<span class="keyword"> const </span>{</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keyword">auto</span> h1 = std::hash<T1>{}(p.first);</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keyword">auto</span> h2 = std::hash<T2>{}(p.second);</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordflow">return</span> h1 ^ h2;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  }</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  };</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordtype">int</span> total_num_;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  std::shared_ptr<Device> dev_;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  std::unordered_map<std::string, std::atomic<int>> dev_index_;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  std::unordered_map<std::string, int> to_updater_finished_;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  std::unordered_map<std::pair<int, std::string>, <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>,</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  key_hasher<int, std::string>> grad_buffer_;</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  std::unordered_map<std::string, Tensor> sum_, param_buffer_;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  std::unordered_map<std::string, std::mutex> mtx_;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  std::unordered_map<std::string, std::condition_variable></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  to_updater_all_finished_;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> };</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> } <span class="comment">// namespace singa</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="preprocessor">#endif // SINGA_MODEL_UPDATER_H_</span></div><div class="ttc" id="classsinga_1_1Updater_html_ac07c0e7cd69b631244b7c2c4bb90c0ec"><div class="ttname"><a href="classsinga_1_1Updater.html#ac07c0e7cd69b631244b7c2c4bb90c0ec">singa::Updater::Apply</a></div><div class="ttdeci">virtual void Apply(int step, const string &name, Tensor &grad, Tensor &value)</div><div class="ttdoc">Forward Apply() to Optimizer. </div></div> |
| <div class="ttc" id="classsinga_1_1Tensor_html"><div class="ttname"><a href="classsinga_1_1Tensor.html">singa::Tensor</a></div><div class="ttdoc">A Tensor instance is a multi-dimensional array resident on a Device (default device is the host CPU)...</div><div class="ttdef"><b>Definition:</b> tensor.h:56</div></div> |
| <div class="ttc" id="classsinga_1_1Updater_html"><div class="ttname"><a href="classsinga_1_1Updater.html">singa::Updater</a></div><div class="ttdoc">Basic Updater class just forward all the method function call to the wrapped Optimizer. </div><div class="ttdef"><b>Definition:</b> updater.h:39</div></div> |
| <div class="ttc" id="namespacesinga_html_af5fd1cb4e1a4b5ae9bba1377b034eb8d"><div class="ttname"><a href="namespacesinga.html#af5fd1cb4e1a4b5ae9bba1377b034eb8d">singa::defaultDevice</a></div><div class="ttdeci">std::shared_ptr< Device > defaultDevice</div><div class="ttdoc">a singleton CppDevice as the host for all devices. </div></div> |
| <div class="ttc" id="classsinga_1_1Updater_html_a6cc4fdac0b011f0500c0d7bf9ad78e1a"><div class="ttname"><a href="classsinga_1_1Updater.html#a6cc4fdac0b011f0500c0d7bf9ad78e1a">singa::Updater::Setup</a></div><div class="ttdeci">virtual void Setup(const OptimizerConf &conf)</div><div class="ttdoc">Forward Setup() to Optimizer. </div></div> |
| <div class="ttc" id="classsinga_1_1Updater_html_a279ada6bda1f42a420245f5258bba221"><div class="ttname"><a href="classsinga_1_1Updater.html#a279ada6bda1f42a420245f5258bba221">singa::Updater::Register</a></div><div class="ttdeci">virtual void Register(const string &name, const ParamSpec &specs)</div><div class="ttdoc">Forward Register() to Optimizer. </div></div> |
| <div class="ttc" id="namespacesinga_html"><div class="ttname"><a href="namespacesinga.html">singa</a></div><div class="ttdoc">Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements...</div><div class="ttdef"><b>Definition:</b> common.h:48</div></div> |
| <div class="ttc" id="classsinga_1_1Optimizer_html"><div class="ttname"><a href="classsinga_1_1Optimizer.html">singa::Optimizer</a></div><div class="ttdoc">The base class for gradient descent algorithms used to update the model parameters in order to optimi...</div><div class="ttdef"><b>Definition:</b> optimizer.h:41</div></div> |
| <div class="ttc" id="classsinga_1_1LocalUpdater_html"><div class="ttname"><a href="classsinga_1_1LocalUpdater.html">singa::LocalUpdater</a></div><div class="ttdoc">LocalUpdater do gradient aggregation and update gradient calling the wrapped Optimizer on a specific ...</div><div class="ttdef"><b>Definition:</b> updater.h:61</div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Mon Apr 22 2019 12:27:05 for Apache Singa by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.13 |
| </small></address> |
| </body> |
| </html> |