| <!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 http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.13"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>mxnet: /work/mxnet/include/mxnet/io.h File Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></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 cellspacing="0" cellpadding="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.13 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| </script> |
| <div id="main-nav"></div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <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 <vector></code><br /> |
| <code>#include <string></code><br /> |
| <code>#include <utility></code><br /> |
| <code>#include <queue></code><br /> |
| <code>#include "<a class="el" href="data_8h_source.html">dmlc/data.h</a>"</code><br /> |
| <code>#include "<a class="el" href="3rdparty_2dmlc-core_2include_2dmlc_2registry_8h_source.html">dmlc/registry.h</a>"</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 src="include_2mxnet_2io_8h__incl.png" border="0" usemap="#_2work_2mxnet_2include_2mxnet_2io_8h" alt=""/></div> |
| <map name="_2work_2mxnet_2include_2mxnet_2io_8h" id="_2work_2mxnet_2include_2mxnet_2io_8h"> |
| <area shape="rect" id="node6" href="data_8h.html" title="defines common input data structure, and interface for handling the input data " alt="" coords="543,393,641,420"/> |
| <area shape="rect" id="node23" href="3rdparty_2dmlc-core_2include_2dmlc_2registry_8h.html" title="./registry.h" alt="" coords="744,468,835,495"/> |
| <area shape="rect" id="node39" href="include_2mxnet_2base_8h.html" title="./base.h" alt="" coords="2682,244,2755,271"/> |
| <area shape="rect" id="node47" href="include_2mxnet_2ndarray_8h.html" title="./ndarray.h" alt="" coords="2955,95,3045,121"/> |
| <area shape="rect" id="node8" href="3rdparty_2dmlc-core_2include_2dmlc_2base_8h.html" title="./base.h" alt="" coords="1107,767,1181,793"/> |
| <area shape="rect" id="node12" href="3rdparty_2dmlc-core_2include_2dmlc_2io_8h.html" title="./io.h" alt="" coords="3582,543,3637,569"/> |
| <area shape="rect" id="node11" href="build__config__default_8h.html" title="Default detection logic for fopen64 and other symbols. May be overriden by CMake. ..." alt="" coords="870,841,1071,868"/> |
| <area shape="rect" id="node19" href="serializer_8h.html" title="serializer template class that helps serialization. This file do not need to be directly used by most..." alt="" coords="2687,617,2788,644"/> |
| <area shape="rect" id="node21" href="type__traits_8h.html" title="type traits information header " alt="" coords="2441,692,2553,719"/> |
| <area shape="rect" id="node24" href="parameter_8h.html" title="Provide lightweight util to do parameter setup and checking. " alt="" coords="1751,543,1860,569"/> |
| <area shape="rect" id="node36" href="json_8h.html" title="Lightweight JSON Reader/Writer that read save into C++ data structs. This includes STL composites and..." alt="" coords="1549,617,1619,644"/> |
| <area shape="rect" id="node37" href="optional_8h.html" title="Container to hold optional data. " alt="" coords="1643,617,1738,644"/> |
| <area shape="rect" id="node38" href="strtonum_8h.html" title="A faster implementation of strtof and strtod. " alt="" coords="1120,617,1221,644"/> |
| <area shape="rect" id="node40" href="tensor_8h.html" title="header file of tensor data structure and functions This lib requires explicit memory allocation and d..." alt="" coords="752,617,893,644"/> |
| <area shape="rect" id="node41" href="op_8h.html" title="Operator information structor. " alt="" coords="2636,468,2727,495"/> |
| <area shape="rect" id="node42" href="symbolic_8h.html" title="Symbolic graph construction API. " alt="" coords="3137,319,3271,345"/> |
| <area shape="rect" id="node45" href="libinfo_8h.html" title="get features of the MXNet library at runtime " alt="" coords="2719,393,2793,420"/> |
| <area shape="rect" id="node46" href="include_2mxnet_2tuple_8h.html" title="Data structure Tuple and TShape to store dynamic sized shapes. " alt="" coords="3217,617,3284,644"/> |
| <area shape="rect" id="node43" href="3rdparty_2tvm_2nnvm_2include_2nnvm_2node_8h.html" title="Graph node data structure. " alt="" coords="3065,393,3132,420"/> |
| <area shape="rect" id="node49" href="storage_8h.html" title="Storage manager across multiple devices. " alt="" coords="3136,169,3227,196"/> |
| <area shape="rect" id="node50" href="engine_8h.html" title="Engine that schedules all the operations according to dependency. " alt="" coords="3481,169,3567,196"/> |
| </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 class="memItemLeft" align="right" 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 class="memItemLeft" align="right" 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 class="memItemLeft" align="right" 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 class="memItemLeft" align="right" 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 class="memItemLeft" align="right" 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 class="memItemLeft" align="right" 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)   <a class="el" href="3rdparty_2dmlc-core_2include_2dmlc_2registry_8h.html#af6870c3bce5b56d427a4d225b1194816">DMLC_REGISTRY_REGISTER</a>(::<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 class="memItemLeft" align="right" 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 id="ad3d0e409cb072cac4a1eb93ee390077b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad3d0e409cb072cac4a1eb93ee390077b">◆ </a></span>MXNET_REGISTER_IO_ITER</h2> |
| |
| <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>   <a class="el" href="3rdparty_2dmlc-core_2include_2dmlc_2registry_8h.html#af6870c3bce5b56d427a4d225b1194816">DMLC_REGISTRY_REGISTER</a>(::<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"><span class="comment">// example of registering a mnist iterator</span></div><div class="line">REGISTER_IO_ITE(MNISTIter)</div><div class="line">.describe(<span class="stringliteral">"Mnist data iterator"</span>)</div><div class="line">.set_body([]() {</div><div class="line"> <span class="keywordflow">return</span> <span class="keyword">new</span> PrefetcherIter(<span class="keyword">new</span> MNISTIter());</div><div class="line"> });</div></div><!-- fragment --> |
| </div> |
| </div> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 5 2023 00:58:42 for mxnet by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.13 |
| </small></address> |
| </body> |
| </html> |
