Google Git
Sign in
apache / singa-site / be983bc44db8673b80f36c133d1ceb12926645fd / . / content / doxygen / html / snapshot_8h_source.html
blob: 3c0177b896a13fc08849488fbf66b75f4395a5fb [file] [log] [blame]
<!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/io/snapshot.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_953eafc3caccd34fc2601f376f19d1ef.html">io</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">snapshot.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">*</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">* Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">* or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">* distributed with this work for additional information</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">* regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">* to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">* &quot;License&quot;); you may not use this file except in compliance</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">* with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">*</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">* http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">*</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">* Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">* software distributed under the License is distributed on an</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">* &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment">* KIND, either express or implied. See the License for the</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment">* specific language governing permissions and limitations</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment">* under the License.</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment">*</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment">*************************************************************/</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#ifndef SINGA_UTILS_SNAPSHOT_H_</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#define SINGA_UTILS_SNAPSHOT_H_</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &quot;singa/io/reader.h&quot;</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &quot;singa/io/writer.h&quot;</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &quot;singa/utils/logging.h&quot;</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#include &quot;singa/proto/core.pb.h&quot;</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#include &quot;singa/core/tensor.h&quot;</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#include &lt;unordered_set&gt;</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#include &lt;unordered_map&gt;</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacesinga.html">singa</a> {</div><div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classsinga_1_1Snapshot.html"> 44</a></span>&#160;<span class="keyword">class </span><a class="code" href="classsinga_1_1Snapshot.html">Snapshot</a> {</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keyword">enum</span> Mode { kRead, kWrite };</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <a class="code" href="classsinga_1_1Snapshot.html#a6c953392f9d314ed0bf644a5d64eac84">Snapshot</a>(<span class="keyword">const</span> std::string&amp; prefix, Mode mode, <span class="keywordtype">int</span> max_param_size = 10);</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; ~<a class="code" href="classsinga_1_1Snapshot.html">Snapshot</a>() {}</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; std::vector&lt;std::pair&lt;std::string, Tensor&gt;&gt; <a class="code" href="classsinga_1_1Snapshot.html#a1b5a7c9bd8571523929f973d60911a9c">Read</a>();</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; std::vector&lt;std::pair&lt;std::string, Shape&gt;&gt; <a class="code" href="classsinga_1_1Snapshot.html#a25c10f3e39b912fb0a72b4e575c60c0f">ReadShape</a>();</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <a class="code" href="classsinga_1_1Tensor.html">Tensor</a> <a class="code" href="classsinga_1_1Snapshot.html#a1b5a7c9bd8571523929f973d60911a9c">Read</a>(<span class="keyword">const</span> std::string&amp; Key);</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; Shape <a class="code" href="classsinga_1_1Snapshot.html#a25c10f3e39b912fb0a72b4e575c60c0f">ReadShape</a>(<span class="keyword">const</span> std::string&amp; key);</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Snapshot.html#a3a5ec45388f191e01668ef8486d4b8f7">Write</a>(<span class="keyword">const</span> std::string&amp; key, <span class="keyword">const</span> <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>&amp; param);</div><div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="classsinga_1_1Snapshot.html#ae311f3448715ebc110c1b238c56dce9b"> 68</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="classsinga_1_1Snapshot.html#ae311f3448715ebc110c1b238c56dce9b">version</a>()<span class="keyword"> const </span>{</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keywordflow">return</span> version_;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; }</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keywordtype">int</span> version_ = 0;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; std::string prefix_;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; Mode mode_;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; std::unique_ptr&lt;io::BinFileWriter&gt; bin_writer_ptr_;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; std::unique_ptr&lt;io::Writer&gt; text_writer_ptr_;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; std::unique_ptr&lt;io::BinFileReader&gt; bin_reader_ptr_;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; std::unordered_set&lt;std::string&gt; param_names_;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; std::unordered_map&lt;std::string, Tensor&gt; param_map_;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;};</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;} <span class="comment">// namespace singa</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;<span class="preprocessor">#endif // SINGA_UTILS_SNAPSHOT_H_</span></div><div class="ttc" id="classsinga_1_1Snapshot_html_a1b5a7c9bd8571523929f973d60911a9c"><div class="ttname"><a href="classsinga_1_1Snapshot.html#a1b5a7c9bd8571523929f973d60911a9c">singa::Snapshot::Read</a></div><div class="ttdeci">std::vector&lt; std::pair&lt; std::string, Tensor &gt; &gt; Read()</div><div class="ttdoc">Read parameters saved as tensors from checkpoint file. </div></div>
<div class="ttc" id="classsinga_1_1Snapshot_html_a6c953392f9d314ed0bf644a5d64eac84"><div class="ttname"><a href="classsinga_1_1Snapshot.html#a6c953392f9d314ed0bf644a5d64eac84">singa::Snapshot::Snapshot</a></div><div class="ttdeci">Snapshot(const std::string &amp;prefix, Mode mode, int max_param_size=10)</div><div class="ttdoc">&lt;prefix&gt;.model is the binary file for parameter key-value pair. </div></div>
<div class="ttc" id="classsinga_1_1Snapshot_html_ae311f3448715ebc110c1b238c56dce9b"><div class="ttname"><a href="classsinga_1_1Snapshot.html#ae311f3448715ebc110c1b238c56dce9b">singa::Snapshot::version</a></div><div class="ttdeci">int version() const</div><div class="ttdoc">available for singa &gt; 1.0.1 </div><div class="ttdef"><b>Definition:</b> snapshot.h:68</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_1Snapshot_html_a25c10f3e39b912fb0a72b4e575c60c0f"><div class="ttname"><a href="classsinga_1_1Snapshot.html#a25c10f3e39b912fb0a72b4e575c60c0f">singa::Snapshot::ReadShape</a></div><div class="ttdeci">std::vector&lt; std::pair&lt; std::string, Shape &gt; &gt; ReadShape()</div><div class="ttdoc">Read parameter shapes from description file. </div></div>
<div class="ttc" id="classsinga_1_1Snapshot_html_a3a5ec45388f191e01668ef8486d4b8f7"><div class="ttname"><a href="classsinga_1_1Snapshot.html#a3a5ec45388f191e01668ef8486d4b8f7">singa::Snapshot::Write</a></div><div class="ttdeci">void Write(const std::string &amp;key, const Tensor &amp;param)</div><div class="ttdoc">Serialize and dump out parameter. </div></div>
<div class="ttc" id="classsinga_1_1Snapshot_html"><div class="ttname"><a href="classsinga_1_1Snapshot.html">singa::Snapshot</a></div><div class="ttdoc">The snapshot management. </div><div class="ttdef"><b>Definition:</b> snapshot.h:44</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><!-- 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 &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>