| <!DOCTYPE html PUBLIC "" |
| ""> |
| <html><head><meta charset="UTF-8" /><title>org.apache.clojure-mxnet.io documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Clojure-mxnet</span> <span class="project-version">1.8.0-SNAPSHOT</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>org</span></div></div></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>apache</span></div></div></li><li class="depth-3"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>clojure-mxnet</span></div></div></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.base.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>base</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.callback.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>callback</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.context.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>context</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.dtype.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>dtype</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.eval-metric.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>eval-metric</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.executor.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>executor</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.image.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>image</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.infer.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>infer</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.initializer.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>initializer</span></div></a></li><li class="depth-4 branch current"><a href="org.apache.clojure-mxnet.io.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>io</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.kvstore.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>kvstore</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.kvstore-server.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>kvstore-server</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.layout.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>layout</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.lr-scheduler.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>lr-scheduler</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.module.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>module</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.monitor.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>monitor</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.ndarray.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>ndarray</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.ndarray-api.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>ndarray-api</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.ndarray-random-api.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>ndarray-random-api</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.optimizer.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>optimizer</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.primitives.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>primitives</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.profiler.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>profiler</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.random.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>random</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.resource-scope.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>resource-scope</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.shape.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>shape</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.symbol.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>symbol</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.symbol-api.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>symbol-api</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.symbol-random-api.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>symbol-random-api</span></div></a></li><li class="depth-4 branch"><a href="org.apache.clojure-mxnet.util.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>util</span></div></a></li><li class="depth-4"><a href="org.apache.clojure-mxnet.visualization.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>visualization</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="org.apache.clojure-mxnet.io.html#var-batch-data"><div class="inner"><span>batch-data</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.io.html#var-batch-index"><div class="inner"><span>batch-index</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.io.html#var-batch-label"><div class="inner"><span>batch-label</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.io.html#var-batch-pad"><div class="inner"><span>batch-pad</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.io.html#var-batches"><div class="inner"><span>batches</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.io.html#var-create-iterator"><div class="inner"><span>create-iterator</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.io.html#var-create-mx-data-pack"><div class="inner"><span>create-mx-data-pack</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.io.html#var-csv-iter"><div class="inner"><span>csv-iter</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.io.html#var-csv-pack"><div class="inner"><span>csv-pack</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.io.html#var-data-batch"><div class="inner"><span>data-batch</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.io.html#var-data-desc"><div class="inner"><span>data-desc</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.io.html#var-data-desc-.3Emap"><div class="inner"><span>data-desc->map</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.io.html#var-dispose"><div class="inner"><span>dispose</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.io.html#var-do-batches"><div class="inner"><span>do-batches</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.io.html#var-for-batches"><div class="inner"><span>for-batches</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.io.html#var-has-next.3F"><div class="inner"><span>has-next?</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.io.html#var-image-recode-pack"><div class="inner"><span>image-recode-pack</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.io.html#var-image-record-iter"><div class="inner"><span>image-record-iter</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.io.html#var-iter-data"><div class="inner"><span>iter-data</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.io.html#var-iter-init-label"><div class="inner"><span>iter-init-label</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.io.html#var-iter-label"><div class="inner"><span>iter-label</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.io.html#var-iterator"><div class="inner"><span>iterator</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.io.html#var-mnist-iter"><div class="inner"><span>mnist-iter</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.io.html#var-mnist-pack"><div class="inner"><span>mnist-pack</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.io.html#var-ndarray-iter"><div class="inner"><span>ndarray-iter</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.io.html#var-next"><div class="inner"><span>next</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.io.html#var-prefetching-iter"><div class="inner"><span>prefetching-iter</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.io.html#var-provide-data"><div class="inner"><span>provide-data</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.io.html#var-provide-data-desc"><div class="inner"><span>provide-data-desc</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.io.html#var-provide-label"><div class="inner"><span>provide-label</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.io.html#var-provide-label-desc"><div class="inner"><span>provide-label-desc</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.io.html#var-rand-iter"><div class="inner"><span>rand-iter</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.io.html#var-reduce-batches"><div class="inner"><span>reduce-batches</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.io.html#var-reset"><div class="inner"><span>reset</span></div></a></li><li class="depth-1"><a href="org.apache.clojure-mxnet.io.html#var-resize-iter"><div class="inner"><span>resize-iter</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">org.apache.clojure-mxnet.io</h1><div class="doc"><pre class="plaintext"></pre></div><div class="public anchor" id="var-batch-data"><h3>batch-data</h3><div class="usage"><code>(batch-data batch)</code></div><div class="doc"><pre class="plaintext">Returns the vector of ndarrays that represents the data |
| </pre></div></div><div class="public anchor" id="var-batch-index"><h3>batch-index</h3><div class="usage"><code>(batch-index batch)</code></div><div class="doc"><pre class="plaintext">Returns the vector of ints that represents the index |
| </pre></div></div><div class="public anchor" id="var-batch-label"><h3>batch-label</h3><div class="usage"><code>(batch-label batch)</code></div><div class="doc"><pre class="plaintext">Returns the vector of ndarrays that represents the label |
| </pre></div></div><div class="public anchor" id="var-batch-pad"><h3>batch-pad</h3><div class="usage"><code>(batch-pad batch)</code></div><div class="doc"><pre class="plaintext">Returns the pad of the batch |
| </pre></div></div><div class="public anchor" id="var-batches"><h3>batches</h3><div class="usage"><code>(batches data-pack)</code></div><div class="doc"><pre class="plaintext">Convert the data-pack to a batch seq |
| </pre></div></div><div class="public anchor" id="var-create-iterator"><h3>create-iterator</h3><div class="usage"><code>(create-iterator iter-name kwargs-map)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-create-mx-data-pack"><h3>create-mx-data-pack</h3><div class="usage"><code>(create-mx-data-pack pack-name kwargs-map)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-csv-iter"><h3>csv-iter</h3><div class="usage"><code>(csv-iter kwargs)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-csv-pack"><h3>csv-pack</h3><div class="usage"><code>(csv-pack kwargs)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-data-batch"><h3>data-batch</h3><div class="usage"><code>(data-batch {:keys [data label index pad bucket-key provided-data provided-label], :as info, :or {data [], label [], index [], pad 0}})</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-data-desc"><h3>data-desc</h3><div class="usage"><code>(data-desc {:keys [name shape dtype layout], :as opts, :or {dtype base/MX_REAL_TYPE, layout layout/UNDEFINED}})</code><code>(data-desc name shape)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-data-desc-.3Emap"><h3>data-desc->map</h3><div class="usage"><code>(data-desc->map dd)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-dispose"><h3>dispose</h3><div class="usage"><code>(dispose iterator)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-do-batches"><h3>do-batches</h3><h4 class="type">macro</h4><div class="usage"><code>(do-batches iter f)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-for-batches"><h3>for-batches</h3><h4 class="type">macro</h4><div class="usage"><code>(for-batches iter f)</code></div><div class="doc"><pre class="plaintext">Takes an iterator and a function of one argument. The iterator will be reset and run thhrough all the batches with the batch passed to the function argument. The result of the function will be conjed to a vector result of all the batches and returned at the end. |
| </pre></div></div><div class="public anchor" id="var-has-next.3F"><h3>has-next?</h3><div class="usage"><code>(has-next? iterator)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-image-recode-pack"><h3>image-recode-pack</h3><div class="usage"><code>(image-recode-pack kwargs)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-image-record-iter"><h3>image-record-iter</h3><div class="usage"><code>(image-record-iter kwargs)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-iter-data"><h3>iter-data</h3><div class="usage"><code>(iter-data iterator)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-iter-init-label"><h3>iter-init-label</h3><div class="usage"><code>(iter-init-label iterator)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-iter-label"><h3>iter-label</h3><div class="usage"><code>(iter-label iterator)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-iterator"><h3>iterator</h3><div class="usage"><code>(iterator data-pack)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-mnist-iter"><h3>mnist-iter</h3><div class="usage"><code>(mnist-iter kwargs)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-mnist-pack"><h3>mnist-pack</h3><div class="usage"><code>(mnist-pack kwargs)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-ndarray-iter"><h3>ndarray-iter</h3><div class="usage"><code>(ndarray-iter data {:keys [label data-batch-size shuffle last-batch-handle data-name label-name], :as opts, :or {label nil, data-batch-size 1, shuffle false, last-batch-handle "pad", data-name "data", label-name "label"}})</code><code>(ndarray-iter data)</code></div><div class="doc"><pre class="plaintext"> * NDArrayIter object in mxnet. Taking NDArray to get dataiter. |
| * |
| * @param data vector of iter - Can either by in the form for [ndarray..] or |
| * {data-desc0 ndarray0 data-desc2 ndarray2 ...} |
| * @opts map of: |
| * :label Same as data, but is not fed to the model during testing. |
| * :data-batch-size Batch Size (default 1) |
| * :shuffle Whether to shuffle the data (default false) |
| * :last-batch-handle = pad, discard, or rollover. (default pad) |
| * :data-name String of data name (default data) |
| * :label-name String of label name (default label) |
| * How to handle the last batch |
| * This iterator will pad, discard or roll over the last batch if |
| * the size of data does not match batch-size. Roll over is intended |
| * for training and can cause problems if used for prediction.</pre></div></div><div class="public anchor" id="var-next"><h3>next</h3><div class="usage"><code>(next iterator)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-prefetching-iter"><h3>prefetching-iter</h3><div class="usage"><code>(prefetching-iter iters data-names label-names)</code></div><div class="doc"><pre class="plaintext">Takes one or more data iterators and combines them with pre-fetching |
| </pre></div></div><div class="public anchor" id="var-provide-data"><h3>provide-data</h3><div class="usage"><code>(provide-data pack-iterator)</code></div><div class="doc"><pre class="plaintext">Provides the description of the data iterator in the form of |
| [{:name name :shape shape-vec}]</pre></div></div><div class="public anchor" id="var-provide-data-desc"><h3>provide-data-desc</h3><div class="usage"><code>(provide-data-desc pack-iterator)</code></div><div class="doc"><pre class="plaintext">Provides the Data Desc of the data iterator in the form of |
| [{:name name :shape shape-vec :dtype dtype :layout layout}]</pre></div></div><div class="public anchor" id="var-provide-label"><h3>provide-label</h3><div class="usage"><code>(provide-label pack-iterator)</code></div><div class="doc"><pre class="plaintext">Provides the description of the label iterator in the form of |
| [{:name name :shape shape-vec}]</pre></div></div><div class="public anchor" id="var-provide-label-desc"><h3>provide-label-desc</h3><div class="usage"><code>(provide-label-desc pack-iterator)</code></div><div class="doc"><pre class="plaintext">Provides the Data Desc of the label iterator in the form of |
| [{:name name :shape shape-vec :dtype dtype :layout layout}]</pre></div></div><div class="public anchor" id="var-rand-iter"><h3>rand-iter</h3><div class="usage"><code>(rand-iter shape-vec {:keys [label data-batch-size shuffle last-batch-handle data-name label-name], :as opts, :or {label nil, data-batch-size 1, shuffle false, last-batch-handle "pad", data-name "rand", label-name "label"}})</code><code>(rand-iter shape-vec)</code></div><div class="doc"><pre class="plaintext">A implementation of a random noise iterator |
| Instead of data pass in the shape vector of the noise shape</pre></div></div><div class="public anchor" id="var-reduce-batches"><h3>reduce-batches</h3><h4 class="type">macro</h4><div class="usage"><code>(reduce-batches iter f initial-val)</code><code>(reduce-batches iter f)</code></div><div class="doc"><pre class="plaintext">Takes an iterator and a function of two arguments. The iterator will be reset and run thhrough all the batches with the batch passed to the function argument. The result of the function will the result of the reduce function |
| </pre></div></div><div class="public anchor" id="var-reset"><h3>reset</h3><div class="usage"><code>(reset iterator)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-resize-iter"><h3>resize-iter</h3><div class="usage"><code>(resize-iter data-iter resize reset-iternal)</code></div><div class="doc"><pre class="plaintext">* Resize a data iterator to given number of batches per epoch. |
| * May produce incomplete batch in the middle of an epoch due |
| * to padding from internal iterator. |
| * |
| * @param data-iter Internal data iterator. |
| * @param resize number of batches per epoch to resize to. |
| * @param reset-internal whether to reset internal iterator with reset</pre></div></div></div></body></html> |
