| <!DOCTYPE html > |
| <html> |
| <head> |
| <title>mxnet - MXNet - org.apache.mxnet</title> |
| <meta name="description" content="mxnet - MXNet - org.apache.mxnet" /> |
| <meta name="keywords" content="mxnet MXNet org.apache.mxnet" /> |
| <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.package'; |
| 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="value"> |
| <div id="definition"> |
| <img alt="Package" src="../../../lib/package_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></p> |
| <h1>mxnet</h1><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package" 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">package</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">mxnet</span> |
| </span> |
| </h4> |
| |
| <div id="comment" class="fullcommenttop"></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="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="types" class="types members"> |
| <h3>Type Members</h3> |
| <ol><li name="org.apache.mxnet.Accuracy" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="AccuracyextendsEvalMetric"></a> |
| <a id="Accuracy:Accuracy"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="Accuracy.html"><span class="name">Accuracy</span></a><span class="result"> extends <a href="EvalMetric.html" class="extype" name="org.apache.mxnet.EvalMetric">EvalMetric</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@AccuracyextendsEvalMetric" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Calculate accuracy |
| </p> |
| </li><li name="org.apache.mxnet.BatchEndCallback" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped"> |
| <a id="BatchEndCallbackextendsAnyRef"></a> |
| <a id="BatchEndCallback:BatchEndCallback"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">trait</span> |
| </span> |
| <span class="symbol"> |
| <a href="BatchEndCallback.html"><span class="name">BatchEndCallback</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@BatchEndCallbackextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.CompositeEvalMetric" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="CompositeEvalMetricextendsEvalMetric"></a> |
| <a id="CompositeEvalMetric:CompositeEvalMetric"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="CompositeEvalMetric.html"><span class="name">CompositeEvalMetric</span></a><span class="result"> extends <a href="EvalMetric.html" class="extype" name="org.apache.mxnet.EvalMetric">EvalMetric</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@CompositeEvalMetricextendsEvalMetric" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Manage multiple evaluation metrics.</p> |
| </li><li name="org.apache.mxnet.Context" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="ContextextendsSerializable"></a> |
| <a id="Context:Context"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="Context.html"><span class="name">Context</span></a><span class="result"> extends <span class="extype" name="scala.Serializable">Serializable</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@ContextextendsSerializable" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Constructing a context which is used to specify the device and device type that will |
| be utilized by the engine.</p> |
| </li><li name="org.apache.mxnet.CustomMetric" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="CustomMetricextendsEvalMetric"></a> |
| <a id="CustomMetric:CustomMetric"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="CustomMetric.html"><span class="name">CustomMetric</span></a><span class="result"> extends <a href="EvalMetric.html" class="extype" name="org.apache.mxnet.EvalMetric">EvalMetric</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@CustomMetricextendsEvalMetric" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Custom evaluation metric that takes a NDArray function.</p> |
| </li><li name="org.apache.mxnet.CustomOp" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped"> |
| <a id="CustomOpextendsAnyRef"></a> |
| <a id="CustomOp:CustomOp"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">abstract </span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="CustomOp.html"><span class="name">CustomOp</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@CustomOpextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Base class for operators implemented in Scala |
| </p> |
| </li><li name="org.apache.mxnet.CustomOpProp" visbl="pub" data-isabs="true" fullComment="yes" group="Ungrouped"> |
| <a id="CustomOpPropextendsAnyRef"></a> |
| <a id="CustomOpProp:CustomOpProp"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">abstract </span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="CustomOpProp.html"><span class="name">CustomOpProp</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@CustomOpPropextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Base class for operator property class implemented in Scala.</p><div class="fullcomment"><div class="comment cmt"><p>Base class for operator property class implemented in Scala. |
| MXNET_CPU_WORKER_NTHREADS must be greater than 1 for custom op to work on CPU</p></div></div> |
| </li><li name="org.apache.mxnet.DataBatch" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="DataBatchextendsAnyRef"></a> |
| <a id="DataBatch:DataBatch"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="DataBatch.html"><span class="name">DataBatch</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@DataBatchextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">class batch of data |
| </p> |
| </li><li name="org.apache.mxnet.DataDesc" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="DataDescextendsProductwithSerializable"></a> |
| <a id="DataDesc:DataDesc"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">case class</span> |
| </span> |
| <span class="symbol"> |
| <a href="DataDesc.html"><span class="name">DataDesc</span></a><span class="params">(<span name="name">name: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="shape">shape: <a href="Shape.html" class="extype" name="org.apache.mxnet.Shape">Shape</a></span>, <span name="dtype">dtype: <a href="DType$.html#DType=org.apache.mxnet.DType.Value" class="extmbr" name="org.apache.mxnet.DType.DType">DType.DType</a> = <span class="symbol"><span class="name"><a href="DType$.html">DType.Float32</a></span></span></span>, <span name="layout">layout: <span class="extype" name="scala.Predef.String">String</span> = <span class="symbol"><span class="name"><a href="Layout$.html">Layout.UNDEFINED</a></span></span></span>)</span><span class="result"> extends <span class="extype" name="scala.Product">Product</span> with <span class="extype" name="scala.Serializable">Serializable</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@DataDescextendsProductwithSerializable" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.DataIter" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped"> |
| <a id="DataIterextendsIterator[org.apache.mxnet.DataBatch]"></a> |
| <a id="DataIter:DataIter"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">abstract </span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="DataIter.html"><span class="name">DataIter</span></a><span class="result"> extends <span class="extype" name="scala.Iterator">Iterator</span>[<a href="DataBatch.html" class="extype" name="org.apache.mxnet.DataBatch">DataBatch</a>]</span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@DataIterextendsIterator[org.apache.mxnet.DataBatch]" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">DataIter object in mxnet.</p> |
| </li><li name="org.apache.mxnet.DataPack" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped"> |
| <a id="DataPackextendsIterable[org.apache.mxnet.DataBatch]"></a> |
| <a id="DataPack:DataPack"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">abstract </span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="DataPack.html"><span class="name">DataPack</span></a><span class="result"> extends <span class="extype" name="scala.Iterable">Iterable</span>[<a href="DataBatch.html" class="extype" name="org.apache.mxnet.DataBatch">DataBatch</a>]</span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@DataPackextendsIterable[org.apache.mxnet.DataBatch]" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">pack of DataIter, use as Iterable class |
| </p> |
| </li><li name="org.apache.mxnet.EpochEndCallback" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped"> |
| <a id="EpochEndCallbackextendsAnyRef"></a> |
| <a id="EpochEndCallback:EpochEndCallback"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">trait</span> |
| </span> |
| <span class="symbol"> |
| <a href="EpochEndCallback.html"><span class="name">EpochEndCallback</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@EpochEndCallbackextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.EvalMetric" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped"> |
| <a id="EvalMetricextendsAnyRef"></a> |
| <a id="EvalMetric:EvalMetric"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">abstract </span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="EvalMetric.html"><span class="name">EvalMetric</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@EvalMetricextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Base class of all evaluation metrics</p> |
| </li><li name="org.apache.mxnet.Executor" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="ExecutorextendsNativeResource"></a> |
| <a id="Executor:Executor"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="Executor.html"><span class="name">Executor</span></a><span class="result"> extends <span class="extype" name="org.apache.mxnet.NativeResource">NativeResource</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@ExecutorextendsNativeResource" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Symbolic Executor component of MXNet <br /> |
| <b> |
| WARNING: it is your responsibility to clear this object through dispose(). |
| </b> |
| </b></p><div class="fullcomment"><div class="comment cmt"><p>Symbolic Executor component of MXNet <br /> |
| <b> |
| WARNING: it is your responsibility to clear this object through dispose(). |
| </b> |
| </p></div><dl class="attributes block"> <dt>See also</dt><dd><span class="cmt"><p>Symbol.bind : to create executor</p></span></dd></dl></div> |
| </li><li name="org.apache.mxnet.F1" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="F1extendsEvalMetric"></a> |
| <a id="F1:F1"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="F1.html"><span class="name">F1</span></a><span class="result"> extends <a href="EvalMetric.html" class="extype" name="org.apache.mxnet.EvalMetric">EvalMetric</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@F1extendsEvalMetric" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Calculate the F1 score of a binary classification problem.</p> |
| </li><li name="org.apache.mxnet.FactorScheduler" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="FactorSchedulerextendsLRScheduler"></a> |
| <a id="FactorScheduler:FactorScheduler"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="FactorScheduler.html"><span class="name">FactorScheduler</span></a><span class="result"> extends <a href="LRScheduler.html" class="extype" name="org.apache.mxnet.LRScheduler">LRScheduler</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@FactorSchedulerextendsLRScheduler" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Class for reducing learning rate in factor</p><div class="fullcomment"><div class="comment cmt"><p>Class for reducing learning rate in factor</p><p>Assume the weight has been updated by n times, then the learning rate will |
| be base_lr * factor^^(floor(n/step)) |
| </p></div></div> |
| </li><li name="org.apache.mxnet.FeedForward" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="FeedForwardextendsNativeResource"></a> |
| <a id="FeedForward:FeedForward"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="FeedForward.html"><span class="name">FeedForward</span></a><span class="result"> extends <span class="extype" name="org.apache.mxnet.NativeResource">NativeResource</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@FeedForwardextendsNativeResource" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Model class of MXNet for training and predicting feedforward nets.</p><div class="fullcomment"><div class="comment cmt"><p>Model class of MXNet for training and predicting feedforward nets. |
| This class is designed for a single-data single output supervised network.</p></div></div> |
| </li><li name="org.apache.mxnet.Initializer" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped"> |
| <a id="InitializerextendsAnyRef"></a> |
| <a id="Initializer:Initializer"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">abstract </span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="Initializer.html"><span class="name">Initializer</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@InitializerextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Base class for Initializer.</p> |
| </li><li name="org.apache.mxnet.KVStore" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="KVStoreextendsNativeResource"></a> |
| <a id="KVStore:KVStore"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="KVStore.html"><span class="name">KVStore</span></a><span class="result"> extends <span class="extype" name="org.apache.mxnet.NativeResource">NativeResource</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@KVStoreextendsNativeResource" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.LRScheduler" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped"> |
| <a id="LRSchedulerextendsAnyRef"></a> |
| <a id="LRScheduler:LRScheduler"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">abstract </span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="LRScheduler.html"><span class="name">LRScheduler</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@LRSchedulerextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Learning rate scheduler, which adaptively changes the learning rate |
| based on the training progress.</p> |
| </li><li name="org.apache.mxnet.MAE" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="MAEextendsEvalMetric"></a> |
| <a id="MAE:MAE"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="MAE.html"><span class="name">MAE</span></a><span class="result"> extends <a href="EvalMetric.html" class="extype" name="org.apache.mxnet.EvalMetric">EvalMetric</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@MAEextendsEvalMetric" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Calculate Mean Absolute Error loss |
| </p> |
| </li><li name="org.apache.mxnet.MSE" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="MSEextendsEvalMetric"></a> |
| <a id="MSE:MSE"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="MSE.html"><span class="name">MSE</span></a><span class="result"> extends <a href="EvalMetric.html" class="extype" name="org.apache.mxnet.EvalMetric">EvalMetric</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@MSEextendsEvalMetric" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.MXIndexedRecordIO" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="MXIndexedRecordIOextendsMXRecordIO"></a> |
| <a id="MXIndexedRecordIO:MXIndexedRecordIO"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="MXIndexedRecordIO.html"><span class="name">MXIndexedRecordIO</span></a><span class="result"> extends <a href="MXRecordIO.html" class="extype" name="org.apache.mxnet.MXRecordIO">MXRecordIO</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@MXIndexedRecordIOextendsMXRecordIO" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Scala interface for read/write RecordIO data formmat with index.</p><div class="fullcomment"><div class="comment cmt"><p>Scala interface for read/write RecordIO data formmat with index. |
| Support random access. |
| </p></div></div> |
| </li><li name="org.apache.mxnet.MXKVStoreCachedStates" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped"> |
| <a id="MXKVStoreCachedStatesextendsAnyRef"></a> |
| <a id="MXKVStoreCachedStates:MXKVStoreCachedStates"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">trait</span> |
| </span> |
| <span class="symbol"> |
| <a href="MXKVStoreCachedStates.html"><span class="name">MXKVStoreCachedStates</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@MXKVStoreCachedStatesextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.MXKVStoreUpdater" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped"> |
| <a id="MXKVStoreUpdaterextendsNativeResource"></a> |
| <a id="MXKVStoreUpdater:MXKVStoreUpdater"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">trait</span> |
| </span> |
| <span class="symbol"> |
| <a href="MXKVStoreUpdater.html"><span class="name">MXKVStoreUpdater</span></a><span class="result"> extends <span class="extype" name="org.apache.mxnet.NativeResource">NativeResource</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@MXKVStoreUpdaterextendsNativeResource" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.MXNetError" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="MXNetErrorextendsException"></a> |
| <a id="MXNetError:MXNetError"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="MXNetError.html"><span class="name">MXNetError</span></a><span class="result"> extends <span class="extype" name="scala.Exception">Exception</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@MXNetErrorextendsException" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.MXRecordIO" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="MXRecordIOextendsAnyRef"></a> |
| <a id="MXRecordIO:MXRecordIO"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="MXRecordIO.html"><span class="name">MXRecordIO</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@MXRecordIOextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Scala interface for read/write RecordIO data format</p> |
| </li><li name="org.apache.mxnet.Mixed" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="MixedextendsInitializer"></a> |
| <a id="Mixed:Mixed"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="Mixed.html"><span class="name">Mixed</span></a><span class="result"> extends <a href="Initializer.html" class="extype" name="org.apache.mxnet.Initializer">Initializer</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@MixedextendsInitializer" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Initialize the weight with mixed Initializer |
| </p> |
| </li><li name="org.apache.mxnet.Model" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="ModelextendsAnyRef"></a> |
| <a id="Model:Model"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="Model.html"><span class="name">Model</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@ModelextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Describe the model flow |
| </p> |
| </li><li name="org.apache.mxnet.Monitor" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="MonitorextendsAnyRef"></a> |
| <a id="Monitor:Monitor"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="Monitor.html"><span class="name">Monitor</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@MonitorextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Monitor outputs, weights, and gradients for debugging.</p> |
| </li><li name="org.apache.mxnet.NDArray" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="NDArrayextendsNativeResource"></a> |
| <a id="NDArray:NDArray"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="NDArray.html"><span class="name">NDArray</span></a><span class="result"> extends <span class="extype" name="org.apache.mxnet.NativeResource">NativeResource</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@NDArrayextendsNativeResource" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">NDArray object in mxnet.</p><div class="fullcomment"><div class="comment cmt"><p>NDArray object in mxnet. |
| NDArray is basic ndarray/Tensor like data structure in mxnet. <br /> |
| <b> |
| NOTE: NDArray is stored in native memory. Use NDArray in a try-with-resources() construct |
| or a [[org.apache.mxnet.ResourceScope]] in a try-with-resource to have them |
| automatically disposed. You can explicitly control the lifetime of NDArray |
| by calling dispose manually. Failure to do this will result in leaking native memory. |
| </b> |
| </p></div></div> |
| </li><li name="org.apache.mxnet.NDArrayAPIBase" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped"> |
| <a id="NDArrayAPIBaseextendsAnyRef"></a> |
| <a id="NDArrayAPIBase:NDArrayAPIBase"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">abstract </span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="NDArrayAPIBase.html"><span class="name">NDArrayAPIBase</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@NDArrayAPIBaseextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.NDArrayBase" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped"> |
| <a id="NDArrayBaseextendsAnyRef"></a> |
| <a id="NDArrayBase:NDArrayBase"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">abstract </span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="NDArrayBase.html"><span class="name">NDArrayBase</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@NDArrayBaseextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.NDArrayOrScalar" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="NDArrayOrScalar[T]extendsAnyRef"></a> |
| <a id="NDArrayOrScalar[T]:NDArrayOrScalar[T]"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="NDArrayOrScalar.html"><span class="name">NDArrayOrScalar</span></a><span class="tparams">[<span name="T">T</span>]</span><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@NDArrayOrScalar[T]extendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.NDArrayRandomAPIBase" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped"> |
| <a id="NDArrayRandomAPIBaseextendsAnyRef"></a> |
| <a id="NDArrayRandomAPIBase:NDArrayRandomAPIBase"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">abstract </span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="NDArrayRandomAPIBase.html"><span class="name">NDArrayRandomAPIBase</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@NDArrayRandomAPIBaseextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.NameManager" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="NameManagerextendsAnyRef"></a> |
| <a id="NameManager:NameManager"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="NameManager.html"><span class="name">NameManager</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@NameManagerextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">NameManager to do automatic naming.</p><div class="fullcomment"><div class="comment cmt"><p>NameManager to do automatic naming. |
| User can also inherit this object to change naming behavior. |
| </p></div></div> |
| </li><li name="org.apache.mxnet.Normal" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="NormalextendsInitializer"></a> |
| <a id="Normal:Normal"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="Normal.html"><span class="name">Normal</span></a><span class="result"> extends <a href="Initializer.html" class="extype" name="org.apache.mxnet.Initializer">Initializer</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@NormalextendsInitializer" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Initialize the weight with normal(0, sigma) |
| </p> |
| </li><li name="org.apache.mxnet.NumpyScope" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="NumpyScopeextendsAnyRef"></a> |
| <a id="NumpyScope:NumpyScope"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="NumpyScope.html"><span class="name">NumpyScope</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@NumpyScopeextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.Optimizer" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped"> |
| <a id="OptimizerextendsSerializable"></a> |
| <a id="Optimizer:Optimizer"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">abstract </span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="Optimizer.html"><span class="name">Optimizer</span></a><span class="result"> extends <span class="extype" name="java.io.Serializable">Serializable</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@OptimizerextendsSerializable" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.Perplexity" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="PerplexityextendsEvalMetric"></a> |
| <a id="Perplexity:Perplexity"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="Perplexity.html"><span class="name">Perplexity</span></a><span class="result"> extends <a href="EvalMetric.html" class="extype" name="org.apache.mxnet.EvalMetric">EvalMetric</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@PerplexityextendsEvalMetric" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Calculate perplexity.</p> |
| </li><li name="org.apache.mxnet.RMSE" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="RMSEextendsEvalMetric"></a> |
| <a id="RMSE:RMSE"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="RMSE.html"><span class="name">RMSE</span></a><span class="result"> extends <a href="EvalMetric.html" class="extype" name="org.apache.mxnet.EvalMetric">EvalMetric</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@RMSEextendsEvalMetric" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Calculate Root Mean Squred Error loss |
| </p> |
| </li><li name="org.apache.mxnet.ResourceScope" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="ResourceScopeextendsAutoCloseable"></a> |
| <a id="ResourceScope:ResourceScope"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="ResourceScope.html"><span class="name">ResourceScope</span></a><span class="result"> extends <span class="extype" name="java.lang.AutoCloseable">AutoCloseable</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@ResourceScopeextendsAutoCloseable" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">This class manages automatically releasing of <code>org.apache.mxnet.NativeResource</code>s |
| </p> |
| </li><li name="org.apache.mxnet.Rtc" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="RtcextendsAnyRef"></a> |
| <a id="Rtc:Rtc"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="Rtc.html"><span class="name">Rtc</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@RtcextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">This class allow you to write cuda kernel in Scala |
| and call them with NDArray.</p> |
| </li><li name="org.apache.mxnet.Shape" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="ShapeextendsSerializable"></a> |
| <a id="Shape:Shape"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="Shape.html"><span class="name">Shape</span></a><span class="result"> extends <span class="extype" name="scala.Serializable">Serializable</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@ShapeextendsSerializable" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Shape of <a href="NDArray.html" class="extype" name="org.apache.mxnet.NDArray">NDArray</a> or other data |
| </p> |
| </li><li name="org.apache.mxnet.SparseNDArray" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="SparseNDArrayextendsNDArray"></a> |
| <a id="SparseNDArray:SparseNDArray"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="SparseNDArray.html"><span class="name">SparseNDArray</span></a><span class="result"> extends <a href="NDArray.html" class="extype" name="org.apache.mxnet.NDArray">NDArray</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@SparseNDArrayextendsNDArray" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Sparse NDArray is the child class of NDArray designed to hold the Sparse format</p><div class="fullcomment"><div class="comment cmt"><p>Sparse NDArray is the child class of NDArray designed to hold the Sparse format</p><p> Currently, Rowsparse and CSR typed NDArray is supported. Most of the Operators |
| will convert Sparse NDArray to dense. Basic operators like <code>add</code> will |
| have optimization for sparse operattions</p></div></div> |
| </li><li name="org.apache.mxnet.Symbol" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="SymbolextendsNativeResource"></a> |
| <a id="Symbol:Symbol"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="Symbol.html"><span class="name">Symbol</span></a><span class="result"> extends <span class="extype" name="org.apache.mxnet.NativeResource">NativeResource</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@SymbolextendsNativeResource" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Symbolic configuration API of mxnet.</p><div class="fullcomment"><div class="comment cmt"><p>Symbolic configuration API of mxnet. <br /> |
| <b> |
| WARNING: it is your responsibility to clear this object through dispose(). |
| </b> |
| </p></div></div> |
| </li><li name="org.apache.mxnet.SymbolAPIBase" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped"> |
| <a id="SymbolAPIBaseextendsAnyRef"></a> |
| <a id="SymbolAPIBase:SymbolAPIBase"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">abstract </span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="SymbolAPIBase.html"><span class="name">SymbolAPIBase</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@SymbolAPIBaseextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.SymbolBase" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped"> |
| <a id="SymbolBaseextendsAnyRef"></a> |
| <a id="SymbolBase:SymbolBase"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">abstract </span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="SymbolBase.html"><span class="name">SymbolBase</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@SymbolBaseextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.SymbolConversions" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="SymbolConversions[V]extendsAnyRef"></a> |
| <a id="SymbolConversions[V]:SymbolConversions[V]"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="SymbolConversions.html"><span class="name">SymbolConversions</span></a><span class="tparams">[<span name="V">V</span>]</span><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@SymbolConversions[V]extendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.SymbolGenerator" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped"> |
| <a id="SymbolGeneratorextendsAnyRef"></a> |
| <a id="SymbolGenerator:SymbolGenerator"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">trait</span> |
| </span> |
| <span class="symbol"> |
| <a href="SymbolGenerator.html"><span class="name">SymbolGenerator</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@SymbolGeneratorextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.SymbolOrScalar" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="SymbolOrScalar[T]extendsAnyRef"></a> |
| <a id="SymbolOrScalar[T]:SymbolOrScalar[T]"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="SymbolOrScalar.html"><span class="name">SymbolOrScalar</span></a><span class="tparams">[<span name="T">T</span>]</span><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@SymbolOrScalar[T]extendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.SymbolRandomAPIBase" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped"> |
| <a id="SymbolRandomAPIBaseextendsAnyRef"></a> |
| <a id="SymbolRandomAPIBase:SymbolRandomAPIBase"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">abstract </span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="SymbolRandomAPIBase.html"><span class="name">SymbolRandomAPIBase</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@SymbolRandomAPIBaseextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.TestUtil" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="TestUtilextendsAnyRef"></a> |
| <a id="TestUtil:TestUtil"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="TestUtil.html"><span class="name">TestUtil</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@TestUtilextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.TopKAccuracy" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="TopKAccuracyextendsEvalMetric"></a> |
| <a id="TopKAccuracy:TopKAccuracy"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="TopKAccuracy.html"><span class="name">TopKAccuracy</span></a><span class="result"> extends <a href="EvalMetric.html" class="extype" name="org.apache.mxnet.EvalMetric">EvalMetric</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@TopKAccuracyextendsEvalMetric" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Calculate top k predictions accuracy |
| </p> |
| </li><li name="org.apache.mxnet.Uniform" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="UniformextendsInitializer"></a> |
| <a id="Uniform:Uniform"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="Uniform.html"><span class="name">Uniform</span></a><span class="result"> extends <a href="Initializer.html" class="extype" name="org.apache.mxnet.Initializer">Initializer</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@UniformextendsInitializer" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Initialize the weight with uniform [-scale, scale] |
| </p> |
| </li><li name="org.apache.mxnet.WarnIfNotDisposed" visbl="prt" data-isabs="true" fullComment="yes" group="Ungrouped"> |
| <a id="WarnIfNotDisposedextendsAnyRef"></a> |
| <a id="WarnIfNotDisposed:WarnIfNotDisposed"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">trait</span> |
| </span> |
| <span class="symbol"> |
| <a href="WarnIfNotDisposed.html"><span class="name">WarnIfNotDisposed</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@WarnIfNotDisposedextendsAnyRef" 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 </dd></dl></div> |
| </li><li name="org.apache.mxnet.Xavier" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="XavierextendsInitializer"></a> |
| <a id="Xavier:Xavier"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="Xavier.html"><span class="name">Xavier</span></a><span class="result"> extends <a href="Initializer.html" class="extype" name="org.apache.mxnet.Initializer">Initializer</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@XavierextendsInitializer" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Initialize the weight with Xavier or similar initialization scheme.</p> |
| </li><li name="org.apache.mxnet.NDArrayCollector" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="NDArrayCollectorextendsAnyRef"></a> |
| <a id="NDArrayCollector:NDArrayCollector"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <a href="NDArrayCollector.html"><span class="name deprecated" title="Deprecated: (Since version 1.5.0) Please use ResourceScope instead">NDArrayCollector</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@NDArrayCollectorextendsAnyRef" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Annotations</dt><dd> |
| <span class="name">@deprecated</span> |
| |
| </dd><dt>Deprecated</dt><dd class="cmt"><p><i>(Since version 1.5.0)</i> Please use ResourceScope instead</p></dd></dl></div> |
| </li></ol> |
| </div> |
| |
| |
| |
| <div id="values" class="values members"> |
| <h3>Value Members</h3> |
| <ol><li name="org.apache.mxnet.Callback" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="Callback"></a> |
| <a id="Callback:Callback"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="Callback$.html"><span class="name">Callback</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@Callback" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Callback functions that can be used to track various status during epoch.</p> |
| </li><li name="org.apache.mxnet.CheckUtils" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="CheckUtils"></a> |
| <a id="CheckUtils:CheckUtils"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="CheckUtils$.html"><span class="name">CheckUtils</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@CheckUtils" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.Context" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="Context"></a> |
| <a id="Context:Context"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="Context$.html"><span class="name">Context</span></a><span class="result"> extends <span class="extype" name="scala.Serializable">Serializable</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@Context" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.DType" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="DType"></a> |
| <a id="DType:DType"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="DType$.html"><span class="name">DType</span></a><span class="result"> extends <span class="extype" name="scala.Enumeration">Enumeration</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@DType" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.DataBatch" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="DataBatch"></a> |
| <a id="DataBatch:DataBatch"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="DataBatch$.html"><span class="name">DataBatch</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@DataBatch" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.DataDesc" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="DataDesc"></a> |
| <a id="DataDesc:DataDesc"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="DataDesc$.html"><span class="name">DataDesc</span></a><span class="result"> extends <span class="extype" name="scala.Serializable">Serializable</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@DataDesc" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.Executor" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="Executor"></a> |
| <a id="Executor:Executor"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="Executor$.html"><span class="name">Executor</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@Executor" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.FeedForward" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="FeedForward"></a> |
| <a id="FeedForward:FeedForward"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="FeedForward$.html"><span class="name">FeedForward</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@FeedForward" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.IO" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="IO"></a> |
| <a id="IO:IO"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="IO$.html"><span class="name">IO</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@IO" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">IO iterators for loading training & validation data |
| </p> |
| </li><li name="org.apache.mxnet.Image" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="Image"></a> |
| <a id="Image:Image"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="Image$.html"><span class="name">Image</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@Image" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Image API of Scala package |
| enable OpenCV feature |
| </p> |
| </li><li name="org.apache.mxnet.KVStore" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="KVStore"></a> |
| <a id="KVStore:KVStore"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="KVStore$.html"><span class="name">KVStore</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@KVStore" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Key value store interface of MXNet for parameter synchronization.</p> |
| </li><li name="org.apache.mxnet.KVStoreServer" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="KVStoreServer"></a> |
| <a id="KVStoreServer:KVStoreServer"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="KVStoreServer$.html"><span class="name">KVStoreServer</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@KVStoreServer" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.Layout" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="Layout"></a> |
| <a id="Layout:Layout"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="Layout$.html"><span class="name">Layout</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@Layout" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Layout definition of DataDesc |
| N Batch size |
| C channels |
| H Height |
| W Weight |
| T sequence length |
| <u>undefined</u> default value of Layout |
| </p> |
| </li><li name="org.apache.mxnet.MXRecordIO" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="MXRecordIO"></a> |
| <a id="MXRecordIO:MXRecordIO"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="MXRecordIO$.html"><span class="name">MXRecordIO</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@MXRecordIO" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.MX_PRIMITIVES" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="MX_PRIMITIVES"></a> |
| <a id="MX_PRIMITIVES:MX_PRIMITIVES"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="MX_PRIMITIVES$.html"><span class="name">MX_PRIMITIVES</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@MX_PRIMITIVES" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.Model" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="Model"></a> |
| <a id="Model:Model"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="Model$.html"><span class="name">Model</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@Model" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.NDArray" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="NDArray"></a> |
| <a id="NDArray:NDArray"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="NDArray$.html"><span class="name">NDArray</span></a><span class="result"> extends <a href="NDArrayBase.html" class="extype" name="org.apache.mxnet.NDArrayBase">NDArrayBase</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@NDArray" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">NDArray Object extends from NDArrayBase for abstract function signatures |
| Main code will be generated during compile time through Macros |
| </p><div class="fullcomment"><div class="comment cmt"><p>NDArray Object extends from NDArrayBase for abstract function signatures |
| Main code will be generated during compile time through Macros |
| </p></div><dl class="attributes block"> <dt>Annotations</dt><dd> |
| <span class="name">@AddNDArrayFunctions</span><span class="args">(<span> |
| |
| <span class="symbol">false</span> |
| </span>)</span> |
| |
| </dd></dl></div> |
| </li><li name="org.apache.mxnet.NDArrayAPI" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="NDArrayAPI"></a> |
| <a id="NDArrayAPI:NDArrayAPI"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="NDArrayAPI$.html"><span class="name">NDArrayAPI</span></a><span class="result"> extends <a href="NDArrayAPIBase.html" class="extype" name="org.apache.mxnet.NDArrayAPIBase">NDArrayAPIBase</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@NDArrayAPI" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">typesafe NDArray API: NDArray.api._ |
| Main code will be generated during compile time through Macros |
| </p><div class="fullcomment"><div class="comment cmt"><p>typesafe NDArray API: NDArray.api._ |
| Main code will be generated during compile time through Macros |
| </p></div><dl class="attributes block"> <dt>Annotations</dt><dd> |
| <span class="name">@AddNDArrayAPIs</span><span class="args">(<span> |
| |
| <span class="symbol">false</span> |
| </span>)</span> |
| |
| </dd></dl></div> |
| </li><li name="org.apache.mxnet.NDArrayOrScalar" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="NDArrayOrScalar"></a> |
| <a id="NDArrayOrScalar:NDArrayOrScalar"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="NDArrayOrScalar$.html"><span class="name">NDArrayOrScalar</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@NDArrayOrScalar" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.NDArrayRandomAPI" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="NDArrayRandomAPI"></a> |
| <a id="NDArrayRandomAPI:NDArrayRandomAPI"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="NDArrayRandomAPI$.html"><span class="name">NDArrayRandomAPI</span></a><span class="result"> extends <a href="NDArrayRandomAPIBase.html" class="extype" name="org.apache.mxnet.NDArrayRandomAPIBase">NDArrayRandomAPIBase</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@NDArrayRandomAPI" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">typesafe NDArray random module: NDArray.random._ |
| Main code will be generated during compile time through Macros |
| </p><div class="fullcomment"><div class="comment cmt"><p>typesafe NDArray random module: NDArray.random._ |
| Main code will be generated during compile time through Macros |
| </p></div><dl class="attributes block"> <dt>Annotations</dt><dd> |
| <span class="name">@AddNDArrayRandomAPIs</span><span class="args">(<span> |
| |
| <span class="symbol">false</span> |
| </span>)</span> |
| |
| </dd></dl></div> |
| </li><li name="org.apache.mxnet.NameManager" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="NameManager"></a> |
| <a id="NameManager:NameManager"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="NameManager$.html"><span class="name">NameManager</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@NameManager" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.NumpyScope" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="NumpyScope"></a> |
| <a id="NumpyScope:NumpyScope"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="NumpyScope$.html"><span class="name">NumpyScope</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@NumpyScope" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">NumpyScope object provides util functions for turning on/off NumPy compatibility |
| and checking whether NumPy compatibility has been turned on/off.</p><div class="fullcomment"><div class="comment cmt"><p>NumpyScope object provides util functions for turning on/off NumPy compatibility |
| and checking whether NumPy compatibility has been turned on/off. NumPy compatibility |
| is introduced first to support zero-dim and zero-size tensors as in NumPy. |
| </p></div></div> |
| </li><li name="org.apache.mxnet.Operator" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="Operator"></a> |
| <a id="Operator:Operator"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="Operator$.html"><span class="name">Operator</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@Operator" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.Optimizer" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="Optimizer"></a> |
| <a id="Optimizer:Optimizer"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="Optimizer$.html"><span class="name">Optimizer</span></a><span class="result"> extends <span class="extype" name="scala.Serializable">Serializable</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@Optimizer" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.Profiler" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="Profiler"></a> |
| <a id="Profiler:Profiler"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="Profiler$.html"><span class="name">Profiler</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@Profiler" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.Random" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="Random"></a> |
| <a id="Random:Random"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="Random$.html"><span class="name">Random</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@Random" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Random Number interface of mxnet.</p> |
| </li><li name="org.apache.mxnet.ResourceScope" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="ResourceScope"></a> |
| <a id="ResourceScope:ResourceScope"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="ResourceScope$.html"><span class="name">ResourceScope</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@ResourceScope" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.Shape" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="Shape"></a> |
| <a id="Shape:Shape"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="Shape$.html"><span class="name">Shape</span></a><span class="result"> extends <span class="extype" name="scala.Serializable">Serializable</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@Shape" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.SparseFormat" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="SparseFormat"></a> |
| <a id="SparseFormat:SparseFormat"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="SparseFormat$.html"><span class="name">SparseFormat</span></a><span class="result"> extends <span class="extype" name="scala.Enumeration">Enumeration</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@SparseFormat" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.SparseNDArray" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="SparseNDArray"></a> |
| <a id="SparseNDArray:SparseNDArray"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="SparseNDArray$.html"><span class="name">SparseNDArray</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@SparseNDArray" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.Symbol" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="Symbol"></a> |
| <a id="Symbol:Symbol"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="Symbol$.html"><span class="name">Symbol</span></a><span class="result"> extends <a href="SymbolBase.html" class="extype" name="org.apache.mxnet.SymbolBase">SymbolBase</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@Symbol" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Symbol Object extends from SymbolBase for abstract function signatures |
| Main code will be generated during compile time through Macros |
| </p><div class="fullcomment"><div class="comment cmt"><p>Symbol Object extends from SymbolBase for abstract function signatures |
| Main code will be generated during compile time through Macros |
| </p></div><dl class="attributes block"> <dt>Annotations</dt><dd> |
| <span class="name">@AddSymbolFunctions</span><span class="args">(<span> |
| |
| <span class="symbol">false</span> |
| </span>)</span> |
| |
| </dd></dl></div> |
| </li><li name="org.apache.mxnet.SymbolAPI" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="SymbolAPI"></a> |
| <a id="SymbolAPI:SymbolAPI"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="SymbolAPI$.html"><span class="name">SymbolAPI</span></a><span class="result"> extends <a href="SymbolAPIBase.html" class="extype" name="org.apache.mxnet.SymbolAPIBase">SymbolAPIBase</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@SymbolAPI" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">typesafe Symbol API: Symbol.api._ |
| Main code will be generated during compile time through Macros |
| </p><div class="fullcomment"><div class="comment cmt"><p>typesafe Symbol API: Symbol.api._ |
| Main code will be generated during compile time through Macros |
| </p></div><dl class="attributes block"> <dt>Annotations</dt><dd> |
| <span class="name">@AddSymbolAPIs</span><span class="args">(<span> |
| |
| <span class="symbol">false</span> |
| </span>)</span> |
| |
| </dd></dl></div> |
| </li><li name="org.apache.mxnet.SymbolConversions" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="SymbolConversions"></a> |
| <a id="SymbolConversions:SymbolConversions"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="SymbolConversions$.html"><span class="name">SymbolConversions</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@SymbolConversions" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.SymbolOrScalar" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="SymbolOrScalar"></a> |
| <a id="SymbolOrScalar:SymbolOrScalar"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="SymbolOrScalar$.html"><span class="name">SymbolOrScalar</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@SymbolOrScalar" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.SymbolRandomAPI" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="SymbolRandomAPI"></a> |
| <a id="SymbolRandomAPI:SymbolRandomAPI"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="SymbolRandomAPI$.html"><span class="name">SymbolRandomAPI</span></a><span class="result"> extends <a href="SymbolRandomAPIBase.html" class="extype" name="org.apache.mxnet.SymbolRandomAPIBase">SymbolRandomAPIBase</a></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@SymbolRandomAPI" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">typesafe Symbol random module: Symbol.random._ |
| Main code will be generated during compile time through Macros |
| </p><div class="fullcomment"><div class="comment cmt"><p>typesafe Symbol random module: Symbol.random._ |
| Main code will be generated during compile time through Macros |
| </p></div><dl class="attributes block"> <dt>Annotations</dt><dd> |
| <span class="name">@AddSymbolRandomAPIs</span><span class="args">(<span> |
| |
| <span class="symbol">false</span> |
| </span>)</span> |
| |
| </dd></dl></div> |
| </li><li name="org.apache.mxnet.Visualization" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="Visualization"></a> |
| <a id="Visualization:Visualization"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="Visualization$.html"><span class="name">Visualization</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@Visualization" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.annotation" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="annotation"></a> |
| <a id="annotation:annotation"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">package</span> |
| </span> |
| <span class="symbol"> |
| <a href="annotation/package.html"><span class="name">annotation</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@annotation" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.contrib" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="contrib"></a> |
| <a id="contrib:contrib"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">package</span> |
| </span> |
| <span class="symbol"> |
| <a href="contrib/package.html"><span class="name">contrib</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@contrib" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.infer" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="infer"></a> |
| <a id="infer:infer"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">package</span> |
| </span> |
| <span class="symbol"> |
| <a href="infer/package.html"><span class="name">infer</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@infer" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.io" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="io"></a> |
| <a id="io:io"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">package</span> |
| </span> |
| <span class="symbol"> |
| <a href="io/package.html"><span class="name">io</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@io" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.module" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="module"></a> |
| <a id="module:module"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">package</span> |
| </span> |
| <span class="symbol"> |
| <a href="module/package.html"><span class="name">module</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@module" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.optimizer" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="optimizer"></a> |
| <a id="optimizer:optimizer"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">package</span> |
| </span> |
| <span class="symbol"> |
| <a href="optimizer/package.html"><span class="name">optimizer</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@optimizer" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.util" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="util"></a> |
| <a id="util:util"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">package</span> |
| </span> |
| <span class="symbol"> |
| <a href="util/package.html"><span class="name">util</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@util" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li></ol> |
| </div> |
| |
| |
| |
| <div id="values" class="values members"> |
| <h3>Deprecated Value Members</h3> |
| <ol><li name="org.apache.mxnet.NDArrayCollector" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="NDArrayCollector"></a> |
| <a id="NDArrayCollector:NDArrayCollector"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">object</span> |
| </span> |
| <span class="symbol"> |
| <a href="NDArrayCollector$.html"><span class="name deprecated" title="Deprecated: (Since version 1.5.0) Please use ResourceScope instead">NDArrayCollector</span></a> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.package@NDArrayCollector" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt"> A collector to store NDArrays.</p><div class="fullcomment"><div class="comment cmt"><p> A collector to store NDArrays. |
| It provides a scope, NDArrays allocated in the scope can either <br /></p><ul><li>be disposed automatically when the code block finishes, or <br /></li><li>simply be collected for future usage. |
| <br /> |
| If the return type of scope is <em>NDArray</em> or <em>NDArrayFuncReturn</em>, |
| the collector is smart enough NOT to collect or dispose the returned NDArray. <br /> |
| However in other cases, it is users' responsibility NOT to leak allocated NDArrays outside, |
| (e.g., store to a global variable and use later, pass to another thread, etc.) <br /> |
| Usage Example: |
| <pre> |
| val a = NDArray.array(Array(-1f, 0f, 1f, 2f, 3f, 4f), shape = Shape(2, 3)) |
| val res = NDArrayCollector.auto().withScope { |
| (NDArray.relu(a) + a).toArray |
| } |
| </pre> |
| In the case above, the intermediate NDArrays |
| (created by <em>NDArray.relu</em> and <em>+</em>) will be disposed automatically. <br /> |
| User can also decide to dispose the collected NDArrays later: <br /> |
| <pre> |
| val collector = NDArrayCollector.manual() |
| val res = collector.withScope { |
| (NDArray.relu(a) + a).toArray |
| } |
| collector.foreach(_.dispose()) |
| </pre> |
| For Java users: <br /> |
| <pre> |
| NDArray a = NDArray.array(new float[]{-1f, 0f, 1f, 2f, 3f, 4f}, |
| Shape.create(2, 3), Context.cpu(0)); |
| float[] sliced = NDArrayCollector.auto().withScope( |
| new scala.runtime.AbstractFunction0<float[]>() { |
| @Override |
| public float[] apply() { |
| a.slice(0, 1).toArray(); |
| } |
| }); |
| </pre> |
| </li></ul></div><dl class="attributes block"> <dt>Annotations</dt><dd> |
| <span class="name">@deprecated</span> |
| |
| </dd><dt>Deprecated</dt><dd class="cmt"><p><i>(Since version 1.5.0)</i> Please use ResourceScope instead</p></dd></dl></div> |
| </li></ol> |
| </div> |
| </div> |
| |
| <div id="inheritedMembers"> |
| |
| |
| </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> |
