Skip to content

P
Paddle

PaddlePaddle / Paddle
大约 1 年 前同步成功

通知 2299
Star 20931
Fork 5422
P
Paddle
切换分支/标签
查找文件 普通视图历史永久链接Permalink
dataproviders.html 116.0 KB
Newer Older
Y
Update docs  
Yu Yang 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 
<!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/html; charset=utf-8" />
    
    <title>Data Providers &mdash; PaddlePaddle  documentation</title>
    
    <link rel="stylesheet" href="../../../_static/classic.css" type="text/css" />
    <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../../../',
        VERSION:     '',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </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 rel="top" title="PaddlePaddle  documentation" href="../../../index.html" />
    <link rel="up" title="Data Providers Documents" href="index.html" />
    <link rel="next" title="Evaluators" href="../evaluators/index.html" />
    <link rel="prev" title="Data Providers Documents" href="index.html" /> 
  </head>
  <body role="document">
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../../../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="../evaluators/index.html" title="Evaluators"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="index.html" title="Data Providers Documents"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../../../index.html">PaddlePaddle  documentation</a> &raquo;</li>
          <li class="nav-item nav-item-1"><a href="../../index.html" >Source Code Documents</a> &raquo;</li>
          <li class="nav-item nav-item-2"><a href="index.html" accesskey="U">Data Providers Documents</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="data-providers">
<h1>Data Providers<a class="headerlink" href="#data-providers" title="Permalink to this headline"></a></h1>
Y
Upload docs  
Yu Yang 已提交
61 62 
<div class="section" id="base-dataprovider">
<h2>Base DataProvider<a class="headerlink" href="#base-dataprovider" title="Permalink to this headline"></a></h2>
Y
Update docs  
Yu Yang 已提交
63 64 
<dl class="class">
<dt id="_CPPv2N6paddle12DataProviderE">
Y
Upload docs  
Yu Yang 已提交
65 66 67 68 69 70 71 72 
<span id="paddle::DataProvider"></span><span class="target" id="paddleclasspaddle_1_1DataProvider"></span><em class="property">class </em><code class="descclassname">paddle::</code><code class="descname">DataProvider</code><a class="headerlink" href="#_CPPv2N6paddle12DataProviderE" title="Permalink to this definition"></a></dt>
<dd><p>Base class for <a class="reference internal" href="#paddleclasspaddle_1_1DataProvider"><span>DataProvider</span></a>, which supplies data for training. </p>
<p><dl class="docutils">
<dt><strong>Note</strong></dt>
<dd>It can supplies multiple streams of data. For typical supervised training, there are two streams: one is for input, one is for label. </dd>
</dl>
</p>
<p>Subclassed by <a class="reference internal" href="#paddleclasspaddle_1_1DataProviderGroup"><span>paddle::DataProviderGroup&lt; T &gt;</span></a>, paddle::DummyDataProvider, <a class="reference internal" href="#paddleclasspaddle_1_1MultiDataProvider"><span>paddle::MultiDataProvider</span></a>, <a class="reference internal" href="#paddleclasspaddle_1_1ProtoDataProvider"><span>paddle::ProtoDataProvider</span></a>, paddle::PyDataProvider, <a class="reference internal" href="#paddleclasspaddle_1_1PyDataProvider2"><span>paddle::PyDataProvider2</span></a>, paddle::SimpleDataProviderBase</p>
Y
Update docs  
Yu Yang 已提交
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 
<div class="breathe-sectiondef container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
<dt id="_CPPv2N6paddle12DataProvider12DataProviderERK10DataConfigb">
<span id="paddle::DataProvider::DataProvider__DataConfigCR.b"></span><span class="target" id="paddleclasspaddle_1_1DataProvider_1a1d4d25a193d3b5d0cf53290397433bae"></span><code class="descname">DataProvider</code><span class="sig-paren">(</span><em class="property">const</em> DataConfig &amp;<em>config</em>, bool <em>useGpu</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle12DataProvider12DataProviderERK10DataConfigb" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="_CPPv2N6paddle12DataProviderD0Ev">
<span id="paddle::DataProvider::~DataProvider"></span>virtual <span class="target" id="paddleclasspaddle_1_1DataProvider_1ad2a097382fe910162dbc4a463c048ed3"></span><code class="descname">~DataProvider</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle12DataProviderD0Ev" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="_CPPv2N6paddle12DataProvider9getConfigEv">
<span id="paddle::DataProvider::getConfig"></span><span class="target" id="paddleclasspaddle_1_1DataProvider_1ad10ab1112a6af0e1f84c335c56df8252"></span><em class="property">const</em> DataConfig &amp;<code class="descname">getConfig</code><span class="sig-paren">(</span><span class="sig-paren">)</span> const<a class="headerlink" href="#_CPPv2N6paddle12DataProvider9getConfigEv" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="_CPPv2N6paddle12DataProvider14setSkipShuffleEv">
<span id="paddle::DataProvider::setSkipShuffle"></span><span class="target" id="paddleclasspaddle_1_1DataProvider_1a3fb79f4e6f497de18710bfbd2cd7eea4"></span>void <code class="descname">setSkipShuffle</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle12DataProvider14setSkipShuffleEv" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="_CPPv2N6paddle12DataProvider12getNextBatchE7int64_tP9DataBatch">
Y
Upload docs  
Yu Yang 已提交
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 
<span id="paddle::DataProvider::getNextBatch__int64_t.DataBatchP"></span><span class="target" id="paddleclasspaddle_1_1DataProvider_1a98d9d269b628ac7c8354a8a7de049a7b"></span>int64_t <code class="descname">getNextBatch</code><span class="sig-paren">(</span>int64_t <em>size</em>, DataBatch *<em>batch</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle12DataProvider12getNextBatchE7int64_tP9DataBatch" title="Permalink to this definition"></a></dt>
<dd><p>Get next batch of training samples. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
<dd>actual size of obtained training samples </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">size</span></code> - <p>size of training samples to get </p>
</li>
<li><code class="first docutils literal"><span class="pre">batch</span></code> - <p>a batch of training samples </p>
</li>
</ul>
</dd>
</dl>
</p>
</dd></dl>
Y
Update docs  
Yu Yang 已提交
113 114 115 116 

<dl class="function">
<dt id="_CPPv2N6paddle12DataProvider7shuffleEv">
<span id="paddle::DataProvider::shuffle"></span>virtual <span class="target" id="paddleclasspaddle_1_1DataProvider_1a7b05642e64f7ed4c15e7b82aa93ac38a"></span>void <code class="descname">shuffle</code><span class="sig-paren">(</span><span class="sig-paren">)</span> = 0<a class="headerlink" href="#_CPPv2N6paddle12DataProvider7shuffleEv" title="Permalink to this definition"></a></dt>
Y
Upload docs  
Yu Yang 已提交
117 
<dd><p>Shuffle the data set. </p>
Y
Update docs  
Yu Yang 已提交
118 119 120 121 122 
</dd></dl>

<dl class="function">
<dt id="_CPPv2N6paddle12DataProvider5resetEv">
<span id="paddle::DataProvider::reset"></span>virtual <span class="target" id="paddleclasspaddle_1_1DataProvider_1a0c1ec00a365e8cd12ad170ac00879890"></span>void <code class="descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle12DataProvider5resetEv" title="Permalink to this definition"></a></dt>
Y
Upload docs  
Yu Yang 已提交
123 124 125 126 127 128 
<dd><p>reset all the value of index </p>
<p><dl class="docutils">
<dt><strong>Note</strong></dt>
<dd><a class="reference internal" href="#paddleclasspaddle_1_1DataProvider_1a0c1ec00a365e8cd12ad170ac00879890"><span>reset()</span></a> must be called before any calls to <a class="reference internal" href="#paddleclasspaddle_1_1DataProvider_1a98d9d269b628ac7c8354a8a7de049a7b"><span>getNextBatch()</span></a> IMPORTANT: subclass <a class="reference internal" href="#paddleclasspaddle_1_1DataProvider_1a0c1ec00a365e8cd12ad170ac00879890"><span>reset()</span></a> should always call the base class <a class="reference internal" href="#paddleclasspaddle_1_1DataProvider_1a0c1ec00a365e8cd12ad170ac00879890"><span>reset()</span></a> at the end of the function </dd>
</dl>
</p>
Y
Update docs  
Yu Yang 已提交
129 130 131 132 133 
</dd></dl>

<dl class="function">
<dt id="_CPPv2N6paddle12DataProvider7getSizeEv">
<span id="paddle::DataProvider::getSize"></span>virtual <span class="target" id="paddleclasspaddle_1_1DataProvider_1a383104e591e2f95f959bbf45c4d06b2e"></span>int64_t <code class="descname">getSize</code><span class="sig-paren">(</span><span class="sig-paren">)</span> = 0<a class="headerlink" href="#_CPPv2N6paddle12DataProvider7getSizeEv" title="Permalink to this definition"></a></dt>
Y
Upload docs  
Yu Yang 已提交
134 135 136 137 138 139 140 141 
<dd><p>Get the size of training samples. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
<dd>the number of training samples in the data set. </dd>
<dt><strong>Note</strong></dt>
<dd>return -1 to indicate unlimited number of samples. </dd>
</dl>
</p>
Y
Update docs  
Yu Yang 已提交
142 143 144 145 
</dd></dl>

<dl class="function">
<dt id="_CPPv2N6paddle12DataProvider20getNextBatchInternalE7int64_tP9DataBatch">
Y
Upload docs  
Yu Yang 已提交
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 
<span id="paddle::DataProvider::getNextBatchInternal__int64_t.DataBatchP"></span>virtual <span class="target" id="paddleclasspaddle_1_1DataProvider_1a1d3a1c543b75c35e2e290512ccd2700f"></span>int64_t <code class="descname">getNextBatchInternal</code><span class="sig-paren">(</span>int64_t <em>size</em>, DataBatch *<em>batch</em><span class="sig-paren">)</span> = 0<a class="headerlink" href="#_CPPv2N6paddle12DataProvider20getNextBatchInternalE7int64_tP9DataBatch" title="Permalink to this definition"></a></dt>
<dd><p>Get next batch training samples internally. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
<dd>actual size of obtained training samples </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">size</span></code> - <p>size of training samples to get </p>
</li>
<li><code class="first docutils literal"><span class="pre">batch</span></code> - <p>a batch of training samples </p>
</li>
</ul>
</dd>
</dl>
</p>
</dd></dl>
Y
Update docs  
Yu Yang 已提交
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 

</div>
<div class="breathe-sectiondef container">
<p class="breathe-sectiondef-title rubric">Public Static Functions</p>
<dl class="function">
<dt id="_CPPv2N6paddle12DataProvider6createERK10DataConfigb">
<span id="paddle::DataProvider::create__DataConfigCR.b"></span><span class="target" id="paddleclasspaddle_1_1DataProvider_1ae6b6c293f49094fa37e06504da998248"></span><a class="reference internal" href="#_CPPv2N6paddle12DataProvider12DataProviderERK10DataConfigb" title="paddle::DataProvider::DataProvider">DataProvider</a> *<code class="descname">create</code><span class="sig-paren">(</span><em class="property">const</em> DataConfig &amp;<em>config</em>, bool <em>useGpu</em> = FLAGS_use_gpu<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle12DataProvider6createERK10DataConfigb" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

</div>
<div class="breathe-sectiondef container">
<p class="breathe-sectiondef-title rubric">Public Static Attributes</p>
<dl class="member">
<dt id="_CPPv2N6paddle12DataProvider10registrar_E">
<span id="paddle::DataProvider::registrar___ClassRegistrar:DataProvider.DataConfig.b:"></span><span class="target" id="paddleclasspaddle_1_1DataProvider_1acc7ff8754097b2ecdd6c85ba98e78e18"></span>ClassRegistrar&lt;<a class="reference internal" href="#_CPPv2N6paddle12DataProvider12DataProviderERK10DataConfigb" title="paddle::DataProvider::DataProvider">DataProvider</a>, DataConfig, bool&gt; <code class="descname">registrar_</code><a class="headerlink" href="#_CPPv2N6paddle12DataProvider10registrar_E" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

</div>
<div class="breathe-sectiondef container">
<p class="breathe-sectiondef-title rubric">Protected Functions</p>
<dl class="function">
<dt id="_CPPv2N6paddle12DataProvider22getNextBatchFromBufferE7int64_tP9DataBatch">
Y
Upload docs  
Yu Yang 已提交
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 
<span id="paddle::DataProvider::getNextBatchFromBuffer__int64_t.DataBatchP"></span><span class="target" id="paddleclasspaddle_1_1DataProvider_1a6b4a1d3ef66863f840e1ab5bafd8e2df"></span>int64_t <code class="descname">getNextBatchFromBuffer</code><span class="sig-paren">(</span>int64_t <em>size</em>, DataBatch *<em>batch</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle12DataProvider22getNextBatchFromBufferE7int64_tP9DataBatch" title="Permalink to this definition"></a></dt>
<dd><p>&#64;brief Get next batch training samples from buffer <dl class="docutils">
<dt><strong>Return</strong></dt>
<dd>actual size of obtained training samples </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">size</span></code> - <p>size of training samples to get </p>
</li>
<li><code class="first docutils literal"><span class="pre">batch</span></code> - <p>a batch of training samples </p>
</li>
</ul>
</dd>
</dl>
</p>
</dd></dl>
Y
Update docs  
Yu Yang 已提交
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 

<dl class="function">
<dt id="_CPPv2N6paddle12DataProvider15initAsyncLoaderEv">
<span id="paddle::DataProvider::initAsyncLoader"></span><span class="target" id="paddleclasspaddle_1_1DataProvider_1abf5599ca341b48aa2e773637952b2c78"></span>void <code class="descname">initAsyncLoader</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle12DataProvider15initAsyncLoaderEv" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

</div>
<div class="breathe-sectiondef container">
<p class="breathe-sectiondef-title rubric">Protected Attributes</p>
<dl class="member">
<dt id="_CPPv2N6paddle12DataProvider7config_E">
<span id="paddle::DataProvider::config___DataConfig"></span><span class="target" id="paddleclasspaddle_1_1DataProvider_1ade224ccf5a10c5e523bdab8332a677f4"></span>DataConfig <code class="descname">config_</code><a class="headerlink" href="#_CPPv2N6paddle12DataProvider7config_E" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="member">
<dt id="_CPPv2N6paddle12DataProvider12skipShuffle_E">
<span id="paddle::DataProvider::skipShuffle___b"></span><span class="target" id="paddleclasspaddle_1_1DataProvider_1a94c94d06d7c86c992a409aa05587b9dc"></span>bool <code class="descname">skipShuffle_</code><a class="headerlink" href="#_CPPv2N6paddle12DataProvider12skipShuffle_E" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="member">
<dt id="_CPPv2N6paddle12DataProvider11usageRatio_E">
<span id="paddle::DataProvider::usageRatio___float"></span><span class="target" id="paddleclasspaddle_1_1DataProvider_1ae7c9e19a48fbc9e6fa80ce18813f9ac5"></span>float <code class="descname">usageRatio_</code><a class="headerlink" href="#_CPPv2N6paddle12DataProvider11usageRatio_E" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="member">
<dt id="_CPPv2N6paddle12DataProvider7useGpu_E">
<span id="paddle::DataProvider::useGpu___b"></span><span class="target" id="paddleclasspaddle_1_1DataProvider_1adbf7a324580b811c2cbf0caa1ee08909"></span>bool <code class="descname">useGpu_</code><a class="headerlink" href="#_CPPv2N6paddle12DataProvider7useGpu_E" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="member">
<dt id="_CPPv2N6paddle12DataProvider13doubleBuffer_E">
Y
Upload docs  
Yu Yang 已提交
230 
<span id="paddle::DataProvider::doubleBuffer___std::unique_ptr:DoubleBuffer:"></span><span class="target" id="paddleclasspaddle_1_1DataProvider_1a9e5acdbe6a91bc1c3e9e191762172194"></span>std::unique_ptr&lt;DoubleBuffer&gt; <code class="descname">doubleBuffer_</code><a class="headerlink" href="#_CPPv2N6paddle12DataProvider13doubleBuffer_E" title="Permalink to this definition"></a></dt>
Y
Update docs  
Yu Yang 已提交
231 232 233 234 235 236 237 238 239 240 
<dd></dd></dl>

<dl class="member">
<dt id="_CPPv2N6paddle12DataProvider14constantSlots_E">
<span id="paddle::DataProvider::constantSlots___ThreadLocal:std::vector:MatrixPtr::"></span><span class="target" id="paddleclasspaddle_1_1DataProvider_1aafd0f8405d4a257910d5825234708a90"></span>ThreadLocal&lt;std::vector&lt;<a class="reference internal" href="../../math/matrix/matrix.html#_CPPv2N6paddle9MatrixPtrE" title="paddle::MatrixPtr">MatrixPtr</a>&gt;&gt; <code class="descname">constantSlots_</code><a class="headerlink" href="#_CPPv2N6paddle12DataProvider14constantSlots_E" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

</div>
</dd></dl>
Y
Upload docs  
Yu Yang 已提交
241 242 243 
</div>
<div class="section" id="dataprovidergroup">
<h2>DataProviderGroup<a class="headerlink" href="#dataprovidergroup" title="Permalink to this headline"></a></h2>
Y
Update docs  
Yu Yang 已提交
244 
<dl class="class">
Y
Upload docs  
Yu Yang 已提交
245 246 247 248 249 250 
<dt>
<span class="target" id="paddleclasspaddle_1_1DataProviderGroup"></span><em class="property">template </em>&lt;<em class="property">class</em> T&gt;</dt>
<dt id="_CPPv2N6paddle17DataProviderGroupE">
<span id="paddle::DataProviderGroup"></span><em class="property">class </em><code class="descclassname">paddle::</code><code class="descname">DataProviderGroup</code><a class="headerlink" href="#_CPPv2N6paddle17DataProviderGroupE" title="Permalink to this definition"></a></dt>
<dd><p>Inherits from <a class="reference internal" href="#paddleclasspaddle_1_1DataProvider"><span>paddle::DataProvider</span></a></p>
<div class="breathe-sectiondef container">
Y
Update docs  
Yu Yang 已提交
251 252 
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
Y
Upload docs  
Yu Yang 已提交
253 254 
<dt id="_CPPv2N6paddle17DataProviderGroup17DataProviderGroupERK10DataConfigb">
<span id="paddle::DataProviderGroup::DataProviderGroup__DataConfigCR.b"></span><span class="target" id="paddleclasspaddle_1_1DataProviderGroup_1aa0e72492025f4cb272fd2f53c14ec7b1"></span><code class="descname">DataProviderGroup</code><span class="sig-paren">(</span><em class="property">const</em> DataConfig &amp;<em>config</em>, bool <em>useGpu</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle17DataProviderGroup17DataProviderGroupERK10DataConfigb" title="Permalink to this definition"></a></dt>
Y
Update docs  
Yu Yang 已提交
255 256 257 
<dd></dd></dl>

<dl class="function">
Y
Upload docs  
Yu Yang 已提交
258 259 
<dt id="_CPPv2N6paddle17DataProviderGroupD0Ev">
<span id="paddle::DataProviderGroup::~DataProviderGroup"></span><span class="target" id="paddleclasspaddle_1_1DataProviderGroup_1abfb0b691ac6a4d07a92949b6ea4d5ae9"></span><code class="descname">~DataProviderGroup</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle17DataProviderGroupD0Ev" title="Permalink to this definition"></a></dt>
Y
Update docs  
Yu Yang 已提交
260 261 262 
<dd></dd></dl>

<dl class="function">
Y
Upload docs  
Yu Yang 已提交
263 264 265 266 267 268 269 270 271 
<dt id="_CPPv2N6paddle17DataProviderGroup5resetEv">
<span id="paddle::DataProviderGroup::reset"></span>virtual <span class="target" id="paddleclasspaddle_1_1DataProviderGroup_1aabc5a09dd7b80a8616108fb2f2989c21"></span>void <code class="descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle17DataProviderGroup5resetEv" title="Permalink to this definition"></a></dt>
<dd><p>reset all the value of index </p>
<p><dl class="docutils">
<dt><strong>Note</strong></dt>
<dd><a class="reference internal" href="#paddleclasspaddle_1_1DataProviderGroup_1aabc5a09dd7b80a8616108fb2f2989c21"><span>reset()</span></a> must be called before any calls to <a class="reference internal" href="#paddleclasspaddle_1_1DataProvider_1a98d9d269b628ac7c8354a8a7de049a7b"><span>getNextBatch()</span></a> IMPORTANT: subclass <a class="reference internal" href="#paddleclasspaddle_1_1DataProviderGroup_1aabc5a09dd7b80a8616108fb2f2989c21"><span>reset()</span></a> should always call the base class <a class="reference internal" href="#paddleclasspaddle_1_1DataProviderGroup_1aabc5a09dd7b80a8616108fb2f2989c21"><span>reset()</span></a> at the end of the function </dd>
</dl>
</p>
</dd></dl>
Y
Update docs  
Yu Yang 已提交
272 273 

<dl class="function">
Y
Upload docs  
Yu Yang 已提交
274 275 276 277 
<dt id="_CPPv2N6paddle17DataProviderGroup7shuffleEv">
<span id="paddle::DataProviderGroup::shuffle"></span>virtual <span class="target" id="paddleclasspaddle_1_1DataProviderGroup_1af5d1ad23716d3d4734917d28e7a93140"></span>void <code class="descname">shuffle</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle17DataProviderGroup7shuffleEv" title="Permalink to this definition"></a></dt>
<dd><p>Shuffle the data set. </p>
</dd></dl>
Y
Update docs  
Yu Yang 已提交
278 279 

<dl class="function">
Y
Upload docs  
Yu Yang 已提交
280 281 282 283 284 285 286 287 288 289 290 
<dt id="_CPPv2N6paddle17DataProviderGroup7getSizeEv">
<span id="paddle::DataProviderGroup::getSize"></span>virtual <span class="target" id="paddleclasspaddle_1_1DataProviderGroup_1a0e3e36653942aaf01670f37127b06a4f"></span>int64_t <code class="descname">getSize</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle17DataProviderGroup7getSizeEv" title="Permalink to this definition"></a></dt>
<dd><p>Get the size of training samples. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
<dd>the number of training samples in the data set. </dd>
<dt><strong>Note</strong></dt>
<dd>return -1 to indicate unlimited number of samples. </dd>
</dl>
</p>
</dd></dl>
Y
Update docs  
Yu Yang 已提交
291 292 

<dl class="function">
Y
Upload docs  
Yu Yang 已提交
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 
<dt id="_CPPv2N6paddle17DataProviderGroup20getNextBatchInternalE7int64_tP9DataBatch">
<span id="paddle::DataProviderGroup::getNextBatchInternal__int64_t.DataBatchP"></span>virtual <span class="target" id="paddleclasspaddle_1_1DataProviderGroup_1a1de57dd0c862ee3b9727afa905f56de8"></span>int64_t <code class="descname">getNextBatchInternal</code><span class="sig-paren">(</span>int64_t <em>size</em>, DataBatch *<em>batch</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle17DataProviderGroup20getNextBatchInternalE7int64_tP9DataBatch" title="Permalink to this definition"></a></dt>
<dd><p>Get next batch training samples internally. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
<dd>actual size of obtained training samples </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">size</span></code> - <p>size of training samples to get </p>
</li>
<li><code class="first docutils literal"><span class="pre">batch</span></code> - <p>a batch of training samples </p>
</li>
</ul>
</dd>
</dl>
</p>
</dd></dl>
Y
Update docs  
Yu Yang 已提交
310 311 312 

</div>
<div class="breathe-sectiondef container">
Y
Upload docs  
Yu Yang 已提交
313 314 315 316 
<p class="breathe-sectiondef-title rubric">Protected Types</p>
<dl class="type">
<dt id="_CPPv2N6paddle17DataProviderGroup12ProviderTypeE">
<span id="paddle::DataProviderGroup::ProviderType"></span><span class="target" id="paddleclasspaddle_1_1DataProviderGroup_1af521f88c5a303510f05bd9c7fd8fc130"></span><em class="property">typedef </em>T <code class="descname">ProviderType</code><a class="headerlink" href="#_CPPv2N6paddle17DataProviderGroup12ProviderTypeE" title="Permalink to this definition"></a></dt>
Y
Update docs  
Yu Yang 已提交
317 318 
<dd></dd></dl>
Y
Upload docs  
Yu Yang 已提交
319 320 321 
<dl class="type">
<dt id="_CPPv2N6paddle17DataProviderGroup15ProviderPtrTypeE">
<span id="paddle::DataProviderGroup::ProviderPtrType"></span><span class="target" id="paddleclasspaddle_1_1DataProviderGroup_1a9eeae52d64d56199a679da2d683a9fcb"></span><em class="property">typedef </em>std::shared_ptr&lt;<a class="reference internal" href="#_CPPv2N6paddle17DataProviderGroup12ProviderTypeE" title="paddle::DataProviderGroup::ProviderType">ProviderType</a>&gt; <code class="descname">ProviderPtrType</code><a class="headerlink" href="#_CPPv2N6paddle17DataProviderGroup15ProviderPtrTypeE" title="Permalink to this definition"></a></dt>
Y
Update docs  
Yu Yang 已提交
322 323 324 325 326 327 
<dd></dd></dl>

</div>
<div class="breathe-sectiondef container">
<p class="breathe-sectiondef-title rubric">Protected Attributes</p>
<dl class="member">
Y
Upload docs  
Yu Yang 已提交
328 329 
<dt id="_CPPv2N6paddle17DataProviderGroup9provider_E">
<span id="paddle::DataProviderGroup::provider___ProviderPtrType"></span><span class="target" id="paddleclasspaddle_1_1DataProviderGroup_1ad8eca96f9a38a42296e26ca338eb1ad8"></span><a class="reference internal" href="#_CPPv2N6paddle17DataProviderGroup15ProviderPtrTypeE" title="paddle::DataProviderGroup::ProviderPtrType">ProviderPtrType</a> <code class="descname">provider_</code><a class="headerlink" href="#_CPPv2N6paddle17DataProviderGroup9provider_E" title="Permalink to this definition"></a></dt>
Y
Update docs  
Yu Yang 已提交
330 331 332 
<dd></dd></dl>

<dl class="member">
Y
Upload docs  
Yu Yang 已提交
333 334 
<dt id="_CPPv2N6paddle17DataProviderGroup9fileList_E">
<span id="paddle::DataProviderGroup::fileList___std::vector:ss:"></span><span class="target" id="paddleclasspaddle_1_1DataProviderGroup_1a90d4a9e3d5aa8f3209b9e77c867ebdf2"></span>std::vector&lt;std::string&gt; <code class="descname">fileList_</code><a class="headerlink" href="#_CPPv2N6paddle17DataProviderGroup9fileList_E" title="Permalink to this definition"></a></dt>
Y
Update docs  
Yu Yang 已提交
335 336 337 
<dd></dd></dl>

<dl class="member">
Y
Upload docs  
Yu Yang 已提交
338 339 
<dt id="_CPPv2N6paddle17DataProviderGroup5lock_E">
<span id="paddle::DataProviderGroup::lock___std::mutex"></span><span class="target" id="paddleclasspaddle_1_1DataProviderGroup_1ad26ce9c43110f9b9981903d0d344e346"></span>std::mutex <code class="descname">lock_</code><a class="headerlink" href="#_CPPv2N6paddle17DataProviderGroup5lock_E" title="Permalink to this definition"></a></dt>
Y
Update docs  
Yu Yang 已提交
340 341 342 
<dd></dd></dl>

<dl class="member">
Y
Upload docs  
Yu Yang 已提交
343 344 
<dt id="_CPPv2N6paddle17DataProviderGroup7loader_E">
<span id="paddle::DataProviderGroup::loader___std::unique_ptr:MultiThreadWorker:ProviderType::"></span><span class="target" id="paddleclasspaddle_1_1DataProviderGroup_1aaa3059ba5b19c13b32ae58836b9162b7"></span>std::unique_ptr&lt;<a class="reference internal" href="../../utils/lock.html#_CPPv2N6paddle17MultiThreadWorkerE" title="paddle::MultiThreadWorker">MultiThreadWorker</a>&lt;<a class="reference internal" href="#_CPPv2N6paddle17DataProviderGroup12ProviderTypeE" title="paddle::DataProviderGroup::ProviderType">ProviderType</a>&gt;&gt; <code class="descname">loader_</code><a class="headerlink" href="#_CPPv2N6paddle17DataProviderGroup7loader_E" title="Permalink to this definition"></a></dt>
Y
Update docs  
Yu Yang 已提交
345 346 
<dd></dd></dl>
Y
Upload docs  
Yu Yang 已提交
347 348 
</div>
</dd></dl>
Y
Update docs  
Yu Yang 已提交
349 350 

</div>
Y
Upload docs  
Yu Yang 已提交
351 352 353 354 355 356 
<div class="section" id="multidataprovider">
<h2>MultiDataProvider<a class="headerlink" href="#multidataprovider" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="_CPPv2N6paddle17MultiDataProviderE">
<span id="paddle::MultiDataProvider"></span><span class="target" id="paddleclasspaddle_1_1MultiDataProvider"></span><em class="property">class </em><code class="descclassname">paddle::</code><code class="descname">MultiDataProvider</code><a class="headerlink" href="#_CPPv2N6paddle17MultiDataProviderE" title="Permalink to this definition"></a></dt>
<dd><p>Inherits from <a class="reference internal" href="#paddleclasspaddle_1_1DataProvider"><span>paddle::DataProvider</span></a></p>
Y
Update docs  
Yu Yang 已提交
357 358 359 
<div class="breathe-sectiondef container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
Y
Upload docs  
Yu Yang 已提交
360 361 
<dt id="_CPPv2N6paddle17MultiDataProvider17MultiDataProviderERK10DataConfigb">
<span id="paddle::MultiDataProvider::MultiDataProvider__DataConfigCR.b"></span><span class="target" id="paddleclasspaddle_1_1MultiDataProvider_1a9335b9b57d19fccd0b374746b0e28336"></span><code class="descname">MultiDataProvider</code><span class="sig-paren">(</span><em class="property">const</em> DataConfig &amp;<em>config</em>, bool <em>useGpu</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle17MultiDataProvider17MultiDataProviderERK10DataConfigb" title="Permalink to this definition"></a></dt>
Y
Update docs  
Yu Yang 已提交
362 363 364 
<dd></dd></dl>

<dl class="function">
Y
Upload docs  
Yu Yang 已提交
365 366 367 368 369 370 371 372 
<dt id="_CPPv2N6paddle17MultiDataProviderD0Ev">
<span id="paddle::MultiDataProvider::~MultiDataProvider"></span><span class="target" id="paddleclasspaddle_1_1MultiDataProvider_1a4059bdb3be2b2cf7d99dd740cea31161"></span><code class="descname">~MultiDataProvider</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle17MultiDataProviderD0Ev" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="_CPPv2N6paddle17MultiDataProvider5resetEv">
<span id="paddle::MultiDataProvider::reset"></span>virtual <span class="target" id="paddleclasspaddle_1_1MultiDataProvider_1aa10250fd3fbeb5dadcb42c7c968b7fdf"></span>void <code class="descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle17MultiDataProvider5resetEv" title="Permalink to this definition"></a></dt>
<dd><p>reset all the value of index </p>
Y
Update docs  
Yu Yang 已提交
373 374 
<p><dl class="docutils">
<dt><strong>Note</strong></dt>
Y
Upload docs  
Yu Yang 已提交
375 
<dd><a class="reference internal" href="#paddleclasspaddle_1_1MultiDataProvider_1aa10250fd3fbeb5dadcb42c7c968b7fdf"><span>reset()</span></a> must be called before any calls to <a class="reference internal" href="#paddleclasspaddle_1_1DataProvider_1a98d9d269b628ac7c8354a8a7de049a7b"><span>getNextBatch()</span></a> IMPORTANT: subclass <a class="reference internal" href="#paddleclasspaddle_1_1MultiDataProvider_1aa10250fd3fbeb5dadcb42c7c968b7fdf"><span>reset()</span></a> should always call the base class <a class="reference internal" href="#paddleclasspaddle_1_1MultiDataProvider_1aa10250fd3fbeb5dadcb42c7c968b7fdf"><span>reset()</span></a> at the end of the function </dd>
Y
Update docs  
Yu Yang 已提交
376 377 378 379 380 
</dl>
</p>
</dd></dl>

<dl class="function">
Y
Upload docs  
Yu Yang 已提交
381 382 383 
<dt id="_CPPv2N6paddle17MultiDataProvider7shuffleEv">
<span id="paddle::MultiDataProvider::shuffle"></span>virtual <span class="target" id="paddleclasspaddle_1_1MultiDataProvider_1ac323b8ff3a8e8c1234b42a20d1e05311"></span>void <code class="descname">shuffle</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle17MultiDataProvider7shuffleEv" title="Permalink to this definition"></a></dt>
<dd><p>Shuffle the data set. </p>
Y
Update docs  
Yu Yang 已提交
384 385 386 
</dd></dl>

<dl class="function">
Y
Upload docs  
Yu Yang 已提交
387 388 389 390 
<dt id="_CPPv2N6paddle17MultiDataProvider7getSizeEv">
<span id="paddle::MultiDataProvider::getSize"></span>virtual <span class="target" id="paddleclasspaddle_1_1MultiDataProvider_1a81a7c862be871db62ae94ab81012fc69"></span>int64_t <code class="descname">getSize</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle17MultiDataProvider7getSizeEv" title="Permalink to this definition"></a></dt>
<dd><p>Get the size of training samples. </p>
<p><dl class="docutils">
Y
Update docs  
Yu Yang 已提交
391 
<dt><strong>Return</strong></dt>
Y
Upload docs  
Yu Yang 已提交
392 393 394 
<dd>the number of training samples in the data set. </dd>
<dt><strong>Note</strong></dt>
<dd>return -1 to indicate unlimited number of samples. </dd>
Y
Update docs  
Yu Yang 已提交
395 396 397 398 399 
</dl>
</p>
</dd></dl>

<dl class="function">
Y
Upload docs  
Yu Yang 已提交
400 401 402 403 404 405 
<dt id="_CPPv2N6paddle17MultiDataProvider20getNextBatchInternalE7int64_tP9DataBatch">
<span id="paddle::MultiDataProvider::getNextBatchInternal__int64_t.DataBatchP"></span>virtual <span class="target" id="paddleclasspaddle_1_1MultiDataProvider_1a2d07eb0ce8a35f61e7784bbfc5033f83"></span>int64_t <code class="descname">getNextBatchInternal</code><span class="sig-paren">(</span>int64_t <em>size</em>, DataBatch *<em>batch</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle17MultiDataProvider20getNextBatchInternalE7int64_tP9DataBatch" title="Permalink to this definition"></a></dt>
<dd><p>Get next batch training samples internally. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
<dd>actual size of obtained training samples </dd>
Y
Update docs  
Yu Yang 已提交
406 407 
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
Y
Upload docs  
Yu Yang 已提交
408 409 410 
<li><code class="first docutils literal"><span class="pre">size</span></code> - <p>size of training samples to get </p>
</li>
<li><code class="first docutils literal"><span class="pre">batch</span></code> - <p>a batch of training samples </p>
Y
Update docs  
Yu Yang 已提交
411 412 413 414 415 416 417 418 
</li>
</ul>
</dd>
</dl>
</p>
</dd></dl>

<dl class="function">
Y
Upload docs  
Yu Yang 已提交
419 420 421 
<dt id="_CPPv2N6paddle17MultiDataProvider10isTestModeEv">
<span id="paddle::MultiDataProvider::isTestMode"></span><span class="target" id="paddleclasspaddle_1_1MultiDataProvider_1a9df5d1af13a8bb15ad3c7e469c3a2a31"></span>bool <code class="descname">isTestMode</code><span class="sig-paren">(</span><span class="sig-paren">)</span> const<a class="headerlink" href="#_CPPv2N6paddle17MultiDataProvider10isTestModeEv" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
Y
Update docs  
Yu Yang 已提交
422 423 424 

</div>
<div class="breathe-sectiondef container">
Y
Upload docs  
Yu Yang 已提交
425 426 427 428 429 
<p class="breathe-sectiondef-title rubric">Protected Attributes</p>
<dl class="member">
<dt id="_CPPv2N6paddle17MultiDataProvider17subDataProviders_E">
<span id="paddle::MultiDataProvider::subDataProviders___std::vector:std::unique_ptr:DataProvider::"></span><span class="target" id="paddleclasspaddle_1_1MultiDataProvider_1a679fbbbf8b7268546f5486f92a230008"></span>std::vector&lt;std::unique_ptr&lt;<a class="reference internal" href="#_CPPv2N6paddle12DataProviderE" title="paddle::DataProvider">DataProvider</a>&gt;&gt; <code class="descname">subDataProviders_</code><a class="headerlink" href="#_CPPv2N6paddle17MultiDataProvider17subDataProviders_E" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
Y
Update docs  
Yu Yang 已提交
430 431 432 433 

</div>
</dd></dl>
Y
Upload docs  
Yu Yang 已提交
434 435 436 437 438 439 
</div>
</div>
<div class="section" id="pydataprovider">
<h1>PyDataProvider<a class="headerlink" href="#pydataprovider" title="Permalink to this headline"></a></h1>
<div class="section" id="ifieldscanner">
<h2>IFieldScanner<a class="headerlink" href="#ifieldscanner" title="Permalink to this headline"></a></h2>
Y
Update docs  
Yu Yang 已提交
440 
<dl class="class">
Y
Upload docs  
Yu Yang 已提交
441 442 443 444 445 
<dt id="_CPPv2N6paddle13IFieldScannerE">
<span id="paddle::IFieldScanner"></span><span class="target" id="paddleclasspaddle_1_1IFieldScanner"></span><em class="property">class </em><code class="descclassname">paddle::</code><code class="descname">IFieldScanner</code><a class="headerlink" href="#_CPPv2N6paddle13IFieldScannerE" title="Permalink to this definition"></a></dt>
<dd><p>FieldScanner Interface.</p>
<p>It will read python object, and fill to argument&#8217;s each slot. There are two steps, prepare and fill. Scanner will alloc memory during prepare step, fill data into argument during fill step. </p>
<p>Subclassed by <a class="reference internal" href="#paddleclasspaddle_1_1DenseScanner"><span>paddle::DenseScanner</span></a>, <a class="reference internal" href="#paddleclasspaddle_1_1IndexScanner"><span>paddle::IndexScanner</span></a>, paddle::SequenceScanner, <a class="reference internal" href="#paddleclasspaddle_1_1SparseNonValueScanner"><span>paddle::SparseNonValueScanner</span></a></p>
Y
Update docs  
Yu Yang 已提交
446 447 448 
<div class="breathe-sectiondef container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
Y
Upload docs  
Yu Yang 已提交
449 450 451 
<dt id="_CPPv2N6paddle13IFieldScanner12DISABLE_COPYE13IFieldScanner">
<span id="paddle::IFieldScanner::DISABLE_COPY__IFieldScanner"></span><span class="target" id="paddleclasspaddle_1_1IFieldScanner_1adfc54719dfd3ceb3a187d2fa8d5997b9"></span><code class="descname">DISABLE_COPY</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv2N6paddle13IFieldScanner13IFieldScannerEP10SlotHeader" title="paddle::IFieldScanner::IFieldScanner">IFieldScanner</a><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle13IFieldScanner12DISABLE_COPYE13IFieldScanner" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
Y
Update docs  
Yu Yang 已提交
452 453 

<dl class="function">
Y
Upload docs  
Yu Yang 已提交
454 455 456 
<dt id="_CPPv2N6paddle13IFieldScanner13IFieldScannerEP10SlotHeader">
<span id="paddle::IFieldScanner::IFieldScanner__SlotHeaderP"></span><span class="target" id="paddleclasspaddle_1_1IFieldScanner_1a852d54211b136d42eea1ec98235e6b38"></span><code class="descname">IFieldScanner</code><span class="sig-paren">(</span>SlotHeader *<em>headerPtr</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle13IFieldScanner13IFieldScannerEP10SlotHeader" title="Permalink to this definition"></a></dt>
<dd><p>Ctor. <dl class="docutils">
Y
Update docs  
Yu Yang 已提交
457 458 
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
Y
Upload docs  
Yu Yang 已提交
459 
<li><code class="first docutils literal"><span class="pre">headerPtr</span></code> - <p>slot header that scanner belong to. </p>
Y
Update docs  
Yu Yang 已提交
460 461 462 463 464 465 466 467 
</li>
</ul>
</dd>
</dl>
</p>
</dd></dl>

<dl class="function">
Y
Upload docs  
Yu Yang 已提交
468 469 470 
<dt id="_CPPv2N6paddle13IFieldScannerD0Ev">
<span id="paddle::IFieldScanner::~IFieldScanner"></span>virtual <span class="target" id="paddleclasspaddle_1_1IFieldScanner_1a2694874652e8c7e8702794cc85ea0d2c"></span><code class="descname">~IFieldScanner</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle13IFieldScannerD0Ev" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
Y
Update docs  
Yu Yang 已提交
471 472 

<dl class="function">
Y
Upload docs  
Yu Yang 已提交
473 474 475 
<dt id="_CPPv2N6paddle13IFieldScanner12startPrepareER8Argument">
<span id="paddle::IFieldScanner::startPrepare__ArgumentR"></span>virtual <span class="target" id="paddleclasspaddle_1_1IFieldScanner_1a59f2d475c6b12f6824cdaa3453e1ac49"></span>void <code class="descname">startPrepare</code><span class="sig-paren">(</span><a class="reference internal" href="../../parameter/parameter/parameter.html#_CPPv2N6paddle8ArgumentE" title="paddle::Argument">Argument</a> &amp;<em>argument</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle13IFieldScanner12startPrepareER8Argument" title="Permalink to this definition"></a></dt>
<dd><p>Start prepare step. </p>
Y
Update docs  
Yu Yang 已提交
476 477 478 
</dd></dl>

<dl class="function">
Y
Upload docs  
Yu Yang 已提交
479 480 481 482 
<dt id="_CPPv2N6paddle13IFieldScanner7prepareER8ArgumentP8PyObject">
<span id="paddle::IFieldScanner::prepare__ArgumentR.PyObjectP"></span>virtual <span class="target" id="paddleclasspaddle_1_1IFieldScanner_1aec5e4919e2b2946094dc3f75a7d17f08"></span>void <code class="descname">prepare</code><span class="sig-paren">(</span><a class="reference internal" href="../../parameter/parameter/parameter.html#_CPPv2N6paddle8ArgumentE" title="paddle::Argument">Argument</a> &amp;<em>argument</em>, PyObject *<em>obj</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle13IFieldScanner7prepareER8ArgumentP8PyObject" title="Permalink to this definition"></a></dt>
<dd><p>Prepare step.</p>
<p><dl class="docutils">
Y
Update docs  
Yu Yang 已提交
483 
<dt><strong>Note</strong></dt>
Y
Upload docs  
Yu Yang 已提交
484 
<dd>the obj could be a timestep of sample or whole sample. It depends what scanner it is. </dd>
Y
Update docs  
Yu Yang 已提交
485 486 487 488 489 
</dl>
</p>
</dd></dl>

<dl class="function">
Y
Upload docs  
Yu Yang 已提交
490 491 492 
<dt id="_CPPv2N6paddle13IFieldScanner13finishPrepareER8Argument">
<span id="paddle::IFieldScanner::finishPrepare__ArgumentR"></span>virtual <span class="target" id="paddleclasspaddle_1_1IFieldScanner_1ac648c8047ffd873ffbf5d889cf3565e5"></span>void <code class="descname">finishPrepare</code><span class="sig-paren">(</span><a class="reference internal" href="../../parameter/parameter/parameter.html#_CPPv2N6paddle8ArgumentE" title="paddle::Argument">Argument</a> &amp;<em>argument</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle13IFieldScanner13finishPrepareER8Argument" title="Permalink to this definition"></a></dt>
<dd><p>Finish Prepare step. </p>
Y
Update docs  
Yu Yang 已提交
493 494 495 
</dd></dl>

<dl class="function">
Y
Upload docs  
Yu Yang 已提交
496 497 498 
<dt id="_CPPv2N6paddle13IFieldScanner9startFillER8Argument">
<span id="paddle::IFieldScanner::startFill__ArgumentR"></span>virtual <span class="target" id="paddleclasspaddle_1_1IFieldScanner_1ae0c654543ef8e863473afcbcf34a5a1f"></span>void <code class="descname">startFill</code><span class="sig-paren">(</span><a class="reference internal" href="../../parameter/parameter/parameter.html#_CPPv2N6paddle8ArgumentE" title="paddle::Argument">Argument</a> &amp;<em>argument</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle13IFieldScanner9startFillER8Argument" title="Permalink to this definition"></a></dt>
<dd><p>Start fill step. </p>
Y
Update docs  
Yu Yang 已提交
499 500 501 
</dd></dl>

<dl class="function">
Y
Upload docs  
Yu Yang 已提交
502 503 504 505 506 507 508 509 
<dt id="_CPPv2N6paddle13IFieldScanner4fillER8ArgumentP8PyObject">
<span id="paddle::IFieldScanner::fill__ArgumentR.PyObjectP"></span>virtual <span class="target" id="paddleclasspaddle_1_1IFieldScanner_1a46f052af1bcb4ade0f8caa752efb4202"></span>void <code class="descname">fill</code><span class="sig-paren">(</span><a class="reference internal" href="../../parameter/parameter/parameter.html#_CPPv2N6paddle8ArgumentE" title="paddle::Argument">Argument</a> &amp;<em>argument</em>, PyObject *<em>obj</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle13IFieldScanner4fillER8ArgumentP8PyObject" title="Permalink to this definition"></a></dt>
<dd><p>Fill step.</p>
<p><dl class="docutils">
<dt><strong>Note</strong></dt>
<dd>the obj could be a timestep of sample or whole sample. It depends what scanner it is. </dd>
</dl>
</p>
Y
Update docs  
Yu Yang 已提交
510 511 512 
</dd></dl>

<dl class="function">
Y
Upload docs  
Yu Yang 已提交
513 514 515 
<dt id="_CPPv2N6paddle13IFieldScanner10finishFillER8Argument">
<span id="paddle::IFieldScanner::finishFill__ArgumentR"></span>virtual <span class="target" id="paddleclasspaddle_1_1IFieldScanner_1a511c98382488cb8fc0b6fb10632f6d5c"></span>void <code class="descname">finishFill</code><span class="sig-paren">(</span><a class="reference internal" href="../../parameter/parameter/parameter.html#_CPPv2N6paddle8ArgumentE" title="paddle::Argument">Argument</a> &amp;<em>argument</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle13IFieldScanner10finishFillER8Argument" title="Permalink to this definition"></a></dt>
<dd><p>Finish fill step. </p>
Y
Update docs  
Yu Yang 已提交
516 517 518 519 
</dd></dl>

</div>
<div class="breathe-sectiondef container">
Y
Upload docs  
Yu Yang 已提交
520 
<p class="breathe-sectiondef-title rubric">Public Static Functions</p>
Y
Update docs  
Yu Yang 已提交
521 
<dl class="function">
Y
Upload docs  
Yu Yang 已提交
522 523 524 525 526 527 528 529 530 
<dt id="_CPPv2N6paddle13IFieldScanner6createEP10SlotHeader">
<span id="paddle::IFieldScanner::create__SlotHeaderP"></span><span class="target" id="paddleclasspaddle_1_1IFieldScanner_1aa8355363cd6d835eee64389c96a3835f"></span><a class="reference internal" href="#_CPPv2N6paddle13IFieldScanner13IFieldScannerEP10SlotHeader" title="paddle::IFieldScanner::IFieldScanner">IFieldScanner</a> *<code class="descname">create</code><span class="sig-paren">(</span>SlotHeader *<em>header</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle13IFieldScanner6createEP10SlotHeader" title="Permalink to this definition"></a></dt>
<dd><p>Factory method. Create a scanner by header. The final scanner may be combine many scanners.</p>
<p><dl class="docutils">
<dt><strong>Note</strong></dt>
<dd>Fatal if header is not support. </dd>
</dl>
</p>
</dd></dl>
Y
Update docs  
Yu Yang 已提交
531 532 533 

</div>
<div class="breathe-sectiondef container">
Y
Upload docs  
Yu Yang 已提交
534 
<p class="breathe-sectiondef-title rubric">Protected Attributes</p>
Y
Update docs  
Yu Yang 已提交
535 
<dl class="member">
Y
Upload docs  
Yu Yang 已提交
536 537 
<dt id="_CPPv2N6paddle13IFieldScanner10headerPtr_E">
<span id="paddle::IFieldScanner::headerPtr___SlotHeaderP"></span><span class="target" id="paddleclasspaddle_1_1IFieldScanner_1a83273be720a6cd9c8c0e264f6b06b05a"></span>SlotHeader *<code class="descname">headerPtr_</code><a class="headerlink" href="#_CPPv2N6paddle13IFieldScanner10headerPtr_E" title="Permalink to this definition"></a></dt>
Y
Update docs  
Yu Yang 已提交
538 539 540 541 542 
<dd></dd></dl>

</div>
</dd></dl>
Y
Upload docs  
Yu Yang 已提交
543 544 545 
</div>
<div class="section" id="densescanner">
<h2>DenseScanner<a class="headerlink" href="#densescanner" title="Permalink to this headline"></a></h2>
Y
Update docs  
Yu Yang 已提交
546 
<dl class="class">
Y
Upload docs  
Yu Yang 已提交
547 548 549 
<dt id="_CPPv2N6paddle12DenseScannerE">
<span id="paddle::DenseScanner"></span><span class="target" id="paddleclasspaddle_1_1DenseScanner"></span><em class="property">class </em><code class="descclassname">paddle::</code><code class="descname">DenseScanner</code><a class="headerlink" href="#_CPPv2N6paddle12DenseScannerE" title="Permalink to this definition"></a></dt>
<dd><p>Scanner for dense slot. </p>
Y
Update docs  
Yu Yang 已提交
550 551 552 553 
<p>Inherits from <a class="reference internal" href="#paddleclasspaddle_1_1IFieldScanner"><span>paddle::IFieldScanner</span></a></p>
<div class="breathe-sectiondef container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
Y
Upload docs  
Yu Yang 已提交
554 555 556 557 558 559 560 561 
<dt id="_CPPv2N6paddle12DenseScanner12DenseScannerEP10SlotHeader">
<span id="paddle::DenseScanner::DenseScanner__SlotHeaderP"></span><span class="target" id="paddleclasspaddle_1_1DenseScanner_1aa04defb9f71f17c03d2fac593473817e"></span><code class="descname">DenseScanner</code><span class="sig-paren">(</span>SlotHeader *<em>ptr</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle12DenseScanner12DenseScannerEP10SlotHeader" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="_CPPv2N6paddle12DenseScanner7prepareER8ArgumentP8PyObject">
<span id="paddle::DenseScanner::prepare__ArgumentR.PyObjectP"></span>virtual <span class="target" id="paddleclasspaddle_1_1DenseScanner_1a06f5357ef4905bac34c23049767930c9"></span>void <code class="descname">prepare</code><span class="sig-paren">(</span><a class="reference internal" href="../../parameter/parameter/parameter.html#_CPPv2N6paddle8ArgumentE" title="paddle::Argument">Argument</a> &amp;<em>argument</em>, PyObject *<em>obj</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle12DenseScanner7prepareER8ArgumentP8PyObject" title="Permalink to this definition"></a></dt>
<dd><p>Prepare. <dl class="docutils">
Y
Update docs  
Yu Yang 已提交
562 563 
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
Y
Upload docs  
Yu Yang 已提交
564 
<li><code class="first docutils literal"><span class="pre">argument</span></code> - <p>target argument </p>
Y
Update docs  
Yu Yang 已提交
565 
</li>
Y
Upload docs  
Yu Yang 已提交
566 
<li><code class="first docutils literal"><span class="pre">obj</span></code> - <p>each timestep of a sample. </p>
Y
Update docs  
Yu Yang 已提交
567 568 569 570 571 572 573 574 
</li>
</ul>
</dd>
</dl>
</p>
</dd></dl>

<dl class="function">
Y
Upload docs  
Yu Yang 已提交
575 576 577 
<dt id="_CPPv2N6paddle12DenseScanner13finishPrepareER8Argument">
<span id="paddle::DenseScanner::finishPrepare__ArgumentR"></span>virtual <span class="target" id="paddleclasspaddle_1_1DenseScanner_1a1ef079c5bd06c0d6cb1168a677c74a89"></span>void <code class="descname">finishPrepare</code><span class="sig-paren">(</span><a class="reference internal" href="../../parameter/parameter/parameter.html#_CPPv2N6paddle8ArgumentE" title="paddle::Argument">Argument</a> &amp;<em>argument</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle12DenseScanner13finishPrepareER8Argument" title="Permalink to this definition"></a></dt>
<dd><p>Finish Prepare step. </p>
Y
Update docs  
Yu Yang 已提交
578 579 580 
</dd></dl>

<dl class="function">
Y
Upload docs  
Yu Yang 已提交
581 582 583 584 585 586 587 588 589 590 591 592 593 
<dt id="_CPPv2N6paddle12DenseScanner4fillER8ArgumentP8PyObject">
<span id="paddle::DenseScanner::fill__ArgumentR.PyObjectP"></span>virtual <span class="target" id="paddleclasspaddle_1_1DenseScanner_1ac0475d4c0541363c0d9429ea6d0da79b"></span>void <code class="descname">fill</code><span class="sig-paren">(</span><a class="reference internal" href="../../parameter/parameter/parameter.html#_CPPv2N6paddle8ArgumentE" title="paddle::Argument">Argument</a> &amp;<em>argument</em>, PyObject *<em>obj</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle12DenseScanner4fillER8ArgumentP8PyObject" title="Permalink to this definition"></a></dt>
<dd><p>Fill argument from obj. <dl class="docutils">
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">argument</span></code> - <p></p>
</li>
<li><code class="first docutils literal"><span class="pre">obj</span></code> - <p></p>
</li>
</ul>
</dd>
</dl>
</p>
Y
Update docs  
Yu Yang 已提交
594 595 
</dd></dl>
Y
Upload docs  
Yu Yang 已提交
596 
</div>
Y
Update docs  
Yu Yang 已提交
597 598 
</dd></dl>
Y
Upload docs  
Yu Yang 已提交
599 600 601 602 603 604 605 606 607 608 
</div>
<div class="section" id="indexscanner">
<h2>IndexScanner<a class="headerlink" href="#indexscanner" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="_CPPv2N6paddle12IndexScannerE">
<span id="paddle::IndexScanner"></span><span class="target" id="paddleclasspaddle_1_1IndexScanner"></span><em class="property">class </em><code class="descclassname">paddle::</code><code class="descname">IndexScanner</code><a class="headerlink" href="#_CPPv2N6paddle12IndexScannerE" title="Permalink to this definition"></a></dt>
<dd><p>Scanner for index slot </p>
<p>Inherits from <a class="reference internal" href="#paddleclasspaddle_1_1IFieldScanner"><span>paddle::IFieldScanner</span></a></p>
<div class="breathe-sectiondef container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
Y
Update docs  
Yu Yang 已提交
609 
<dl class="function">
Y
Upload docs  
Yu Yang 已提交
610 611 612 
<dt id="_CPPv2N6paddle12IndexScanner12IndexScannerEP10SlotHeader">
<span id="paddle::IndexScanner::IndexScanner__SlotHeaderP"></span><span class="target" id="paddleclasspaddle_1_1IndexScanner_1ad0b7cd33f0edabf30b5c99196f18fe01"></span><code class="descname">IndexScanner</code><span class="sig-paren">(</span>SlotHeader *<em>ptr</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle12IndexScanner12IndexScannerEP10SlotHeader" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
Y
Update docs  
Yu Yang 已提交
613 614 

<dl class="function">
Y
Upload docs  
Yu Yang 已提交
615 616 617 618 619 620 621 622 
<dt id="_CPPv2N6paddle12IndexScanner7prepareER8ArgumentP8PyObject">
<span id="paddle::IndexScanner::prepare__ArgumentR.PyObjectP"></span>virtual <span class="target" id="paddleclasspaddle_1_1IndexScanner_1af16d91e8a204fc660a9cbe45eec5310f"></span>void <code class="descname">prepare</code><span class="sig-paren">(</span><a class="reference internal" href="../../parameter/parameter/parameter.html#_CPPv2N6paddle8ArgumentE" title="paddle::Argument">Argument</a> &amp;<em>argument</em>, PyObject *<em>obj</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle12IndexScanner7prepareER8ArgumentP8PyObject" title="Permalink to this definition"></a></dt>
<dd><p>Prepare memory space.</p>
<p><dl class="docutils">
<dt><strong>Note</strong></dt>
<dd>obj is a single timestep of sample </dd>
</dl>
</p>
Y
Update docs  
Yu Yang 已提交
623 624 625 
</dd></dl>

<dl class="function">
Y
Upload docs  
Yu Yang 已提交
626 627 628 
<dt id="_CPPv2N6paddle12IndexScanner13finishPrepareER8Argument">
<span id="paddle::IndexScanner::finishPrepare__ArgumentR"></span>virtual <span class="target" id="paddleclasspaddle_1_1IndexScanner_1ae5f5314bd4dc869a8ba4dd33b3b57d43"></span>void <code class="descname">finishPrepare</code><span class="sig-paren">(</span><a class="reference internal" href="../../parameter/parameter/parameter.html#_CPPv2N6paddle8ArgumentE" title="paddle::Argument">Argument</a> &amp;<em>argument</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle12IndexScanner13finishPrepareER8Argument" title="Permalink to this definition"></a></dt>
<dd><p>Finish Prepare step. </p>
Y
Update docs  
Yu Yang 已提交
629 630 631 
</dd></dl>

<dl class="function">
Y
Upload docs  
Yu Yang 已提交
632 633 634 
<dt id="_CPPv2N6paddle12IndexScanner4fillER8ArgumentP8PyObject">
<span id="paddle::IndexScanner::fill__ArgumentR.PyObjectP"></span>virtual <span class="target" id="paddleclasspaddle_1_1IndexScanner_1afa4763633db79aa535970cb60ed2c4a1"></span>void <code class="descname">fill</code><span class="sig-paren">(</span><a class="reference internal" href="../../parameter/parameter/parameter.html#_CPPv2N6paddle8ArgumentE" title="paddle::Argument">Argument</a> &amp;<em>argument</em>, PyObject *<em>obj</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle12IndexScanner4fillER8ArgumentP8PyObject" title="Permalink to this definition"></a></dt>
<dd><p>Fill one index to argument. </p>
Y
Update docs  
Yu Yang 已提交
635 636 637 638 639 
</dd></dl>

</div>
</dd></dl>
Y
Upload docs  
Yu Yang 已提交
640 641 642 
</div>
<div class="section" id="sparsenonvaluescanner">
<h2>SparseNonValueScanner<a class="headerlink" href="#sparsenonvaluescanner" title="Permalink to this headline"></a></h2>
Y
Update docs  
Yu Yang 已提交
643 644 
<dl class="class">
<dt id="_CPPv2N6paddle21SparseNonValueScannerE">
Y
Upload docs  
Yu Yang 已提交
645 
<span id="paddle::SparseNonValueScanner"></span><span class="target" id="paddleclasspaddle_1_1SparseNonValueScanner"></span><em class="property">class </em><code class="descclassname">paddle::</code><code class="descname">SparseNonValueScanner</code><a class="headerlink" href="#_CPPv2N6paddle21SparseNonValueScannerE" title="Permalink to this definition"></a></dt>
Y
Update docs  
Yu Yang 已提交
646 
<dd><p>Inherits from <a class="reference internal" href="#paddleclasspaddle_1_1IFieldScanner"><span>paddle::IFieldScanner</span></a></p>
Y
Upload docs  
Yu Yang 已提交
647 
<p>Subclassed by paddle::SparseValueScanner</p>
Y
Update docs  
Yu Yang 已提交
648 649 650 651 
<div class="breathe-sectiondef container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
<dt id="_CPPv2N6paddle21SparseNonValueScanner21SparseNonValueScannerEP10SlotHeader">
Y
Upload docs  
Yu Yang 已提交
652 
<span id="paddle::SparseNonValueScanner::SparseNonValueScanner__SlotHeaderP"></span><span class="target" id="paddleclasspaddle_1_1SparseNonValueScanner_1a34df14f1ab333000b0ebc439f895c348"></span><code class="descname">SparseNonValueScanner</code><span class="sig-paren">(</span>SlotHeader *<em>ptr</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle21SparseNonValueScanner21SparseNonValueScannerEP10SlotHeader" title="Permalink to this definition"></a></dt>
Y
Update docs  
Yu Yang 已提交
653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 
<dd></dd></dl>

<dl class="function">
<dt id="_CPPv2N6paddle21SparseNonValueScanner7prepareER8ArgumentP8PyObject">
<span id="paddle::SparseNonValueScanner::prepare__ArgumentR.PyObjectP"></span>virtual <span class="target" id="paddleclasspaddle_1_1SparseNonValueScanner_1a3e7f7690a43bba59b8ef795754664f8b"></span>void <code class="descname">prepare</code><span class="sig-paren">(</span><a class="reference internal" href="../../parameter/parameter/parameter.html#_CPPv2N6paddle8ArgumentE" title="paddle::Argument">Argument</a> &amp;<em>argument</em>, PyObject *<em>obj</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle21SparseNonValueScanner7prepareER8ArgumentP8PyObject" title="Permalink to this definition"></a></dt>
<dd><p>Prepare memory space <dl class="docutils">
<dt><strong>Note</strong></dt>
<dd>obj is a timestep of one sample. </dd>
</dl>
</p>
</dd></dl>

<dl class="function">
<dt id="_CPPv2N6paddle21SparseNonValueScanner13finishPrepareER8Argument">
<span id="paddle::SparseNonValueScanner::finishPrepare__ArgumentR"></span>virtual <span class="target" id="paddleclasspaddle_1_1SparseNonValueScanner_1a6bb2ee71907ea1bd6aa1317a0a516325"></span>void <code class="descname">finishPrepare</code><span class="sig-paren">(</span><a class="reference internal" href="../../parameter/parameter/parameter.html#_CPPv2N6paddle8ArgumentE" title="paddle::Argument">Argument</a> &amp;<em>argument</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle21SparseNonValueScanner13finishPrepareER8Argument" title="Permalink to this definition"></a></dt>
<dd><p>Finish Prepare step. </p>
</dd></dl>

<dl class="function">
<dt id="_CPPv2N6paddle21SparseNonValueScanner9startFillER8Argument">
<span id="paddle::SparseNonValueScanner::startFill__ArgumentR"></span>virtual <span class="target" id="paddleclasspaddle_1_1SparseNonValueScanner_1aaec784422b1358600198ab0a2b387e94"></span>void <code class="descname">startFill</code><span class="sig-paren">(</span><a class="reference internal" href="../../parameter/parameter/parameter.html#_CPPv2N6paddle8ArgumentE" title="paddle::Argument">Argument</a> &amp;<em>argument</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle21SparseNonValueScanner9startFillER8Argument" title="Permalink to this definition"></a></dt>
<dd><p>Start fill step. </p>
</dd></dl>

<dl class="function">
<dt id="_CPPv2N6paddle21SparseNonValueScanner4fillER8ArgumentP8PyObject">
<span id="paddle::SparseNonValueScanner::fill__ArgumentR.PyObjectP"></span>virtual <span class="target" id="paddleclasspaddle_1_1SparseNonValueScanner_1acef6e5425aa9c4b1865cca005df2a25e"></span>void <code class="descname">fill</code><span class="sig-paren">(</span><a class="reference internal" href="../../parameter/parameter/parameter.html#_CPPv2N6paddle8ArgumentE" title="paddle::Argument">Argument</a> &amp;<em>argument</em>, PyObject *<em>obj</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle21SparseNonValueScanner4fillER8ArgumentP8PyObject" title="Permalink to this definition"></a></dt>
<dd><p>Fill one sparse vector to argument. <dl class="docutils">
<dt><strong>Note</strong></dt>
<dd>obj is a timestep of one sample. </dd>
</dl>
</p>
</dd></dl>

</div>
<div class="breathe-sectiondef container">
<p class="breathe-sectiondef-title rubric">Protected Functions</p>
<dl class="function">
<dt id="_CPPv2N6paddle21SparseNonValueScanner7setDataEPiP4realP8PyObject">
<span id="paddle::SparseNonValueScanner::setData__iP.realP.PyObjectP"></span>virtual <span class="target" id="paddleclasspaddle_1_1SparseNonValueScanner_1a849d280e40e9f3ba9947e799c389fafd"></span>void <code class="descname">setData</code><span class="sig-paren">(</span>int *<em>col</em>, real *<em>dat</em>, PyObject *<em>obj</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle21SparseNonValueScanner7setDataEPiP4realP8PyObject" title="Permalink to this definition"></a></dt>
<dd><p>Set a single sparse index and value. <dl class="docutils">
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">col</span></code> - <p>sparse index </p>
</li>
<li><code class="first docutils literal"><span class="pre">dat</span></code> - <p>sparse value </p>
</li>
<li><code class="first docutils literal"><span class="pre">obj</span></code> - <p>Python Object. For sparse_non_value is a PyInt or PyLong. For sparse_value is a Tuple (int, float). </p>
</li>
</ul>
</dd>
</dl>
</p>
</dd></dl>

</div>
<div class="breathe-sectiondef container">
<p class="breathe-sectiondef-title rubric">Protected Attributes</p>
<dl class="member">
<dt id="_CPPv2N6paddle21SparseNonValueScanner4nnz_E">
<span id="paddle::SparseNonValueScanner::nnz___s"></span><span class="target" id="paddleclasspaddle_1_1SparseNonValueScanner_1a3133f8513f67786d4967ab3dac3bfa69"></span>size_t <code class="descname">nnz_</code><a class="headerlink" href="#_CPPv2N6paddle21SparseNonValueScanner4nnz_E" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="member">
<dt id="_CPPv2N6paddle21SparseNonValueScanner7height_E">
<span id="paddle::SparseNonValueScanner::height___s"></span><span class="target" id="paddleclasspaddle_1_1SparseNonValueScanner_1adbacd44fd0ce6877370b89a587ff6b12"></span>size_t <code class="descname">height_</code><a class="headerlink" href="#_CPPv2N6paddle21SparseNonValueScanner7height_E" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

</div>
</dd></dl>
Y
Upload docs  
Yu Yang 已提交
724 725 726 
</div>
<div class="section" id="sparsevaluescanner">
<h2>SparseValueScanner<a class="headerlink" href="#sparsevaluescanner" title="Permalink to this headline"></a></h2>
Y
Update docs  
Yu Yang 已提交
727 728 
<dl class="class">
<dt id="_CPPv2N6paddle18SparseValueScannerE">
Y
Upload docs  
Yu Yang 已提交
729 
<span id="paddle::SparseValueScanner"></span><span class="target" id="paddleclasspaddle_1_1SparseValueScanner"></span><em class="property">class </em><code class="descclassname">paddle::</code><code class="descname">SparseValueScanner</code><a class="headerlink" href="#_CPPv2N6paddle18SparseValueScannerE" title="Permalink to this definition"></a></dt>
Y
Update docs  
Yu Yang 已提交
730 731 732 733 734 
<dd><p>Inherits from <a class="reference internal" href="#paddleclasspaddle_1_1SparseNonValueScanner"><span>paddle::SparseNonValueScanner</span></a></p>
<div class="breathe-sectiondef container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
<dt id="_CPPv2N6paddle18SparseValueScanner18SparseValueScannerEP10SlotHeader">
Y
Upload docs  
Yu Yang 已提交
735 
<span id="paddle::SparseValueScanner::SparseValueScanner__SlotHeaderP"></span><span class="target" id="paddleclasspaddle_1_1SparseValueScanner_1ac60678603f86a3ee2b1df3bf6b3de343"></span><code class="descname">SparseValueScanner</code><span class="sig-paren">(</span>SlotHeader *<em>ptr</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle18SparseValueScanner18SparseValueScannerEP10SlotHeader" title="Permalink to this definition"></a></dt>
Y
Update docs  
Yu Yang 已提交
736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 
<dd></dd></dl>

<dl class="function">
<dt id="_CPPv2N6paddle18SparseValueScanner13finishPrepareER8Argument">
<span id="paddle::SparseValueScanner::finishPrepare__ArgumentR"></span>virtual <span class="target" id="paddleclasspaddle_1_1SparseValueScanner_1aa24ba4b1484c3db126155e3f6f83134f"></span>void <code class="descname">finishPrepare</code><span class="sig-paren">(</span><a class="reference internal" href="../../parameter/parameter/parameter.html#_CPPv2N6paddle8ArgumentE" title="paddle::Argument">Argument</a> &amp;<em>argument</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle18SparseValueScanner13finishPrepareER8Argument" title="Permalink to this definition"></a></dt>
<dd><p>Finish Prepare step. </p>
</dd></dl>

</div>
<div class="breathe-sectiondef container">
<p class="breathe-sectiondef-title rubric">Protected Functions</p>
<dl class="function">
<dt id="_CPPv2N6paddle18SparseValueScanner7setDataEPiP4realP8PyObject">
<span id="paddle::SparseValueScanner::setData__iP.realP.PyObjectP"></span>virtual <span class="target" id="paddleclasspaddle_1_1SparseValueScanner_1a7ce575283c13b11a44f7236507e68b01"></span>void <code class="descname">setData</code><span class="sig-paren">(</span>int *<em>col</em>, real *<em>dat</em>, PyObject *<em>obj</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle18SparseValueScanner7setDataEPiP4realP8PyObject" title="Permalink to this definition"></a></dt>
<dd><p>Set a single sparse index and value. <dl class="docutils">
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">col</span></code> - <p>sparse index </p>
</li>
<li><code class="first docutils literal"><span class="pre">dat</span></code> - <p>sparse value </p>
</li>
<li><code class="first docutils literal"><span class="pre">obj</span></code> - <p>Python Object. For sparse_non_value is a PyInt or PyLong. For sparse_value is a Tuple (int, float). </p>
</li>
</ul>
</dd>
</dl>
</p>
</dd></dl>

</div>
</dd></dl>
Y
Upload docs  
Yu Yang 已提交
768 769 770 771 772 773 774 
</div>
<div class="section" id="sequencescanner">
<h2>SequenceScanner<a class="headerlink" href="#sequencescanner" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="_CPPv2N6paddle18SparseValueScannerE">
<span id="paddle::SparseValueScanner"></span><span class="target" id="paddleclasspaddle_1_1SparseValueScanner"></span><em class="property">class </em><code class="descclassname">paddle::</code><code class="descname">SparseValueScanner</code><a class="headerlink" href="#_CPPv2N6paddle18SparseValueScannerE" title="Permalink to this definition"></a></dt>
<dd><p>Inherits from <a class="reference internal" href="#paddleclasspaddle_1_1SparseNonValueScanner"><span>paddle::SparseNonValueScanner</span></a></p>
Y
Update docs  
Yu Yang 已提交
775 776 777 
<div class="breathe-sectiondef container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
Y
Upload docs  
Yu Yang 已提交
778 779 
<dt id="_CPPv2N6paddle18SparseValueScanner18SparseValueScannerEP10SlotHeader">
<span id="paddle::SparseValueScanner::SparseValueScanner__SlotHeaderP"></span><span class="target" id="paddleclasspaddle_1_1SparseValueScanner_1ac60678603f86a3ee2b1df3bf6b3de343"></span><code class="descname">SparseValueScanner</code><span class="sig-paren">(</span>SlotHeader *<em>ptr</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle18SparseValueScanner18SparseValueScannerEP10SlotHeader" title="Permalink to this definition"></a></dt>
Y
Update docs  
Yu Yang 已提交
780 781 782 
<dd></dd></dl>

<dl class="function">
Y
Upload docs  
Yu Yang 已提交
783 784 785 786 
<dt id="_CPPv2N6paddle18SparseValueScanner13finishPrepareER8Argument">
<span id="paddle::SparseValueScanner::finishPrepare__ArgumentR"></span>virtual <span class="target" id="paddleclasspaddle_1_1SparseValueScanner_1aa24ba4b1484c3db126155e3f6f83134f"></span>void <code class="descname">finishPrepare</code><span class="sig-paren">(</span><a class="reference internal" href="../../parameter/parameter/parameter.html#_CPPv2N6paddle8ArgumentE" title="paddle::Argument">Argument</a> &amp;<em>argument</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle18SparseValueScanner13finishPrepareER8Argument" title="Permalink to this definition"></a></dt>
<dd><p>Finish Prepare step. </p>
</dd></dl>
Y
Update docs  
Yu Yang 已提交
787
Y
Upload docs  
Yu Yang 已提交
788 789 790 
</div>
<div class="breathe-sectiondef container">
<p class="breathe-sectiondef-title rubric">Protected Functions</p>
Y
Update docs  
Yu Yang 已提交
791 
<dl class="function">
Y
Upload docs  
Yu Yang 已提交
792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 
<dt id="_CPPv2N6paddle18SparseValueScanner7setDataEPiP4realP8PyObject">
<span id="paddle::SparseValueScanner::setData__iP.realP.PyObjectP"></span>virtual <span class="target" id="paddleclasspaddle_1_1SparseValueScanner_1a7ce575283c13b11a44f7236507e68b01"></span>void <code class="descname">setData</code><span class="sig-paren">(</span>int *<em>col</em>, real *<em>dat</em>, PyObject *<em>obj</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle18SparseValueScanner7setDataEPiP4realP8PyObject" title="Permalink to this definition"></a></dt>
<dd><p>Set a single sparse index and value. <dl class="docutils">
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">col</span></code> - <p>sparse index </p>
</li>
<li><code class="first docutils literal"><span class="pre">dat</span></code> - <p>sparse value </p>
</li>
<li><code class="first docutils literal"><span class="pre">obj</span></code> - <p>Python Object. For sparse_non_value is a PyInt or PyLong. For sparse_value is a Tuple (int, float). </p>
</li>
</ul>
</dd>
</dl>
</p>
Y
Update docs  
Yu Yang 已提交
807 808 
</dd></dl>
Y
Upload docs  
Yu Yang 已提交
809 810 811 812 813 814 815 816 817 818 819 820 821 
</div>
</dd></dl>

</div>
<div class="section" id="ipydataprovidercache">
<h2>IPyDataProviderCache<a class="headerlink" href="#ipydataprovidercache" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="_CPPv2N6paddle20IPyDataProviderCacheE">
<span id="paddle::IPyDataProviderCache"></span><span class="target" id="paddleclasspaddle_1_1IPyDataProviderCache"></span><em class="property">class </em><code class="descclassname">paddle::</code><code class="descname">IPyDataProviderCache</code><a class="headerlink" href="#_CPPv2N6paddle20IPyDataProviderCacheE" title="Permalink to this definition"></a></dt>
<dd><p>Py Data Provider Cache Interface. </p>
<p>Subclassed by <a class="reference internal" href="#paddleclasspaddle_1_1CacheOnePassInMemory"><span>paddle::CacheOnePassInMemory</span></a>, <a class="reference internal" href="#paddleclasspaddle_1_1NoCacheStrategy"><span>paddle::NoCacheStrategy</span></a></p>
<div class="breathe-sectiondef container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
Y
Update docs  
Yu Yang 已提交
822 
<dl class="function">
Y
Upload docs  
Yu Yang 已提交
823 824 825 826 827 828 829 830 831 832 833 834 
<dt id="_CPPv2N6paddle20IPyDataProviderCacheD0Ev">
<span id="paddle::IPyDataProviderCache::~IPyDataProviderCache"></span>virtual <span class="target" id="paddleclasspaddle_1_1IPyDataProviderCache_1a986e919051b2c173be86b9240c417311"></span><code class="descname">~IPyDataProviderCache</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle20IPyDataProviderCacheD0Ev" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="_CPPv2N6paddle20IPyDataProviderCache5resetEv">
<span id="paddle::IPyDataProviderCache::reset"></span>virtual <span class="target" id="paddleclasspaddle_1_1IPyDataProviderCache_1acb82068255c8feecd946722b1e087fd1"></span>bool <code class="descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span> = 0<a class="headerlink" href="#_CPPv2N6paddle20IPyDataProviderCache5resetEv" title="Permalink to this definition"></a></dt>
<dd><p>invoke when <a class="reference internal" href="#paddleclasspaddle_1_1DataProvider_1a0c1ec00a365e8cd12ad170ac00879890"><span>DataProvider::reset()</span></a> <dl class="docutils">
<dt><strong>Return</strong></dt>
<dd>true if read data from python. </dd>
</dl>
</p>
Y
Update docs  
Yu Yang 已提交
835 836 837 
</dd></dl>

<dl class="function">
Y
Upload docs  
Yu Yang 已提交
838 839 840 841 842 843 844 845 846 847 848 849 850 
<dt id="_CPPv2N6paddle20IPyDataProviderCache4dropEPNSt5dequeI11PyObjectPtrEE">
<span id="paddle::IPyDataProviderCache::drop__std::deque:PyObjectPtr:P"></span>virtual <span class="target" id="paddleclasspaddle_1_1IPyDataProviderCache_1a7dbdb55a79bd8aa1bff28a4b1e36d81c"></span>void <code class="descname">drop</code><span class="sig-paren">(</span>std::deque&lt;PyObjectPtr&gt; *<em>data</em><span class="sig-paren">)</span> = 0<a class="headerlink" href="#_CPPv2N6paddle20IPyDataProviderCache4dropEPNSt5dequeI11PyObjectPtrEE" title="Permalink to this definition"></a></dt>
<dd><p>invoke when these data are used by <a class="reference internal" href="#paddleclasspaddle_1_1DataProvider"><span>DataProvider</span></a>, and need to clear. <dl class="docutils">
<dt><strong>Note</strong></dt>
<dd>The implemented class must clear these data array. Or if you want to delete the PyObjectPtr later, you should make sure the paddle process only have one active thread calling python code (use PyGuard otherwise). </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">data</span></code> - <p>used data.</p>
</li>
</ul>
</dd>
</dl>
</p>
Y
Update docs  
Yu Yang 已提交
851 852 853 
</dd></dl>

<dl class="function">
Y
Upload docs  
Yu Yang 已提交
854 855 856 857 
<dt id="_CPPv2N6paddle20IPyDataProviderCache4loadEv">
<span id="paddle::IPyDataProviderCache::load"></span>virtual <span class="target" id="paddleclasspaddle_1_1IPyDataProviderCache_1a59ccf101c184477ff77ea0f618eeffc8"></span>std::deque&lt;PyObjectPtr&gt; *<code class="descname">load</code><span class="sig-paren">(</span><span class="sig-paren">)</span> = 0<a class="headerlink" href="#_CPPv2N6paddle20IPyDataProviderCache4loadEv" title="Permalink to this definition"></a></dt>
<dd><p>Return whole data in cache. </p>
</dd></dl>
Y
Update docs  
Yu Yang 已提交
858 859 860 

</div>
<div class="breathe-sectiondef container">
Y
Upload docs  
Yu Yang 已提交
861 862 863 864 865 866 
<p class="breathe-sectiondef-title rubric">Public Static Functions</p>
<dl class="function">
<dt id="_CPPv2N6paddle20IPyDataProviderCache6createE9CacheType">
<span id="paddle::IPyDataProviderCache::create__CacheType"></span><span class="target" id="paddleclasspaddle_1_1IPyDataProviderCache_1af390cc1038d92e555d4173f31397cc91"></span><a class="reference internal" href="#_CPPv2N6paddle20IPyDataProviderCacheE" title="paddle::IPyDataProviderCache">IPyDataProviderCache</a> *<code class="descname">create</code><span class="sig-paren">(</span>CacheType <em>ct</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle20IPyDataProviderCache6createE9CacheType" title="Permalink to this definition"></a></dt>
<dd><p>Factory method. Convert CacheType to IPyDataProviderCache* </p>
</dd></dl>
Y
Update docs  
Yu Yang 已提交
867
Y
Upload docs  
Yu Yang 已提交
868 869 
</div>
</dd></dl>
Y
Update docs  
Yu Yang 已提交
870 871 

</div>
Y
Upload docs  
Yu Yang 已提交
872 873 874 875 876 877 878 
<div class="section" id="nocachestrategy">
<h2>NoCacheStrategy<a class="headerlink" href="#nocachestrategy" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="_CPPv2N6paddle15NoCacheStrategyE">
<span id="paddle::NoCacheStrategy"></span><span class="target" id="paddleclasspaddle_1_1NoCacheStrategy"></span><em class="property">class </em><code class="descclassname">paddle::</code><code class="descname">NoCacheStrategy</code><a class="headerlink" href="#_CPPv2N6paddle15NoCacheStrategyE" title="Permalink to this definition"></a></dt>
<dd><p>No Cache Strategy. Will destruct old data immediately and load data from python every pass. </p>
<p>Inherits from <a class="reference internal" href="#paddleclasspaddle_1_1IPyDataProviderCache"><span>paddle::IPyDataProviderCache</span></a></p>
Y
Update docs  
Yu Yang 已提交
879 
<div class="breathe-sectiondef container">
Y
Upload docs  
Yu Yang 已提交
880 881 882 883 884 885 886 887 888 889 
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
<dt id="_CPPv2N6paddle15NoCacheStrategy5resetEv">
<span id="paddle::NoCacheStrategy::reset"></span>virtual <span class="target" id="paddleclasspaddle_1_1NoCacheStrategy_1a6df4eaccffeb0e7e69f68afb98300fc0"></span>bool <code class="descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle15NoCacheStrategy5resetEv" title="Permalink to this definition"></a></dt>
<dd><p>invoke when <a class="reference internal" href="#paddleclasspaddle_1_1DataProvider_1a0c1ec00a365e8cd12ad170ac00879890"><span>DataProvider::reset()</span></a> <dl class="docutils">
<dt><strong>Return</strong></dt>
<dd>true if read data from python. </dd>
</dl>
</p>
</dd></dl>
Y
Update docs  
Yu Yang 已提交
890
Y
Upload docs  
Yu Yang 已提交
891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 
<dl class="function">
<dt id="_CPPv2N6paddle15NoCacheStrategy4dropEPNSt5dequeI11PyObjectPtrEE">
<span id="paddle::NoCacheStrategy::drop__std::deque:PyObjectPtr:P"></span>virtual <span class="target" id="paddleclasspaddle_1_1NoCacheStrategy_1a9333fe134249c2ac567df6044d6367de"></span>void <code class="descname">drop</code><span class="sig-paren">(</span>std::deque&lt;PyObjectPtr&gt; *<em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle15NoCacheStrategy4dropEPNSt5dequeI11PyObjectPtrEE" title="Permalink to this definition"></a></dt>
<dd><p>invoke when these data are used by <a class="reference internal" href="#paddleclasspaddle_1_1DataProvider"><span>DataProvider</span></a>, and need to clear. <dl class="docutils">
<dt><strong>Note</strong></dt>
<dd>The implemented class must clear these data array. Or if you want to delete the PyObjectPtr later, you should make sure the paddle process only have one active thread calling python code (use PyGuard otherwise). </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">data</span></code> - <p>used data.</p>
</li>
</ul>
</dd>
</dl>
</p>
</dd></dl>
Y
Update docs  
Yu Yang 已提交
906
Y
Upload docs  
Yu Yang 已提交
907 908 909 910 911 
<dl class="function">
<dt id="_CPPv2N6paddle15NoCacheStrategy4loadEv">
<span id="paddle::NoCacheStrategy::load"></span>virtual <span class="target" id="paddleclasspaddle_1_1NoCacheStrategy_1afb54b93574a3f43104d8e55d2d8c259b"></span>std::deque&lt;PyObjectPtr&gt; *<code class="descname">load</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle15NoCacheStrategy4loadEv" title="Permalink to this definition"></a></dt>
<dd><p>Return whole data in cache. </p>
</dd></dl>
Y
Update docs  
Yu Yang 已提交
912
Y
Upload docs  
Yu Yang 已提交
913 914 
</div>
</dd></dl>
Y
Update docs  
Yu Yang 已提交
915 916 

</div>
Y
Upload docs  
Yu Yang 已提交
917 918 919 920 921 922 923 924 
<div class="section" id="cacheonepassinmemory">
<h2>CacheOnePassInMemory<a class="headerlink" href="#cacheonepassinmemory" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="_CPPv2N6paddle20CacheOnePassInMemoryE">
<span id="paddle::CacheOnePassInMemory"></span><span class="target" id="paddleclasspaddle_1_1CacheOnePassInMemory"></span><em class="property">class </em><code class="descclassname">paddle::</code><code class="descname">CacheOnePassInMemory</code><a class="headerlink" href="#_CPPv2N6paddle20CacheOnePassInMemoryE" title="Permalink to this definition"></a></dt>
<dd><p>Cache One Pass In Memory strategy.</p>
<p>In first pass, will load data from python and store them in memory. The rest passes, will load data from memory. </p>
<p>Inherits from <a class="reference internal" href="#paddleclasspaddle_1_1IPyDataProviderCache"><span>paddle::IPyDataProviderCache</span></a></p>
Y
Update docs  
Yu Yang 已提交
925 
<div class="breathe-sectiondef container">
Y
Upload docs  
Yu Yang 已提交
926 
<p class="breathe-sectiondef-title rubric">Public Functions</p>
Y
Update docs  
Yu Yang 已提交
927 
<dl class="function">
Y
Upload docs  
Yu Yang 已提交
928 929 
<dt id="_CPPv2N6paddle20CacheOnePassInMemory20CacheOnePassInMemoryEv">
<span id="paddle::CacheOnePassInMemory::CacheOnePassInMemory"></span><span class="target" id="paddleclasspaddle_1_1CacheOnePassInMemory_1a9ffe6049eac836b6c281b67fea71e524"></span><code class="descname">CacheOnePassInMemory</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle20CacheOnePassInMemory20CacheOnePassInMemoryEv" title="Permalink to this definition"></a></dt>
Y
Update docs  
Yu Yang 已提交
930 931 932 
<dd></dd></dl>

<dl class="function">
Y
Upload docs  
Yu Yang 已提交
933 934 935 936 937 938 939 940 
<dt id="_CPPv2N6paddle20CacheOnePassInMemory5resetEv">
<span id="paddle::CacheOnePassInMemory::reset"></span>virtual <span class="target" id="paddleclasspaddle_1_1CacheOnePassInMemory_1ac2faf131badc1a5e238f5c591abee499"></span>bool <code class="descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle20CacheOnePassInMemory5resetEv" title="Permalink to this definition"></a></dt>
<dd><p>invoke when <a class="reference internal" href="#paddleclasspaddle_1_1DataProvider_1a0c1ec00a365e8cd12ad170ac00879890"><span>DataProvider::reset()</span></a> <dl class="docutils">
<dt><strong>Return</strong></dt>
<dd>true if read data from python. </dd>
</dl>
</p>
</dd></dl>
Y
Update docs  
Yu Yang 已提交
941 942 

<dl class="function">
Y
Upload docs  
Yu Yang 已提交
943 944 945 946 947 948 949 950 951 952 953 954 955 956 
<dt id="_CPPv2N6paddle20CacheOnePassInMemory4dropEPNSt5dequeI11PyObjectPtrEE">
<span id="paddle::CacheOnePassInMemory::drop__std::deque:PyObjectPtr:P"></span>virtual <span class="target" id="paddleclasspaddle_1_1CacheOnePassInMemory_1ae535ea1707a787e4888cb4c908f82705"></span>void <code class="descname">drop</code><span class="sig-paren">(</span>std::deque&lt;PyObjectPtr&gt; *<em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle20CacheOnePassInMemory4dropEPNSt5dequeI11PyObjectPtrEE" title="Permalink to this definition"></a></dt>
<dd><p>invoke when these data are used by <a class="reference internal" href="#paddleclasspaddle_1_1DataProvider"><span>DataProvider</span></a>, and need to clear. <dl class="docutils">
<dt><strong>Note</strong></dt>
<dd>The implemented class must clear these data array. Or if you want to delete the PyObjectPtr later, you should make sure the paddle process only have one active thread calling python code (use PyGuard otherwise). </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">data</span></code> - <p>used data.</p>
</li>
</ul>
</dd>
</dl>
</p>
</dd></dl>
Y
Update docs  
Yu Yang 已提交
957 958 

<dl class="function">
Y
Upload docs  
Yu Yang 已提交
959 960 961 
<dt id="_CPPv2N6paddle20CacheOnePassInMemory4loadEv">
<span id="paddle::CacheOnePassInMemory::load"></span>virtual <span class="target" id="paddleclasspaddle_1_1CacheOnePassInMemory_1a95549d6eef3022fe85cac854d3caff74"></span>std::deque&lt;PyObjectPtr&gt; *<code class="descname">load</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle20CacheOnePassInMemory4loadEv" title="Permalink to this definition"></a></dt>
<dd><p>Return whole data in cache. </p>
Y
Update docs  
Yu Yang 已提交
962 963 
</dd></dl>
Y
Upload docs  
Yu Yang 已提交
964 
</div>
Y
Update docs  
Yu Yang 已提交
965 966 
</dd></dl>
Y
Upload docs  
Yu Yang 已提交
967 968 969 970 971 972 973 974 975 976 
</div>
<div class="section" id="ipydataprovider">
<h2>IPyDataProvider<a class="headerlink" href="#ipydataprovider" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="_CPPv2N6paddle15PyDataProvider2E">
<span id="paddle::PyDataProvider2"></span><span class="target" id="paddleclasspaddle_1_1PyDataProvider2"></span><em class="property">class </em><code class="descclassname">paddle::</code><code class="descname">PyDataProvider2</code><a class="headerlink" href="#_CPPv2N6paddle15PyDataProvider2E" title="Permalink to this definition"></a></dt>
<dd><p><a class="reference internal" href="#paddleclasspaddle_1_1PyDataProvider2"><span>PyDataProvider2</span></a>.</p>
<p>For usage, please refer python module &#8216;paddle.trainer.PyDataProvider2&#8217;</p>
<p>Here, we start a thread to read data. It is totally asynchronous for reading data. And it support cache strategies. </p>
<p>Inherits from <a class="reference internal" href="#paddleclasspaddle_1_1DataProvider"><span>paddle::DataProvider</span></a></p>
Y
Update docs  
Yu Yang 已提交
977 978 979 
<div class="breathe-sectiondef container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
Y
Upload docs  
Yu Yang 已提交
980 981 982 983 
<dt id="_CPPv2N6paddle15PyDataProvider215PyDataProvider2ERK10DataConfigb">
<span id="paddle::PyDataProvider2::PyDataProvider2__DataConfigCR.b"></span><span class="target" id="paddleclasspaddle_1_1PyDataProvider2_1a493a2635a8b83aeb9be3ce6db0d3aa55"></span><code class="descname">PyDataProvider2</code><span class="sig-paren">(</span><em class="property">const</em> DataConfig &amp;<em>config</em>, bool <em>useGpu</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle15PyDataProvider215PyDataProvider2ERK10DataConfigb" title="Permalink to this definition"></a></dt>
<dd><p>Ctor </p>
</dd></dl>
Y
Update docs  
Yu Yang 已提交
984 985 

<dl class="function">
Y
Upload docs  
Yu Yang 已提交
986 987 988 989 990 991 992 
<dt id="_CPPv2N6paddle15PyDataProvider2D0Ev">
<span id="paddle::PyDataProvider2::~PyDataProvider2"></span>virtual <span class="target" id="paddleclasspaddle_1_1PyDataProvider2_1a3f265566b0f6bb653a2d37ddbb8beb11"></span><code class="descname">~PyDataProvider2</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle15PyDataProvider2D0Ev" title="Permalink to this definition"></a></dt>
<dd><p>Dtor <dl class="docutils">
<dt><strong>Note</strong></dt>
<dd>will stop loading thread when destructing </dd>
</dl>
</p>
Y
Update docs  
Yu Yang 已提交
993 994 995 
</dd></dl>

<dl class="function">
Y
Upload docs  
Yu Yang 已提交
996 997 998 
<dt id="_CPPv2N6paddle15PyDataProvider25resetEv">
<span id="paddle::PyDataProvider2::reset"></span>virtual <span class="target" id="paddleclasspaddle_1_1PyDataProvider2_1a905324717b124964912952f267dba44b"></span>void <code class="descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle15PyDataProvider25resetEv" title="Permalink to this definition"></a></dt>
<dd><p>Resetting the PyDataProvider. May start reading thread here. </p>
Y
Update docs  
Yu Yang 已提交
999 1000 1001 
</dd></dl>

<dl class="function">
Y
Upload docs  
Yu Yang 已提交
1002 1003 1004 
<dt id="_CPPv2N6paddle15PyDataProvider27shuffleEv">
<span id="paddle::PyDataProvider2::shuffle"></span>virtual <span class="target" id="paddleclasspaddle_1_1PyDataProvider2_1a94938d24c413541633a31f2f95ce9503"></span>void <code class="descname">shuffle</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle15PyDataProvider27shuffleEv" title="Permalink to this definition"></a></dt>
<dd><p>Shuffle. Do nothing because PyDataProvider do shuffle implicitly by random select data from datapool. </p>
Y
Update docs  
Yu Yang 已提交
1005 1006 1007 
</dd></dl>

<dl class="function">
Y
Upload docs  
Yu Yang 已提交
1008 1009 1010 1011 
<dt id="_CPPv2N6paddle15PyDataProvider27getSizeEv">
<span id="paddle::PyDataProvider2::getSize"></span>virtual <span class="target" id="paddleclasspaddle_1_1PyDataProvider2_1af10be764838042265b1b57d6d23683ec"></span>int64_t <code class="descname">getSize</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle15PyDataProvider27getSizeEv" title="Permalink to this definition"></a></dt>
<dd><p>Not limited size. </p>
</dd></dl>
Y
Update docs  
Yu Yang 已提交
1012 1013 

<dl class="function">
Y
Upload docs  
Yu Yang 已提交
1014 1015 1016 
<dt id="_CPPv2N6paddle15PyDataProvider220getNextBatchInternalE7int64_tP9DataBatch">
<span id="paddle::PyDataProvider2::getNextBatchInternal__int64_t.DataBatchP"></span>virtual <span class="target" id="paddleclasspaddle_1_1PyDataProvider2_1a208602779d17708e5134f1120f3f0b6e"></span>int64_t <code class="descname">getNextBatchInternal</code><span class="sig-paren">(</span>int64_t <em>size_</em>, DataBatch *<em>batch</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle15PyDataProvider220getNextBatchInternalE7int64_tP9DataBatch" title="Permalink to this definition"></a></dt>
<dd><p>Loading a batch of data. </p>
Y
Update docs  
Yu Yang 已提交
1017 1018 
</dd></dl>
Y
Upload docs  
Yu Yang 已提交
1019 
</div>
Y
Update docs  
Yu Yang 已提交
1020 1021 
</dd></dl>
Y
Upload docs  
Yu Yang 已提交
1022 
</div>
Y
Update docs  
Yu Yang 已提交
1023 1024 
</div>
<div class="section" id="proto-data-provider">
Y
Upload docs  
Yu Yang 已提交
1025 1026 1027 1028 
<h1>Proto Data Provider<a class="headerlink" href="#proto-data-provider" title="Permalink to this headline"></a></h1>
<div class="section" id="protodataprovider">
<h2>ProtoDataProvider<a class="headerlink" href="#protodataprovider" title="Permalink to this headline"></a></h2>
<dl class="class">
Y
Update docs  
Yu Yang 已提交
1029 
<dt id="_CPPv2N6paddle17ProtoDataProviderE">
Y
Upload docs  
Yu Yang 已提交
1030 1031 1032 
<span id="paddle::ProtoDataProvider"></span><span class="target" id="paddleclasspaddle_1_1ProtoDataProvider"></span><em class="property">class </em><code class="descclassname">paddle::</code><code class="descname">ProtoDataProvider</code><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProviderE" title="Permalink to this definition"></a></dt>
<dd><p>Provider data from protobuf data file with each sample specified by proto message. </p>
<p>DataSample defined in DataFormat.proto.</p>
Y
Update docs  
Yu Yang 已提交
1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 
<p>The file format is</p>
<p>header</p>
<p>sample1</p>
<p>sample2</p>
<p>...</p>
<p>sampleN</p>
<p><dl class="docutils">
<dt><strong>Note</strong></dt>
<dd>: In the data file, each message is prefixed with its length. The read/write of the protbuf are implemented in ProtoReader.h </dd>
</dl>
</p>
<p>Inherits from <a class="reference internal" href="#paddleclasspaddle_1_1DataProvider"><span>paddle::DataProvider</span></a></p>
<p>Subclassed by <a class="reference internal" href="#paddleclasspaddle_1_1ProtoSequenceDataProvider"><span>paddle::ProtoSequenceDataProvider</span></a></p>
<div class="breathe-sectiondef container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
<dt id="_CPPv2N6paddle17ProtoDataProvider17ProtoDataProviderERK10DataConfigbb">
<span id="paddle::ProtoDataProvider::ProtoDataProvider__DataConfigCR.b.b"></span><span class="target" id="paddleclasspaddle_1_1ProtoDataProvider_1a1444b87df672b4dd937d5647fee23936"></span><code class="descname">ProtoDataProvider</code><span class="sig-paren">(</span><em class="property">const</em> DataConfig &amp;<em>config</em>, bool <em>useGpu</em>, bool <em>loadDataAll</em> = true<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider17ProtoDataProviderERK10DataConfigbb" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="_CPPv2N6paddle17ProtoDataProvider5resetEv">
<span id="paddle::ProtoDataProvider::reset"></span>virtual <span class="target" id="paddleclasspaddle_1_1ProtoDataProvider_1a4c31d54b6f4ec7e6e11a8824650ec34f"></span>void <code class="descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider5resetEv" title="Permalink to this definition"></a></dt>
Y
Upload docs  
Yu Yang 已提交
1056 1057 1058 1059 1060 1061 
<dd><p>reset all the value of index </p>
<p><dl class="docutils">
<dt><strong>Note</strong></dt>
<dd><a class="reference internal" href="#paddleclasspaddle_1_1ProtoDataProvider_1a4c31d54b6f4ec7e6e11a8824650ec34f"><span>reset()</span></a> must be called before any calls to <a class="reference internal" href="#paddleclasspaddle_1_1DataProvider_1a98d9d269b628ac7c8354a8a7de049a7b"><span>getNextBatch()</span></a> IMPORTANT: subclass <a class="reference internal" href="#paddleclasspaddle_1_1ProtoDataProvider_1a4c31d54b6f4ec7e6e11a8824650ec34f"><span>reset()</span></a> should always call the base class <a class="reference internal" href="#paddleclasspaddle_1_1ProtoDataProvider_1a4c31d54b6f4ec7e6e11a8824650ec34f"><span>reset()</span></a> at the end of the function </dd>
</dl>
</p>
Y
Update docs  
Yu Yang 已提交
1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 
</dd></dl>

<dl class="function">
<dt id="_CPPv2N6paddle17ProtoDataProvider7getSizeEv">
<span id="paddle::ProtoDataProvider::getSize"></span>virtual <span class="target" id="paddleclasspaddle_1_1ProtoDataProvider_1a2937d941318f1692cd9aed6cafcaf13e"></span>int64_t <code class="descname">getSize</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider7getSizeEv" title="Permalink to this definition"></a></dt>
<dd><p><dl class="docutils">
<dt><strong>Note</strong></dt>
<dd>this size includes the sequences which are skipped because they are longer than the batch size. </dd>
</dl>
</p>
</dd></dl>

<dl class="function">
<dt id="_CPPv2N6paddle17ProtoDataProvider7shuffleEv">
<span id="paddle::ProtoDataProvider::shuffle"></span>virtual <span class="target" id="paddleclasspaddle_1_1ProtoDataProvider_1a5651ad4073486a86f798c54432c852b5"></span>void <code class="descname">shuffle</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider7shuffleEv" title="Permalink to this definition"></a></dt>
Y
Upload docs  
Yu Yang 已提交
1077 
<dd><p>Shuffle the data set. </p>
Y
Update docs  
Yu Yang 已提交
1078 1079 1080 1081 1082 1083 1084 1085 1086 
</dd></dl>

<dl class="function">
<dt id="_CPPv2N6paddle17ProtoDataProvider8loadDataERKNSt6vectorINSt6stringEEE">
<span id="paddle::ProtoDataProvider::loadData__std::vector:ss:CR"></span><span class="target" id="paddleclasspaddle_1_1ProtoDataProvider_1a3ef03215a33b54f58ffa0880ee13c869"></span>void <code class="descname">loadData</code><span class="sig-paren">(</span><em class="property">const</em> std::vector&lt;std::string&gt; &amp;<em>fileList</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider8loadDataERKNSt6vectorINSt6stringEEE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="_CPPv2N6paddle17ProtoDataProvider20getNextBatchInternalE7int64_tP9DataBatch">
Y
Upload docs  
Yu Yang 已提交
1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 
<span id="paddle::ProtoDataProvider::getNextBatchInternal__int64_t.DataBatchP"></span>virtual <span class="target" id="paddleclasspaddle_1_1ProtoDataProvider_1a5562b11758a3c2479101b314097c2e67"></span>int64_t <code class="descname">getNextBatchInternal</code><span class="sig-paren">(</span>int64_t <em>size</em>, DataBatch *<em>batch</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider20getNextBatchInternalE7int64_tP9DataBatch" title="Permalink to this definition"></a></dt>
<dd><p>Get next batch training samples internally. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
<dd>actual size of obtained training samples </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">size</span></code> - <p>size of training samples to get </p>
</li>
<li><code class="first docutils literal"><span class="pre">batch</span></code> - <p>a batch of training samples </p>
</li>
</ul>
</dd>
</dl>
</p>
</dd></dl>
Y
Update docs  
Yu Yang 已提交
1103 1104 1105 1106 1107 1108 1109 

</div>
<div class="breathe-sectiondef container">
<p class="breathe-sectiondef-title rubric">Protected Functions</p>
<dl class="function">
<dt id="_CPPv2N6paddle17ProtoDataProvider8loadDataERKNSt6stringE">
<span id="paddle::ProtoDataProvider::loadData__ssCR"></span><span class="target" id="paddleclasspaddle_1_1ProtoDataProvider_1a8c34e7e24a00bccc3cc5e74354ae2607"></span>void <code class="descname">loadData</code><span class="sig-paren">(</span><em class="property">const</em> std::string &amp;<em>fileName</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider8loadDataERKNSt6stringE" title="Permalink to this definition"></a></dt>
Y
Upload docs  
Yu Yang 已提交
1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 
<dd><p>load protobuf data from a list of file </p>
<p><dl class="docutils">
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">fileName</span></code> - <p>file name of a file which contains a list of file names </p>
</li>
</ul>
</dd>
</dl>
</p>
</dd></dl>
Y
Update docs  
Yu Yang 已提交
1121 1122 1123 1124 

<dl class="function">
<dt id="_CPPv2N6paddle17ProtoDataProvider12loadDataFileERKNSt6stringE">
<span id="paddle::ProtoDataProvider::loadDataFile__ssCR"></span><span class="target" id="paddleclasspaddle_1_1ProtoDataProvider_1afa1f97a7980c9a5d971b78a307ea6f9e"></span>void <code class="descname">loadDataFile</code><span class="sig-paren">(</span><em class="property">const</em> std::string &amp;<em>fileName</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider12loadDataFileERKNSt6stringE" title="Permalink to this definition"></a></dt>
Y
Upload docs  
Yu Yang 已提交
1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 
<dd><p>load protobuf data from file </p>
<p><dl class="docutils">
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">fileName</span></code> - <p>data file name </p>
</li>
</ul>
</dd>
</dl>
</p>
</dd></dl>
Y
Update docs  
Yu Yang 已提交
1136 1137 1138 1139 

<dl class="function">
<dt id="_CPPv2N6paddle17ProtoDataProvider15checkDataHeaderERK10DataHeader">
<span id="paddle::ProtoDataProvider::checkDataHeader__DataHeaderCR"></span><span class="target" id="paddleclasspaddle_1_1ProtoDataProvider_1a1bc314edfeb05e1ff7ef6c9f8d152acf"></span>void <code class="descname">checkDataHeader</code><span class="sig-paren">(</span><em class="property">const</em> DataHeader &amp;<em>header</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider15checkDataHeaderERK10DataHeader" title="Permalink to this definition"></a></dt>
Y
Upload docs  
Yu Yang 已提交
1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 
<dd><p>check data header of each data sample </p>
<p><dl class="docutils">
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">header</span></code> - <p>data header read from protobuf data </p>
</li>
</ul>
</dd>
</dl>
</p>
</dd></dl>
Y
Update docs  
Yu Yang 已提交
1151 1152 1153 1154 

<dl class="function">
<dt id="_CPPv2N6paddle17ProtoDataProvider9fillSlotsERK10DataSample">
<span id="paddle::ProtoDataProvider::fillSlots__DataSampleCR"></span><span class="target" id="paddleclasspaddle_1_1ProtoDataProvider_1a045666b799ab0679fd8abc9d57ee3235"></span>void <code class="descname">fillSlots</code><span class="sig-paren">(</span><em class="property">const</em> DataSample &amp;<em>sample</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider9fillSlotsERK10DataSample" title="Permalink to this definition"></a></dt>
Y
Upload docs  
Yu Yang 已提交
1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 
<dd><p>fill protobuf data into slot_, slot_ is a vector of <a class="reference internal" href="#paddlestructpaddle_1_1ProtoDataProvider_1_1ProtoSlot"><span>ProtoSlot</span></a> in memory. </p>
<p><dl class="docutils">
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">sample</span></code> - <p>data sample read from protobuf data </p>
</li>
</ul>
</dd>
</dl>
</p>
</dd></dl>
Y
Update docs  
Yu Yang 已提交
1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 

<dl class="function">
<dt id="_CPPv2N6paddle17ProtoDataProvider7iidDataEv">
<span id="paddle::ProtoDataProvider::iidData"></span><span class="target" id="paddleclasspaddle_1_1ProtoDataProvider_1a331829ff4263fea18ac791113085e814"></span>bool <code class="descname">iidData</code><span class="sig-paren">(</span><span class="sig-paren">)</span> const<a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider7iidDataEv" title="Permalink to this definition"></a></dt>
<dd><p>return true if each sample is one sequence, i.e., independent of other samples. </p>
</dd></dl>

<dl class="function">
<dt id="_CPPv2N6paddle17ProtoDataProvider11checkSampleERK10DataSample">
<span id="paddle::ProtoDataProvider::checkSample__DataSampleCR"></span><span class="target" id="paddleclasspaddle_1_1ProtoDataProvider_1ad7049069d10986c616e1d191e5ec0d81"></span>void <code class="descname">checkSample</code><span class="sig-paren">(</span><em class="property">const</em> DataSample &amp;<em>sample</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider11checkSampleERK10DataSample" title="Permalink to this definition"></a></dt>
Y
Upload docs  
Yu Yang 已提交
1176 1177 
<dd><p>check that sample is consistent with header_ </p>
</dd></dl>
Y
Update docs  
Yu Yang 已提交
1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 

<dl class="function">
<dt>
<em class="property">template </em>&lt;<em class="property">class</em> Op&gt;</dt>
<dt id="_CPPv2N6paddle17ProtoDataProvider12sequenceLoopE2Op7int64_t">
<span id="paddle::ProtoDataProvider::sequenceLoop__Op.int64_t"></span><span class="target" id="paddleclasspaddle_1_1ProtoDataProvider_1abc5d838bf06d417a89671affbd5687ef"></span>int64_t <code class="descname">sequenceLoop</code><span class="sig-paren">(</span>Op <em>op</em>, int64_t <em>size</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider12sequenceLoopE2Op7int64_t" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="function">
<dt>
<em class="property">template </em>&lt;<em class="property">class</em> Op&gt;</dt>
<dt id="_CPPv2N6paddle17ProtoDataProvider10sampleLoopE2Op7int64_t">
<span id="paddle::ProtoDataProvider::sampleLoop__Op.int64_t"></span><span class="target" id="paddleclasspaddle_1_1ProtoDataProvider_1a2120b825191a2027ff721c83782b106c"></span>int64_t <code class="descname">sampleLoop</code><span class="sig-paren">(</span>Op <em>op</em>, int64_t <em>size</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider10sampleLoopE2Op7int64_t" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="function">
<dt>
<em class="property">template </em>&lt;<em class="property">class</em> Op&gt;</dt>
<dt id="_CPPv2N6paddle17ProtoDataProvider13subSampleLoopE2Op7int64_ti">
<span id="paddle::ProtoDataProvider::subSampleLoop__Op.int64_t.i"></span><span class="target" id="paddleclasspaddle_1_1ProtoDataProvider_1a2b7076c45d5a91e3a15335d49174450c"></span>int64_t <code class="descname">subSampleLoop</code><span class="sig-paren">(</span>Op <em>op</em>, int64_t <em>size</em>, int <em>slot</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider13subSampleLoopE2Op7int64_ti" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="_CPPv2N6paddle17ProtoDataProvider13showDataStatsEv">
<span id="paddle::ProtoDataProvider::showDataStats"></span><span class="target" id="paddleclasspaddle_1_1ProtoDataProvider_1a6080604d45a6c7302b7fea76c4a3bc1c"></span>void <code class="descname">showDataStats</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider13showDataStatsEv" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

</div>
<div class="breathe-sectiondef container">
<p class="breathe-sectiondef-title rubric">Protected Attributes</p>
<dl class="member">
<dt id="_CPPv2N6paddle17ProtoDataProvider7header_E">
<span id="paddle::ProtoDataProvider::header___DataHeader"></span><span class="target" id="paddleclasspaddle_1_1ProtoDataProvider_1a7cb5edec235db30d5c5c033ca9ee443f"></span>DataHeader <code class="descname">header_</code><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider7header_E" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="member">
<dt id="_CPPv2N6paddle17ProtoDataProvider12numVecSlots_E">
<span id="paddle::ProtoDataProvider::numVecSlots___i"></span><span class="target" id="paddleclasspaddle_1_1ProtoDataProvider_1a87a24205bc188931f029b6ea22750dda"></span>int <code class="descname">numVecSlots_</code><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider12numVecSlots_E" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="member">
<dt id="_CPPv2N6paddle17ProtoDataProvider6slots_E">
<span id="paddle::ProtoDataProvider::slots___std::vector:ProtoSlot:"></span><span class="target" id="paddleclasspaddle_1_1ProtoDataProvider_1a0a31d2c6ea254cef43ef9161f8e65e52"></span>std::vector&lt;<a class="reference internal" href="#_CPPv2N6paddle17ProtoDataProvider9ProtoSlotE" title="paddle::ProtoDataProvider::ProtoSlot">ProtoSlot</a>&gt; <code class="descname">slots_</code><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider6slots_E" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="member">
<dt id="_CPPv2N6paddle17ProtoDataProvider11sampleNums_E">
<span id="paddle::ProtoDataProvider::sampleNums___s"></span><span class="target" id="paddleclasspaddle_1_1ProtoDataProvider_1afb5e9c365f039b3cdd90fd453a289ab7"></span>size_t <code class="descname">sampleNums_</code><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider11sampleNums_E" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="member">
<dt id="_CPPv2N6paddle17ProtoDataProvider23sequenceStartPositions_E">
<span id="paddle::ProtoDataProvider::sequenceStartPositions___std::vector:s:"></span><span class="target" id="paddleclasspaddle_1_1ProtoDataProvider_1af872deeb9526acc95cdb1eeb1ebd08e3"></span>std::vector&lt;size_t&gt; <code class="descname">sequenceStartPositions_</code><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider23sequenceStartPositions_E" title="Permalink to this definition"></a></dt>
<dd><p>The starting position of each sequence in samples. The last element should be num of samples. If empty, each sample is one sequence. </p>
</dd></dl>

<dl class="member">
<dt id="_CPPv2N6paddle17ProtoDataProvider21currentSequenceIndex_E">
<span id="paddle::ProtoDataProvider::currentSequenceIndex___int64_t"></span><span class="target" id="paddleclasspaddle_1_1ProtoDataProvider_1a5f8b70c01ccccc8406cb26cd8adaa7eb"></span>int64_t <code class="descname">currentSequenceIndex_</code><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider21currentSequenceIndex_E" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="member">
<dt id="_CPPv2N6paddle17ProtoDataProvider20shuffledSequenceIds_E">
<span id="paddle::ProtoDataProvider::shuffledSequenceIds___std::vector:s:"></span><span class="target" id="paddleclasspaddle_1_1ProtoDataProvider_1a50ef3267cae329ec134691da482f49b5"></span>std::vector&lt;size_t&gt; <code class="descname">shuffledSequenceIds_</code><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider20shuffledSequenceIds_E" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="member">
<dt id="_CPPv2N6paddle17ProtoDataProvider9cpuBatch_E">
Y
Upload docs  
Yu Yang 已提交
1246 
<span id="paddle::ProtoDataProvider::cpuBatch___ThreadLocalD:DataBatch:"></span><span class="target" id="paddleclasspaddle_1_1ProtoDataProvider_1aa67b8e5444e4853e0e864910fad9964b"></span>ThreadLocalD&lt;DataBatch&gt; <code class="descname">cpuBatch_</code><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider9cpuBatch_E" title="Permalink to this definition"></a></dt>
Y
Update docs  
Yu Yang 已提交
1247 1248 1249 1250 
<dd></dd></dl>

<dl class="member">
<dt id="_CPPv2N6paddle17ProtoDataProvider9gpuBatch_E">
Y
Upload docs  
Yu Yang 已提交
1251 
<span id="paddle::ProtoDataProvider::gpuBatch___ThreadLocalD:DataBatch:"></span><span class="target" id="paddleclasspaddle_1_1ProtoDataProvider_1a8e61322f799747d216955245278dc3bf"></span>ThreadLocalD&lt;DataBatch&gt; <code class="descname">gpuBatch_</code><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider9gpuBatch_E" title="Permalink to this definition"></a></dt>
Y
Update docs  
Yu Yang 已提交
1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 
<dd></dd></dl>

<dl class="member">
<dt id="_CPPv2N6paddle17ProtoDataProvider5lock_E">
<span id="paddle::ProtoDataProvider::lock___RWLock"></span><span class="target" id="paddleclasspaddle_1_1ProtoDataProvider_1ad956c5a11a361d09aabcfa28f0e678a7"></span><a class="reference internal" href="../../utils/thread.html#_CPPv2N6paddle6RWLockE" title="paddle::RWLock">RWLock</a> <code class="descname">lock_</code><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider5lock_E" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="member">
<dt id="_CPPv2N6paddle17ProtoDataProvider9nnzStats_E">
<span id="paddle::ProtoDataProvider::nnzStats___std::vector:StatPtr:"></span><span class="target" id="paddleclasspaddle_1_1ProtoDataProvider_1a25e72fe5b6dd687e9672d395d2bf7efd"></span>std::vector&lt;StatPtr&gt; <code class="descname">nnzStats_</code><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider9nnzStats_E" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

</div>
<dl class="class">
<dt id="_CPPv2N6paddle17ProtoDataProvider9ProtoSlotE">
<span id="paddle::ProtoDataProvider::ProtoSlot"></span><span class="target" id="paddlestructpaddle_1_1ProtoDataProvider_1_1ProtoSlot"></span><em class="property">struct </em><code class="descname">ProtoSlot</code><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider9ProtoSlotE" title="Permalink to this definition"></a></dt>
<dd><div class="breathe-sectiondef container">
<p class="breathe-sectiondef-title rubric">Public Members</p>
<dl class="member">
<dt id="_CPPv2N6paddle17ProtoDataProvider9ProtoSlot4typeE">
<span id="paddle::ProtoDataProvider::ProtoSlot::type__SlotDef::SlotType"></span><span class="target" id="paddlestructpaddle_1_1ProtoDataProvider_1_1ProtoSlot_1a756d632bac54b2915069cc0712753895"></span>SlotDef::SlotType <code class="descname">type</code><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider9ProtoSlot4typeE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="member">
<dt id="_CPPv2N6paddle17ProtoDataProvider9ProtoSlot3dimE">
<span id="paddle::ProtoDataProvider::ProtoSlot::dim__i"></span><span class="target" id="paddlestructpaddle_1_1ProtoDataProvider_1_1ProtoSlot_1a7287f7d382b6cacbfa75e79270c476e4"></span>int <code class="descname">dim</code><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider9ProtoSlot3dimE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="member">
<dt id="_CPPv2N6paddle17ProtoDataProvider9ProtoSlot9indexDataE">
<span id="paddle::ProtoDataProvider::ProtoSlot::indexData__std::vector:i:"></span><span class="target" id="paddlestructpaddle_1_1ProtoDataProvider_1_1ProtoSlot_1a244da06737c7902a85d0d8392b65183b"></span>std::vector&lt;int&gt; <code class="descname">indexData</code><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider9ProtoSlot9indexDataE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="member">
<dt id="_CPPv2N6paddle17ProtoDataProvider9ProtoSlot9denseDataE">
<span id="paddle::ProtoDataProvider::ProtoSlot::denseData__std::vector:real:"></span><span class="target" id="paddlestructpaddle_1_1ProtoDataProvider_1_1ProtoSlot_1a71ed272648ae1a3fc1df49d4daa2e0f0"></span>std::vector&lt;real&gt; <code class="descname">denseData</code><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider9ProtoSlot9denseDataE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="member">
<dt id="_CPPv2N6paddle17ProtoDataProvider9ProtoSlot18sparseNonValueDataE">
<span id="paddle::ProtoDataProvider::ProtoSlot::sparseNonValueData__std::vector:sparse_non_value_t:"></span><span class="target" id="paddlestructpaddle_1_1ProtoDataProvider_1_1ProtoSlot_1afb39915e14f356233d087fd3a55f0b1a"></span>std::vector&lt;<a class="reference internal" href="../../math/matrix/matrix.html#_CPPv2N6paddle18sparse_non_value_tE" title="paddle::sparse_non_value_t">sparse_non_value_t</a>&gt; <code class="descname">sparseNonValueData</code><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider9ProtoSlot18sparseNonValueDataE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="member">
<dt id="_CPPv2N6paddle17ProtoDataProvider9ProtoSlot20sparseFloatValueDataE">
<span id="paddle::ProtoDataProvider::ProtoSlot::sparseFloatValueData__std::vector:sparse_float_value_t:"></span><span class="target" id="paddlestructpaddle_1_1ProtoDataProvider_1_1ProtoSlot_1a9b30d9bc79f5bb85d22cfff006ac0a8b"></span>std::vector&lt;<a class="reference internal" href="../../math/matrix/matrix.html#_CPPv2N6paddle20sparse_float_value_tE" title="paddle::sparse_float_value_t">sparse_float_value_t</a>&gt; <code class="descname">sparseFloatValueData</code><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider9ProtoSlot20sparseFloatValueDataE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="member">
<dt id="_CPPv2N6paddle17ProtoDataProvider9ProtoSlot7indicesE">
<span id="paddle::ProtoDataProvider::ProtoSlot::indices__std::vector:int64_t:"></span><span class="target" id="paddlestructpaddle_1_1ProtoDataProvider_1_1ProtoSlot_1a2899a55ceded91a71bcc000ec23a549a"></span>std::vector&lt;int64_t&gt; <code class="descname">indices</code><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider9ProtoSlot7indicesE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="member">
<dt id="_CPPv2N6paddle17ProtoDataProvider9ProtoSlot10subIndicesE">
<span id="paddle::ProtoDataProvider::ProtoSlot::subIndices__std::vector:int64_t:"></span><span class="target" id="paddlestructpaddle_1_1ProtoDataProvider_1_1ProtoSlot_1a7b6f0f140df5b083329343bfd7043a59"></span>std::vector&lt;int64_t&gt; <code class="descname">subIndices</code><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider9ProtoSlot10subIndicesE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="member">
<dt id="_CPPv2N6paddle17ProtoDataProvider9ProtoSlot12varDenseDataE">
<span id="paddle::ProtoDataProvider::ProtoSlot::varDenseData__std::vector:ProtoVarSlot:"></span><span class="target" id="paddlestructpaddle_1_1ProtoDataProvider_1_1ProtoSlot_1ae9990f845f1587c3aa5f379cdee6246b"></span>std::vector&lt;<a class="reference internal" href="#_CPPv2N6paddle17ProtoDataProvider12ProtoVarSlotE" title="paddle::ProtoDataProvider::ProtoVarSlot">ProtoVarSlot</a>&gt; <code class="descname">varDenseData</code><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider9ProtoSlot12varDenseDataE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="member">
<dt id="_CPPv2N6paddle17ProtoDataProvider9ProtoSlot10varIndicesE">
<span id="paddle::ProtoDataProvider::ProtoSlot::varIndices__std::vector:std::vector:i::"></span><span class="target" id="paddlestructpaddle_1_1ProtoDataProvider_1_1ProtoSlot_1a50c1ea83c76b671f1956361e5810df60"></span>std::vector&lt;std::vector&lt;int&gt;&gt; <code class="descname">varIndices</code><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider9ProtoSlot10varIndicesE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="member">
<dt id="_CPPv2N6paddle17ProtoDataProvider9ProtoSlot7strDataE">
<span id="paddle::ProtoDataProvider::ProtoSlot::strData__std::vector:ss:"></span><span class="target" id="paddlestructpaddle_1_1ProtoDataProvider_1_1ProtoSlot_1a71c48ff692d1bbedda4f905533a20476"></span>std::vector&lt;std::string&gt; <code class="descname">strData</code><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider9ProtoSlot7strDataE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

</div>
</dd></dl>

<dl class="class">
<dt id="_CPPv2N6paddle17ProtoDataProvider12ProtoVarSlotE">
<span id="paddle::ProtoDataProvider::ProtoVarSlot"></span><span class="target" id="paddlestructpaddle_1_1ProtoDataProvider_1_1ProtoVarSlot"></span><em class="property">struct </em><code class="descname">ProtoVarSlot</code><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider12ProtoVarSlotE" title="Permalink to this definition"></a></dt>
<dd><div class="breathe-sectiondef container">
<p class="breathe-sectiondef-title rubric">Public Members</p>
<dl class="member">
<dt id="_CPPv2N6paddle17ProtoDataProvider12ProtoVarSlot4dataE">
<span id="paddle::ProtoDataProvider::ProtoVarSlot::data__std::vector:real:"></span><span class="target" id="paddlestructpaddle_1_1ProtoDataProvider_1_1ProtoVarSlot_1addc65504ff553e270d4c2ef43d853f77"></span>std::vector&lt;real&gt; <code class="descname">data</code><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider12ProtoVarSlot4dataE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="member">
<dt id="_CPPv2N6paddle17ProtoDataProvider12ProtoVarSlot4dimsE">
<span id="paddle::ProtoDataProvider::ProtoVarSlot::dims__std::vector:i:"></span><span class="target" id="paddlestructpaddle_1_1ProtoDataProvider_1_1ProtoVarSlot_1aa4596a52f49c60014d51f26c05cc4ab6"></span>std::vector&lt;int&gt; <code class="descname">dims</code><a class="headerlink" href="#_CPPv2N6paddle17ProtoDataProvider12ProtoVarSlot4dimsE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

</div>
</dd></dl>

</dd></dl>
Y
Upload docs  
Yu Yang 已提交
1348 1349 1350 
</div>
<div class="section" id="protosequencedataprovider">
<h2>ProtoSequenceDataProvider<a class="headerlink" href="#protosequencedataprovider" title="Permalink to this headline"></a></h2>
Y
Update docs  
Yu Yang 已提交
1351 1352 
<dl class="class">
<dt id="_CPPv2N6paddle25ProtoSequenceDataProviderE">
Y
Upload docs  
Yu Yang 已提交
1353 1354 1355 1356 1357 1358 1359 
<span id="paddle::ProtoSequenceDataProvider"></span><span class="target" id="paddleclasspaddle_1_1ProtoSequenceDataProvider"></span><em class="property">class </em><code class="descclassname">paddle::</code><code class="descname">ProtoSequenceDataProvider</code><a class="headerlink" href="#_CPPv2N6paddle25ProtoSequenceDataProviderE" title="Permalink to this definition"></a></dt>
<dd><p>Special use for Proto data: instances should contain sparse-non-value slots and label. </p>
<p><dl class="docutils">
<dt><strong>Note</strong></dt>
<dd><a class="reference internal" href="#paddleclasspaddle_1_1ProtoSequenceDataProvider"><span>ProtoSequenceDataProvider</span></a> treats each SPARSE SLOT as a SEQUENCE </dd>
</dl>
</p>
Y
Update docs  
Yu Yang 已提交
1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 
<p>Inherits from <a class="reference internal" href="#paddleclasspaddle_1_1ProtoDataProvider"><span>paddle::ProtoDataProvider</span></a></p>
<div class="breathe-sectiondef container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
<dt id="_CPPv2N6paddle25ProtoSequenceDataProvider25ProtoSequenceDataProviderERK10DataConfigbb">
<span id="paddle::ProtoSequenceDataProvider::ProtoSequenceDataProvider__DataConfigCR.b.b"></span><span class="target" id="paddleclasspaddle_1_1ProtoSequenceDataProvider_1acd224131500c8167cfc285e5caa2070a"></span><code class="descname">ProtoSequenceDataProvider</code><span class="sig-paren">(</span><em class="property">const</em> DataConfig &amp;<em>config</em>, bool <em>useGpu</em>, bool <em>loadDataAll</em> = true<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle25ProtoSequenceDataProvider25ProtoSequenceDataProviderERK10DataConfigbb" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="_CPPv2N6paddle25ProtoSequenceDataProviderD0Ev">
<span id="paddle::ProtoSequenceDataProvider::~ProtoSequenceDataProvider"></span><span class="target" id="paddleclasspaddle_1_1ProtoSequenceDataProvider_1ad7abd169d2ffd6fd6c630522288c776d"></span><code class="descname">~ProtoSequenceDataProvider</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle25ProtoSequenceDataProviderD0Ev" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="_CPPv2N6paddle25ProtoSequenceDataProvider20getNextBatchInternalE7int64_tP9DataBatch">
Y
Upload docs  
Yu Yang 已提交
1375 1376 
<span id="paddle::ProtoSequenceDataProvider::getNextBatchInternal__int64_t.DataBatchP"></span>virtual <span class="target" id="paddleclasspaddle_1_1ProtoSequenceDataProvider_1a153ae716b4d8fec75cde272f76a18b2b"></span>int64_t <code class="descname">getNextBatchInternal</code><span class="sig-paren">(</span>int64_t <em>size</em>, DataBatch *<em>batch</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle25ProtoSequenceDataProvider20getNextBatchInternalE7int64_tP9DataBatch" title="Permalink to this definition"></a></dt>
<dd><p>Get next batch training samples internally. </p>
Y
Update docs  
Yu Yang 已提交
1377 
<p><dl class="docutils">
Y
Upload docs  
Yu Yang 已提交
1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 
<dt><strong>Return</strong></dt>
<dd>actual size of obtained training samples </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">size</span></code> - <p>size of training samples to get </p>
</li>
<li><code class="first docutils literal"><span class="pre">batch</span></code> - <p>a batch of training samples </p>
</li>
</ul>
</dd>
Y
Update docs  
Yu Yang 已提交
1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 
</dl>
</p>
</dd></dl>

</div>
</dd></dl>

</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h3><a href="../../../index.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">Data Providers</a><ul>
Y
Upload docs  
Yu Yang 已提交
1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 
<li><a class="reference internal" href="#base-dataprovider">Base DataProvider</a></li>
<li><a class="reference internal" href="#dataprovidergroup">DataProviderGroup</a></li>
<li><a class="reference internal" href="#multidataprovider">MultiDataProvider</a></li>
</ul>
</li>
<li><a class="reference internal" href="#pydataprovider">PyDataProvider</a><ul>
<li><a class="reference internal" href="#ifieldscanner">IFieldScanner</a></li>
<li><a class="reference internal" href="#densescanner">DenseScanner</a></li>
<li><a class="reference internal" href="#indexscanner">IndexScanner</a></li>
<li><a class="reference internal" href="#sparsenonvaluescanner">SparseNonValueScanner</a></li>
<li><a class="reference internal" href="#sparsevaluescanner">SparseValueScanner</a></li>
<li><a class="reference internal" href="#sequencescanner">SequenceScanner</a></li>
<li><a class="reference internal" href="#ipydataprovidercache">IPyDataProviderCache</a></li>
<li><a class="reference internal" href="#nocachestrategy">NoCacheStrategy</a></li>
<li><a class="reference internal" href="#cacheonepassinmemory">CacheOnePassInMemory</a></li>
<li><a class="reference internal" href="#ipydataprovider">IPyDataProvider</a></li>
</ul>
</li>
<li><a class="reference internal" href="#proto-data-provider">Proto Data Provider</a><ul>
<li><a class="reference internal" href="#protodataprovider">ProtoDataProvider</a></li>
<li><a class="reference internal" href="#protosequencedataprovider">ProtoSequenceDataProvider</a></li>
Y
Update docs  
Yu Yang 已提交
1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="index.html"
                        title="previous chapter">Data Providers Documents</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="../evaluators/index.html"
                        title="next chapter">Evaluators</a></p>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../../../_sources/source/gserver/dataprovider/dataproviders.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
<div id="searchbox" style="display: none" role="search">
  <h3>Quick search</h3>
    <form class="search" action="../../../search.html" method="get">
      <input type="text" name="q" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="../../../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="../evaluators/index.html" title="Evaluators"
             >next</a> |</li>
        <li class="right" >
          <a href="index.html" title="Data Providers Documents"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../../../index.html">PaddlePaddle  documentation</a> &raquo;</li>
          <li class="nav-item nav-item-1"><a href="../../index.html" >Source Code Documents</a> &raquo;</li>
          <li class="nav-item nav-item-2"><a href="index.html" >Data Providers Documents</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &copy; Copyright 2016, PaddlePaddle developers.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.5.
    </div>
  </body>
</html>