Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1LocalUpdater.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1LocalUpdater.html?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1LocalUpdater.html (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1LocalUpdater.html Mon Apr 22 10:37:18 2019 @@ -0,0 +1,196 @@ +<!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::LocalUpdater 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_1LocalUpdater.html">LocalUpdater</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#nested-classes">Classes</a> | +<a href="#pub-methods">Public Member Functions</a> | +<a href="classsinga_1_1LocalUpdater-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">singa::LocalUpdater Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p><a class="el" href="classsinga_1_1LocalUpdater.html" title="LocalUpdater do gradient aggregation and update gradient calling the wrapped Optimizer on a specific ...">LocalUpdater</a> do gradient aggregation and update gradient calling the wrapped <a class="el" href="classsinga_1_1Optimizer.html" title="The base class for gradient descent algorithms used to update the model parameters in order to optimi...">Optimizer</a> on a specific device (i.e., CPU or GPU). + <a href="classsinga_1_1LocalUpdater.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="updater_8h_source.html">updater.h</a>></code></p> +<div class="dynheader"> +Inheritance diagram for singa::LocalUpdater:</div> +<div class="dyncontent"> +<div class="center"><img src="classsinga_1_1LocalUpdater__inherit__graph.png" border="0" usemap="#singa_1_1LocalUpdater_inherit__map" alt="Inheritance graph"/></div> +<!-- MAP 0 --> +<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> +<div class="dynheader"> +Collaboration diagram for singa::LocalUpdater:</div> +<div class="dyncontent"> +<div class="center"><img src="classsinga_1_1LocalUpdater__coll__graph.png" border="0" usemap="#singa_1_1LocalUpdater_coll__map" alt="Collaboration graph"/></div> +<!-- MAP 1 --> +<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> +<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:a42cc1d623486798832607a2ead0f31db"><td class="memItemLeft" align="right" valign="top"><a id="a42cc1d623486798832607a2ead0f31db"></a> + </td><td class="memItemRight" valign="bottom"><b>LocalUpdater</b> (int total_num, <a class="el" href="classsinga_1_1Optimizer.html">Optimizer</a> *opt, std::shared_ptr< <a class="el" href="classsinga_1_1Device.html">Device</a> > dev=<a class="el" href="namespacesinga.html#af5fd1cb4e1a4b5ae9bba1377b034eb8d">defaultDevice</a>)</td></tr> +<tr class="separator:a42cc1d623486798832607a2ead0f31db"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4b44fb78738f1ed042c3425e5681aa33"><td class="memItemLeft" align="right" valign="top"><a id="a4b44fb78738f1ed042c3425e5681aa33"></a> +virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1LocalUpdater.html#a4b44fb78738f1ed042c3425e5681aa33">Register</a> (const string &name, const ParamSpec &specs) override</td></tr> +<tr class="memdesc:a4b44fb78738f1ed042c3425e5681aa33"><td class="mdescLeft"> </td><td class="mdescRight">Forward <a class="el" href="classsinga_1_1LocalUpdater.html#a4b44fb78738f1ed042c3425e5681aa33" title="Forward Register() to Optimizer. ">Register()</a> to <a class="el" href="classsinga_1_1Optimizer.html" title="The base class for gradient descent algorithms used to update the model parameters in order to optimi...">Optimizer</a>. <br /></td></tr> +<tr class="separator:a4b44fb78738f1ed042c3425e5681aa33"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a700d688de66ac310dcaa93d0ce9adeb2"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1LocalUpdater.html#a700d688de66ac310dcaa93d0ce9adeb2">Apply</a> (int step, const string &name, <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> &grad, <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> &value) override</td></tr> +<tr class="memdesc:a700d688de66ac310dcaa93d0ce9adeb2"><td class="mdescLeft"> </td><td class="mdescRight">Update parameter value based on given gradient by invoking optimizer algoritim. <a href="#a700d688de66ac310dcaa93d0ce9adeb2">More...</a><br /></td></tr> +<tr class="separator:a700d688de66ac310dcaa93d0ce9adeb2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="inherit_header pub_methods_classsinga_1_1Updater"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classsinga_1_1Updater')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classsinga_1_1Updater.html">singa::Updater</a></td></tr> +<tr class="memitem:a076f5d544dc73d7d8ea629c683810f4f inherit pub_methods_classsinga_1_1Updater"><td class="memItemLeft" align="right" valign="top"><a id="a076f5d544dc73d7d8ea629c683810f4f"></a> + </td><td class="memItemRight" valign="bottom"><b>Updater</b> (<a class="el" href="classsinga_1_1Optimizer.html">Optimizer</a> *opt)</td></tr> +<tr class="separator:a076f5d544dc73d7d8ea629c683810f4f inherit pub_methods_classsinga_1_1Updater"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6cc4fdac0b011f0500c0d7bf9ad78e1a inherit pub_methods_classsinga_1_1Updater"><td class="memItemLeft" align="right" valign="top"><a id="a6cc4fdac0b011f0500c0d7bf9ad78e1a"></a> +virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Updater.html#a6cc4fdac0b011f0500c0d7bf9ad78e1a">Setup</a> (const OptimizerConf &conf)</td></tr> +<tr class="memdesc:a6cc4fdac0b011f0500c0d7bf9ad78e1a inherit pub_methods_classsinga_1_1Updater"><td class="mdescLeft"> </td><td class="mdescRight">Forward <a class="el" href="classsinga_1_1Updater.html#a6cc4fdac0b011f0500c0d7bf9ad78e1a" title="Forward Setup() to Optimizer. ">Setup()</a> to <a class="el" href="classsinga_1_1Optimizer.html" title="The base class for gradient descent algorithms used to update the model parameters in order to optimi...">Optimizer</a>. <br /></td></tr> +<tr class="separator:a6cc4fdac0b011f0500c0d7bf9ad78e1a inherit pub_methods_classsinga_1_1Updater"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa0d7577d8025726e3274829aeafca7c1 inherit pub_methods_classsinga_1_1Updater"><td class="memItemLeft" align="right" valign="top"><a id="aa0d7577d8025726e3274829aeafca7c1"></a> +<a class="el" href="classsinga_1_1Optimizer.html">Optimizer</a> * </td><td class="memItemRight" valign="bottom"><b>GetOptimizer</b> ()</td></tr> +<tr class="separator:aa0d7577d8025726e3274829aeafca7c1 inherit pub_methods_classsinga_1_1Updater"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a56efaf6e6432f78ad214565088c9d546 inherit pub_methods_classsinga_1_1Updater"><td class="memItemLeft" align="right" valign="top"><a id="a56efaf6e6432f78ad214565088c9d546"></a> + </td><td class="memItemRight" valign="bottom"><b>Updater</b> (const <a class="el" href="classsinga_1_1Updater.html">Updater</a> &)=delete</td></tr> +<tr class="separator:a56efaf6e6432f78ad214565088c9d546 inherit pub_methods_classsinga_1_1Updater"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9242e97e0aba87d58226f60e1ed54099 inherit pub_methods_classsinga_1_1Updater"><td class="memItemLeft" align="right" valign="top"><a id="a9242e97e0aba87d58226f60e1ed54099"></a> +void </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classsinga_1_1Updater.html">Updater</a> &)=delete</td></tr> +<tr class="separator:a9242e97e0aba87d58226f60e1ed54099 inherit pub_methods_classsinga_1_1Updater"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a> +Additional Inherited Members</h2></td></tr> +<tr class="inherit_header pro_attribs_classsinga_1_1Updater"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classsinga_1_1Updater')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classsinga_1_1Updater.html">singa::Updater</a></td></tr> +<tr class="memitem:a5ddbf085ad8a0828a0ef1e8633e8a3e4 inherit pro_attribs_classsinga_1_1Updater"><td class="memItemLeft" align="right" valign="top"><a id="a5ddbf085ad8a0828a0ef1e8633e8a3e4"></a> +<a class="el" href="classsinga_1_1Optimizer.html">Optimizer</a> * </td><td class="memItemRight" valign="bottom"><b>opt_</b></td></tr> +<tr class="separator:a5ddbf085ad8a0828a0ef1e8633e8a3e4 inherit pro_attribs_classsinga_1_1Updater"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p><a class="el" href="classsinga_1_1LocalUpdater.html" title="LocalUpdater do gradient aggregation and update gradient calling the wrapped Optimizer on a specific ...">LocalUpdater</a> do gradient aggregation and update gradient calling the wrapped <a class="el" href="classsinga_1_1Optimizer.html" title="The base class for gradient descent algorithms used to update the model parameters in order to optimi...">Optimizer</a> on a specific device (i.e., CPU or GPU). </p> +</div><h2 class="groupheader">Member Function Documentation</h2> +<a id="a700d688de66ac310dcaa93d0ce9adeb2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a700d688de66ac310dcaa93d0ce9adeb2">◆ </a></span>Apply()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual void singa::LocalUpdater::Apply </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"><em>step</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const string & </td> + <td class="paramname"><em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classsinga_1_1Tensor.html">Tensor</a> & </td> + <td class="paramname"><em>grad</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classsinga_1_1Tensor.html">Tensor</a> & </td> + <td class="paramname"><em>value</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Update parameter value based on given gradient by invoking optimizer algoritim. </p> +<p>When tranining net call this function will be blocked until all the partial gradients are aggrageted in a synchronized style training. </p> + +<p>Reimplemented from <a class="el" href="classsinga_1_1Updater.html#ac07c0e7cd69b631244b7c2c4bb90c0ec">singa::Updater</a>.</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="updater_8h_source.html">updater.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>
Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1LocalUpdater__coll__graph.dot URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1LocalUpdater__coll__graph.dot?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1LocalUpdater__coll__graph.dot (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1LocalUpdater__coll__graph.dot Mon Apr 22 10:37:18 2019 @@ -0,0 +1,16 @@ +digraph "singa::LocalUpdater" +{ + edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; + node [fontname="Helvetica",fontsize="10",shape=record]; + Node2 [label="singa::LocalUpdater",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black"]; + Node3 -> Node2 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; + Node3 [label="singa::Updater",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classsinga_1_1Updater.html",tooltip="Basic Updater class just forward all the method function call to the wrapped Optimizer. "]; + Node4 -> Node3 [dir="back",color="darkorchid3",fontsize="10",style="dashed",label=" opt_" ,fontname="Helvetica"]; + Node4 [label="singa::Optimizer",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classsinga_1_1Optimizer.html",tooltip="The base class for gradient descent algorithms used to update the model parameters in order to optimi..."]; + Node5 -> Node4 [dir="back",color="darkorchid3",fontsize="10",style="dashed",label=" constraint_" ,fontname="Helvetica"]; + Node5 [label="singa::Constraint",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classsinga_1_1Constraint.html",tooltip="Apply constraints for parameters (gradient). "]; + Node6 -> Node4 [dir="back",color="darkorchid3",fontsize="10",style="dashed",label=" learning_rate_generator_" ,fontname="Helvetica"]; + Node6 [label="function\< float(int)\>",height=0.2,width=0.4,color="grey75", fillcolor="white", style="filled"]; + Node7 -> Node4 [dir="back",color="darkorchid3",fontsize="10",style="dashed",label=" regularizer_" ,fontname="Helvetica"]; + Node7 [label="singa::Regularizer",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classsinga_1_1Regularizer.html",tooltip="Apply regularization for parameters (gradient), e.g., L1 norm and L2 norm. "]; +} Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1LocalUpdater__coll__graph.md5 URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1LocalUpdater__coll__graph.md5?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1LocalUpdater__coll__graph.md5 (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1LocalUpdater__coll__graph.md5 Mon Apr 22 10:37:18 2019 @@ -0,0 +1 @@ +aac75a52beabcd8ec06f9aa2840be009 \ No newline at end of file Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1LocalUpdater__inherit__graph.dot URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1LocalUpdater__inherit__graph.dot?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1LocalUpdater__inherit__graph.dot (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1LocalUpdater__inherit__graph.dot Mon Apr 22 10:37:18 2019 @@ -0,0 +1,8 @@ +digraph "singa::LocalUpdater" +{ + edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; + node [fontname="Helvetica",fontsize="10",shape=record]; + Node0 [label="singa::LocalUpdater",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black"]; + Node1 -> Node0 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; + Node1 [label="singa::Updater",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classsinga_1_1Updater.html",tooltip="Basic Updater class just forward all the method function call to the wrapped Optimizer. "]; +} Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1LocalUpdater__inherit__graph.md5 URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1LocalUpdater__inherit__graph.md5?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1LocalUpdater__inherit__graph.md5 (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1LocalUpdater__inherit__graph.md5 Mon Apr 22 10:37:18 2019 @@ -0,0 +1 @@ +46de61d9d30db6956754a2991748ab97 \ No newline at end of file Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1Loss-members.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1Loss-members.html?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1Loss-members.html (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1Loss-members.html Mon Apr 22 10:37:18 2019 @@ -0,0 +1,89 @@ +<!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: Member List</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_1Loss.html">Loss</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="headertitle"> +<div class="title">singa::Loss Member List</div> </div> +</div><!--header--> +<div class="contents"> + +<p>This is the complete list of members for <a class="el" href="classsinga_1_1Loss.html">singa::Loss</a>, including all inherited members.</p> +<table class="directory"> + <tr class="even"><td class="entry"><a class="el" href="classsinga_1_1Loss.html#a82a5257979b7111e283b2da846124a08">Backward</a>()=0</td><td class="entry"><a class="el" href="classsinga_1_1Loss.html">singa::Loss</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr> + <tr><td class="entry"><a class="el" href="classsinga_1_1Loss.html#a7dfd3be50e9f20430604d4adab1664ce">Evaluate</a>(int flag, const Tensor &prediction, const Tensor &target)</td><td class="entry"><a class="el" href="classsinga_1_1Loss.html">singa::Loss</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classsinga_1_1Loss.html#ad8ce9cac8b07719a2dcf2e5a50585f80">Forward</a>(int flag, const Tensor &prediction, const Tensor &target)=0</td><td class="entry"><a class="el" href="classsinga_1_1Loss.html">singa::Loss</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>Loss</b>()=default (defined in <a class="el" href="classsinga_1_1Loss.html">singa::Loss</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Loss.html">singa::Loss</a></td><td class="entry"></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>Setup</b>(const string &conf) (defined in <a class="el" href="classsinga_1_1Loss.html">singa::Loss</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Loss.html">singa::Loss</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classsinga_1_1Loss.html#a5be3a26d72200fb17ce1b2fa8c866525">Setup</a>(const LossConf &conf)</td><td class="entry"><a class="el" href="classsinga_1_1Loss.html">singa::Loss</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>ToDevice</b>(std::shared_ptr< Device > device) (defined in <a class="el" href="classsinga_1_1Loss.html">singa::Loss</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Loss.html">singa::Loss</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>~Loss</b>() (defined in <a class="el" href="classsinga_1_1Loss.html">singa::Loss</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Loss.html">singa::Loss</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr> +</table></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> Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1Loss.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1Loss.html?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1Loss.html (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1Loss.html Mon Apr 22 10:37:18 2019 @@ -0,0 +1,214 @@ +<!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::Loss 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_1Loss.html">Loss</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="classsinga_1_1Loss-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">singa::Loss Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> +</div><!--header--> +<div class="contents"> + +<p>The base loss class, which declares the APIs for computing the objective score (loss) for a pair of prediction (from the model) and the target (i.e. + <a href="classsinga_1_1Loss.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="loss_8h_source.html">loss.h</a>></code></p> +<div class="dynheader"> +Inheritance diagram for singa::Loss:</div> +<div class="dyncontent"> +<div class="center"><img src="classsinga_1_1Loss__inherit__graph.png" border="0" usemap="#singa_1_1Loss_inherit__map" alt="Inheritance graph"/></div> +<!-- MAP 0 --> +<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> +<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:ab1ffff2b3ddebd84bd1ea19104e1bba5"><td class="memItemLeft" align="right" valign="top"><a id="ab1ffff2b3ddebd84bd1ea19104e1bba5"></a> +void </td><td class="memItemRight" valign="bottom"><b>Setup</b> (const string &conf)</td></tr> +<tr class="separator:ab1ffff2b3ddebd84bd1ea19104e1bba5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:afe5a390383602feed7b0adf3a6afb487"><td class="memItemLeft" align="right" valign="top"><a id="afe5a390383602feed7b0adf3a6afb487"></a> +virtual void </td><td class="memItemRight" valign="bottom"><b>ToDevice</b> (std::shared_ptr< <a class="el" href="classsinga_1_1Device.html">Device</a> > device)</td></tr> +<tr class="separator:afe5a390383602feed7b0adf3a6afb487"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5be3a26d72200fb17ce1b2fa8c866525"><td class="memItemLeft" align="right" valign="top"><a id="a5be3a26d72200fb17ce1b2fa8c866525"></a> +virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Loss.html#a5be3a26d72200fb17ce1b2fa8c866525">Setup</a> (const LossConf &conf)</td></tr> +<tr class="memdesc:a5be3a26d72200fb17ce1b2fa8c866525"><td class="mdescLeft"> </td><td class="mdescRight">Set meta fields from user configurations. <br /></td></tr> +<tr class="separator:a5be3a26d72200fb17ce1b2fa8c866525"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad8ce9cac8b07719a2dcf2e5a50585f80"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Loss.html#ad8ce9cac8b07719a2dcf2e5a50585f80">Forward</a> (int flag, const <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> &prediction, const <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> &target)=0</td></tr> +<tr class="memdesc:ad8ce9cac8b07719a2dcf2e5a50585f80"><td class="mdescLeft"> </td><td class="mdescRight">Compute the loss values for each sample/instance given the prediction and the target. <a href="#ad8ce9cac8b07719a2dcf2e5a50585f80">More...</a><br /></td></tr> +<tr class="separator:ad8ce9cac8b07719a2dcf2e5a50585f80"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7dfd3be50e9f20430604d4adab1664ce"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Loss.html#a7dfd3be50e9f20430604d4adab1664ce">Evaluate</a> (int flag, const <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> &prediction, const <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> &target)</td></tr> +<tr class="memdesc:a7dfd3be50e9f20430604d4adab1664ce"><td class="mdescLeft"> </td><td class="mdescRight">Average loss values for all samples in the mini-batch It calls <a class="el" href="classsinga_1_1Loss.html#ad8ce9cac8b07719a2dcf2e5a50585f80" title="Compute the loss values for each sample/instance given the prediction and the target. ">Forward()</a> internally. <a href="#a7dfd3be50e9f20430604d4adab1664ce">More...</a><br /></td></tr> +<tr class="separator:a7dfd3be50e9f20430604d4adab1664ce"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a82a5257979b7111e283b2da846124a08"><td class="memItemLeft" align="right" valign="top"><a id="a82a5257979b7111e283b2da846124a08"></a> +virtual <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Loss.html#a82a5257979b7111e283b2da846124a08">Backward</a> ()=0</td></tr> +<tr class="memdesc:a82a5257979b7111e283b2da846124a08"><td class="mdescLeft"> </td><td class="mdescRight">Compute the gradients of the loss values w.r.t. the prediction. <br /></td></tr> +<tr class="separator:a82a5257979b7111e283b2da846124a08"><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 base loss class, which declares the APIs for computing the objective score (loss) for a pair of prediction (from the model) and the target (i.e. </p> +<p>the ground truth). It also computes the gradients of the objective w.r.t. the prediction. It has similar APIs as <a class="el" href="classsinga_1_1Layer.html" title="The base layer class. ">Layer</a>. </p> +</div><h2 class="groupheader">Member Function Documentation</h2> +<a id="a7dfd3be50e9f20430604d4adab1664ce"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a7dfd3be50e9f20430604d4adab1664ce">◆ </a></span>Evaluate()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">float singa::Loss::Evaluate </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"><em>flag</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>prediction</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>target</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Average loss values for all samples in the mini-batch It calls <a class="el" href="classsinga_1_1Loss.html#ad8ce9cac8b07719a2dcf2e5a50585f80" title="Compute the loss values for each sample/instance given the prediction and the target. ">Forward()</a> internally. </p> +<p>The calling pattern should be [Evaluate|Forward] Backward. </p> + +</div> +</div> +<a id="ad8ce9cac8b07719a2dcf2e5a50585f80"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ad8ce9cac8b07719a2dcf2e5a50585f80">◆ </a></span>Forward()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> singa::Loss::Forward </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"><em>flag</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>prediction</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>target</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Compute the loss values for each sample/instance given the prediction and the target. </p> + +<p>Implemented in <a class="el" href="classsinga_1_1SoftmaxCrossEntropy.html#a7dacf1dfecad29db29d942e874f3a8fa">singa::SoftmaxCrossEntropy</a>, and <a class="el" href="classsinga_1_1MSE.html#a1ef0a065a58e39957d6de834cf99e917">singa::MSE</a>.</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="loss_8h_source.html">loss.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> Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1Loss__inherit__graph.dot URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1Loss__inherit__graph.dot?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1Loss__inherit__graph.dot (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1Loss__inherit__graph.dot Mon Apr 22 10:37:18 2019 @@ -0,0 +1,10 @@ +digraph "singa::Loss" +{ + edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; + node [fontname="Helvetica",fontsize="10",shape=record]; + Node0 [label="singa::Loss",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black"]; + Node0 -> Node1 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; + Node1 [label="singa::MSE",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classsinga_1_1MSE.html",tooltip="MSE is for mean squared error or squared euclidean distance. "]; + Node0 -> Node2 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; + Node2 [label="singa::SoftmaxCrossEntropy",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classsinga_1_1SoftmaxCrossEntropy.html",tooltip="Softmax + cross entropy for multi-category classification. "]; +} Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1Loss__inherit__graph.md5 URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1Loss__inherit__graph.md5?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1Loss__inherit__graph.md5 (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1Loss__inherit__graph.md5 Mon Apr 22 10:37:18 2019 @@ -0,0 +1 @@ +ae6e48d66f59caf167dec8ea5829bed3 \ No newline at end of file Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1MSE-members.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1MSE-members.html?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1MSE-members.html (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1MSE-members.html Mon Apr 22 10:37:18 2019 @@ -0,0 +1,89 @@ +<!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: Member List</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_1MSE.html">MSE</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="headertitle"> +<div class="title">singa::MSE Member List</div> </div> +</div><!--header--> +<div class="contents"> + +<p>This is the complete list of members for <a class="el" href="classsinga_1_1MSE.html">singa::MSE</a>, including all inherited members.</p> +<table class="directory"> + <tr class="even"><td class="entry"><a class="el" href="classsinga_1_1MSE.html#af7aa618b33de0ed0d1da3ba9878c7987">Backward</a>() override</td><td class="entry"><a class="el" href="classsinga_1_1MSE.html">singa::MSE</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr><td class="entry"><a class="el" href="classsinga_1_1Loss.html#a7dfd3be50e9f20430604d4adab1664ce">Evaluate</a>(int flag, const Tensor &prediction, const Tensor &target)</td><td class="entry"><a class="el" href="classsinga_1_1Loss.html">singa::Loss</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classsinga_1_1MSE.html#a1ef0a065a58e39957d6de834cf99e917">Forward</a>(int flag, const Tensor &prediction, const Tensor &target) override</td><td class="entry"><a class="el" href="classsinga_1_1MSE.html">singa::MSE</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>Loss</b>()=default (defined in <a class="el" href="classsinga_1_1Loss.html">singa::Loss</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Loss.html">singa::Loss</a></td><td class="entry"></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>Setup</b>(const string &conf) (defined in <a class="el" href="classsinga_1_1Loss.html">singa::Loss</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Loss.html">singa::Loss</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classsinga_1_1Loss.html#a5be3a26d72200fb17ce1b2fa8c866525">Setup</a>(const LossConf &conf)</td><td class="entry"><a class="el" href="classsinga_1_1Loss.html">singa::Loss</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>ToDevice</b>(std::shared_ptr< Device > device) (defined in <a class="el" href="classsinga_1_1Loss.html">singa::Loss</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Loss.html">singa::Loss</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>~Loss</b>() (defined in <a class="el" href="classsinga_1_1Loss.html">singa::Loss</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Loss.html">singa::Loss</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr> +</table></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> Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1MSE.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1MSE.html?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1MSE.html (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1MSE.html Mon Apr 22 10:37:18 2019 @@ -0,0 +1,204 @@ +<!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::MSE 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_1MSE.html">MSE</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="classsinga_1_1MSE-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">singa::MSE Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p><a class="el" href="classsinga_1_1MSE.html" title="MSE is for mean squared error or squared euclidean distance. ">MSE</a> is for mean squared error or squared euclidean distance. + <a href="classsinga_1_1MSE.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="loss_8h_source.html">loss.h</a>></code></p> +<div class="dynheader"> +Inheritance diagram for singa::MSE:</div> +<div class="dyncontent"> +<div class="center"><img src="classsinga_1_1MSE__inherit__graph.png" border="0" usemap="#singa_1_1MSE_inherit__map" alt="Inheritance graph"/></div> +<!-- MAP 0 --> +<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> +<div class="dynheader"> +Collaboration diagram for singa::MSE:</div> +<div class="dyncontent"> +<div class="center"><img src="classsinga_1_1MSE__coll__graph.png" border="0" usemap="#singa_1_1MSE_coll__map" alt="Collaboration graph"/></div> +<!-- MAP 1 --> +<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> +<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:a1ef0a065a58e39957d6de834cf99e917"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsinga_1_1Tensor.html">Tensor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1MSE.html#a1ef0a065a58e39957d6de834cf99e917">Forward</a> (int flag, const <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> &prediction, const <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> &target) override</td></tr> +<tr class="memdesc:a1ef0a065a58e39957d6de834cf99e917"><td class="mdescLeft"> </td><td class="mdescRight">Compute the loss values for each sample/instance given the prediction and the target, which is 0.5/||prediction-target||^2 Users can call Average(const Tensor&) to get the average loss value over all samples in the batch. <a href="#a1ef0a065a58e39957d6de834cf99e917">More...</a><br /></td></tr> +<tr class="separator:a1ef0a065a58e39957d6de834cf99e917"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af7aa618b33de0ed0d1da3ba9878c7987"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsinga_1_1Tensor.html">Tensor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1MSE.html#af7aa618b33de0ed0d1da3ba9878c7987">Backward</a> () override</td></tr> +<tr class="memdesc:af7aa618b33de0ed0d1da3ba9878c7987"><td class="mdescLeft"> </td><td class="mdescRight">Compute the gradients of the loss values w.r.t. <a href="#af7aa618b33de0ed0d1da3ba9878c7987">More...</a><br /></td></tr> +<tr class="separator:af7aa618b33de0ed0d1da3ba9878c7987"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="inherit_header pub_methods_classsinga_1_1Loss"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classsinga_1_1Loss')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classsinga_1_1Loss.html">singa::Loss</a></td></tr> +<tr class="memitem:ab1ffff2b3ddebd84bd1ea19104e1bba5 inherit pub_methods_classsinga_1_1Loss"><td class="memItemLeft" align="right" valign="top"><a id="ab1ffff2b3ddebd84bd1ea19104e1bba5"></a> +void </td><td class="memItemRight" valign="bottom"><b>Setup</b> (const string &conf)</td></tr> +<tr class="separator:ab1ffff2b3ddebd84bd1ea19104e1bba5 inherit pub_methods_classsinga_1_1Loss"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:afe5a390383602feed7b0adf3a6afb487 inherit pub_methods_classsinga_1_1Loss"><td class="memItemLeft" align="right" valign="top"><a id="afe5a390383602feed7b0adf3a6afb487"></a> +virtual void </td><td class="memItemRight" valign="bottom"><b>ToDevice</b> (std::shared_ptr< <a class="el" href="classsinga_1_1Device.html">Device</a> > device)</td></tr> +<tr class="separator:afe5a390383602feed7b0adf3a6afb487 inherit pub_methods_classsinga_1_1Loss"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5be3a26d72200fb17ce1b2fa8c866525 inherit pub_methods_classsinga_1_1Loss"><td class="memItemLeft" align="right" valign="top"><a id="a5be3a26d72200fb17ce1b2fa8c866525"></a> +virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Loss.html#a5be3a26d72200fb17ce1b2fa8c866525">Setup</a> (const LossConf &conf)</td></tr> +<tr class="memdesc:a5be3a26d72200fb17ce1b2fa8c866525 inherit pub_methods_classsinga_1_1Loss"><td class="mdescLeft"> </td><td class="mdescRight">Set meta fields from user configurations. <br /></td></tr> +<tr class="separator:a5be3a26d72200fb17ce1b2fa8c866525 inherit pub_methods_classsinga_1_1Loss"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7dfd3be50e9f20430604d4adab1664ce inherit pub_methods_classsinga_1_1Loss"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Loss.html#a7dfd3be50e9f20430604d4adab1664ce">Evaluate</a> (int flag, const <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> &prediction, const <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> &target)</td></tr> +<tr class="memdesc:a7dfd3be50e9f20430604d4adab1664ce inherit pub_methods_classsinga_1_1Loss"><td class="mdescLeft"> </td><td class="mdescRight">Average loss values for all samples in the mini-batch It calls <a class="el" href="classsinga_1_1Loss.html#ad8ce9cac8b07719a2dcf2e5a50585f80" title="Compute the loss values for each sample/instance given the prediction and the target. ">Forward()</a> internally. <a href="classsinga_1_1Loss.html#a7dfd3be50e9f20430604d4adab1664ce">More...</a><br /></td></tr> +<tr class="separator:a7dfd3be50e9f20430604d4adab1664ce inherit pub_methods_classsinga_1_1Loss"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p><a class="el" href="classsinga_1_1MSE.html" title="MSE is for mean squared error or squared euclidean distance. ">MSE</a> is for mean squared error or squared euclidean distance. </p> +</div><h2 class="groupheader">Member Function Documentation</h2> +<a id="af7aa618b33de0ed0d1da3ba9878c7987"></a> +<h2 class="memtitle"><span class="permalink"><a href="#af7aa618b33de0ed0d1da3ba9878c7987">◆ </a></span>Backward()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classsinga_1_1Tensor.html">Tensor</a> singa::MSE::Backward </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Compute the gradients of the loss values w.r.t. </p> +<p>the prediction, which is (prediction-target)/batchsize </p> + +<p>Implements <a class="el" href="classsinga_1_1Loss.html#a82a5257979b7111e283b2da846124a08">singa::Loss</a>.</p> + +</div> +</div> +<a id="a1ef0a065a58e39957d6de834cf99e917"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a1ef0a065a58e39957d6de834cf99e917">◆ </a></span>Forward()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classsinga_1_1Tensor.html">Tensor</a> singa::MSE::Forward </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"><em>flag</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>prediction</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>target</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Compute the loss values for each sample/instance given the prediction and the target, which is 0.5/||prediction-target||^2 Users can call Average(const Tensor&) to get the average loss value over all samples in the batch. </p> + +<p>Implements <a class="el" href="classsinga_1_1Loss.html#ad8ce9cac8b07719a2dcf2e5a50585f80">singa::Loss</a>.</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="loss_8h_source.html">loss.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> Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1MSE__coll__graph.dot URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1MSE__coll__graph.dot?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1MSE__coll__graph.dot (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1MSE__coll__graph.dot Mon Apr 22 10:37:18 2019 @@ -0,0 +1,8 @@ +digraph "singa::MSE" +{ + edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; + node [fontname="Helvetica",fontsize="10",shape=record]; + Node2 [label="singa::MSE",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black"]; + Node3 -> Node2 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; + Node3 [label="singa::Loss",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classsinga_1_1Loss.html",tooltip="The base loss class, which declares the APIs for computing the objective score (loss) for a pair of p..."]; +} Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1MSE__coll__graph.md5 URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1MSE__coll__graph.md5?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1MSE__coll__graph.md5 (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1MSE__coll__graph.md5 Mon Apr 22 10:37:18 2019 @@ -0,0 +1 @@ +da9c6efd9e2b4ab405b449bd79986bef \ No newline at end of file Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1MSE__inherit__graph.dot URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1MSE__inherit__graph.dot?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1MSE__inherit__graph.dot (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1MSE__inherit__graph.dot Mon Apr 22 10:37:18 2019 @@ -0,0 +1,8 @@ +digraph "singa::MSE" +{ + edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; + node [fontname="Helvetica",fontsize="10",shape=record]; + Node0 [label="singa::MSE",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black"]; + Node1 -> Node0 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; + Node1 [label="singa::Loss",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classsinga_1_1Loss.html",tooltip="The base loss class, which declares the APIs for computing the objective score (loss) for a pair of p..."]; +} Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1MSE__inherit__graph.md5 URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1MSE__inherit__graph.md5?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1MSE__inherit__graph.md5 (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1MSE__inherit__graph.md5 Mon Apr 22 10:37:18 2019 @@ -0,0 +1 @@ +eabf8b7a28148b4e11beb09209be619f \ No newline at end of file Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1Metric-members.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1Metric-members.html?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1Metric-members.html (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1Metric-members.html Mon Apr 22 10:37:18 2019 @@ -0,0 +1,88 @@ +<!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: Member List</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_1Metric.html">Metric</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="headertitle"> +<div class="title">singa::Metric Member List</div> </div> +</div><!--header--> +<div class="contents"> + +<p>This is the complete list of members for <a class="el" href="classsinga_1_1Metric.html">singa::Metric</a>, including all inherited members.</p> +<table class="directory"> + <tr class="even"><td class="entry"><a class="el" href="classsinga_1_1Metric.html#aed1195424d9e3dcbf14517b09733c172">Evaluate</a>(const Tensor &prediction, const Tensor &target)</td><td class="entry"><a class="el" href="classsinga_1_1Metric.html">singa::Metric</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classsinga_1_1Metric.html#a4b054fad66714476b2477248f80faeab">Forward</a>(const Tensor &prediction, const Tensor &target)=0</td><td class="entry"><a class="el" href="classsinga_1_1Metric.html">singa::Metric</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>Metric</b>()=default (defined in <a class="el" href="classsinga_1_1Metric.html">singa::Metric</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Metric.html">singa::Metric</a></td><td class="entry"></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>Setup</b>(const string &conf) (defined in <a class="el" href="classsinga_1_1Metric.html">singa::Metric</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Metric.html">singa::Metric</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classsinga_1_1Metric.html#a0d5f2debebaedd389a59a2ee18068175">Setup</a>(const MetricConf &conf)</td><td class="entry"><a class="el" href="classsinga_1_1Metric.html">singa::Metric</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>ToDevice</b>(std::shared_ptr< Device > device) (defined in <a class="el" href="classsinga_1_1Metric.html">singa::Metric</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Metric.html">singa::Metric</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>~Metric</b>() (defined in <a class="el" href="classsinga_1_1Metric.html">singa::Metric</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Metric.html">singa::Metric</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr> +</table></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> Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1Metric.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1Metric.html?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1Metric.html (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1Metric.html Mon Apr 22 10:37:18 2019 @@ -0,0 +1,120 @@ +<!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::Metric 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_1Metric.html">Metric</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="classsinga_1_1Metric-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">singa::Metric Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> +</div><!--header--> +<div class="contents"> + +<p>The base metric class, which declares the APIs for computing the performance evaluation metrics given the prediction of the model and the ground truth, i.e., the target. + <a href="classsinga_1_1Metric.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="metric_8h_source.html">metric.h</a>></code></p> +<div class="dynheader"> +Inheritance diagram for singa::Metric:</div> +<div class="dyncontent"> +<div class="center"><img src="classsinga_1_1Metric__inherit__graph.png" border="0" usemap="#singa_1_1Metric_inherit__map" alt="Inheritance graph"/></div> +<!-- MAP 0 --> +<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> +<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:a62178144c6f4b219bd1f403716862d9b"><td class="memItemLeft" align="right" valign="top"><a id="a62178144c6f4b219bd1f403716862d9b"></a> +virtual void </td><td class="memItemRight" valign="bottom"><b>ToDevice</b> (std::shared_ptr< <a class="el" href="classsinga_1_1Device.html">Device</a> > device)</td></tr> +<tr class="separator:a62178144c6f4b219bd1f403716862d9b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a76de5dfdcaef7166babb1f4a4757dde5"><td class="memItemLeft" align="right" valign="top"><a id="a76de5dfdcaef7166babb1f4a4757dde5"></a> +void </td><td class="memItemRight" valign="bottom"><b>Setup</b> (const string &conf)</td></tr> +<tr class="separator:a76de5dfdcaef7166babb1f4a4757dde5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0d5f2debebaedd389a59a2ee18068175"><td class="memItemLeft" align="right" valign="top"><a id="a0d5f2debebaedd389a59a2ee18068175"></a> +virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Metric.html#a0d5f2debebaedd389a59a2ee18068175">Setup</a> (const MetricConf &conf)</td></tr> +<tr class="memdesc:a0d5f2debebaedd389a59a2ee18068175"><td class="mdescLeft"> </td><td class="mdescRight">Set meta fields from user configurations. <br /></td></tr> +<tr class="separator:a0d5f2debebaedd389a59a2ee18068175"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4b054fad66714476b2477248f80faeab"><td class="memItemLeft" align="right" valign="top"><a id="a4b054fad66714476b2477248f80faeab"></a> +virtual <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Metric.html#a4b054fad66714476b2477248f80faeab">Forward</a> (const <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> &prediction, const <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> &target)=0</td></tr> +<tr class="memdesc:a4b054fad66714476b2477248f80faeab"><td class="mdescLeft"> </td><td class="mdescRight">Compute the metric for each data sample. <br /></td></tr> +<tr class="separator:a4b054fad66714476b2477248f80faeab"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aed1195424d9e3dcbf14517b09733c172"><td class="memItemLeft" align="right" valign="top"><a id="aed1195424d9e3dcbf14517b09733c172"></a> +float </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Metric.html#aed1195424d9e3dcbf14517b09733c172">Evaluate</a> (const <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> &prediction, const <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> &target)</td></tr> +<tr class="memdesc:aed1195424d9e3dcbf14517b09733c172"><td class="mdescLeft"> </td><td class="mdescRight">Comptue the metric value averaged over all samples (in a batch) <br /></td></tr> +<tr class="separator:aed1195424d9e3dcbf14517b09733c172"><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 base metric class, which declares the APIs for computing the performance evaluation metrics given the prediction of the model and the ground truth, i.e., the target. </p> +<p>The target type is a template argument. For data samples with a single label, T could be 1-d tenor (or vector<int>); If each data sample has multiple labels, T could be vector<vector<int>>, one vector per sample. </p> +</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="metric_8h_source.html">metric.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> Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1Metric__inherit__graph.dot URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1Metric__inherit__graph.dot?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1Metric__inherit__graph.dot (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1Metric__inherit__graph.dot Mon Apr 22 10:37:18 2019 @@ -0,0 +1,8 @@ +digraph "singa::Metric" +{ + edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; + node [fontname="Helvetica",fontsize="10",shape=record]; + Node0 [label="singa::Metric",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black"]; + Node0 -> Node1 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; + Node1 [label="singa::Accuracy",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classsinga_1_1Accuracy.html",tooltip="Compute the accuray of the prediction, which is matched against the ground truth labels. "]; +} Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1Metric__inherit__graph.md5 URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1Metric__inherit__graph.md5?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1Metric__inherit__graph.md5 (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1Metric__inherit__graph.md5 Mon Apr 22 10:37:18 2019 @@ -0,0 +1 @@ +623104dae32254436c8bf6dd7c3c31da \ No newline at end of file Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1Nesterov-members.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1Nesterov-members.html?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1Nesterov-members.html (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1Nesterov-members.html Mon Apr 22 10:37:18 2019 @@ -0,0 +1,99 @@ +<!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: Member List</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_1Nesterov.html">Nesterov</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="headertitle"> +<div class="title">singa::Nesterov Member List</div> </div> +</div><!--header--> +<div class="contents"> + +<p>This is the complete list of members for <a class="el" href="classsinga_1_1Nesterov.html">singa::Nesterov</a>, including all inherited members.</p> +<table class="directory"> + <tr class="even"><td class="entry"><a class="el" href="classsinga_1_1Nesterov.html#a6551a089c8073dd13b27d59b06ccf2eb">Apply</a>(int epoch, float lr, const string &name, Tensor &grad, Tensor &value, int step=-1) override</td><td class="entry"><a class="el" href="classsinga_1_1Nesterov.html">singa::Nesterov</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html#a23eb982f713174589788369a0316e81d">singa::Optimizer::Apply</a>(int epoch, const string &name, Tensor &grad, Tensor &value, int step=-1)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>ApplyRegularizerConstraint</b>(int epoch, const string &name, const Tensor &value, Tensor &grad, int step=-1) (defined in <a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>conf_</b> (defined in <a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>constraint_</b> (defined in <a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>constraints_</b> (defined in <a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>GetLearningRate</b>(int step) (defined in <a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>learning_rate_generator_</b> (defined in <a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>learning_rate_multplier_</b> (defined in <a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>Optimizer</b>()=default (defined in <a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html#a6385d176ba3b2bf744221f8801291f3e">Register</a>(const string &name, const ParamSpec &specs)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>regularizer_</b> (defined in <a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>regularizers_</b> (defined in <a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html#a2f3ba1fe776cdf373565b0cf208bf540">SetLearningRateGenerator</a>(function< float(int)> func)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classsinga_1_1Nesterov.html#a2ffcfb0b5c20aeaa7af40254bcf85396">SetMomentumGenerator</a>(std::function< float(int)> func)</td><td class="entry"><a class="el" href="classsinga_1_1Nesterov.html">singa::Nesterov</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classsinga_1_1Nesterov.html#a117377bc4294f46759e7d87834c6772d">Setup</a>(const OptimizerConf &conf)</td><td class="entry"><a class="el" href="classsinga_1_1Nesterov.html">singa::Nesterov</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html#ad0940567e5f2ac6ec99132f2c013c94a">singa::Optimizer::Setup</a>(const string &str)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>~Optimizer</b>() (defined in <a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> +</table></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>
