| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta content="text/xhtml;charset=utf-8" http-equiv="Content-Type"/> |
| <meta content="IE=9" http-equiv="X-UA-Compatible"/> |
| <meta content="Doxygen 1.8.11" name="generator"/> |
| <title>mxnet: include/mxnet/io.h File Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script src="jquery.js" type="text/javascript"></script> |
| <script src="dynsections.js" type="text/javascript"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script src="search/searchdata.js" type="text/javascript"></script> |
| <script src="search/search.js" type="text/javascript"></script> |
| <script type="text/javascript"> |
| $(document).ready(function() { init_search(); }); |
| </script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css"/> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellpadding="0" cellspacing="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">mxnet |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.11 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <div class="tabs" id="navrow1"> |
| <ul class="tablist"> |
| <li><a href="index.html"><span>Main Page</span></a></li> |
| <li><a href="namespaces.html"><span>Namespaces</span></a></li> |
| <li><a href="annotated.html"><span>Classes</span></a></li> |
| <li class="current"><a href="files.html"><span>Files</span></a></li> |
| <li> |
| <div class="MSearchBoxInactive" id="MSearchBox"> |
| <span class="left"> |
| <img alt="" id="MSearchSelect" onmouseout="return searchBox.OnSearchSelectHide()" onmouseover="return searchBox.OnSearchSelectShow()" src="search/mag_sel.png"/> |
| <input accesskey="S" id="MSearchField" onblur="searchBox.OnSearchFieldFocus(false)" onfocus="searchBox.OnSearchFieldFocus(true)" onkeyup="searchBox.OnSearchFieldChange(event)" type="text" value="Search"/> |
| </span><span class="right"> |
| <a href="javascript:searchBox.CloseResultsWindow()" id="MSearchClose"><img alt="" border="0" id="MSearchCloseImg" src="search/close.png"/></a> |
| </span> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="tabs2" id="navrow2"> |
| <ul class="tablist"> |
| <li><a href="files.html"><span>File List</span></a></li> |
| <li><a href="globals.html"><span>File Members</span></a></li> |
| </ul> |
| </div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" onkeydown="return searchBox.OnSearchSelectKey(event)" onmouseout="return searchBox.OnSearchSelectHide()" onmouseover="return searchBox.OnSearchSelectShow()"> |
| </div> |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe frameborder="0" id="MSearchResults" name="MSearchResults" src="javascript:void(0)"> |
| </iframe> |
| </div> |
| <div class="navpath" id="nav-path"> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_1143c7affb9ebd026cb6818dd282def7.html">mxnet</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#namespaces">Namespaces</a> | |
| <a href="#define-members">Macros</a> | |
| <a href="#typedef-members">Typedefs</a> </div> |
| <div class="headertitle"> |
| <div class="title">io.h File Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="textblock"><code>#include <dmlc/data.h></code><br/> |
| <code>#include <dmlc/registry.h></code><br/> |
| <code>#include <vector></code><br/> |
| <code>#include <string></code><br/> |
| <code>#include <utility></code><br/> |
| <code>#include <queue></code><br/> |
| <code>#include "<a class="el" href="include_2mxnet_2base_8h_source.html">./base.h</a>"</code><br/> |
| <code>#include "<a class="el" href="include_2mxnet_2ndarray_8h_source.html">./ndarray.h</a>"</code><br/> |
| </div><div class="textblock"><div class="dynheader"> |
| Include dependency graph for io.h:</div> |
| <div class="dyncontent"> |
| <div class="center"><img alt="" border="0" src="include_2mxnet_2io_8h__incl.png" usemap="#include_2mxnet_2io_8h"/></div> |
| <map id="include_2mxnet_2io_8h" name="include_2mxnet_2io_8h"> |
| <area alt="" coords="739,229,813,256" href="include_2mxnet_2base_8h.html" id="node8" shape="rect" title="./base.h"/> |
| <area alt="" coords="774,80,863,107" href="include_2mxnet_2ndarray_8h.html" id="node17" shape="rect" title="./ndarray.h"/> |
| <area alt="" coords="579,155,669,181" href="storage_8h.html" id="node22" shape="rect" title="Storage manager across multiple devices. "/> |
| <area alt="" coords="419,155,504,181" href="engine_8h.html" id="node23" shape="rect" title="Engine that schedules all the operations according to dependency. "/> |
| </map> |
| </div> |
| </div> |
| <p><a href="include_2mxnet_2io_8h_source.html">Go to the source code of this file.</a></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> |
| Classes</h2></td></tr> |
| <tr class="memitem:"><td align="right" class="memItemLeft" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1IIterator.html">mxnet::IIterator< DType ></a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">iterator type <a href="classmxnet_1_1IIterator.html#details">More...</a><br/></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td align="right" class="memItemLeft" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1DataInst.html">mxnet::DataInst</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">a single data instance <a href="structmxnet_1_1DataInst.html#details">More...</a><br/></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td align="right" class="memItemLeft" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1DataBatch.html">mxnet::DataBatch</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structmxnet_1_1DataBatch.html" title="DataBatch of NDArray, returned by Iterator. ">DataBatch</a> of <a class="el" href="classmxnet_1_1NDArray.html" title="ndarray interface ">NDArray</a>, returned by Iterator. <a href="structmxnet_1_1DataBatch.html#details">More...</a><br/></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td align="right" class="memItemLeft" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1DataIteratorReg.html">mxnet::DataIteratorReg</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Registry entry for DataIterator factory functions. <a href="structmxnet_1_1DataIteratorReg.html#details">More...</a><br/></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a> |
| Namespaces</h2></td></tr> |
| <tr class="memitem:namespacemxnet"><td align="right" class="memItemLeft" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet.html">mxnet</a></td></tr> |
| <tr class="memdesc:namespacemxnet"><td class="mdescLeft"> </td><td class="mdescRight">namespace of mxnet <br/></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> |
| Macros</h2></td></tr> |
| <tr class="memitem:ad3d0e409cb072cac4a1eb93ee390077b"><td align="right" class="memItemLeft" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2mxnet_2io_8h.html#ad3d0e409cb072cac4a1eb93ee390077b">MXNET_REGISTER_IO_ITER</a>(name) DMLC_REGISTRY_REGISTER(::<a class="el" href="structmxnet_1_1DataIteratorReg.html">mxnet::DataIteratorReg</a>, DataIteratorReg, name)</td></tr> |
| <tr class="memdesc:ad3d0e409cb072cac4a1eb93ee390077b"><td class="mdescLeft"> </td><td class="mdescRight">Macro to register Iterators. <a href="#ad3d0e409cb072cac4a1eb93ee390077b">More...</a><br/></td></tr> |
| <tr class="separator:ad3d0e409cb072cac4a1eb93ee390077b"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> |
| Typedefs</h2></td></tr> |
| <tr class="memitem:a6dca73c81706d54b0ddb0ef967d1e132"><td align="right" class="memItemLeft" valign="top">typedef std::function< IIterator< DataBatch > *()> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet.html#a6dca73c81706d54b0ddb0ef967d1e132">mxnet::DataIteratorFactory</a></td></tr> |
| <tr class="memdesc:a6dca73c81706d54b0ddb0ef967d1e132"><td class="mdescLeft"> </td><td class="mdescRight">typedef the factory function of data iterator <a href="namespacemxnet.html#a6dca73c81706d54b0ddb0ef967d1e132">More...</a><br/></td></tr> |
| <tr class="separator:a6dca73c81706d54b0ddb0ef967d1e132"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <h2 class="groupheader">Macro Definition Documentation</h2> |
| <a class="anchor" id="ad3d0e409cb072cac4a1eb93ee390077b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define MXNET_REGISTER_IO_ITER</td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname">name</td><td>)</td> |
| <td> DMLC_REGISTRY_REGISTER(::<a class="el" href="structmxnet_1_1DataIteratorReg.html">mxnet::DataIteratorReg</a>, DataIteratorReg, name)</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Macro to register Iterators. </p> |
| <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> // example of registering a mnist iterator</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> REGISTER_IO_ITE(MNISTIter)</div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> .describe("Mnist data iterator")</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> .set_body([]() {</div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> return new PrefetcherIter(new MNISTIter());</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> });</div></div><!-- fragment --> |
| </div> |
| </div> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Sep 19 2019 13:11:20 for mxnet by <a href="http://www.doxygen.org/index.html"> |
| <img alt="doxygen" class="footer" src="doxygen.png"/> |
| </a> 1.8.11 |
| </small></address> |
| </body> |
| </html> |