| <!DOCTYPE html> |
| |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"/> |
| <meta content="IE=edge" http-equiv="X-UA-Compatible"/> |
| <meta content="width=device-width, initial-scale=1" name="viewport"/> |
| <title>Gluon Data API — mxnet documentation</title> |
| <link crossorigin="anonymous" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css" integrity="sha384-1q8mTJOASx8j1Au+a5WDVnPi2lkFfwwEAa8hDDdjZlpLegxhjVME1fgjWPGmkzs7" rel="stylesheet"/> |
| <link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css" rel="stylesheet"/> |
| <link href="../../../_static/basic.css" rel="stylesheet" type="text/css"> |
| <link href="../../../_static/pygments.css" rel="stylesheet" type="text/css"> |
| <link href="../../../_static/mxnet.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript"> |
| var DOCUMENTATION_OPTIONS = { |
| URL_ROOT: '../../../', |
| VERSION: '', |
| COLLAPSE_INDEX: false, |
| FILE_SUFFIX: '.html', |
| HAS_SOURCE: true, |
| SOURCELINK_SUFFIX: '' |
| }; |
| </script> |
| <script src="https://code.jquery.com/jquery-1.11.1.min.js" type="text/javascript"></script> |
| <script src="../../../_static/underscore.js" type="text/javascript"></script> |
| <script src="../../../_static/searchtools_custom.js" type="text/javascript"></script> |
| <script src="../../../_static/doctools.js" type="text/javascript"></script> |
| <script src="../../../_static/selectlang.js" type="text/javascript"></script> |
| <script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script> |
| <script type="text/javascript"> jQuery(function() { Search.loadIndex("/searchindex.js"); Search.init();}); </script> |
| <script> |
| (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ |
| (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new |
| Date();a=s.createElement(o), |
| m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) |
| })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); |
| |
| ga('create', 'UA-96378503-1', 'auto'); |
| ga('send', 'pageview'); |
| |
| </script> |
| <!-- --> |
| <!-- <script type="text/javascript" src="../../../_static/jquery.js"></script> --> |
| <!-- --> |
| <!-- <script type="text/javascript" src="../../../_static/underscore.js"></script> --> |
| <!-- --> |
| <!-- <script type="text/javascript" src="../../../_static/doctools.js"></script> --> |
| <!-- --> |
| <!-- <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script> --> |
| <!-- --> |
| <link href="gluon.html" rel="up" title="Gluon Package"> |
| <link href="model_zoo.html" rel="next" title="Gluon Model Zoo"/> |
| <link href="loss.html" rel="prev" title="Gluon Loss API"/> |
| <link href="https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/image/mxnet-icon.png" rel="icon" type="image/png"/> |
| </link></link></link></head> |
| <body background="https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/image/mxnet-background-compressed.jpeg" role="document"> |
| <div class="content-block"><div class="navbar navbar-fixed-top"> |
| <div class="container" id="navContainer"> |
| <div class="innder" id="header-inner"> |
| <h1 id="logo-wrap"> |
| <a href="../../../" id="logo"><img src="https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/image/mxnet_logo.png"/></a> |
| </h1> |
| <nav class="nav-bar" id="main-nav"> |
| <a class="main-nav-link" href="../../../install/index.html">Install</a> |
| <a class="main-nav-link" href="../../../tutorials/index.html">Tutorials</a> |
| <span id="dropdown-menu-position-anchor"> |
| <a aria-expanded="true" aria-haspopup="true" class="main-nav-link dropdown-toggle" data-toggle="dropdown" href="#" role="button">Gluon <span class="caret"></span></a> |
| <ul class="dropdown-menu navbar-menu" id="package-dropdown-menu"> |
| <li><a class="main-nav-link" href="../../../gluon/index.html">About</a></li> |
| <li><a class="main-nav-link" href="http://gluon.mxnet.io">Tutorials</a></li> |
| </ul> |
| </span> |
| <span id="dropdown-menu-position-anchor"> |
| <a aria-expanded="true" aria-haspopup="true" class="main-nav-link dropdown-toggle" data-toggle="dropdown" href="#" role="button">API <span class="caret"></span></a> |
| <ul class="dropdown-menu navbar-menu" id="package-dropdown-menu"> |
| <li><a class="main-nav-link" href="../../../api/python/index.html">Python</a></li> |
| <li><a class="main-nav-link" href="../../../api/scala/index.html">Scala</a></li> |
| <li><a class="main-nav-link" href="../../../api/r/index.html">R</a></li> |
| <li><a class="main-nav-link" href="../../../api/julia/index.html">Julia</a></li> |
| <li><a class="main-nav-link" href="../../../api/c++/index.html">C++</a></li> |
| <li><a class="main-nav-link" href="../../../api/perl/index.html">Perl</a></li> |
| </ul> |
| </span> |
| <span id="dropdown-menu-position-anchor-docs"> |
| <a aria-expanded="true" aria-haspopup="true" class="main-nav-link dropdown-toggle" data-toggle="dropdown" href="#" role="button">Docs <span class="caret"></span></a> |
| <ul class="dropdown-menu navbar-menu" id="package-dropdown-menu-docs"> |
| <li><a class="main-nav-link" href="../../../faq/index.html">FAQ</a></li> |
| <li><a class="main-nav-link" href="../../../architecture/index.html">Architecture</a></li> |
| <li><a class="main-nav-link" href="https://github.com/apache/incubator-mxnet/tree/1.0.0/example">Examples</a></li> |
| <li><a class="main-nav-link" href="../../../model_zoo/index.html">Model Zoo</a></li> |
| </ul> |
| </span> |
| <a class="main-nav-link" href="https://github.com/dmlc/mxnet">Github</a> |
| <span id="dropdown-menu-position-anchor-community"> |
| <a aria-expanded="true" aria-haspopup="true" class="main-nav-link dropdown-toggle" data-toggle="dropdown" href="#" role="button">Community <span class="caret"></span></a> |
| <ul class="dropdown-menu navbar-menu" id="package-dropdown-menu-community"> |
| <li><a class="main-nav-link" href="../../../community/index.html">Community</a></li> |
| <li><a class="main-nav-link" href="../../../community/contribute.html">Contribute</a></li> |
| <li><a class="main-nav-link" href="../../../community/powered_by.html">Powered By</a></li> |
| </ul> |
| </span> |
| <a class="main-nav-link" href="http://discuss.mxnet.io">Discuss</a> |
| <span id="dropdown-menu-position-anchor-version" style="position: relative"><a href="#" class="main-nav-link dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="true">Versions(1.0.0)<span class="caret"></span></a><ul id="package-dropdown-menu" class="dropdown-menu"><li><a class="main-nav-link" href=https://mxnet.incubator.apache.org/>1.0.0</a></li><li><a class="main-nav-link" href=https://mxnet.incubator.apache.org/versions/0.12.1/index.html>0.12.1</a></li><li><a class="main-nav-link" href=https://mxnet.incubator.apache.org/versions/0.12.0/index.html>0.12.0</a></li><li><a class="main-nav-link" href=https://mxnet.incubator.apache.org/versions/0.11.0/index.html>0.11.0</a></li><li><a class="main-nav-link" href=https://mxnet.incubator.apache.org/versions/master/index.html>master</a></li></ul></span></nav> |
| <script> function getRootPath(){ return "../../../" } </script> |
| <div class="burgerIcon dropdown"> |
| <a class="dropdown-toggle" data-toggle="dropdown" href="#" role="button">☰</a> |
| <ul class="dropdown-menu" id="burgerMenu"> |
| <li><a href="../../../install/index.html">Install</a></li> |
| <li><a class="main-nav-link" href="../../../tutorials/index.html">Tutorials</a></li> |
| <li class="dropdown-submenu"> |
| <a href="#" tabindex="-1">Community</a> |
| <ul class="dropdown-menu"> |
| <li><a href="../../../community/index.html" tabindex="-1">Community</a></li> |
| <li><a href="../../../community/contribute.html" tabindex="-1">Contribute</a></li> |
| <li><a href="../../../community/powered_by.html" tabindex="-1">Powered By</a></li> |
| </ul> |
| </li> |
| <li class="dropdown-submenu"> |
| <a href="#" tabindex="-1">API</a> |
| <ul class="dropdown-menu"> |
| <li><a href="../../../api/python/index.html" tabindex="-1">Python</a> |
| </li> |
| <li><a href="../../../api/scala/index.html" tabindex="-1">Scala</a> |
| </li> |
| <li><a href="../../../api/r/index.html" tabindex="-1">R</a> |
| </li> |
| <li><a href="../../../api/julia/index.html" tabindex="-1">Julia</a> |
| </li> |
| <li><a href="../../../api/c++/index.html" tabindex="-1">C++</a> |
| </li> |
| <li><a href="../../../api/perl/index.html" tabindex="-1">Perl</a> |
| </li> |
| </ul> |
| </li> |
| <li class="dropdown-submenu"> |
| <a href="#" tabindex="-1">Docs</a> |
| <ul class="dropdown-menu"> |
| <li><a href="../../../tutorials/index.html" tabindex="-1">Tutorials</a></li> |
| <li><a href="../../../faq/index.html" tabindex="-1">FAQ</a></li> |
| <li><a href="../../../architecture/index.html" tabindex="-1">Architecture</a></li> |
| <li><a href="https://github.com/apache/incubator-mxnet/tree/1.0.0/example" tabindex="-1">Examples</a></li> |
| <li><a href="../../../model_zoo/index.html" tabindex="-1">Model Zoo</a></li> |
| </ul> |
| </li> |
| <li><a href="../../../architecture/index.html">Architecture</a></li> |
| <li><a class="main-nav-link" href="https://github.com/dmlc/mxnet">Github</a></li> |
| <li id="dropdown-menu-position-anchor-version-mobile" class="dropdown-submenu" style="position: relative"><a href="#" tabindex="-1">Versions(1.0.0)</a><ul class="dropdown-menu"><li><a tabindex="-1" href=https://mxnet.incubator.apache.org/>1.0.0</a></li><li><a tabindex="-1" href=https://mxnet.incubator.apache.org/versions/0.12.1/index.html>0.12.1</a></li><li><a tabindex="-1" href=https://mxnet.incubator.apache.org/versions/0.12.0/index.html>0.12.0</a></li><li><a tabindex="-1" href=https://mxnet.incubator.apache.org/versions/0.11.0/index.html>0.11.0</a></li><li><a tabindex="-1" href=https://mxnet.incubator.apache.org/versions/master/index.html>master</a></li></ul></li></ul> |
| </div> |
| <div class="plusIcon dropdown"> |
| <a class="dropdown-toggle" data-toggle="dropdown" href="#" role="button"><span aria-hidden="true" class="glyphicon glyphicon-plus"></span></a> |
| <ul class="dropdown-menu dropdown-menu-right" id="plusMenu"></ul> |
| </div> |
| <div id="search-input-wrap"> |
| <form action="../../../search.html" autocomplete="off" class="" method="get" role="search"> |
| <div class="form-group inner-addon left-addon"> |
| <i class="glyphicon glyphicon-search"></i> |
| <input class="form-control" name="q" placeholder="Search" type="text"/> |
| </div> |
| <input name="check_keywords" type="hidden" value="yes"> |
| <input name="area" type="hidden" value="default"/> |
| </input></form> |
| <div id="search-preview"></div> |
| </div> |
| <div id="searchIcon"> |
| <span aria-hidden="true" class="glyphicon glyphicon-search"></span> |
| </div> |
| <!-- <div id="lang-select-wrap"> --> |
| <!-- <label id="lang-select-label"> --> |
| <!-- <\!-- <i class="fa fa-globe"></i> -\-> --> |
| <!-- <span></span> --> |
| <!-- </label> --> |
| <!-- <select id="lang-select"> --> |
| <!-- <option value="en">Eng</option> --> |
| <!-- <option value="zh">中文</option> --> |
| <!-- </select> --> |
| <!-- </div> --> |
| <!-- <a id="mobile-nav-toggle"> |
| <span class="mobile-nav-toggle-bar"></span> |
| <span class="mobile-nav-toggle-bar"></span> |
| <span class="mobile-nav-toggle-bar"></span> |
| </a> --> |
| </div> |
| </div> |
| </div> |
| <script type="text/javascript"> |
| $('body').css('background', 'white'); |
| </script> |
| <div class="container"> |
| <div class="row"> |
| <div aria-label="main navigation" class="sphinxsidebar leftsidebar" role="navigation"> |
| <div class="sphinxsidebarwrapper"> |
| <ul class="current"> |
| <li class="toctree-l1 current"><a class="reference internal" href="../index.html">Python Documents</a><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="../index.html#ndarray-api">NDArray API</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../index.html#symbol-api">Symbol API</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../index.html#module-api">Module API</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../index.html#autograd-api">Autograd API</a></li> |
| <li class="toctree-l2 current"><a class="reference internal" href="../index.html#gluon-api">Gluon API</a><ul class="current"> |
| <li class="toctree-l3 current"><a class="reference internal" href="gluon.html">Gluon Package</a><ul class="current"> |
| <li class="toctree-l4 current"><a class="reference internal" href="gluon.html#overview">Overview</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="gluon.html#parameter">Parameter</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="gluon.html#containers">Containers</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="gluon.html#trainer">Trainer</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="gluon.html#utilities">Utilities</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="gluon.html#api-reference">API Reference</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="nn.html">Gluon Neural Network Layers</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="rnn.html">Gluon Recurrent Neural Network API</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="loss.html">Gluon Loss API</a></li> |
| <li class="toctree-l3 current"><a class="current reference internal" href="">Gluon Data API</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#overview">Overview</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#data">Data</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#api-reference">API Reference</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="model_zoo.html">Gluon Model Zoo</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="contrib.html">Gluon Contrib API</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../index.html#kvstore-api">KVStore API</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../index.html#io-api">IO API</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../index.html#image-api">Image API</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../index.html#optimization-api">Optimization API</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../index.html#callback-api">Callback API</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../index.html#metric-api">Metric API</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../index.html#run-time-compilation-api">Run-Time Compilation API</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../../r/index.html">R Documents</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../julia/index.html">Julia Documents</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../c++/index.html">C++ Documents</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../scala/index.html">Scala Documents</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../perl/index.html">Perl Documents</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../faq/index.html">HowTo Documents</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../architecture/index.html">System Documents</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../tutorials/index.html">Tutorials</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../community/index.html">Community</a></li> |
| </ul> |
| </div> |
| </div> |
| <div class="content"> |
| <div class="page-tracker"></div> |
| <div class="section" id="gluon-data-api"> |
| <span id="gluon-data-api"></span><h1>Gluon Data API<a class="headerlink" href="#gluon-data-api" title="Permalink to this headline">¶</a></h1> |
| <div class="section" id="overview"> |
| <span id="overview"></span><h2>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h2> |
| <p>This document lists the data APIs in Gluon:</p> |
| <table border="1" class="longtable docutils"> |
| <colgroup> |
| <col width="10%"/> |
| <col width="90%"/> |
| </colgroup> |
| <tbody valign="top"> |
| <tr class="row-odd"><td><a class="reference internal" href="#module-mxnet.gluon.data" title="mxnet.gluon.data"><code class="xref py py-obj docutils literal"><span class="pre">mxnet.gluon.data</span></code></a></td> |
| <td>Dataset utilities.</td> |
| </tr> |
| <tr class="row-even"><td><a class="reference internal" href="#module-mxnet.gluon.data.vision" title="mxnet.gluon.data.vision"><code class="xref py py-obj docutils literal"><span class="pre">mxnet.gluon.data.vision</span></code></a></td> |
| <td>Dataset container.</td> |
| </tr> |
| </tbody> |
| </table> |
| <p>The <code class="docutils literal"><span class="pre">Gluon</span> <span class="pre">Data</span></code> API, defined in the <code class="docutils literal"><span class="pre">gluon.data</span></code> package, provides useful dataset loading |
| and processing tools, as well as common public datasets.</p> |
| <p>In the rest of this document, we list routines provided by the <code class="docutils literal"><span class="pre">gluon.data</span></code> package.</p> |
| </div> |
| <div class="section" id="data"> |
| <span id="data"></span><h2>Data<a class="headerlink" href="#data" title="Permalink to this headline">¶</a></h2> |
| <table border="1" class="longtable docutils"> |
| <colgroup> |
| <col width="10%"/> |
| <col width="90%"/> |
| </colgroup> |
| <tbody valign="top"> |
| <tr class="row-odd"><td><a class="reference internal" href="#mxnet.gluon.data.Dataset" title="mxnet.gluon.data.Dataset"><code class="xref py py-obj docutils literal"><span class="pre">Dataset</span></code></a></td> |
| <td>Abstract dataset class.</td> |
| </tr> |
| <tr class="row-even"><td><a class="reference internal" href="#mxnet.gluon.data.ArrayDataset" title="mxnet.gluon.data.ArrayDataset"><code class="xref py py-obj docutils literal"><span class="pre">ArrayDataset</span></code></a></td> |
| <td>A dataset of multiple arrays.</td> |
| </tr> |
| <tr class="row-odd"><td><a class="reference internal" href="#mxnet.gluon.data.RecordFileDataset" title="mxnet.gluon.data.RecordFileDataset"><code class="xref py py-obj docutils literal"><span class="pre">RecordFileDataset</span></code></a></td> |
| <td>A dataset wrapping over a RecordIO (.rec) file.</td> |
| </tr> |
| </tbody> |
| </table> |
| <table border="1" class="longtable docutils"> |
| <colgroup> |
| <col width="10%"/> |
| <col width="90%"/> |
| </colgroup> |
| <tbody valign="top"> |
| <tr class="row-odd"><td><a class="reference internal" href="#mxnet.gluon.data.Sampler" title="mxnet.gluon.data.Sampler"><code class="xref py py-obj docutils literal"><span class="pre">Sampler</span></code></a></td> |
| <td>Base class for samplers.</td> |
| </tr> |
| <tr class="row-even"><td><a class="reference internal" href="#mxnet.gluon.data.SequentialSampler" title="mxnet.gluon.data.SequentialSampler"><code class="xref py py-obj docutils literal"><span class="pre">SequentialSampler</span></code></a></td> |
| <td>Samples elements from [0, length) sequentially.</td> |
| </tr> |
| <tr class="row-odd"><td><a class="reference internal" href="#mxnet.gluon.data.RandomSampler" title="mxnet.gluon.data.RandomSampler"><code class="xref py py-obj docutils literal"><span class="pre">RandomSampler</span></code></a></td> |
| <td>Samples elements from [0, length) randomly without replacement.</td> |
| </tr> |
| <tr class="row-even"><td><a class="reference internal" href="#mxnet.gluon.data.BatchSampler" title="mxnet.gluon.data.BatchSampler"><code class="xref py py-obj docutils literal"><span class="pre">BatchSampler</span></code></a></td> |
| <td>Wraps over another <cite>Sampler</cite> and return mini-batches of samples.</td> |
| </tr> |
| </tbody> |
| </table> |
| <table border="1" class="longtable docutils"> |
| <colgroup> |
| <col width="10%"/> |
| <col width="90%"/> |
| </colgroup> |
| <tbody valign="top"> |
| <tr class="row-odd"><td><a class="reference internal" href="#mxnet.gluon.data.DataLoader" title="mxnet.gluon.data.DataLoader"><code class="xref py py-obj docutils literal"><span class="pre">DataLoader</span></code></a></td> |
| <td>Loads data from a dataset and returns mini-batches of data.</td> |
| </tr> |
| </tbody> |
| </table> |
| <div class="section" id="vision"> |
| <span id="vision"></span><h3>Vision<a class="headerlink" href="#vision" title="Permalink to this headline">¶</a></h3> |
| <table border="1" class="longtable docutils"> |
| <colgroup> |
| <col width="10%"/> |
| <col width="90%"/> |
| </colgroup> |
| <tbody valign="top"> |
| <tr class="row-odd"><td><a class="reference internal" href="#mxnet.gluon.data.vision.MNIST" title="mxnet.gluon.data.vision.MNIST"><code class="xref py py-obj docutils literal"><span class="pre">MNIST</span></code></a></td> |
| <td>MNIST handwritten digits dataset from <a class="reference external" href="http://yann.lecun.com/exdb/mnist">http://yann.lecun.com/exdb/mnist</a></td> |
| </tr> |
| <tr class="row-even"><td><a class="reference internal" href="#mxnet.gluon.data.vision.FashionMNIST" title="mxnet.gluon.data.vision.FashionMNIST"><code class="xref py py-obj docutils literal"><span class="pre">FashionMNIST</span></code></a></td> |
| <td>A dataset of Zalando’s article images consisting of fashion products,</td> |
| </tr> |
| <tr class="row-odd"><td><a class="reference internal" href="#mxnet.gluon.data.vision.CIFAR10" title="mxnet.gluon.data.vision.CIFAR10"><code class="xref py py-obj docutils literal"><span class="pre">CIFAR10</span></code></a></td> |
| <td>CIFAR10 image classification dataset from <a class="reference external" href="https://www.cs.toronto.edu/~kriz/cifar.html">https://www.cs.toronto.edu/~kriz/cifar.html</a></td> |
| </tr> |
| <tr class="row-even"><td><a class="reference internal" href="#mxnet.gluon.data.vision.CIFAR100" title="mxnet.gluon.data.vision.CIFAR100"><code class="xref py py-obj docutils literal"><span class="pre">CIFAR100</span></code></a></td> |
| <td>CIFAR100 image classification dataset from <a class="reference external" href="https://www.cs.toronto.edu/~kriz/cifar.html">https://www.cs.toronto.edu/~kriz/cifar.html</a></td> |
| </tr> |
| <tr class="row-odd"><td><a class="reference internal" href="#mxnet.gluon.data.vision.ImageRecordDataset" title="mxnet.gluon.data.vision.ImageRecordDataset"><code class="xref py py-obj docutils literal"><span class="pre">ImageRecordDataset</span></code></a></td> |
| <td>A dataset wrapping over a RecordIO file containing images.</td> |
| </tr> |
| <tr class="row-even"><td><a class="reference internal" href="#mxnet.gluon.data.vision.ImageFolderDataset" title="mxnet.gluon.data.vision.ImageFolderDataset"><code class="xref py py-obj docutils literal"><span class="pre">ImageFolderDataset</span></code></a></td> |
| <td>A dataset for loading image files stored in a folder structure like:</td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="section" id="api-reference"> |
| <span id="api-reference"></span><h2>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline">¶</a></h2> |
| <script src="../../../_static/js/auto_module_index.js" type="text/javascript"></script><span class="target" id="module-mxnet.gluon.data"></span><p>Dataset utilities.</p> |
| <dl class="class"> |
| <dt id="mxnet.gluon.data.ArrayDataset"> |
| <em class="property">class </em><code class="descclassname">mxnet.gluon.data.</code><code class="descname">ArrayDataset</code><span class="sig-paren">(</span><em>*args</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/data/dataset.html#ArrayDataset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.data.ArrayDataset" title="Permalink to this definition">¶</a></dt> |
| <dd><p>A dataset of multiple arrays.</p> |
| <p>The i-th sample is <cite>(x1[i], x2[i], ...)</cite>.</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name"/> |
| <col class="field-body"/> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>*args</strong> – <p>The data arrays.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| <dl class="class"> |
| <dt id="mxnet.gluon.data.BatchSampler"> |
| <em class="property">class </em><code class="descclassname">mxnet.gluon.data.</code><code class="descname">BatchSampler</code><span class="sig-paren">(</span><em>sampler</em>, <em>batch_size</em>, <em>last_batch='keep'</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/data/sampler.html#BatchSampler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.data.BatchSampler" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Wraps over another <cite>Sampler</cite> and return mini-batches of samples.</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name"/> |
| <col class="field-body"/> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
| <li><strong>sampler</strong> (<a class="reference internal" href="#mxnet.gluon.data.Sampler" title="mxnet.gluon.data.Sampler"><em>Sampler</em></a>) – The source Sampler.</li> |
| <li><strong>batch_size</strong> (<em>int</em>) – Size of mini-batch.</li> |
| <li><strong>last_batch</strong> (<em>{'keep', 'discard', 'rollover'}</em>) – <p>Specifies how the last batch is handled if batch_size does not evenly |
| divide sequence length.</p> |
| <p>If ‘keep’, the last batch will be returned directly, but will contain |
| less element than <cite>batch_size</cite> requires.</p> |
| <p>If ‘discard’, the last batch will be discarded.</p> |
| <p>If ‘rollover’, the remaining elements will be rolled over to the next |
| iteration.</p> |
| </li> |
| </ul> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <p class="rubric">Examples</p> |
| <div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">sampler</span> <span class="o">=</span> <span class="n">gluon</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">SequentialSampler</span><span class="p">(</span><span class="mi">10</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">batch_sampler</span> <span class="o">=</span> <span class="n">gluon</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">BatchSampler</span><span class="p">(</span><span class="n">sampler</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="s1">'keep'</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="nb">list</span><span class="p">(</span><span class="n">batch_sampler</span><span class="p">)</span> |
| <span class="go">[[0, 1, 2], [3, 4, 5], [6, 7, 8], [9]]</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| <dl class="class"> |
| <dt id="mxnet.gluon.data.DataLoader"> |
| <em class="property">class </em><code class="descclassname">mxnet.gluon.data.</code><code class="descname">DataLoader</code><span class="sig-paren">(</span><em>dataset</em>, <em>batch_size=None</em>, <em>shuffle=False</em>, <em>sampler=None</em>, <em>last_batch=None</em>, <em>batch_sampler=None</em>, <em>batchify_fn=None</em>, <em>num_workers=0</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/data/dataloader.html#DataLoader"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.data.DataLoader" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Loads data from a dataset and returns mini-batches of data.</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name"/> |
| <col class="field-body"/> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
| <li><strong>dataset</strong> (<a class="reference internal" href="#mxnet.gluon.data.Dataset" title="mxnet.gluon.data.Dataset"><em>Dataset</em></a>) – Source dataset. Note that numpy and mxnet arrays can be directly used |
| as a Dataset.</li> |
| <li><strong>batch_size</strong> (<em>int</em>) – Size of mini-batch.</li> |
| <li><strong>shuffle</strong> (<em>bool</em>) – Whether to shuffle the samples.</li> |
| <li><strong>sampler</strong> (<a class="reference internal" href="#mxnet.gluon.data.Sampler" title="mxnet.gluon.data.Sampler"><em>Sampler</em></a>) – The sampler to use. Either specify sampler or shuffle, not both.</li> |
| <li><strong>last_batch</strong> (<em>{'keep', 'discard', 'rollover'}</em>) – <p>How to handle the last batch if batch_size does not evenly divide |
| <cite>len(dataset)</cite>.</p> |
| <p>keep - A batch with less samples than previous batches is returned. |
| discard - The last batch is discarded if its incomplete. |
| rollover - The remaining samples are rolled over to the next epoch.</p> |
| </li> |
| <li><strong>batch_sampler</strong> (<a class="reference internal" href="#mxnet.gluon.data.Sampler" title="mxnet.gluon.data.Sampler"><em>Sampler</em></a>) – A sampler that returns mini-batches. Do not specify batch_size, |
| shuffle, sampler, and last_batch if batch_sampler is specified.</li> |
| <li><strong>batchify_fn</strong> (<em>callable</em>) – <p>Callback function to allow users to specify how to merge samples |
| into a batch. Defaults to <cite>default_batchify_fn</cite>:</p> |
| <div class="highlight-python"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">default_batchify_fn</span><span class="p">(</span><span class="n">data</span><span class="p">):</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">data</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">nd</span><span class="o">.</span><span class="n">NDArray</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">nd</span><span class="o">.</span><span class="n">stack</span><span class="p">(</span><span class="o">*</span><span class="n">data</span><span class="p">)</span> |
| <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">data</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="nb">tuple</span><span class="p">):</span> |
| <span class="n">data</span> <span class="o">=</span> <span class="nb">zip</span><span class="p">(</span><span class="o">*</span><span class="n">data</span><span class="p">)</span> |
| <span class="k">return</span> <span class="p">[</span><span class="n">default_batchify_fn</span><span class="p">(</span><span class="n">i</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">data</span><span class="p">]</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">data</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="n">data</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">nd</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">data</span><span class="o">.</span><span class="n">dtype</span><span class="p">)</span> |
| </pre></div> |
| </div> |
| </li> |
| <li><strong>num_workers</strong> (<em>int, default 0</em>) – The number of multiprocessing workers to use for data preprocessing. |
| <cite>num_workers > 0</cite> is not supported on Windows yet.</li> |
| </ul> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| <dl class="class"> |
| <dt id="mxnet.gluon.data.Dataset"> |
| <em class="property">class </em><code class="descclassname">mxnet.gluon.data.</code><code class="descname">Dataset</code><a class="reference internal" href="../../../_modules/mxnet/gluon/data/dataset.html#Dataset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.data.Dataset" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Abstract dataset class. All datasets should have this interface.</p> |
| <p>Subclasses need to override <cite>__getitem__</cite>, which returns the i-th |
| element, and <cite>__len__</cite>, which returns the total number elements.</p> |
| <div class="admonition note"> |
| <p class="first admonition-title">Note</p> |
| <p class="last">An mxnet or numpy array can be directly used as a dataset.</p> |
| </div> |
| </dd></dl> |
| <dl class="class"> |
| <dt id="mxnet.gluon.data.RandomSampler"> |
| <em class="property">class </em><code class="descclassname">mxnet.gluon.data.</code><code class="descname">RandomSampler</code><span class="sig-paren">(</span><em>length</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/data/sampler.html#RandomSampler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.data.RandomSampler" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Samples elements from [0, length) randomly without replacement.</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name"/> |
| <col class="field-body"/> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>length</strong> (<em>int</em>) – Length of the sequence.</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| <dl class="class"> |
| <dt id="mxnet.gluon.data.RecordFileDataset"> |
| <em class="property">class </em><code class="descclassname">mxnet.gluon.data.</code><code class="descname">RecordFileDataset</code><span class="sig-paren">(</span><em>filename</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/data/dataset.html#RecordFileDataset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.data.RecordFileDataset" title="Permalink to this definition">¶</a></dt> |
| <dd><p>A dataset wrapping over a RecordIO (.rec) file.</p> |
| <p>Each sample is a string representing the raw content of an record.</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name"/> |
| <col class="field-body"/> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filename</strong> (<em>str</em>) – Path to rec file.</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| <dl class="class"> |
| <dt id="mxnet.gluon.data.Sampler"> |
| <em class="property">class </em><code class="descclassname">mxnet.gluon.data.</code><code class="descname">Sampler</code><a class="reference internal" href="../../../_modules/mxnet/gluon/data/sampler.html#Sampler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.data.Sampler" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Base class for samplers.</p> |
| <p>All samplers should subclass <cite>Sampler</cite> and define <cite>__iter__</cite> and <cite>__len__</cite> |
| methods.</p> |
| </dd></dl> |
| <dl class="class"> |
| <dt id="mxnet.gluon.data.SequentialSampler"> |
| <em class="property">class </em><code class="descclassname">mxnet.gluon.data.</code><code class="descname">SequentialSampler</code><span class="sig-paren">(</span><em>length</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/data/sampler.html#SequentialSampler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.data.SequentialSampler" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Samples elements from [0, length) sequentially.</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name"/> |
| <col class="field-body"/> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>length</strong> (<em>int</em>) – Length of the sequence.</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| <span class="target" id="module-mxnet.gluon.data.vision"></span><p>Dataset container.</p> |
| <dl class="class"> |
| <dt id="mxnet.gluon.data.vision.MNIST"> |
| <em class="property">class </em><code class="descclassname">mxnet.gluon.data.vision.</code><code class="descname">MNIST</code><span class="sig-paren">(</span><em>root='~/.mxnet/datasets/mnist'</em>, <em>train=True</em>, <em>transform=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/data/vision.html#MNIST"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.data.vision.MNIST" title="Permalink to this definition">¶</a></dt> |
| <dd><p>MNIST handwritten digits dataset from <a class="reference external" href="http://yann.lecun.com/exdb/mnist">http://yann.lecun.com/exdb/mnist</a></p> |
| <p>Each sample is an image (in 3D NDArray) with shape (28, 28, 1).</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name"/> |
| <col class="field-body"/> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
| <li><strong>root</strong> (<em>str, default '~/.mxnet/datasets/mnist'</em>) – Path to temp folder for storing data.</li> |
| <li><strong>train</strong> (<em>bool, default True</em>) – Whether to load the training or testing set.</li> |
| <li><strong>transform</strong> (<em>function, default None</em>) – A user defined callback that transforms each sample. For example:</li> |
| </ul> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <dl class="docutils"> |
| <dt>:param :</dt> |
| <dd>transform=lambda data, label: (data.astype(np.float32)/255, label)</dd> |
| </dl> |
| <p>:type : :</p> |
| </dd></dl> |
| <dl class="class"> |
| <dt id="mxnet.gluon.data.vision.FashionMNIST"> |
| <em class="property">class </em><code class="descclassname">mxnet.gluon.data.vision.</code><code class="descname">FashionMNIST</code><span class="sig-paren">(</span><em>root='~/.mxnet/datasets/fashion-mnist'</em>, <em>train=True</em>, <em>transform=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/data/vision.html#FashionMNIST"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.data.vision.FashionMNIST" title="Permalink to this definition">¶</a></dt> |
| <dd><p>A dataset of Zalando’s article images consisting of fashion products, |
| a drop-in replacement of the original MNIST dataset from |
| <a class="reference external" href="https://github.com/zalandoresearch/fashion-mnist">https://github.com/zalandoresearch/fashion-mnist</a></p> |
| <p>Each sample is an image (in 3D NDArray) with shape (28, 28, 1).</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name"/> |
| <col class="field-body"/> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
| <li><strong>root</strong> (<em>str, default '~/.mxnet/datasets/fashion-mnist'</em>) – Path to temp folder for storing data.</li> |
| <li><strong>train</strong> (<em>bool, default True</em>) – Whether to load the training or testing set.</li> |
| <li><strong>transform</strong> (<em>function, default None</em>) – A user defined callback that transforms each sample. For example:</li> |
| </ul> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <dl class="docutils"> |
| <dt>:param :</dt> |
| <dd>transform=lambda data, label: (data.astype(np.float32)/255, label)</dd> |
| </dl> |
| <p>:type : :</p> |
| </dd></dl> |
| <dl class="class"> |
| <dt id="mxnet.gluon.data.vision.CIFAR10"> |
| <em class="property">class </em><code class="descclassname">mxnet.gluon.data.vision.</code><code class="descname">CIFAR10</code><span class="sig-paren">(</span><em>root='~/.mxnet/datasets/cifar10'</em>, <em>train=True</em>, <em>transform=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/data/vision.html#CIFAR10"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.data.vision.CIFAR10" title="Permalink to this definition">¶</a></dt> |
| <dd><p>CIFAR10 image classification dataset from <a class="reference external" href="https://www.cs.toronto.edu/~kriz/cifar.html">https://www.cs.toronto.edu/~kriz/cifar.html</a></p> |
| <p>Each sample is an image (in 3D NDArray) with shape (32, 32, 1).</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name"/> |
| <col class="field-body"/> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
| <li><strong>root</strong> (<em>str, default '~/.mxnet/datasets/cifar10'</em>) – Path to temp folder for storing data.</li> |
| <li><strong>train</strong> (<em>bool, default True</em>) – Whether to load the training or testing set.</li> |
| <li><strong>transform</strong> (<em>function, default None</em>) – A user defined callback that transforms each sample. For example:</li> |
| </ul> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <dl class="docutils"> |
| <dt>:param :</dt> |
| <dd>transform=lambda data, label: (data.astype(np.float32)/255, label)</dd> |
| </dl> |
| <p>:type : :</p> |
| </dd></dl> |
| <dl class="class"> |
| <dt id="mxnet.gluon.data.vision.CIFAR100"> |
| <em class="property">class </em><code class="descclassname">mxnet.gluon.data.vision.</code><code class="descname">CIFAR100</code><span class="sig-paren">(</span><em>root='~/.mxnet/datasets/cifar100'</em>, <em>fine_label=False</em>, <em>train=True</em>, <em>transform=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/data/vision.html#CIFAR100"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.data.vision.CIFAR100" title="Permalink to this definition">¶</a></dt> |
| <dd><p>CIFAR100 image classification dataset from <a class="reference external" href="https://www.cs.toronto.edu/~kriz/cifar.html">https://www.cs.toronto.edu/~kriz/cifar.html</a></p> |
| <p>Each sample is an image (in 3D NDArray) with shape (32, 32, 1).</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name"/> |
| <col class="field-body"/> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
| <li><strong>root</strong> (<em>str, default '~/.mxnet/datasets/cifar100'</em>) – Path to temp folder for storing data.</li> |
| <li><strong>fine_label</strong> (<em>bool, default False</em>) – Whether to load the fine-grained (100 classes) or coarse-grained (20 super-classes) labels.</li> |
| <li><strong>train</strong> (<em>bool, default True</em>) – Whether to load the training or testing set.</li> |
| <li><strong>transform</strong> (<em>function, default None</em>) – A user defined callback that transforms each sample. For example:</li> |
| </ul> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <dl class="docutils"> |
| <dt>:param :</dt> |
| <dd>transform=lambda data, label: (data.astype(np.float32)/255, label)</dd> |
| </dl> |
| <p>:type : :</p> |
| </dd></dl> |
| <dl class="class"> |
| <dt id="mxnet.gluon.data.vision.ImageRecordDataset"> |
| <em class="property">class </em><code class="descclassname">mxnet.gluon.data.vision.</code><code class="descname">ImageRecordDataset</code><span class="sig-paren">(</span><em>filename</em>, <em>flag=1</em>, <em>transform=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/data/vision.html#ImageRecordDataset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.data.vision.ImageRecordDataset" title="Permalink to this definition">¶</a></dt> |
| <dd><p>A dataset wrapping over a RecordIO file containing images.</p> |
| <p>Each sample is an image and its corresponding label.</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name"/> |
| <col class="field-body"/> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
| <li><strong>filename</strong> (<em>str</em>) – Path to rec file.</li> |
| <li><strong>flag</strong> (<em>{0, 1}, default 1</em>) – <p>If 0, always convert images to greyscale.</p> |
| <p>If 1, always convert images to colored (RGB).</p> |
| </li> |
| <li><strong>transform</strong> (<em>function, default None</em>) – A user defined callback that transforms each sample. For example:</li> |
| </ul> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <dl class="docutils"> |
| <dt>:param :</dt> |
| <dd>transform=lambda data, label: (data.astype(np.float32)/255, label)</dd> |
| </dl> |
| <p>:type : :</p> |
| </dd></dl> |
| <dl class="class"> |
| <dt id="mxnet.gluon.data.vision.ImageFolderDataset"> |
| <em class="property">class </em><code class="descclassname">mxnet.gluon.data.vision.</code><code class="descname">ImageFolderDataset</code><span class="sig-paren">(</span><em>root</em>, <em>flag=1</em>, <em>transform=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mxnet/gluon/data/vision.html#ImageFolderDataset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mxnet.gluon.data.vision.ImageFolderDataset" title="Permalink to this definition">¶</a></dt> |
| <dd><p>A dataset for loading image files stored in a folder structure like:</p> |
| <div class="highlight-python"><div class="highlight"><pre><span></span>root/car/0001.jpg |
| root/car/xxxa.jpg |
| root/car/yyyb.jpg |
| root/bus/123.jpg |
| root/bus/023.jpg |
| root/bus/wwww.jpg |
| </pre></div> |
| </div> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name"/> |
| <col class="field-body"/> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
| <li><strong>root</strong> (<em>str</em>) – Path to root directory.</li> |
| <li><strong>flag</strong> (<em>{0, 1}, default 1</em>) – If 0, always convert loaded images to greyscale (1 channel). |
| If 1, always convert loaded images to colored (3 channels).</li> |
| <li><strong>transform</strong> (<em>callable, default None</em>) – A function that takes data and label and transforms them:</li> |
| </ul> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <dl class="docutils"> |
| <dt>:param :</dt> |
| <dd>transform = lambda data, label: (data.astype(np.float32)/255, label)</dd> |
| </dl> |
| <p>:type : :</p> |
| <dl class="attribute"> |
| <dt id="mxnet.gluon.data.vision.ImageFolderDataset.synsets"> |
| <code class="descname">synsets</code><a class="headerlink" href="#mxnet.gluon.data.vision.ImageFolderDataset.synsets" title="Permalink to this definition">¶</a></dt> |
| <dd><p><em>list</em></p> |
| <p>List of class names. <cite>synsets[i]</cite> is the name for the integer label <cite>i</cite></p> |
| </dd></dl> |
| <dl class="attribute"> |
| <dt id="mxnet.gluon.data.vision.ImageFolderDataset.items"> |
| <code class="descname">items</code><a class="headerlink" href="#mxnet.gluon.data.vision.ImageFolderDataset.items" title="Permalink to this definition">¶</a></dt> |
| <dd><p><em>list of tuples</em></p> |
| <p>List of all images in (filename, label) pairs.</p> |
| </dd></dl> |
| </dd></dl> |
| <script>auto_index("api-reference");</script></div> |
| </div> |
| </div> |
| </div> |
| <div aria-label="main navigation" class="sphinxsidebar rightsidebar" role="navigation"> |
| <div class="sphinxsidebarwrapper"> |
| <h3><a href="../../../index.html">Table Of Contents</a></h3> |
| <ul> |
| <li><a class="reference internal" href="#">Gluon Data API</a><ul> |
| <li><a class="reference internal" href="#overview">Overview</a></li> |
| <li><a class="reference internal" href="#data">Data</a><ul> |
| <li><a class="reference internal" href="#vision">Vision</a></li> |
| </ul> |
| </li> |
| <li><a class="reference internal" href="#api-reference">API Reference</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div><div class="footer"> |
| <div class="section-disclaimer"> |
| <div class="container"> |
| <div> |
| <img height="60" src="https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/image/apache_incubator_logo.png"/> |
| <p> |
| Apache MXNet is an effort undergoing incubation at The Apache Software Foundation (ASF), <strong>sponsored by the <i>Apache Incubator</i></strong>. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF. |
| </p> |
| <p> |
| "Copyright © 2017, The Apache Software Foundation |
| Apache MXNet, MXNet, Apache, the Apache feather, and the Apache MXNet project logo are either registered trademarks or trademarks of the Apache Software Foundation." |
| </p> |
| </div> |
| </div> |
| </div> |
| </div> <!-- pagename != index --> |
| </div> |
| <script crossorigin="anonymous" integrity="sha384-0mSbJDEHialfmuBBQP6A4Qrprq5OVfW37PRR3j5ELqxss1yVqOtnepnHVP9aJ7xS" src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/js/bootstrap.min.js"></script> |
| <script src="../../../_static/js/sidebar.js" type="text/javascript"></script> |
| <script src="../../../_static/js/search.js" type="text/javascript"></script> |
| <script src="../../../_static/js/navbar.js" type="text/javascript"></script> |
| <script src="../../../_static/js/clipboard.min.js" type="text/javascript"></script> |
| <script src="../../../_static/js/copycode.js" type="text/javascript"></script> |
| <script src="../../../_static/js/page.js" type="text/javascript"></script> |
| <script type="text/javascript"> |
| $('body').ready(function () { |
| $('body').css('visibility', 'visible'); |
| }); |
| </script> |
| </body> |
| </html> |