blob: 660fbb1a047bb515a49bf1c6e508d8c208b8a66f [file] [log] [blame]
<!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::DataBatch Struct 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&amp;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&amp;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="structmxnet_1_1DataBatch.html">DataBatch</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structmxnet_1_1DataBatch-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mxnet::DataBatch Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><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></p>
<p><code>#include &lt;<a class="el" href="include_2mxnet_2io_8h_source.html">io.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for mxnet::DataBatch:</div>
<div class="dyncontent">
<div class="center"><img src="structmxnet_1_1DataBatch__coll__graph.png" border="0" usemap="#mxnet_1_1DataBatch_coll__map" alt="Collaboration graph"/></div>
<!-- MAP 0 -->
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:acc98dd6f48816ca7462352a929e48959"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1DataBatch.html#acc98dd6f48816ca7462352a929e48959">data</a></td></tr>
<tr class="memdesc:acc98dd6f48816ca7462352a929e48959"><td class="mdescLeft">&#160;</td><td class="mdescRight">content of dense data, if this <a class="el" href="structmxnet_1_1DataBatch.html" title="DataBatch of NDArray, returned by Iterator.">DataBatch</a> is dense <a href="structmxnet_1_1DataBatch.html#acc98dd6f48816ca7462352a929e48959">More...</a><br /></td></tr>
<tr class="separator:acc98dd6f48816ca7462352a929e48959"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a26a2ca473161c2c2a914cbc7ae4eb74e"><td class="memItemLeft" align="right" valign="top">std::vector&lt; uint64_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1DataBatch.html#a26a2ca473161c2c2a914cbc7ae4eb74e">index</a></td></tr>
<tr class="memdesc:a26a2ca473161c2c2a914cbc7ae4eb74e"><td class="mdescLeft">&#160;</td><td class="mdescRight">index of image data <a href="structmxnet_1_1DataBatch.html#a26a2ca473161c2c2a914cbc7ae4eb74e">More...</a><br /></td></tr>
<tr class="separator:a26a2ca473161c2c2a914cbc7ae4eb74e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e9faeff00dd061f04a88c3ea5758aa2"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1DataBatch.html#a2e9faeff00dd061f04a88c3ea5758aa2">extra_data</a></td></tr>
<tr class="memdesc:a2e9faeff00dd061f04a88c3ea5758aa2"><td class="mdescLeft">&#160;</td><td class="mdescRight">extra data to be fed to the network <a href="structmxnet_1_1DataBatch.html#a2e9faeff00dd061f04a88c3ea5758aa2">More...</a><br /></td></tr>
<tr class="separator:a2e9faeff00dd061f04a88c3ea5758aa2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad93df826690100bb16689952fc83558"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1DataBatch.html#aad93df826690100bb16689952fc83558">num_batch_padd</a></td></tr>
<tr class="memdesc:aad93df826690100bb16689952fc83558"><td class="mdescLeft">&#160;</td><td class="mdescRight">num of example padded to batch <a href="structmxnet_1_1DataBatch.html#aad93df826690100bb16689952fc83558">More...</a><br /></td></tr>
<tr class="separator:aad93df826690100bb16689952fc83558"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><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. </p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="acc98dd6f48816ca7462352a929e48959"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc98dd6f48816ca7462352a929e48959">&#9670;&nbsp;</a></span>data</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;<a class="el" href="classmxnet_1_1NDArray.html">NDArray</a>&gt; mxnet::DataBatch::data</td>
</tr>
</table>
</div><div class="memdoc">
<p>content of dense data, if this <a class="el" href="structmxnet_1_1DataBatch.html" title="DataBatch of NDArray, returned by Iterator.">DataBatch</a> is dense </p>
</div>
</div>
<a id="a2e9faeff00dd061f04a88c3ea5758aa2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2e9faeff00dd061f04a88c3ea5758aa2">&#9670;&nbsp;</a></span>extra_data</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string mxnet::DataBatch::extra_data</td>
</tr>
</table>
</div><div class="memdoc">
<p>extra data to be fed to the network </p>
</div>
</div>
<a id="a26a2ca473161c2c2a914cbc7ae4eb74e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a26a2ca473161c2c2a914cbc7ae4eb74e">&#9670;&nbsp;</a></span>index</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;uint64_t&gt; mxnet::DataBatch::index</td>
</tr>
</table>
</div><div class="memdoc">
<p>index of image data </p>
</div>
</div>
<a id="aad93df826690100bb16689952fc83558"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad93df826690100bb16689952fc83558">&#9670;&nbsp;</a></span>num_batch_padd</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mxnet::DataBatch::num_batch_padd</td>
</tr>
</table>
</div><div class="memdoc">
<p>num of example padded to batch </p>
</div>
</div>
<hr/>The documentation for this struct 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 &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>