| <!DOCTYPE html > |
| <html> |
| <head> |
| <title>sgd_updateParam - MXNet - org.apache.mxnet.javaapi.sgd_updateParam</title> |
| <meta name="description" content="sgd updateParam - MXNet - org.apache.mxnet.javaapi.sgd updateParam" /> |
| <meta name="keywords" content="sgd updateParam MXNet org.apache.mxnet.javaapi.sgd updateParam" /> |
| <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> |
| |
| <link href="../../../../lib/template.css" media="screen" type="text/css" rel="stylesheet" /> |
| <link href="../../../../lib/diagrams.css" media="screen" type="text/css" rel="stylesheet" id="diagrams-css" /> |
| <script type="text/javascript" src="../../../../lib/jquery.js" id="jquery-js"></script> |
| <script type="text/javascript" src="../../../../lib/jquery-ui.js"></script> |
| <script type="text/javascript" src="../../../../lib/template.js"></script> |
| <script type="text/javascript" src="../../../../lib/tools.tooltip.js"></script> |
| |
| <script type="text/javascript"> |
| if(top === self) { |
| var url = '../../../../index.html'; |
| var hash = 'org.apache.mxnet.javaapi.sgd_updateParam'; |
| var anchor = window.location.hash; |
| var anchor_opt = ''; |
| if (anchor.length >= 1) |
| anchor_opt = '@' + anchor.substring(1); |
| window.location.href = url + '#' + hash + anchor_opt; |
| } |
| </script> |
| |
| </head> |
| <body class="type"> |
| <div id="definition"> |
| <img alt="Class" src="../../../../lib/class_big.png" /> |
| <p id="owner"><a href="../../../package.html" class="extype" name="org">org</a>.<a href="../../package.html" class="extype" name="org.apache">apache</a>.<a href="../package.html" class="extype" name="org.apache.mxnet">mxnet</a>.<a href="package.html" class="extype" name="org.apache.mxnet.javaapi">javaapi</a></p> |
| <h1>sgd_updateParam</h1><h3><span class="morelinks"><div>Related Doc: |
| <a href="package.html" class="extype" name="org.apache.mxnet.javaapi">package javaapi</a> |
| </div></span></h3><span class="permalink"> |
| <a href="../../../../index.html#org.apache.mxnet.javaapi.sgd_updateParam" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| </div> |
| |
| <h4 id="signature" class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">sgd_updateParam</span><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4> |
| |
| <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>This Param Object is specifically used for sgd_update</p></div><div class="toggleContainer block"> |
| <span class="toggle">Linear Supertypes</span> |
| <div class="superTypes hiddenContent"><span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> |
| </div></div> |
| |
| |
| <div id="mbrsel"> |
| <div id="textfilter"><span class="pre"></span><span class="input"><input id="mbrsel-input" type="text" accesskey="/" /></span><span class="post"></span></div> |
| <div id="order"> |
| <span class="filtertype">Ordering</span> |
| <ol> |
| |
| <li class="alpha in"><span>Alphabetic</span></li> |
| <li class="inherit out"><span>By Inheritance</span></li> |
| </ol> |
| </div> |
| <div id="ancestors"> |
| <span class="filtertype">Inherited<br /> |
| </span> |
| <ol id="linearization"> |
| <li class="in" name="org.apache.mxnet.javaapi.sgd_updateParam"><span>sgd_updateParam</span></li><li class="in" name="scala.AnyRef"><span>AnyRef</span></li><li class="in" name="scala.Any"><span>Any</span></li> |
| </ol> |
| </div><div id="ancestors"> |
| <span class="filtertype"></span> |
| <ol> |
| <li class="hideall out"><span>Hide All</span></li> |
| <li class="showall in"><span>Show All</span></li> |
| </ol> |
| </div> |
| <div id="visbl"> |
| <span class="filtertype">Visibility</span> |
| <ol><li class="public in"><span>Public</span></li><li class="all out"><span>All</span></li></ol> |
| </div> |
| </div> |
| |
| <div id="template"> |
| <div id="allMembers"> |
| <div id="constructors" class="members"> |
| <h3>Instance Constructors</h3> |
| <ol><li name="org.apache.mxnet.javaapi.sgd_updateParam#<init>" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="<init>(weight:org.apache.mxnet.javaapi.NDArray,grad:org.apache.mxnet.javaapi.NDArray,lr:Float):org.apache.mxnet.javaapi.sgd_updateParam"></a> |
| <a id="<init>:sgd_updateParam"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">new</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">sgd_updateParam</span><span class="params">(<span name="weight">weight: <a href="NDArray.html" class="extype" name="org.apache.mxnet.javaapi.NDArray">NDArray</a></span>, <span name="grad">grad: <a href="NDArray.html" class="extype" name="org.apache.mxnet.javaapi.NDArray">NDArray</a></span>, <span name="lr">lr: <span class="extype" name="java.lang.Float">Float</span></span>)</span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.mxnet.javaapi.sgd_updateParam@<init>(weight:org.apache.mxnet.javaapi.NDArray,grad:org.apache.mxnet.javaapi.NDArray,lr:Float):org.apache.mxnet.javaapi.sgd_updateParam" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">weight</dt><dd class="cmt"><p>Weight</p></dd><dt class="param">grad</dt><dd class="cmt"><p>Gradient</p></dd><dt class="param">lr</dt><dd class="cmt"><p>Learning rate</p></dd></dl></div> |
| </li></ol> |
| </div> |
| |
| |
| |
| |
| |
| <div id="values" class="values members"> |
| <h3>Value Members</h3> |
| <ol><li name="scala.AnyRef#!=" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="!=(x$1:Any):Boolean"></a> |
| <a id="!=(Any):Boolean"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span title="gt4s: $bang$eq" class="name">!=</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.mxnet.javaapi.sgd_updateParam@!=(x$1:Any):Boolean" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div> |
| </li><li name="scala.AnyRef###" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="##():Int"></a> |
| <a id="##():Int"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span title="gt4s: $hash$hash" class="name">##</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.mxnet.javaapi.sgd_updateParam@##():Int" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div> |
| </li><li name="scala.AnyRef#==" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="==(x$1:Any):Boolean"></a> |
| <a id="==(Any):Boolean"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span title="gt4s: $eq$eq" class="name">==</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.mxnet.javaapi.sgd_updateParam@==(x$1:Any):Boolean" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div> |
| </li><li name="scala.Any#asInstanceOf" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="asInstanceOf[T0]:T0"></a> |
| <a id="asInstanceOf[T0]:T0"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">asInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <span class="extype" name="scala.Any.asInstanceOf.T0">T0</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.mxnet.javaapi.sgd_updateParam@asInstanceOf[T0]:T0" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Any</dd></dl></div> |
| </li><li name="scala.AnyRef#clone" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="clone():Object"></a> |
| <a id="clone():AnyRef"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">clone</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.mxnet.javaapi.sgd_updateParam@clone():Object" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Attributes</dt><dd>protected[<a href="../../../../java$lang.html" class="extype" name="java.lang">java.lang</a>] </dd><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd> |
| <span class="name">@throws</span><span class="args">(<span> |
| |
| <span class="defval" name="classOf[java.lang.CloneNotSupportedException]">...</span> |
| </span>)</span> |
| |
| </dd></dl></div> |
| </li><li name="scala.AnyRef#eq" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="eq(x$1:AnyRef):Boolean"></a> |
| <a id="eq(AnyRef):Boolean"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">eq</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.AnyRef">AnyRef</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.mxnet.javaapi.sgd_updateParam@eq(x$1:AnyRef):Boolean" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div> |
| </li><li name="scala.AnyRef#equals" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="equals(x$1:Any):Boolean"></a> |
| <a id="equals(Any):Boolean"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">equals</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.mxnet.javaapi.sgd_updateParam@equals(x$1:Any):Boolean" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div> |
| </li><li name="scala.AnyRef#finalize" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="finalize():Unit"></a> |
| <a id="finalize():Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">finalize</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.mxnet.javaapi.sgd_updateParam@finalize():Unit" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Attributes</dt><dd>protected[<a href="../../../../java$lang.html" class="extype" name="java.lang">java.lang</a>] </dd><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd> |
| <span class="name">@throws</span><span class="args">(<span> |
| |
| <span class="symbol">classOf[java.lang.Throwable]</span> |
| </span>)</span> |
| |
| </dd></dl></div> |
| </li><li name="scala.AnyRef#getClass" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="getClass():Class[_]"></a> |
| <a id="getClass():Class[_]"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">getClass</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.Class">Class</span>[_]</span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.mxnet.javaapi.sgd_updateParam@getClass():Class[_]" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div> |
| </li><li name="org.apache.mxnet.javaapi.sgd_updateParam#getClip_gradient" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="getClip_gradient():Float"></a> |
| <a id="getClip_gradient():Float"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">getClip_gradient</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.Float">Float</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.mxnet.javaapi.sgd_updateParam@getClip_gradient():Float" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.javaapi.sgd_updateParam#getGrad" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="getGrad():org.apache.mxnet.javaapi.NDArray"></a> |
| <a id="getGrad():NDArray"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">getGrad</span><span class="params">()</span><span class="result">: <a href="NDArray.html" class="extype" name="org.apache.mxnet.javaapi.NDArray">NDArray</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.mxnet.javaapi.sgd_updateParam@getGrad():org.apache.mxnet.javaapi.NDArray" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.javaapi.sgd_updateParam#getLazy_update" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="getLazy_update():Boolean"></a> |
| <a id="getLazy_update():Boolean"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">getLazy_update</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.Boolean">Boolean</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.mxnet.javaapi.sgd_updateParam@getLazy_update():Boolean" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.javaapi.sgd_updateParam#getLr" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="getLr():Float"></a> |
| <a id="getLr():Float"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">getLr</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.Float">Float</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.mxnet.javaapi.sgd_updateParam@getLr():Float" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.javaapi.sgd_updateParam#getOut" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="getOut():org.apache.mxnet.NDArray"></a> |
| <a id="getOut():mxnet.NDArray"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">getOut</span><span class="params">()</span><span class="result">: <span class="extype" name="org.apache.mxnet.NDArray">mxnet.NDArray</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.mxnet.javaapi.sgd_updateParam@getOut():org.apache.mxnet.NDArray" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.javaapi.sgd_updateParam#getRescale_grad" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="getRescale_grad():Float"></a> |
| <a id="getRescale_grad():Float"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">getRescale_grad</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.Float">Float</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.mxnet.javaapi.sgd_updateParam@getRescale_grad():Float" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.javaapi.sgd_updateParam#getWd" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="getWd():Float"></a> |
| <a id="getWd():Float"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">getWd</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.Float">Float</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.mxnet.javaapi.sgd_updateParam@getWd():Float" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.javaapi.sgd_updateParam#getWeight" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="getWeight():org.apache.mxnet.javaapi.NDArray"></a> |
| <a id="getWeight():NDArray"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">getWeight</span><span class="params">()</span><span class="result">: <a href="NDArray.html" class="extype" name="org.apache.mxnet.javaapi.NDArray">NDArray</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.mxnet.javaapi.sgd_updateParam@getWeight():org.apache.mxnet.javaapi.NDArray" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="scala.AnyRef#hashCode" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="hashCode():Int"></a> |
| <a id="hashCode():Int"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">hashCode</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.mxnet.javaapi.sgd_updateParam@hashCode():Int" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div> |
| </li><li name="scala.Any#isInstanceOf" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="isInstanceOf[T0]:Boolean"></a> |
| <a id="isInstanceOf[T0]:Boolean"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">isInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.mxnet.javaapi.sgd_updateParam@isInstanceOf[T0]:Boolean" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Any</dd></dl></div> |
| </li><li name="scala.AnyRef#ne" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="ne(x$1:AnyRef):Boolean"></a> |
| <a id="ne(AnyRef):Boolean"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">ne</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.AnyRef">AnyRef</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.mxnet.javaapi.sgd_updateParam@ne(x$1:AnyRef):Boolean" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div> |
| </li><li name="scala.AnyRef#notify" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="notify():Unit"></a> |
| <a id="notify():Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">notify</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.mxnet.javaapi.sgd_updateParam@notify():Unit" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div> |
| </li><li name="scala.AnyRef#notifyAll" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="notifyAll():Unit"></a> |
| <a id="notifyAll():Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">notifyAll</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.mxnet.javaapi.sgd_updateParam@notifyAll():Unit" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div> |
| </li><li name="org.apache.mxnet.javaapi.sgd_updateParam#setClip_gradient" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="setClip_gradient(clip_gradient:Float):org.apache.mxnet.javaapi.sgd_updateParam"></a> |
| <a id="setClip_gradient(Float):sgd_updateParam"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">setClip_gradient</span><span class="params">(<span name="clip_gradient">clip_gradient: <span class="extype" name="java.lang.Float">Float</span></span>)</span><span class="result">: <a href="" class="extype" name="org.apache.mxnet.javaapi.sgd_updateParam">sgd_updateParam</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.mxnet.javaapi.sgd_updateParam@setClip_gradient(clip_gradient:Float):org.apache.mxnet.javaapi.sgd_updateParam" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">clip_gradient</dt><dd class="cmt"><p>Clip gradient to the range of [-clip_gradient, clip_gradient] If clip_gradient <= 0, gradient clipping is turned off. grad = max(min(grad, clip_gradient), -clip_gradient).</p></dd></dl></div> |
| </li><li name="org.apache.mxnet.javaapi.sgd_updateParam#setLazy_update" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="setLazy_update(lazy_update:Boolean):org.apache.mxnet.javaapi.sgd_updateParam"></a> |
| <a id="setLazy_update(Boolean):sgd_updateParam"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">setLazy_update</span><span class="params">(<span name="lazy_update">lazy_update: <span class="extype" name="java.lang.Boolean">Boolean</span></span>)</span><span class="result">: <a href="" class="extype" name="org.apache.mxnet.javaapi.sgd_updateParam">sgd_updateParam</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.mxnet.javaapi.sgd_updateParam@setLazy_update(lazy_update:Boolean):org.apache.mxnet.javaapi.sgd_updateParam" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">lazy_update</dt><dd class="cmt"><p>If true, lazy updates are applied if gradient's stype is row_sparse.</p></dd></dl></div> |
| </li><li name="org.apache.mxnet.javaapi.sgd_updateParam#setOut" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="setOut(out:org.apache.mxnet.javaapi.NDArray):org.apache.mxnet.javaapi.sgd_updateParam"></a> |
| <a id="setOut(NDArray):sgd_updateParam"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">setOut</span><span class="params">(<span name="out">out: <a href="NDArray.html" class="extype" name="org.apache.mxnet.javaapi.NDArray">NDArray</a></span>)</span><span class="result">: <a href="" class="extype" name="org.apache.mxnet.javaapi.sgd_updateParam">sgd_updateParam</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.mxnet.javaapi.sgd_updateParam@setOut(out:org.apache.mxnet.javaapi.NDArray):org.apache.mxnet.javaapi.sgd_updateParam" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.javaapi.sgd_updateParam#setRescale_grad" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="setRescale_grad(rescale_grad:Float):org.apache.mxnet.javaapi.sgd_updateParam"></a> |
| <a id="setRescale_grad(Float):sgd_updateParam"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">setRescale_grad</span><span class="params">(<span name="rescale_grad">rescale_grad: <span class="extype" name="java.lang.Float">Float</span></span>)</span><span class="result">: <a href="" class="extype" name="org.apache.mxnet.javaapi.sgd_updateParam">sgd_updateParam</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.mxnet.javaapi.sgd_updateParam@setRescale_grad(rescale_grad:Float):org.apache.mxnet.javaapi.sgd_updateParam" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">rescale_grad</dt><dd class="cmt"><p>Rescale gradient to grad = rescale_grad*grad.</p></dd></dl></div> |
| </li><li name="org.apache.mxnet.javaapi.sgd_updateParam#setWd" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="setWd(wd:Float):org.apache.mxnet.javaapi.sgd_updateParam"></a> |
| <a id="setWd(Float):sgd_updateParam"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">setWd</span><span class="params">(<span name="wd">wd: <span class="extype" name="java.lang.Float">Float</span></span>)</span><span class="result">: <a href="" class="extype" name="org.apache.mxnet.javaapi.sgd_updateParam">sgd_updateParam</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.mxnet.javaapi.sgd_updateParam@setWd(wd:Float):org.apache.mxnet.javaapi.sgd_updateParam" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">wd</dt><dd class="cmt"><p>Weight decay augments the objective function with a regularization term that penalizes large weights. The penalty scales with the square of the magnitude of each weight.</p></dd></dl></div> |
| </li><li name="scala.AnyRef#synchronized" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="synchronized[T0](x$1:=>T0):T0"></a> |
| <a id="synchronized[T0](⇒T0):T0"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">synchronized</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="params">(<span name="arg0">arg0: ⇒ <span class="extype" name="java.lang.AnyRef.synchronized.T0">T0</span></span>)</span><span class="result">: <span class="extype" name="java.lang.AnyRef.synchronized.T0">T0</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.mxnet.javaapi.sgd_updateParam@synchronized[T0](x$1:=>T0):T0" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div> |
| </li><li name="scala.AnyRef#toString" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="toString():String"></a> |
| <a id="toString():String"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.mxnet.javaapi.sgd_updateParam@toString():String" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div> |
| </li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="wait():Unit"></a> |
| <a id="wait():Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">wait</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.mxnet.javaapi.sgd_updateParam@wait():Unit" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd> |
| <span class="name">@throws</span><span class="args">(<span> |
| |
| <span class="defval" name="classOf[java.lang.InterruptedException]">...</span> |
| </span>)</span> |
| |
| </dd></dl></div> |
| </li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="wait(x$1:Long,x$2:Int):Unit"></a> |
| <a id="wait(Long,Int):Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">wait</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Long">Long</span></span>, <span name="arg1">arg1: <span class="extype" name="scala.Int">Int</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.mxnet.javaapi.sgd_updateParam@wait(x$1:Long,x$2:Int):Unit" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd> |
| <span class="name">@throws</span><span class="args">(<span> |
| |
| <span class="defval" name="classOf[java.lang.InterruptedException]">...</span> |
| </span>)</span> |
| |
| </dd></dl></div> |
| </li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="wait(x$1:Long):Unit"></a> |
| <a id="wait(Long):Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">wait</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Long">Long</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../../index.html#org.apache.mxnet.javaapi.sgd_updateParam@wait(x$1:Long):Unit" title="Permalink" target="_top"> |
| <img src="../../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd> |
| <span class="name">@throws</span><span class="args">(<span> |
| |
| <span class="defval" name="classOf[java.lang.InterruptedException]">...</span> |
| </span>)</span> |
| |
| </dd></dl></div> |
| </li></ol> |
| </div> |
| |
| |
| |
| |
| </div> |
| |
| <div id="inheritedMembers"> |
| <div class="parent" name="scala.AnyRef"> |
| <h3>Inherited from <span class="extype" name="scala.AnyRef">AnyRef</span></h3> |
| </div><div class="parent" name="scala.Any"> |
| <h3>Inherited from <span class="extype" name="scala.Any">Any</span></h3> |
| </div> |
| |
| </div> |
| |
| <div id="groupedMembers"> |
| <div class="group" name="Ungrouped"> |
| <h3>Ungrouped</h3> |
| |
| </div> |
| </div> |
| |
| </div> |
| |
| <div id="tooltip"></div> |
| |
| <div id="footer"> </div> |
| |
| |
| </body> |
| </html> |
