You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@singa.apache.org by mo...@apache.org on 2019/04/22 10:37:24 UTC
svn commit: r1857944 [24/35] - in /incubator/singa/site/trunk/doxygen: ./
html/ html/search/
Added: incubator/singa/site/trunk/doxygen/html/layer_8h_source.html
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/layer_8h_source.html?rev=1857944&view=auto
==============================================================================
--- incubator/singa/site/trunk/doxygen/html/layer_8h_source.html (added)
+++ incubator/singa/site/trunk/doxygen/html/layer_8h_source.html Mon Apr 22 10:37:18 2019
@@ -0,0 +1,104 @@
+<!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/layer.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">layer.h</div> </div>
+</div><!--header-->
+<div class="contents">
+<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><d
iv 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, software</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13<
/span> <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * limitations under the License.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> */</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#ifndef SINGA_MODEL_LAYER_H_</span></div><div clas
s="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#define SINGA_MODEL_LAYER_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 <vector></span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <stack></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <utility></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span
> <span class="preprocessor">#include "singa/core/tensor.h"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "singa/proto/model.pb.h"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "singa/utils/factory.h"</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">namespace </span><a class="code" href="namespacesinga.html">singa</a> {</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">typedef</span> vector<size_t> Shape;</div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classsinga_1_1
Layer.html"> 37</a></span> <span class="keyword">class </span><a class="code" href="classsinga_1_1Layer.html">Layer</a> {</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <a class="code" href="classsinga_1_1Layer.html">Layer</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classsinga_1_1Layer.html#a1462d97e5a7c0954d34b56d94eebeb9b"> 43</a></span>  <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Layer.html#a1462d97e5a7c0954d34b56d94eebeb9b">Setup</a>(<span class="keyword">const</span> Shape& in_shape, <span class="keyword">const</span> <span class="keywordtype">string</span>& proto_str) {</div><div class="line"><
a name="l00044"></a><span class="lineno"> 44</span>  LayerConf conf;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  conf.ParseFromString(proto_str);</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  this-><a class="code" href="classsinga_1_1Layer.html#a1462d97e5a7c0954d34b56d94eebeb9b">Setup</a>(in_shape, conf);</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  }</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classsinga_1_1Layer.html#a3a302d7b93109f8d00837b72f501c1e2"> 50</a></span>  <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Layer.html#a3a302d7b93109f8d00837b72f501c1e2">Setup</a>(<span class="keyword">const</span> vector<Shape>& in_shapes, <span class="keyword">const</span> <span class="ke
ywordtype">string</span>& proto_str) {</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  LayerConf conf;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  conf.ParseFromString(proto_str);</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  this-><a class="code" href="classsinga_1_1Layer.html#a1462d97e5a7c0954d34b56d94eebeb9b">Setup</a>(in_shapes, conf);</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> </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="comment">// ============= Following Functions could be override =====================</span></div><div class="line"><a name="l00059"></a><span class="lineno"><a class="line
" href="classsinga_1_1Layer.html#a17b438a539df56a539a538a939072b81"> 59</a></span> <span class="comment"></span> <span class="keyword">virtual</span> <a class="code" href="classsinga_1_1Layer.html#a17b438a539df56a539a538a939072b81">~Layer</a>() {};</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="classsinga_1_1Layer.html#aaebc00e461ce04a98793381a9d1e63c1"> 63</a></span>  <span class="keyword">virtual</span> <span class="keyword">const</span> std::string <a class="code" href="classsinga_1_1Layer.html#aaebc00e461ce04a98793381a9d1e63c1">layer_type</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="stringliteral">"Unknown"</span>; }</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00072"></a><span class="lineno"><a class="line" hr
ef="classsinga_1_1Layer.html#a3866ece143b21c76702ca4ce76e79500"> 72</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Layer.html#a3866ece143b21c76702ca4ce76e79500">Setup</a>(<span class="keyword">const</span> Shape& in_sample, <span class="keyword">const</span> LayerConf& conf) {</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  name_ = conf.name();</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="comment">// TODO(wangwei) load param values from checkpoint files.</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  }</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div><div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="classsinga_1_1Layer.html#a580bee8561fae6918d4438841fb1b938"> 78</a></span>  <sp
an class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Layer.html#a580bee8561fae6918d4438841fb1b938">Setup</a>(<span class="keyword">const</span> vector<Shape>& in_samples, <span class="keyword">const</span> LayerConf& conf) {</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  name_ = conf.name();</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="comment">// TODO(wangwei) load param values from checkpoint files.</span></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="l00084"></a><span class="lineno"><a class="line" href="classsinga_1_1Layer.html#ad98c0285b0b3ffe2dfc4d5fdbc2baf16"> 84</a></span>  <span class="keyword">virtual</span> <span class="keyword">const</span> Shape <
a class="code" href="classsinga_1_1Layer.html#ad98c0285b0b3ffe2dfc4d5fdbc2baf16">GetOutputSampleShape</a>()<span class="keyword"> const </span>{</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  LOG(FATAL) << <span class="stringliteral">"Pls override this function"</span>;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordflow">return</span> vector<size_t>{};</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  }</div><div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="classsinga_1_1Layer.html#a1768c424d60860b7b0208b124d68f0e9"> 90</a></span>  <span class="keyword">virtual</span> <span class="keyword">const</span> Shape <a class="code" href="classsinga_1_1Layer.html#a1768c424d60860b7b0208b124d68f0e9">GetOutputSampleShape</a>(<span class="keywordtype">int</span> k) {</div><div class="line"><a name="l0
0091"></a><span class="lineno"> 91</span>  LOG(FATAL) << <span class="stringliteral">"Pls override this function"</span>;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keywordflow">return</span> vector<size_t>{};</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  }</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div><div class="line"><a name="l00103"></a><span class="lineno"><a class="line" href="classsinga_1_1Layer.html#a9f96ab5f12aae149cdb4e94ebaefb756"> 103</a></span>  <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classsinga_1_1Tensor.html">Tensor</a> <a class="code" href="classsinga_1_1Layer.html#a9f96ab5f12aae149cdb4e94ebaefb756">Forward</a>(<span class="keywordtype">int</span> flag, <span class="keyword">const</span> <a class="code" href="classsinga_1_1Tensor.html">Ten
sor</a>& input) {</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  LOG(FATAL) << <span class="stringliteral">"Not implemented"</span>;</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <a class="code" href="classsinga_1_1Tensor.html">Tensor</a> t;</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keywordflow">return</span> t;</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  }</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> </div><div class="line"><a name="l00114"></a><span class="lineno"><a class="line" href="classsinga_1_1Layer.html#a5bf2b8e388ddbba2438f84c41ccc131a"> 114</a></span>  <span class="keyword">virtual</span> <span class="keyword">const</span> vector<Tensor> <a class="code" href="classsinga_1_1Layer.html#a5bf2b8e388ddbba2438f84c41ccc131a">Forward
</a>(<span class="keywordtype">int</span> flag, <span class="keyword">const</span> vector<Tensor>& inputs) {</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  vector<Tensor> ret;</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keywordflow">if</span> (inputs.size() == 1) ret.push_back(<a class="code" href="classsinga_1_1Layer.html#a9f96ab5f12aae149cdb4e94ebaefb756">Forward</a>(flag, inputs.at(0)));</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  LOG(FATAL) << <span class="stringliteral">"Not implemented"</span>;</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keywordflow">return</span> ret;</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  }</div><div class="
line"><a name="l00121"></a><span class="lineno"> 121</span> </div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="comment">// layer has no parameters.</span></div><div class="line"><a name="l00132"></a><span class="lineno"><a class="line" href="classsinga_1_1Layer.html#aed4aa3ffd81015c702252813e0872c1e"> 132</a></span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keyword">const</span> std::pair<Tensor, vector<Tensor>> <a class="code" href="classsinga_1_1Layer.html#aed4aa3ffd81015c702252813e0872c1e">Backward</a>(<span class="keywordtype">int</span> flag,</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="keyword">const</span> <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>& grad) {</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> 
; LOG(FATAL) << <span class="stringliteral">"Not implemented!"</span>;</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <a class="code" href="classsinga_1_1Tensor.html">Tensor</a> t;</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="keywordflow">return</span> std::make_pair(t, vector<Tensor>{});</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  }</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div><div class="line"><a name="l00141"></a><span class="lineno"><a class="line" href="classsinga_1_1Layer.html#a30572f8078e2f958cbf93e37eb975da6"> 141</a></span>  <span class="keyword">virtual</span> <span class="keyword">const</span> std::pair<vector<Tensor>, vector<Tensor>> <a class="code" href="classsinga_1_1Layer.html#a30572f8078e2f958cbf93e37eb975da6">Backward</a>(</div><div class="
line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="keywordtype">int</span> flag, <span class="keyword">const</span> vector<Tensor>& grads) {</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  vector<Tensor> input_grad, param_grad;</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <span class="keywordflow">if</span> (grads.size() == 1u) {</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <span class="keyword">auto</span> ret = <a class="code" href="classsinga_1_1Layer.html#aed4aa3ffd81015c702252813e0872c1e">Backward</a>(flag, grads.at(0));</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  input_grad.push_back(ret.first);</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  param_grad = ret.second;</div><div class="line"><a name="l00148"></a><span clas
s="lineno"> 148</span>  } <span class="keywordflow">else</span> {</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  LOG(FATAL) << <span class="stringliteral">"Not implemented"</span>;</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  }</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  <span class="keywordflow">return</span> std::make_pair(input_grad, param_grad);</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  }</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> </div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="comment">// virtual Layer* Clone(std::shared_ptr<Device> device);</span></div><div class="line"><a name="l00159"></a><span class="lineno"><a class="line" href="classsinga_1_1Layer.html#a3ffe3b58b69ccb87c48e4172f818cba5
"> 159</a></span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Layer.html#a3ffe3b58b69ccb87c48e4172f818cba5">ToDevice</a>(std::shared_ptr<Device> device) {</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  }</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> </div><div class="line"><a name="l00163"></a><span class="lineno"><a class="line" href="classsinga_1_1Layer.html#a2cccba7a2b3a1bed714f9be2b8b4d520"> 163</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Layer.html#a2cccba7a2b3a1bed714f9be2b8b4d520">AsType</a>(DataType dtype) {</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  }</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> </div><div class="line"><a name="l
00167"></a><span class="lineno"><a class="line" href="classsinga_1_1Layer.html#a2f1ab53e65ec8592794494995164f12c"> 167</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Layer.html#a2f1ab53e65ec8592794494995164f12c">ToProto</a>(LayerConf* conf)<span class="keyword"> const </span>{</div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  <span class="comment">//conf->set_name(name_);</span></div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  <span class="comment">//for (const auto& spec : param_specs_) {</span></div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  <span class="comment">// ParamSpec* p = conf->add_param();</span></div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  <span class="comment">// p->CopyFrom(spec);</span></div><div class="line"><a name=
"l00172"></a><span class="lineno"> 172</span>  <span class="comment">//}</span></div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  <span class="comment">// TODO(wangwei) add param values into conf;</span></div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  }</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>  <span class="comment">// ========================================================================</span></div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> </div><div class="line"><a name="l00180"></a><span class="lineno"><a class="line" href="classsinga_1_1Layer.html#aa7386bdb843345ba6c2095c83ffbd244"> 180</a></span>  std::string <a class="code" href="classsinga_1_1Layer.html#aa7386bdb843345ba6c2095c83ffbd244">ToProtoStr</a>()<span class="keyword"
> const </span>{</div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  LayerConf conf;</div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  <a class="code" href="classsinga_1_1Layer.html#a2f1ab53e65ec8592794494995164f12c">ToProto</a>(&conf);</div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  <span class="keywordtype">string</span> str;</div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  conf.SerializeToString(&str);</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  <span class="keywordflow">return</span> str;</div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  }</div><div class="line"><a name="l00189"></a><span class="lineno"><a class="line" href="classsinga_1_1Layer.html#aaf39129d5cc63a8f9c6e8ad069a7fc83"> 189</a></span>  <span class="keyword">const</span> vector
<ParamSpec> <a class="code" href="classsinga_1_1Layer.html#aaf39129d5cc63a8f9c6e8ad069a7fc83">param_specs</a>() { <span class="keywordflow">return</span> param_specs_; }</div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span> </div><div class="line"><a name="l00192"></a><span class="lineno"><a class="line" href="classsinga_1_1Layer.html#a61c0d34827ca76e7a950b48903e591be"> 192</a></span>  <span class="keyword">const</span> ParamSpec& <a class="code" href="classsinga_1_1Layer.html#a61c0d34827ca76e7a950b48903e591be">param_specs</a>(<span class="keywordtype">size_t</span> i) {</div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  CHECK_LT(i, param_specs_.size());</div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  <span class="keywordflow">return</span> param_specs_.at(i);</div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  }</div><div class="l
ine"><a name="l00196"></a><span class="lineno"> 196</span> </div><div class="line"><a name="l00198"></a><span class="lineno"><a class="line" href="classsinga_1_1Layer.html#a93d307e8c2852b2c94102c8a7d198d13"> 198</a></span>  <span class="keyword">virtual</span> <span class="keyword">const</span> vector<Tensor> <a class="code" href="classsinga_1_1Layer.html#a93d307e8c2852b2c94102c8a7d198d13">param_values</a>() {</div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  <span class="keywordflow">return</span> vector<Tensor>{};</div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  }</div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span> </div><div class="line"><a name="l00203"></a><span class="lineno"><a class="line" href="classsinga_1_1Layer.html#ada81666769392e45ceb216263a8786db"> 203</a></span>  <span class="keyword">const</span> vector<string> <a class="code"
href="classsinga_1_1Layer.html#ada81666769392e45ceb216263a8786db">param_names</a>() {</div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  vector<string> pname;</div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  <span class="keywordflow">for</span> (<span class="keyword">const</span> <span class="keyword">auto</span>& spec : param_specs_) pname.push_back(spec.name());</div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  <span class="keywordflow">return</span> pname;</div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  }</div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> </div><div class="line"><a name="l00210"></a><span class="lineno"><a class="line" href="classsinga_1_1Layer.html#a32216d201842a380d739df6a78759bb9"> 210</a></span>  <span class="keyword">const</span> <span class="keywordtype">string</
span>& <a class="code" href="classsinga_1_1Layer.html#a32216d201842a380d739df6a78759bb9">param_name</a>(<span class="keywordtype">size_t</span> i) {</div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span>  CHECK_LT(i, param_specs_.size());</div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span>  <span class="keywordflow">return</span> param_specs_.at(i).name();</div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span>  }</div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span> </div><div class="line"><a name="l00217"></a><span class="lineno"><a class="line" href="classsinga_1_1Layer.html#a127ffc9ed2504e1553d45336cb589ea1"> 217</a></span>  <span class="keyword">const</span> std::string <a class="code" href="classsinga_1_1Layer.html#a127ffc9ed2504e1553d45336cb589ea1">name</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> name_; }</
div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span> </div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span>  std::string name_;</div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span>  vector<ParamSpec> param_specs_;</div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span> };</div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span> </div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="preprocessor">#define RegisterLayerClass(Name, SubLayer) \</span></div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="preprocessor"> static Registra<Layer, SubLayer> Name##SubLayer(#Name);</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> <span class="keyword">inline</span> std::shared_ptr<Layer> CreateLayer(<span class="keyword">const</span> std::string type) {</div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span>  std::shared_ptr<Layer> layer(<a class="code" href="classFactory.html">Factory<Layer>::Create</a>(type));</div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span>  <span class="keywordflow">return</span> layer;</div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span> }</div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span> </div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="keyword">inline</span> <span class="keyword">const</span> std::vector<std::string> GetRegisteredLayers() {</div><div class="line"><a name="l002
44"></a><span class="lineno"> 244</span>  vector<std::string> ret;</div><div class="line"><a name="l00245"></a><span class="lineno"> 245</span>  <span class="keywordflow">for</span> (<span class="keyword">const</span> <span class="keywordtype">string</span> type : <a class="code" href="classFactory.html">Factory<Layer>::GetIDs</a>()) {</div><div class="line"><a name="l00246"></a><span class="lineno"> 246</span>  <span class="keyword">auto</span> layer = CreateLayer(type);</div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span>  ret.push_back(<span class="stringliteral">"Register type: "</span> + type);</div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span>  }</div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span>  <span class="keywordflow">return</span> ret;</div><div class="line"><a name="l00250"></a><span class="lineno"> 250</span> }</div><div
class="line"><a name="l00251"></a><span class="lineno"> 251</span> } <span class="comment">// namespace singa</span></div><div class="line"><a name="l00252"></a><span class="lineno"> 252</span> <span class="preprocessor">#endif // SINGA_MODEL_LAYER_H_</span></div><div class="ttc" id="classsinga_1_1Layer_html_a32216d201842a380d739df6a78759bb9"><div class="ttname"><a href="classsinga_1_1Layer.html#a32216d201842a380d739df6a78759bb9">singa::Layer::param_name</a></div><div class="ttdeci">const string & param_name(size_t i)</div><div class="ttdoc">Return the &#39;i&#39;-th parameter name. </div><div class="ttdef"><b>Definition:</b> layer.h:210</div></div>
+<div class="ttc" id="classsinga_1_1Layer_html_a127ffc9ed2504e1553d45336cb589ea1"><div class="ttname"><a href="classsinga_1_1Layer.html#a127ffc9ed2504e1553d45336cb589ea1">singa::Layer::name</a></div><div class="ttdeci">const std::string name() const</div><div class="ttdoc">Each layer instance would optionally have a name. </div><div class="ttdef"><b>Definition:</b> layer.h:217</div></div>
+<div class="ttc" id="classsinga_1_1Layer_html_ada81666769392e45ceb216263a8786db"><div class="ttname"><a href="classsinga_1_1Layer.html#ada81666769392e45ceb216263a8786db">singa::Layer::param_names</a></div><div class="ttdeci">const vector< string > param_names()</div><div class="ttdoc">Return names of all parmaeters. </div><div class="ttdef"><b>Definition:</b> layer.h:203</div></div>
+<div class="ttc" id="classsinga_1_1Layer_html_a2f1ab53e65ec8592794494995164f12c"><div class="ttname"><a href="classsinga_1_1Layer.html#a2f1ab53e65ec8592794494995164f12c">singa::Layer::ToProto</a></div><div class="ttdeci">virtual void ToProto(LayerConf *conf) const</div><div class="ttdoc">Serialize the layer info (including params) into a LayerConf proto message. </div><div class="ttdef"><b>Definition:</b> layer.h:167</div></div>
+<div class="ttc" id="classsinga_1_1Layer_html_aaebc00e461ce04a98793381a9d1e63c1"><div class="ttname"><a href="classsinga_1_1Layer.html#aaebc00e461ce04a98793381a9d1e63c1">singa::Layer::layer_type</a></div><div class="ttdeci">virtual const std::string layer_type() const</div><div class="ttdoc">Each layer sub-class would optionaly have a type name. </div><div class="ttdef"><b>Definition:</b> layer.h:63</div></div>
+<div class="ttc" id="classsinga_1_1Layer_html_a1462d97e5a7c0954d34b56d94eebeb9b"><div class="ttname"><a href="classsinga_1_1Layer.html#a1462d97e5a7c0954d34b56d94eebeb9b">singa::Layer::Setup</a></div><div class="ttdeci">void Setup(const Shape &in_shape, const string &proto_str)</div><div class="ttdoc">Set meta data fields from a string representing a proto message. </div><div class="ttdef"><b>Definition:</b> layer.h:43</div></div>
+<div class="ttc" id="classsinga_1_1Layer_html_a61c0d34827ca76e7a950b48903e591be"><div class="ttname"><a href="classsinga_1_1Layer.html#a61c0d34827ca76e7a950b48903e591be">singa::Layer::param_specs</a></div><div class="ttdeci">const ParamSpec & param_specs(size_t i)</div><div class="ttdoc">Return the i-th ParamSpec. </div><div class="ttdef"><b>Definition:</b> layer.h:192</div></div>
+<div class="ttc" id="classsinga_1_1Layer_html_ad98c0285b0b3ffe2dfc4d5fdbc2baf16"><div class="ttname"><a href="classsinga_1_1Layer.html#ad98c0285b0b3ffe2dfc4d5fdbc2baf16">singa::Layer::GetOutputSampleShape</a></div><div class="ttdeci">virtual const Shape GetOutputSampleShape() const</div><div class="ttdoc">Return the shape of the generated Tensor without the batchsize dimension. </div><div class="ttdef"><b>Definition:</b> layer.h:84</div></div>
+<div class="ttc" id="classFactory_html"><div class="ttname"><a href="classFactory.html">Factory</a></div><div class="ttdoc">Factory template to generate class (or a sub-class) object based on id. </div><div class="ttdef"><b>Definition:</b> factory.h:45</div></div>
+<div class="ttc" id="classsinga_1_1Layer_html_aed4aa3ffd81015c702252813e0872c1e"><div class="ttname"><a href="classsinga_1_1Layer.html#aed4aa3ffd81015c702252813e0872c1e">singa::Layer::Backward</a></div><div class="ttdeci">virtual const std::pair< Tensor, vector< Tensor > > Backward(int flag, const Tensor &grad)</div><div class="ttdoc">Compute gradients of this layer. </div><div class="ttdef"><b>Definition:</b> layer.h:132</div></div>
+<div class="ttc" id="classsinga_1_1Layer_html_aa7386bdb843345ba6c2095c83ffbd244"><div class="ttname"><a href="classsinga_1_1Layer.html#aa7386bdb843345ba6c2095c83ffbd244">singa::Layer::ToProtoStr</a></div><div class="ttdeci">std::string ToProtoStr() const</div><div class="ttdoc">Serialize the layer info, including params_, into a string representing a LayerParameter message...</div><div class="ttdef"><b>Definition:</b> layer.h:180</div></div>
+<div class="ttc" id="classsinga_1_1Layer_html_a17b438a539df56a539a538a939072b81"><div class="ttname"><a href="classsinga_1_1Layer.html#a17b438a539df56a539a538a939072b81">singa::Layer::~Layer</a></div><div class="ttdeci">virtual ~Layer()</div><div class="ttdoc">Destruct objects created by this layer. </div><div class="ttdef"><b>Definition:</b> layer.h:59</div></div>
+<div class="ttc" id="classsinga_1_1Layer_html_a3ffe3b58b69ccb87c48e4172f818cba5"><div class="ttname"><a href="classsinga_1_1Layer.html#a3ffe3b58b69ccb87c48e4172f818cba5">singa::Layer::ToDevice</a></div><div class="ttdeci">virtual void ToDevice(std::shared_ptr< Device > device)</div><div class="ttdoc">Clone the layer to the given device. </div><div class="ttdef"><b>Definition:</b> layer.h:159</div></div>
+<div class="ttc" id="classsinga_1_1Layer_html_a3866ece143b21c76702ca4ce76e79500"><div class="ttname"><a href="classsinga_1_1Layer.html#a3866ece143b21c76702ca4ce76e79500">singa::Layer::Setup</a></div><div class="ttdeci">virtual void Setup(const Shape &in_sample, const LayerConf &conf)</div><div class="ttdoc">Set meta data fields configured in &#39;conf&#39; (a proto message). </div><div class="ttdef"><b>Definition:</b> layer.h:72</div></div>
+<div class="ttc" id="classsinga_1_1Layer_html_a1768c424d60860b7b0208b124d68f0e9"><div class="ttname"><a href="classsinga_1_1Layer.html#a1768c424d60860b7b0208b124d68f0e9">singa::Layer::GetOutputSampleShape</a></div><div class="ttdeci">virtual const Shape GetOutputSampleShape(int k)</div><div class="ttdoc">Return the shape of the k-th generated tensor without the batchsize dimension. </div><div class="ttdef"><b>Definition:</b> layer.h:90</div></div>
+<div class="ttc" id="classsinga_1_1Layer_html_a93d307e8c2852b2c94102c8a7d198d13"><div class="ttname"><a href="classsinga_1_1Layer.html#a93d307e8c2852b2c94102c8a7d198d13">singa::Layer::param_values</a></div><div class="ttdeci">virtual const vector< Tensor > param_values()</div><div class="ttdoc">Return pointers to parameter Tensor s. </div><div class="ttdef"><b>Definition:</b> layer.h:198</div></div>
+<div class="ttc" id="classsinga_1_1Layer_html_a580bee8561fae6918d4438841fb1b938"><div class="ttname"><a href="classsinga_1_1Layer.html#a580bee8561fae6918d4438841fb1b938">singa::Layer::Setup</a></div><div class="ttdeci">virtual void Setup(const vector< Shape > &in_samples, const LayerConf &conf)</div><div class="ttdoc">Used for layers that have multiple input tensors, e.g., concatenate layer. </div><div class="ttdef"><b>Definition:</b> layer.h:78</div></div>
+<div class="ttc" id="classsinga_1_1Layer_html_aaf39129d5cc63a8f9c6e8ad069a7fc83"><div class="ttname"><a href="classsinga_1_1Layer.html#aaf39129d5cc63a8f9c6e8ad069a7fc83">singa::Layer::param_specs</a></div><div class="ttdeci">const vector< ParamSpec > param_specs()</div><div class="ttdoc">Return specs/configuration of all parameter instances of this layer. </div><div class="ttdef"><b>Definition:</b> layer.h:189</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_1Layer_html_a5bf2b8e388ddbba2438f84c41ccc131a"><div class="ttname"><a href="classsinga_1_1Layer.html#a5bf2b8e388ddbba2438f84c41ccc131a">singa::Layer::Forward</a></div><div class="ttdeci">virtual const vector< Tensor > Forward(int flag, const vector< Tensor > &inputs)</div><div class="ttdoc">Do feature transformation for the given &#39;input&#39; tensor (denoted as x). </div><div class="ttdef"><b>Definition:</b> layer.h:114</div></div>
+<div class="ttc" id="classsinga_1_1Layer_html_a3a302d7b93109f8d00837b72f501c1e2"><div class="ttname"><a href="classsinga_1_1Layer.html#a3a302d7b93109f8d00837b72f501c1e2">singa::Layer::Setup</a></div><div class="ttdeci">void Setup(const vector< Shape > &in_shapes, const string &proto_str)</div><div class="ttdoc">&#39;in_shapes&#39; is the shape of the input feature for one sample </div><div class="ttdef"><b>Definition:</b> layer.h:50</div></div>
+<div class="ttc" id="classsinga_1_1Layer_html_a2cccba7a2b3a1bed714f9be2b8b4d520"><div class="ttname"><a href="classsinga_1_1Layer.html#a2cccba7a2b3a1bed714f9be2b8b4d520">singa::Layer::AsType</a></div><div class="ttdeci">virtual void AsType(DataType dtype)</div><div class="ttdoc">Set the data type of Tensor in this layer. </div><div class="ttdef"><b>Definition:</b> layer.h:163</div></div>
+<div class="ttc" id="classsinga_1_1Layer_html"><div class="ttname"><a href="classsinga_1_1Layer.html">singa::Layer</a></div><div class="ttdoc">The base layer class. </div><div class="ttdef"><b>Definition:</b> layer.h:37</div></div>
+<div class="ttc" id="classsinga_1_1Layer_html_a9f96ab5f12aae149cdb4e94ebaefb756"><div class="ttname"><a href="classsinga_1_1Layer.html#a9f96ab5f12aae149cdb4e94ebaefb756">singa::Layer::Forward</a></div><div class="ttdeci">virtual const Tensor Forward(int flag, const Tensor &input)</div><div class="ttdoc">Do feature transformation for the given &#39;input&#39; tensor (denoted as x). </div><div class="ttdef"><b>Definition:</b> layer.h:103</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_1Layer_html_a30572f8078e2f958cbf93e37eb975da6"><div class="ttname"><a href="classsinga_1_1Layer.html#a30572f8078e2f958cbf93e37eb975da6">singa::Layer::Backward</a></div><div class="ttdeci">virtual const std::pair< vector< Tensor >, vector< Tensor > > Backward(int flag, const vector< Tensor > &grads)</div><div class="ttdef"><b>Definition:</b> layer.h:141</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>