| <!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::Constraint 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_1Constraint.html">Constraint</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classsinga_1_1Constraint-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">singa::Constraint Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Apply constraints for parameters (gradient). |
| <a href="classsinga_1_1Constraint.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="optimizer_8h_source.html">optimizer.h</a>></code></p> |
| <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:a30379350dde982a4c566af3f60531157"><td class="memItemLeft" align="right" valign="top"><a id="a30379350dde982a4c566af3f60531157"></a> |
|  </td><td class="memItemRight" valign="bottom"><b>Constraint</b> (const ConstraintConf &conf)</td></tr> |
| <tr class="separator:a30379350dde982a4c566af3f60531157"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a57f8f6592605f0b2b2221b190ea18cce"><td class="memItemLeft" align="right" valign="top"><a id="a57f8f6592605f0b2b2221b190ea18cce"></a> |
|  </td><td class="memItemRight" valign="bottom"><b>Constraint</b> (const string &type, float threshold)</td></tr> |
| <tr class="separator:a57f8f6592605f0b2b2221b190ea18cce"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aca6550dcdc073d6c12a3065759970019"><td class="memItemLeft" align="right" valign="top"><a id="aca6550dcdc073d6c12a3065759970019"></a> |
| void </td><td class="memItemRight" valign="bottom"><b>Setup</b> (const ConstraintConf &conf)</td></tr> |
| <tr class="separator:aca6550dcdc073d6c12a3065759970019"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abb53e5016959821205b37e6f219deab4"><td class="memItemLeft" align="right" valign="top"><a id="abb53e5016959821205b37e6f219deab4"></a> |
| void </td><td class="memItemRight" valign="bottom"><b>Setup</b> (const string &conf_str)</td></tr> |
| <tr class="separator:abb53e5016959821205b37e6f219deab4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afeea35b7cc9bbceb9973d9918b70d211"><td class="memItemLeft" align="right" valign="top"><a id="afeea35b7cc9bbceb9973d9918b70d211"></a> |
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Constraint.html#afeea35b7cc9bbceb9973d9918b70d211">Apply</a> (int epoch, const <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> &value, <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> &grad, int step=-1)</td></tr> |
| <tr class="memdesc:afeea35b7cc9bbceb9973d9918b70d211"><td class="mdescLeft"> </td><td class="mdescRight">Apply the constraint to a single parmeter object, e.g., W, or b e.g., clip each gradient if it is too large w.r.t the threshold, https://www.reddit.com/r/MachineLearning/comments/31b6x8/gradient_clipping_rnns/. <br /></td></tr> |
| <tr class="separator:afeea35b7cc9bbceb9973d9918b70d211"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab6b7bc7abeb5d6d14be0839193e377c1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Constraint.html#ab6b7bc7abeb5d6d14be0839193e377c1">Apply</a> (int epoch, const vector< <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> > &values, const vector< <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> > &grads, int step=-1)</td></tr> |
| <tr class="memdesc:ab6b7bc7abeb5d6d14be0839193e377c1"><td class="mdescLeft"> </td><td class="mdescRight">Apply the constraint for multiple parameter objects together. <a href="#ab6b7bc7abeb5d6d14be0839193e377c1">More...</a><br /></td></tr> |
| <tr class="separator:ab6b7bc7abeb5d6d14be0839193e377c1"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Apply constraints for parameters (gradient). </p> |
| <p>E.g., restrict the norm of parmeter gradients to be within a threshold. http://keras.io/constraints/ TODO(wangwei) implement a sub-class for each type of constraint </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="ab6b7bc7abeb5d6d14be0839193e377c1"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab6b7bc7abeb5d6d14be0839193e377c1">◆ </a></span>Apply()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void singa::Constraint::Apply </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>epoch</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const vector< <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> > & </td> |
| <td class="paramname"><em>values</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const vector< <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> > & </td> |
| <td class="paramname"><em>grads</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>step</em> = <code>-1</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Apply the constraint for multiple parameter objects together. </p> |
| <p>https://github.com/Lasagne/Lasagne/blob/master/lasagne/updates.py </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>/home/moaz/incubator-singa/include/singa/model/<a class="el" href="optimizer_8h_source.html">optimizer.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> |
