| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>mxnet: mxnet::Dataset Class 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.17 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</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="namespacemxnet.html">mxnet</a></li><li class="navelem"><a class="el" href="classmxnet_1_1Dataset.html">Dataset</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classmxnet_1_1Dataset-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">mxnet::Dataset Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A random accessable dataset which provides <a class="el" href="classmxnet_1_1Dataset.html#a8550593570031a697f75511a5cb36004" title="Get the size of the dataset.">GetLen()</a> and <a class="el" href="classmxnet_1_1Dataset.html#a3c339ebde8d952c374b85685f1eebc77" title="Get the ndarray items given index in dataset.">GetItem()</a>. Unlike DataIter, it's a static lookup storage which is friendly to random access. The dataset itself should NOT contain data processing, which should be applied during data augmentation or transformation processes. |
| <a href="classmxnet_1_1Dataset.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="include_2mxnet_2io_8h_source.html">io.h</a>></code></p> |
| <div class="dynheader"> |
| Collaboration diagram for mxnet::Dataset:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classmxnet_1_1Dataset__coll__graph.png" border="0" usemap="#mxnet_1_1Dataset_coll__map" alt="Collaboration graph"/></div> |
| <!-- MAP 0 --> |
| </div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a8550593570031a697f75511a5cb36004"><td class="memItemLeft" align="right" valign="top">virtual uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Dataset.html#a8550593570031a697f75511a5cb36004">GetLen</a> (void) const =0</td></tr> |
| <tr class="memdesc:a8550593570031a697f75511a5cb36004"><td class="mdescLeft"> </td><td class="mdescRight">Get the size of the dataset. <a href="classmxnet_1_1Dataset.html#a8550593570031a697f75511a5cb36004">More...</a><br /></td></tr> |
| <tr class="separator:a8550593570031a697f75511a5cb36004"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3c339ebde8d952c374b85685f1eebc77"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Dataset.html#a3c339ebde8d952c374b85685f1eebc77">GetItem</a> (uint64_t idx, std::vector< <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> > *ret)=0</td></tr> |
| <tr class="memdesc:a3c339ebde8d952c374b85685f1eebc77"><td class="mdescLeft"> </td><td class="mdescRight">Get the ndarray items given index in dataset. <a href="classmxnet_1_1Dataset.html#a3c339ebde8d952c374b85685f1eebc77">More...</a><br /></td></tr> |
| <tr class="separator:a3c339ebde8d952c374b85685f1eebc77"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a095b35669c096d79f78fef0001928dc7"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Dataset.html#a095b35669c096d79f78fef0001928dc7">~Dataset</a> (void)</td></tr> |
| <tr class="separator:a095b35669c096d79f78fef0001928dc7"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>A random accessable dataset which provides <a class="el" href="classmxnet_1_1Dataset.html#a8550593570031a697f75511a5cb36004" title="Get the size of the dataset.">GetLen()</a> and <a class="el" href="classmxnet_1_1Dataset.html#a3c339ebde8d952c374b85685f1eebc77" title="Get the ndarray items given index in dataset.">GetItem()</a>. Unlike DataIter, it's a static lookup storage which is friendly to random access. The dataset itself should NOT contain data processing, which should be applied during data augmentation or transformation processes. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a095b35669c096d79f78fef0001928dc7"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a095b35669c096d79f78fef0001928dc7">◆ </a></span>~Dataset()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual mxnet::Dataset::~Dataset </td> |
| <td>(</td> |
| <td class="paramtype">void </td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a3c339ebde8d952c374b85685f1eebc77"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3c339ebde8d952c374b85685f1eebc77">◆ </a></span>GetItem()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual bool mxnet::Dataset::GetItem </td> |
| <td>(</td> |
| <td class="paramtype">uint64_t </td> |
| <td class="paramname"><em>idx</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::vector< <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> > * </td> |
| <td class="paramname"><em>ret</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the ndarray items given index in dataset. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">idx</td><td>the integer index for required data </td></tr> |
| <tr><td class="paramname">ret</td><td>the returned ndarray items </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a8550593570031a697f75511a5cb36004"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8550593570031a697f75511a5cb36004">◆ </a></span>GetLen()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual uint64_t mxnet::Dataset::GetLen </td> |
| <td>(</td> |
| <td class="paramtype">void </td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the size of the dataset. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>/work/mxnet/include/mxnet/<a class="el" href="include_2mxnet_2io_8h_source.html">io.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 5 2023 03:47:41 for mxnet by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.17 |
| </small></address> |
| </body> |
| </html> |