| <!DOCTYPE html > |
| <html> |
| <head> |
| <title>KVStore - MXNet - org.apache.mxnet.KVStore</title> |
| <meta name="description" content="KVStore - MXNet - org.apache.mxnet.KVStore" /> |
| <meta name="keywords" content="KVStore MXNet org.apache.mxnet.KVStore" /> |
| <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.KVStore'; |
| var anchor = window.location.hash; |
| var anchor_opt = ''; |
| if (anchor.length >= 1) |
| anchor_opt = '@' + anchor.substring(1); |
| window.location.href = url + '#' + hash + anchor_opt; |
| } |
| </script> |
| |
| </head> |
| <body class="type"> |
| <div id="definition"> |
| <a href="KVStore$.html" title="See companion object"><img alt="Class/Object" src="../../../lib/class_to_object_big.png" /></a> |
| <p id="owner"><a href="../../package.html" class="extype" name="org">org</a>.<a href="../package.html" class="extype" name="org.apache">apache</a>.<a href="package.html" class="extype" name="org.apache.mxnet">mxnet</a></p> |
| <h1><a href="KVStore$.html" title="See companion object">KVStore</a></h1><h3><span class="morelinks"><div> |
| Related Docs: |
| <a href="KVStore$.html" title="See companion object">object KVStore</a> |
| | <a href="package.html" class="extype" name="org.apache.mxnet">package mxnet</a> |
| </div></span></h3><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| </div> |
| |
| <h4 id="signature" class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">class</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">KVStore</span><span class="result"> extends <span class="extype" name="org.apache.mxnet.NativeResource">NativeResource</span></span> |
| </span> |
| </h4> |
| |
| <div id="comment" class="fullcommenttop"><div class="toggleContainer block"> |
| <span class="toggle">Linear Supertypes</span> |
| <div class="superTypes hiddenContent"><span class="extype" name="org.apache.mxnet.NativeResource">NativeResource</span>, <a href="WarnIfNotDisposed.html" class="extype" name="org.apache.mxnet.WarnIfNotDisposed">WarnIfNotDisposed</a>, <span class="extype" name="java.lang.AutoCloseable">AutoCloseable</span>, <span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div> |
| </div></div> |
| |
| |
| <div id="mbrsel"> |
| <div id="textfilter"><span class="pre"></span><span class="input"><input id="mbrsel-input" type="text" accesskey="/" /></span><span class="post"></span></div> |
| <div id="order"> |
| <span class="filtertype">Ordering</span> |
| <ol> |
| |
| <li class="alpha in"><span>Alphabetic</span></li> |
| <li class="inherit out"><span>By Inheritance</span></li> |
| </ol> |
| </div> |
| <div id="ancestors"> |
| <span class="filtertype">Inherited<br /> |
| </span> |
| <ol id="linearization"> |
| <li class="in" name="org.apache.mxnet.KVStore"><span>KVStore</span></li><li class="in" name="org.apache.mxnet.NativeResource"><span>NativeResource</span></li><li class="in" name="org.apache.mxnet.WarnIfNotDisposed"><span>WarnIfNotDisposed</span></li><li class="in" name="java.lang.AutoCloseable"><span>AutoCloseable</span></li><li class="in" name="scala.AnyRef"><span>AnyRef</span></li><li class="in" name="scala.Any"><span>Any</span></li> |
| </ol> |
| </div><div id="ancestors"> |
| <span class="filtertype"></span> |
| <ol> |
| <li class="hideall out"><span>Hide All</span></li> |
| <li class="showall in"><span>Show All</span></li> |
| </ol> |
| </div> |
| <div id="visbl"> |
| <span class="filtertype">Visibility</span> |
| <ol><li class="public in"><span>Public</span></li><li class="all out"><span>All</span></li></ol> |
| </div> |
| </div> |
| |
| <div id="template"> |
| <div id="allMembers"> |
| <div id="constructors" class="members"> |
| <h3>Instance Constructors</h3> |
| <ol><li name="org.apache.mxnet.KVStore#<init>" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="<init>(handle:org.apache.mxnet.Base.KVStoreHandle):org.apache.mxnet.KVStore"></a> |
| <a id="<init>:KVStore"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">new</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">KVStore</span><span class="params">(<span name="handle">handle: <span class="extype" name="org.apache.mxnet.Base.KVStoreHandle">KVStoreHandle</span></span>)</span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@<init>(handle:org.apache.mxnet.Base.KVStoreHandle):org.apache.mxnet.KVStore" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li></ol> |
| </div> |
| |
| |
| |
| |
| |
| <div id="values" class="values members"> |
| <h3>Value Members</h3> |
| <ol><li name="scala.AnyRef#!=" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="!=(x$1:Any):Boolean"></a> |
| <a id="!=(Any):Boolean"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span title="gt4s: $bang$eq" class="name">!=</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@!=(x$1:Any):Boolean" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div> |
| </li><li name="scala.AnyRef###" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="##():Int"></a> |
| <a id="##():Int"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span title="gt4s: $hash$hash" class="name">##</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@##():Int" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div> |
| </li><li name="scala.AnyRef#==" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="==(x$1:Any):Boolean"></a> |
| <a id="==(Any):Boolean"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span title="gt4s: $eq$eq" class="name">==</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@==(x$1:Any):Boolean" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div> |
| </li><li name="scala.Any#asInstanceOf" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="asInstanceOf[T0]:T0"></a> |
| <a id="asInstanceOf[T0]:T0"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">asInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <span class="extype" name="scala.Any.asInstanceOf.T0">T0</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@asInstanceOf[T0]:T0" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Any</dd></dl></div> |
| </li><li name="org.apache.mxnet.KVStore#barrier" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="barrier():Unit"></a> |
| <a id="barrier():Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">barrier</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@barrier():Unit" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Global barrier among all worker nodes</p><div class="fullcomment"><div class="comment cmt"><p>Global barrier among all worker nodes</p><p>For example, assume there are n machines, we want to let machine 0 first |
| init the values, and then pull the inited value to all machines. Before |
| pulling, we can place a barrier to guarantee that the initialization is |
| finished. |
| </p></div></div> |
| </li><li name="org.apache.mxnet.KVStore#bytesAllocated" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="bytesAllocated:Long"></a> |
| <a id="bytesAllocated:Long"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">val</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">bytesAllocated</span><span class="result">: <span class="extype" name="scala.Long">Long</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@bytesAllocated:Long" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Off-Heap Bytes Allocated for this object |
| </p><div class="fullcomment"><div class="comment cmt"><p>Off-Heap Bytes Allocated for this object |
| </p></div><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="org.apache.mxnet.KVStore">KVStore</a> → NativeResource</dd></dl></div> |
| </li><li name="scala.AnyRef#clone" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="clone():Object"></a> |
| <a id="clone():AnyRef"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">clone</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.AnyRef">AnyRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@clone():Object" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Attributes</dt><dd>protected[<a href="../../../java$lang.html" class="extype" name="java.lang">java.lang</a>] </dd><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd> |
| <span class="name">@throws</span><span class="args">(<span> |
| |
| <span class="defval" name="classOf[java.lang.CloneNotSupportedException]">...</span> |
| </span>)</span> |
| |
| </dd></dl></div> |
| </li><li name="org.apache.mxnet.NativeResource#close" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="close():Unit"></a> |
| <a id="close():Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">close</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@close():Unit" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>NativeResource → AutoCloseable</dd></dl></div> |
| </li><li name="org.apache.mxnet.WarnIfNotDisposed#creationTrace" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="creationTrace:Option[Array[StackTraceElement]]"></a> |
| <a id="creationTrace:Option[Array[StackTraceElement]]"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">val</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">creationTrace</span><span class="result">: <span class="extype" name="scala.Option">Option</span>[<span class="extype" name="scala.Array">Array</span>[<span class="extype" name="java.lang.StackTraceElement">StackTraceElement</span>]]</span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@creationTrace:Option[Array[StackTraceElement]]" 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><dt>Definition Classes</dt><dd><a href="WarnIfNotDisposed.html" class="extype" name="org.apache.mxnet.WarnIfNotDisposed">WarnIfNotDisposed</a></dd></dl></div> |
| </li><li name="org.apache.mxnet.NativeResource#dispose" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="dispose():Unit"></a> |
| <a id="dispose():Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">dispose</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@dispose():Unit" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>NativeResource</dd></dl></div> |
| </li><li name="scala.AnyRef#eq" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="eq(x$1:AnyRef):Boolean"></a> |
| <a id="eq(AnyRef):Boolean"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">eq</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.AnyRef">AnyRef</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@eq(x$1:AnyRef):Boolean" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div> |
| </li><li name="scala.AnyRef#equals" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="equals(x$1:Any):Boolean"></a> |
| <a id="equals(Any):Boolean"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">equals</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@equals(x$1:Any):Boolean" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div> |
| </li><li name="org.apache.mxnet.WarnIfNotDisposed#finalize" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="finalize():Unit"></a> |
| <a id="finalize():Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">finalize</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@finalize():Unit" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Attributes</dt><dd>protected </dd><dt>Definition Classes</dt><dd><a href="WarnIfNotDisposed.html" class="extype" name="org.apache.mxnet.WarnIfNotDisposed">WarnIfNotDisposed</a> → AnyRef</dd></dl></div> |
| </li><li name="scala.AnyRef#getClass" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="getClass():Class[_]"></a> |
| <a id="getClass():Class[_]"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">getClass</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.Class">Class</span>[_]</span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@getClass():Class[_]" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div> |
| </li><li name="scala.AnyRef#hashCode" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="hashCode():Int"></a> |
| <a id="hashCode():Int"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">hashCode</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@hashCode():Int" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div> |
| </li><li name="org.apache.mxnet.KVStore#init" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="init(key:String,value:org.apache.mxnet.NDArray):Unit"></a> |
| <a id="init(String,NDArray):Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">init</span><span class="params">(<span name="key">key: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="value">value: <a href="NDArray.html" class="extype" name="org.apache.mxnet.NDArray">NDArray</a></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@init(key:String,value:org.apache.mxnet.NDArray):Unit" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.KVStore#init" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="init(keys:Array[String],values:Array[org.apache.mxnet.NDArray]):Unit"></a> |
| <a id="init(Array[String],Array[NDArray]):Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">init</span><span class="params">(<span name="keys">keys: <span class="extype" name="scala.Array">Array</span>[<span class="extype" name="scala.Predef.String">String</span>]</span>, <span name="values">values: <span class="extype" name="scala.Array">Array</span>[<a href="NDArray.html" class="extype" name="org.apache.mxnet.NDArray">NDArray</a>]</span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@init(keys:Array[String],values:Array[org.apache.mxnet.NDArray]):Unit" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Initialize a single or a sequence of key-value pairs into the store.</p><div class="fullcomment"><div class="comment cmt"><p>Initialize a single or a sequence of key-value pairs into the store. |
| For each key, one must init it before push and pull. |
| Only worker 0's (rank == 0) data are used. |
| This function returns after data have been initialized successfully |
| </p></div><dl class="paramcmts block"><dt class="param">keys</dt><dd class="cmt"><p>The keys.</p></dd><dt class="param">values</dt><dd class="cmt"><p>The values.</p></dd></dl></div> |
| </li><li name="org.apache.mxnet.NativeResource#isDisposed" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="isDisposed:Boolean"></a> |
| <a id="isDisposed:Boolean"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">isDisposed</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@isDisposed:Boolean" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>NativeResource → <a href="WarnIfNotDisposed.html" class="extype" name="org.apache.mxnet.WarnIfNotDisposed">WarnIfNotDisposed</a></dd></dl></div> |
| </li><li name="scala.Any#isInstanceOf" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="isInstanceOf[T0]:Boolean"></a> |
| <a id="isInstanceOf[T0]:Boolean"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">isInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@isInstanceOf[T0]:Boolean" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Any</dd></dl></div> |
| </li><li name="org.apache.mxnet.KVStore#loadOptimizerStates" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="loadOptimizerStates(fname:String):Unit"></a> |
| <a id="loadOptimizerStates(String):Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">loadOptimizerStates</span><span class="params">(<span name="fname">fname: <span class="extype" name="scala.Predef.String">String</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@loadOptimizerStates(fname:String):Unit" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Load optimizer (updater) state from file</p><div class="fullcomment"><div class="comment cmt"><p>Load optimizer (updater) state from file</p></div><dl class="paramcmts block"><dt class="param">fname</dt><dd class="cmt"><p>Path to input states file.</p></dd></dl></div> |
| </li><li name="org.apache.mxnet.WarnIfNotDisposed#logDisposeWarning" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="logDisposeWarning():Unit"></a> |
| <a id="logDisposeWarning():Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">logDisposeWarning</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@logDisposeWarning():Unit" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Attributes</dt><dd>protected </dd><dt>Definition Classes</dt><dd><a href="WarnIfNotDisposed.html" class="extype" name="org.apache.mxnet.WarnIfNotDisposed">WarnIfNotDisposed</a></dd></dl></div> |
| </li><li name="org.apache.mxnet.KVStore#nativeAddress" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="nativeAddress:org.apache.mxnet.Base.CPtrAddress"></a> |
| <a id="nativeAddress:CPtrAddress"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">nativeAddress</span><span class="result">: <span class="extype" name="org.apache.mxnet.Base.CPtrAddress">CPtrAddress</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@nativeAddress:org.apache.mxnet.Base.CPtrAddress" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">native Address associated with this object |
| </p><div class="fullcomment"><div class="comment cmt"><p>native Address associated with this object |
| </p></div><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="org.apache.mxnet.KVStore">KVStore</a> → NativeResource</dd></dl></div> |
| </li><li name="org.apache.mxnet.KVStore#nativeDeAllocator" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="nativeDeAllocator:org.apache.mxnet.Base.CPtrAddress=>org.apache.mxnet.Base.MXUint"></a> |
| <a id="nativeDeAllocator:(CPtrAddress)⇒MXUint"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">nativeDeAllocator</span><span class="result">: (<span class="extype" name="org.apache.mxnet.Base.CPtrAddress">CPtrAddress</span>) ⇒ <span class="extype" name="org.apache.mxnet.Base.MXUint">MXUint</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@nativeDeAllocator:org.apache.mxnet.Base.CPtrAddress=>org.apache.mxnet.Base.MXUint" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Function Pointer to the NativeDeAllocator of nativeAddress |
| </p><div class="fullcomment"><div class="comment cmt"><p>Function Pointer to the NativeDeAllocator of nativeAddress |
| </p></div><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="org.apache.mxnet.KVStore">KVStore</a> → NativeResource</dd></dl></div> |
| </li><li name="scala.AnyRef#ne" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="ne(x$1:AnyRef):Boolean"></a> |
| <a id="ne(AnyRef):Boolean"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">ne</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.AnyRef">AnyRef</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@ne(x$1:AnyRef):Boolean" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div> |
| </li><li name="scala.AnyRef#notify" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="notify():Unit"></a> |
| <a id="notify():Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">notify</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@notify():Unit" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div> |
| </li><li name="scala.AnyRef#notifyAll" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="notifyAll():Unit"></a> |
| <a id="notifyAll():Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">notifyAll</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@notifyAll():Unit" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div> |
| </li><li name="org.apache.mxnet.KVStore#numDeadNode" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="numDeadNode(nodeId:Int):Int"></a> |
| <a id="numDeadNode(Int):Int"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">numDeadNode</span><span class="params">(<span name="nodeId">nodeId: <span class="extype" name="scala.Int">Int</span></span>)</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@numDeadNode(nodeId:Int):Int" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.KVStore#numWorkers" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="numWorkers:Int"></a> |
| <a id="numWorkers:Int"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">numWorkers</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@numWorkers:Int" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Get the number of worker nodes</p><div class="fullcomment"><div class="comment cmt"><p>Get the number of worker nodes</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>The number of worker nodes</p></dd></dl></div> |
| </li><li name="org.apache.mxnet.KVStore#pull" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="pull(key:String,outs:Array[org.apache.mxnet.NDArray]):Unit"></a> |
| <a id="pull(String,Array[NDArray]):Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">pull</span><span class="params">(<span name="key">key: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="outs">outs: <span class="extype" name="scala.Array">Array</span>[<a href="NDArray.html" class="extype" name="org.apache.mxnet.NDArray">NDArray</a>]</span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@pull(key:String,outs:Array[org.apache.mxnet.NDArray]):Unit" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.KVStore#pull" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="pull(key:String,outs:Array[org.apache.mxnet.NDArray],priority:Int):Unit"></a> |
| <a id="pull(String,Array[NDArray],Int):Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">pull</span><span class="params">(<span name="key">key: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="outs">outs: <span class="extype" name="scala.Array">Array</span>[<a href="NDArray.html" class="extype" name="org.apache.mxnet.NDArray">NDArray</a>]</span>, <span name="priority">priority: <span class="extype" name="scala.Int">Int</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@pull(key:String,outs:Array[org.apache.mxnet.NDArray],priority:Int):Unit" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.KVStore#pull" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="pull(key:String,out:org.apache.mxnet.NDArray,priority:Int):Unit"></a> |
| <a id="pull(String,NDArray,Int):Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">pull</span><span class="params">(<span name="key">key: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="out">out: <a href="NDArray.html" class="extype" name="org.apache.mxnet.NDArray">NDArray</a></span>, <span name="priority">priority: <span class="extype" name="scala.Int">Int</span> = <span class="symbol">0</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@pull(key:String,out:org.apache.mxnet.NDArray,priority:Int):Unit" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.KVStore#pull" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="pull(keys:Array[String],outs:Array[org.apache.mxnet.NDArray]):Unit"></a> |
| <a id="pull(Array[String],Array[NDArray]):Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">pull</span><span class="params">(<span name="keys">keys: <span class="extype" name="scala.Array">Array</span>[<span class="extype" name="scala.Predef.String">String</span>]</span>, <span name="outs">outs: <span class="extype" name="scala.Array">Array</span>[<a href="NDArray.html" class="extype" name="org.apache.mxnet.NDArray">NDArray</a>]</span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@pull(keys:Array[String],outs:Array[org.apache.mxnet.NDArray]):Unit" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.KVStore#pull" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="pull(keys:Array[String],outs:Array[org.apache.mxnet.NDArray],priority:Int):Unit"></a> |
| <a id="pull(Array[String],Array[NDArray],Int):Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">pull</span><span class="params">(<span name="keys">keys: <span class="extype" name="scala.Array">Array</span>[<span class="extype" name="scala.Predef.String">String</span>]</span>, <span name="outs">outs: <span class="extype" name="scala.Array">Array</span>[<a href="NDArray.html" class="extype" name="org.apache.mxnet.NDArray">NDArray</a>]</span>, <span name="priority">priority: <span class="extype" name="scala.Int">Int</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@pull(keys:Array[String],outs:Array[org.apache.mxnet.NDArray],priority:Int):Unit" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Pull a single value or a sequence of values from the store.</p><div class="fullcomment"><div class="comment cmt"><p>Pull a single value or a sequence of values from the store.</p><p>Data consistency: |
| 1. this function returns after adding an operator to the engine. But any |
| further read on out will be blocked until it is finished. |
| 2. pull is always called after all previous push and pull on the same key are finished |
| 3. It pulls the newest value from the store.</p></div><dl class="paramcmts block"><dt class="param">keys</dt><dd class="cmt"><p>Keys</p></dd><dt class="param">outs</dt><dd class="cmt"><p>According values</p></dd><dt class="param">priority</dt><dd class="cmt"><p> |
| The priority of the push operation. |
| The higher the priority, the faster this action is likely |
| to be executed before other push actions.</p></dd></dl></div> |
| </li><li name="org.apache.mxnet.KVStore#push" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="push(key:String,values:Array[org.apache.mxnet.NDArray]):Unit"></a> |
| <a id="push(String,Array[NDArray]):Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">push</span><span class="params">(<span name="key">key: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="values">values: <span class="extype" name="scala.Array">Array</span>[<a href="NDArray.html" class="extype" name="org.apache.mxnet.NDArray">NDArray</a>]</span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@push(key:String,values:Array[org.apache.mxnet.NDArray]):Unit" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.KVStore#push" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="push(key:String,values:Array[org.apache.mxnet.NDArray],priority:Int):Unit"></a> |
| <a id="push(String,Array[NDArray],Int):Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">push</span><span class="params">(<span name="key">key: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="values">values: <span class="extype" name="scala.Array">Array</span>[<a href="NDArray.html" class="extype" name="org.apache.mxnet.NDArray">NDArray</a>]</span>, <span name="priority">priority: <span class="extype" name="scala.Int">Int</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@push(key:String,values:Array[org.apache.mxnet.NDArray],priority:Int):Unit" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.KVStore#push" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="push(key:String,value:org.apache.mxnet.NDArray,priority:Int):Unit"></a> |
| <a id="push(String,NDArray,Int):Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">push</span><span class="params">(<span name="key">key: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="value">value: <a href="NDArray.html" class="extype" name="org.apache.mxnet.NDArray">NDArray</a></span>, <span name="priority">priority: <span class="extype" name="scala.Int">Int</span> = <span class="symbol">0</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@push(key:String,value:org.apache.mxnet.NDArray,priority:Int):Unit" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.KVStore#push" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="push(keys:Array[String],values:Array[org.apache.mxnet.NDArray]):Unit"></a> |
| <a id="push(Array[String],Array[NDArray]):Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">push</span><span class="params">(<span name="keys">keys: <span class="extype" name="scala.Array">Array</span>[<span class="extype" name="scala.Predef.String">String</span>]</span>, <span name="values">values: <span class="extype" name="scala.Array">Array</span>[<a href="NDArray.html" class="extype" name="org.apache.mxnet.NDArray">NDArray</a>]</span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@push(keys:Array[String],values:Array[org.apache.mxnet.NDArray]):Unit" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="org.apache.mxnet.KVStore#push" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="push(keys:Array[String],values:Array[org.apache.mxnet.NDArray],priority:Int):Unit"></a> |
| <a id="push(Array[String],Array[NDArray],Int):Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">push</span><span class="params">(<span name="keys">keys: <span class="extype" name="scala.Array">Array</span>[<span class="extype" name="scala.Predef.String">String</span>]</span>, <span name="values">values: <span class="extype" name="scala.Array">Array</span>[<a href="NDArray.html" class="extype" name="org.apache.mxnet.NDArray">NDArray</a>]</span>, <span name="priority">priority: <span class="extype" name="scala.Int">Int</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@push(keys:Array[String],values:Array[org.apache.mxnet.NDArray],priority:Int):Unit" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Push a single or a sequence of key-value pairs into the store.</p><div class="fullcomment"><div class="comment cmt"><p>Push a single or a sequence of key-value pairs into the store. |
| Data consistency: |
| 1. this function returns after adding an operator to the engine. |
| 2. push is always called after all previous push and pull on the same key are finished |
| 3. there is no synchronization between workers. One can use _barrier() to sync all workers |
| </p></div><dl class="paramcmts block"><dt class="param">keys</dt><dd class="cmt"><p>Keys</p></dd><dt class="param">values</dt><dd class="cmt"><p>According values</p></dd><dt class="param">priority</dt><dd class="cmt"><p> |
| The priority of the push operation. |
| The higher the priority, the faster this action is likely |
| to be executed before other push actions.</p></dd></dl></div> |
| </li><li name="org.apache.mxnet.KVStore#rank" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="rank:Int"></a> |
| <a id="rank:Int"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">rank</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@rank:Int" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Get the rank of this worker node</p><div class="fullcomment"><div class="comment cmt"><p>Get the rank of this worker node</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>The rank of this node, which is in [0, get_num_workers())</p></dd></dl></div> |
| </li><li name="org.apache.mxnet.KVStore#ref" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="ref:org.apache.mxnet.NativeResourceRef"></a> |
| <a id="ref:NativeResourceRef"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">val</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">ref</span><span class="result">: <span class="extype" name="org.apache.mxnet.NativeResourceRef">NativeResourceRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@ref:org.apache.mxnet.NativeResourceRef" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Call NativeResource.register to get the reference |
| </p><div class="fullcomment"><div class="comment cmt"><p>Call NativeResource.register to get the reference |
| </p></div><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="org.apache.mxnet.KVStore">KVStore</a> → NativeResource</dd></dl></div> |
| </li><li name="org.apache.mxnet.NativeResource#register" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="register():org.apache.mxnet.NativeResourceRef"></a> |
| <a id="register():NativeResourceRef"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">register</span><span class="params">()</span><span class="result">: <span class="extype" name="org.apache.mxnet.NativeResourceRef">NativeResourceRef</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@register():org.apache.mxnet.NativeResourceRef" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Register this object for PhantomReference tracking and in |
| ResourceScope if used inside ResourceScope.</p><div class="fullcomment"><div class="comment cmt"><p>Register this object for PhantomReference tracking and in |
| ResourceScope if used inside ResourceScope.</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>NativeResourceRef that tracks reachability of this object |
| using PhantomReference</p></dd></dl><dl class="attributes block"> <dt>Definition Classes</dt><dd>NativeResource</dd></dl></div> |
| </li><li name="org.apache.mxnet.KVStore#saveOptimizerStates" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="saveOptimizerStates(fname:String):Unit"></a> |
| <a id="saveOptimizerStates(String):Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">saveOptimizerStates</span><span class="params">(<span name="fname">fname: <span class="extype" name="scala.Predef.String">String</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@saveOptimizerStates(fname:String):Unit" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Save optimizer (updater) state to file</p><div class="fullcomment"><div class="comment cmt"><p>Save optimizer (updater) state to file</p></div><dl class="paramcmts block"><dt class="param">fname</dt><dd class="cmt"><p>Path to output states file.</p></dd></dl></div> |
| </li><li name="org.apache.mxnet.KVStore#setBarrierBeforeExit" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="setBarrierBeforeExit(barrierBeforeExit:Boolean):Unit"></a> |
| <a id="setBarrierBeforeExit(Boolean):Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">setBarrierBeforeExit</span><span class="params">(<span name="barrierBeforeExit">barrierBeforeExit: <span class="extype" name="scala.Boolean">Boolean</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@setBarrierBeforeExit(barrierBeforeExit:Boolean):Unit" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Whether to do barrier when the kvstore finalizes</p> |
| </li><li name="org.apache.mxnet.KVStore#setOptimizer" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="setOptimizer(optimizer:org.apache.mxnet.Optimizer):Unit"></a> |
| <a id="setOptimizer(Optimizer):Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">setOptimizer</span><span class="params">(<span name="optimizer">optimizer: <a href="Optimizer.html" class="extype" name="org.apache.mxnet.Optimizer">Optimizer</a></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@setOptimizer(optimizer:org.apache.mxnet.Optimizer):Unit" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Register an optimizer to the store |
| If there are multiple machines, this process (should be a worker node) |
| will pack this optimizer and send it to all servers.</p><div class="fullcomment"><div class="comment cmt"><p>Register an optimizer to the store |
| If there are multiple machines, this process (should be a worker node) |
| will pack this optimizer and send it to all servers. It returns after |
| this action is done. |
| </p></div><dl class="paramcmts block"><dt class="param">optimizer</dt><dd class="cmt"><p>the optimizer</p></dd></dl></div> |
| </li><li name="org.apache.mxnet.KVStore#setUpdater" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="setUpdater(updater:org.apache.mxnet.MXKVStoreUpdater):Unit"></a> |
| <a id="setUpdater(MXKVStoreUpdater):Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">setUpdater</span><span class="params">(<span name="updater">updater: <a href="MXKVStoreUpdater.html" class="extype" name="org.apache.mxnet.MXKVStoreUpdater">MXKVStoreUpdater</a></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@setUpdater(updater:org.apache.mxnet.MXKVStoreUpdater):Unit" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <p class="shortcomment cmt">Set a push updater into the store.</p><div class="fullcomment"><div class="comment cmt"><p>Set a push updater into the store.</p><p>This function only changes the local store. Use setOptimizer for |
| multi-machines. |
| </p></div><dl class="paramcmts block"><dt class="param">updater</dt><dd class="cmt"><p>the updater function</p></dd></dl></div> |
| </li><li name="scala.AnyRef#synchronized" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="synchronized[T0](x$1:=>T0):T0"></a> |
| <a id="synchronized[T0](⇒T0):T0"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">synchronized</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="params">(<span name="arg0">arg0: ⇒ <span class="extype" name="java.lang.AnyRef.synchronized.T0">T0</span></span>)</span><span class="result">: <span class="extype" name="java.lang.AnyRef.synchronized.T0">T0</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@synchronized[T0](x$1:=>T0):T0" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div> |
| </li><li name="scala.AnyRef#toString" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="toString():String"></a> |
| <a id="toString():String"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@toString():String" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div> |
| </li><li name="org.apache.mxnet.WarnIfNotDisposed#tracingEnabled" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="tracingEnabled:Boolean"></a> |
| <a id="tracingEnabled:Boolean"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">tracingEnabled</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@tracingEnabled:Boolean" 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><dt>Definition Classes</dt><dd><a href="WarnIfNotDisposed.html" class="extype" name="org.apache.mxnet.WarnIfNotDisposed">WarnIfNotDisposed</a></dd></dl></div> |
| </li><li name="org.apache.mxnet.KVStore#type" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped"> |
| <a id="type:String"></a> |
| <a id="type:String"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier"></span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">type</span><span class="result">: <span class="extype" name="scala.Predef.String">String</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@type:String" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| |
| </li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="wait():Unit"></a> |
| <a id="wait():Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">wait</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@wait():Unit" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd> |
| <span class="name">@throws</span><span class="args">(<span> |
| |
| <span class="defval" name="classOf[java.lang.InterruptedException]">...</span> |
| </span>)</span> |
| |
| </dd></dl></div> |
| </li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="wait(x$1:Long,x$2:Int):Unit"></a> |
| <a id="wait(Long,Int):Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">wait</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Long">Long</span></span>, <span name="arg1">arg1: <span class="extype" name="scala.Int">Int</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@wait(x$1:Long,x$2:Int):Unit" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd> |
| <span class="name">@throws</span><span class="args">(<span> |
| |
| <span class="defval" name="classOf[java.lang.InterruptedException]">...</span> |
| </span>)</span> |
| |
| </dd></dl></div> |
| </li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped"> |
| <a id="wait(x$1:Long):Unit"></a> |
| <a id="wait(Long):Unit"></a> |
| <h4 class="signature"> |
| <span class="modifier_kind"> |
| <span class="modifier">final </span> |
| <span class="kind">def</span> |
| </span> |
| <span class="symbol"> |
| <span class="name">wait</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Long">Long</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span> |
| </span> |
| </h4><span class="permalink"> |
| <a href="../../../index.html#org.apache.mxnet.KVStore@wait(x$1:Long):Unit" title="Permalink" target="_top"> |
| <img src="../../../lib/permalink.png" alt="Permalink" /> |
| </a> |
| </span> |
| <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd> |
| <span class="name">@throws</span><span class="args">(<span> |
| |
| <span class="defval" name="classOf[java.lang.InterruptedException]">...</span> |
| </span>)</span> |
| |
| </dd></dl></div> |
| </li></ol> |
| </div> |
| |
| |
| |
| |
| </div> |
| |
| <div id="inheritedMembers"> |
| <div class="parent" name="org.apache.mxnet.NativeResource"> |
| <h3>Inherited from <span class="extype" name="org.apache.mxnet.NativeResource">NativeResource</span></h3> |
| </div><div class="parent" name="org.apache.mxnet.WarnIfNotDisposed"> |
| <h3>Inherited from <a href="WarnIfNotDisposed.html" class="extype" name="org.apache.mxnet.WarnIfNotDisposed">WarnIfNotDisposed</a></h3> |
| </div><div class="parent" name="java.lang.AutoCloseable"> |
| <h3>Inherited from <span class="extype" name="java.lang.AutoCloseable">AutoCloseable</span></h3> |
| </div><div class="parent" name="scala.AnyRef"> |
| <h3>Inherited from <span class="extype" name="scala.AnyRef">AnyRef</span></h3> |
| </div><div class="parent" name="scala.Any"> |
| <h3>Inherited from <span class="extype" name="scala.Any">Any</span></h3> |
| </div> |
| |
| </div> |
| |
| <div id="groupedMembers"> |
| <div class="group" name="Ungrouped"> |
| <h3>Ungrouped</h3> |
| |
| </div> |
| </div> |
| |
| </div> |
| |
| <div id="tooltip"></div> |
| |
| <div id="footer"> </div> |
| |
| |
| </body> |
| </html> |
