| <!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: singa::Snapshot Class Reference</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="namespacesinga.html">singa</a></li><li class="navelem"><a class="el" href="classsinga_1_1Snapshot.html">Snapshot</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-types">Public Types</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classsinga_1_1Snapshot-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">singa::Snapshot Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>The snapshot management. |
| <a href="classsinga_1_1Snapshot.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="snapshot_8h_source.html">snapshot.h</a>></code></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> |
| Public Types</h2></td></tr> |
| <tr class="memitem:a4fb33858ec17db4ecc275311b0168f44"><td class="memItemLeft" align="right" valign="top"><a id="a4fb33858ec17db4ecc275311b0168f44"></a>enum  </td><td class="memItemRight" valign="bottom"><b>Mode</b> { <b>kRead</b>, |
| <b>kWrite</b> |
| }</td></tr> |
| <tr class="separator:a4fb33858ec17db4ecc275311b0168f44"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a6c953392f9d314ed0bf644a5d64eac84"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Snapshot.html#a6c953392f9d314ed0bf644a5d64eac84">Snapshot</a> (const std::string &prefix, Mode mode, int max_param_size=10)</td></tr> |
| <tr class="memdesc:a6c953392f9d314ed0bf644a5d64eac84"><td class="mdescLeft"> </td><td class="mdescRight"><prefix>.model is the binary file for parameter key-value pair. <a href="#a6c953392f9d314ed0bf644a5d64eac84">More...</a><br /></td></tr> |
| <tr class="separator:a6c953392f9d314ed0bf644a5d64eac84"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1b5a7c9bd8571523929f973d60911a9c"><td class="memItemLeft" align="right" valign="top"><a id="a1b5a7c9bd8571523929f973d60911a9c"></a> |
| std::vector< std::pair< std::string, <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Snapshot.html#a1b5a7c9bd8571523929f973d60911a9c">Read</a> ()</td></tr> |
| <tr class="memdesc:a1b5a7c9bd8571523929f973d60911a9c"><td class="mdescLeft"> </td><td class="mdescRight">Read parameters saved as tensors from checkpoint file. <br /></td></tr> |
| <tr class="separator:a1b5a7c9bd8571523929f973d60911a9c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a25c10f3e39b912fb0a72b4e575c60c0f"><td class="memItemLeft" align="right" valign="top"><a id="a25c10f3e39b912fb0a72b4e575c60c0f"></a> |
| std::vector< std::pair< std::string, Shape > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Snapshot.html#a25c10f3e39b912fb0a72b4e575c60c0f">ReadShape</a> ()</td></tr> |
| <tr class="memdesc:a25c10f3e39b912fb0a72b4e575c60c0f"><td class="mdescLeft"> </td><td class="mdescRight">Read parameter shapes from description file. <br /></td></tr> |
| <tr class="separator:a25c10f3e39b912fb0a72b4e575c60c0f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa5153b76cd995cf42c7b61010ffdd648"><td class="memItemLeft" align="right" valign="top"><a id="aa5153b76cd995cf42c7b61010ffdd648"></a> |
| <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Snapshot.html#aa5153b76cd995cf42c7b61010ffdd648">Read</a> (const std::string &Key)</td></tr> |
| <tr class="memdesc:aa5153b76cd995cf42c7b61010ffdd648"><td class="mdescLeft"> </td><td class="mdescRight">Read parameter returned as a tensor for a given parameter name. <br /></td></tr> |
| <tr class="separator:aa5153b76cd995cf42c7b61010ffdd648"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0475ba53518a9f6b6bcced2d00db14be"><td class="memItemLeft" align="right" valign="top"><a id="a0475ba53518a9f6b6bcced2d00db14be"></a> |
| Shape </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Snapshot.html#a0475ba53518a9f6b6bcced2d00db14be">ReadShape</a> (const std::string &key)</td></tr> |
| <tr class="memdesc:a0475ba53518a9f6b6bcced2d00db14be"><td class="mdescLeft"> </td><td class="mdescRight">Read parameter shape for a given parameter name. <br /></td></tr> |
| <tr class="separator:a0475ba53518a9f6b6bcced2d00db14be"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3a5ec45388f191e01668ef8486d4b8f7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Snapshot.html#a3a5ec45388f191e01668ef8486d4b8f7">Write</a> (const std::string &key, const <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> &param)</td></tr> |
| <tr class="memdesc:a3a5ec45388f191e01668ef8486d4b8f7"><td class="mdescLeft"> </td><td class="mdescRight">Serialize and dump out parameter. <a href="#a3a5ec45388f191e01668ef8486d4b8f7">More...</a><br /></td></tr> |
| <tr class="separator:a3a5ec45388f191e01668ef8486d4b8f7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae311f3448715ebc110c1b238c56dce9b"><td class="memItemLeft" align="right" valign="top"><a id="ae311f3448715ebc110c1b238c56dce9b"></a> |
| int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Snapshot.html#ae311f3448715ebc110c1b238c56dce9b">version</a> () const</td></tr> |
| <tr class="memdesc:ae311f3448715ebc110c1b238c56dce9b"><td class="mdescLeft"> </td><td class="mdescRight">available for singa > 1.0.1 <br /></td></tr> |
| <tr class="separator:ae311f3448715ebc110c1b238c56dce9b"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>The snapshot management. </p> |
| <p>It dumps the model parameter snapshot as checkpoint files, which coud be used for fine-tuning and deployment. The model paramters are separated from model definition, i.e., net construction. Users either randomly initialize the layer parameters or using the parameters from checkpoint files using <a class="el" href="classsinga_1_1Snapshot.html" title="The snapshot management. ">Snapshot</a> after creating the neural network. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a6c953392f9d314ed0bf644a5d64eac84"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6c953392f9d314ed0bf644a5d64eac84">◆ </a></span>Snapshot()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">singa::Snapshot::Snapshot </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>prefix</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">Mode </td> |
| <td class="paramname"><em>mode</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>max_param_size</em> = <code>10</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p><prefix>.model is the binary file for parameter key-value pair. </p> |
| <p><prefix>.meta is the text file describing information about paramters, i.e. name and shape, one line per parameter. kRead for reading snapshot, whereas kWrite for dumping out snapshot. max_param_size: in MB </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a3a5ec45388f191e01668ef8486d4b8f7"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3a5ec45388f191e01668ef8486d4b8f7">◆ </a></span>Write()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void singa::Snapshot::Write </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>key</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> & </td> |
| <td class="paramname"><em>param</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Serialize and dump out parameter. </p> |
| <p>This method will write two files, one binary file is for serialized tensors, the other csv file is for parameter names and shapes. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>/home/moaz/incubator-singa/include/singa/io/<a class="el" href="snapshot_8h_source.html">snapshot.h</a></li> |
| </ul> |
| </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> |
