Skip to content

P
Paddle

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

通知 2299
Star 20931
Fork 5422
P
Paddle
切换分支/标签
查找文件 普通视图历史永久链接Permalink
cpp_data_feeding.html 19.1 KB
Newer Older
T
Deploy to GitHub Pages: 3647ed648713b22f92c588ae5773fe4936e90f7f  
Travis CI 已提交
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 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 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 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 


<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>C++ Data Feeding &mdash; PaddlePaddle  documentation</title>
  

  
  

  

  
  
    

  

  
  
    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  

  
  
        <link rel="index" title="Index"
              href="../genindex.html"/>
        <link rel="search" title="Search" href="../search.html"/>
    <link rel="top" title="PaddlePaddle  documentation" href="../index.html"/> 

  <link rel="stylesheet" href="https://cdn.jsdelivr.net/perfect-scrollbar/0.6.14/css/perfect-scrollbar.min.css" type="text/css" />
  <link rel="stylesheet" href="../_static/css/override.css" type="text/css" />
  <script>
  var _hmt = _hmt || [];
  (function() {
    var hm = document.createElement("script");
    hm.src = "//hm.baidu.com/hm.js?b9a314ab40d04d805655aab1deee08ba";
    var s = document.getElementsByTagName("script")[0]; 
    s.parentNode.insertBefore(hm, s);
  })();
  </script>

  

  
  <script src="../_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

  
  <header class="site-header">
    <div class="site-logo">
      <a href="/"><img src="../_static/images/PP_w.png"></a>
    </div>
    <div class="site-nav-links">
      <div class="site-menu">
        <a class="fork-on-github" href="https://github.com/PaddlePaddle/Paddle" target="_blank"><i class="fa fa-github"></i>Fork me on Github</a>
        <div class="language-switcher dropdown">
          <a type="button" data-toggle="dropdown">
            <span>English</span>
            <i class="fa fa-angle-up"></i>
            <i class="fa fa-angle-down"></i>
          </a>
          <ul class="dropdown-menu">
            <li><a href="/doc_cn">中文</a></li>
            <li><a href="/doc">English</a></li>
          </ul>
        </div>
        <ul class="site-page-links">
          <li><a href="/">Home</a></li>
        </ul>
      </div>
      <div class="doc-module">
        
        <ul>
<li class="toctree-l1"><a class="reference internal" href="../getstarted/index_en.html">GET STARTED</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_and_install/index_en.html">Install and Build</a></li>
<li class="toctree-l1"><a class="reference internal" href="../howto/index_en.html">HOW TO</a></li>
<li class="toctree-l1"><a class="reference internal" href="../dev/index_en.html">Development</a></li>
</ul>

        
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>        
      </div>
    </div>
  </header>
  
  <div class="main-content-wrap">

    
    <nav class="doc-menu-vertical" role="navigation">
        
          
          <ul>
<li class="toctree-l1"><a class="reference internal" href="../getstarted/index_en.html">GET STARTED</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../getstarted/quickstart_en.html">Quick Start</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../build_and_install/index_en.html">Install and Build</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../build_and_install/pip_install_en.html">Install Using pip</a></li>
<li class="toctree-l2"><a class="reference internal" href="../build_and_install/docker_install_en.html">Run in Docker Containers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../build_and_install/build_en.html">Build using Docker</a></li>
<li class="toctree-l2"><a class="reference internal" href="../build_and_install/build_from_source_en.html">Build from Sources</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../howto/index_en.html">HOW TO</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../howto/cmd_parameter/index_en.html">Set Command-line Parameters</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../howto/cmd_parameter/use_case_en.html">Use Case</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/cmd_parameter/arguments_en.html">Argument Outline</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/cmd_parameter/detail_introduction_en.html">Detail Description</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../howto/cluster/index_en.html">Distributed Training</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../howto/cluster/preparations_en.html">Preparations</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/cluster/cmd_argument_en.html">Command-line arguments</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/cluster/multi_cluster/index_en.html">Use different clusters</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../howto/cluster/multi_cluster/fabric_en.html">Cluster Training Using Fabric</a></li>
<li class="toctree-l4"><a class="reference internal" href="../howto/cluster/multi_cluster/openmpi_en.html">Cluster Training Using OpenMPI</a></li>
<li class="toctree-l4"><a class="reference internal" href="../howto/cluster/multi_cluster/k8s_en.html">PaddlePaddle On Kubernetes</a></li>
<li class="toctree-l4"><a class="reference internal" href="../howto/cluster/multi_cluster/k8s_aws_en.html">Distributed PaddlePaddle Training on AWS with Kubernetes</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../howto/rnn/index_en.html">RNN Models</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../howto/rnn/rnn_config_en.html">RNN Configuration</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../howto/optimization/gpu_profiling_en.html">Tune GPU Performance</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../dev/index_en.html">Development</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../dev/new_layer_en.html">Write New Layers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../dev/contribute_to_paddle_en.html">Contribute Code</a></li>
<li class="toctree-l2"><a class="reference internal" href="../dev/write_docs_en.html">Contribute Documentation</a></li>
</ul>
</li>
</ul>

        
    </nav>
    
    <section class="doc-content-wrap">

      

 







<div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
      
    <li>C++ Data Feeding</li>
  </ul>
</div>
      
      <div class="wy-nav-content" id="doc-content">
        <div class="rst-content">
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="c-data-feeding">
<span id="c-data-feeding"></span><h1>C++ Data Feeding<a class="headerlink" href="#c-data-feeding" title="Permalink to this headline"></a></h1>
<p>In training with Paddle V2 API, data feeding wholly dependents on Python code. To get rid of the Python environment and achieve the goal of &#8220;wrapping the whole training by a while loop op&#8221; in Paddle Fluid, a C++ data feeding mechanism is required.</p>
<p>In this document we show the fundamental design of C++ data feeding process, which includes the data reading, shuffling and batching.</p>
<div class="section" id="reader">
<span id="reader"></span><h2>Reader<a class="headerlink" href="#reader" title="Permalink to this headline"></a></h2>
<p>A new concept named &#8216;Reader&#8217; is introduced. <code class="docutils literal"><span class="pre">Reader</span></code> is a series of inherited classes which can be hold by our <code class="docutils literal"><span class="pre">Variable</span></code> and they are used to read or process file data.</p>
<div class="section" id="readerbase">
<span id="readerbase"></span><h3><code class="docutils literal"><span class="pre">ReaderBase</span></code><a class="headerlink" href="#readerbase" title="Permalink to this headline"></a></h3>
<p><code class="docutils literal"><span class="pre">ReaderBase</span></code> is the abstract base class of all readers. It defines the all readers&#8217; interfaces.</p>
<div class="highlight-cpp"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">ReaderBase</span> <span class="p">{</span>
 <span class="k">public</span><span class="o">:</span>
  <span class="k">explicit</span> <span class="n">ReaderBase</span><span class="p">(</span><span class="k">const</span> <span class="n">std</span><span class="o">::</span><span class="n">vector</span><span class="o">&lt;</span><span class="n">DDim</span><span class="o">&gt;&amp;</span> <span class="n">shapes</span><span class="p">)</span> <span class="o">:</span> <span class="n">shapes_</span><span class="p">(</span><span class="n">shapes</span><span class="p">)</span> <span class="p">{</span>
    <span class="n">PADDLE_ENFORCE</span><span class="p">(</span><span class="o">!</span><span class="n">shapes_</span><span class="p">.</span><span class="n">empty</span><span class="p">());</span>
  <span class="p">}</span>
  <span class="c1">// Read the next batch of data. (A &#39;batch&#39; can be only one instance)</span>
  <span class="k">virtual</span> <span class="kt">void</span> <span class="n">ReadNext</span><span class="p">(</span><span class="n">std</span><span class="o">::</span><span class="n">vector</span><span class="o">&lt;</span><span class="n">LoDTensor</span><span class="o">&gt;*</span> <span class="n">out</span><span class="p">)</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
  <span class="c1">// Show whether the next bacth exists.</span>
  <span class="k">virtual</span> <span class="kt">bool</span> <span class="nf">HasNext</span><span class="p">()</span> <span class="k">const</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
  
  <span class="c1">// Reinitialize the reader and read the file from the begin.</span>
  <span class="k">virtual</span> <span class="kt">void</span> <span class="nf">ReInit</span><span class="p">()</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
  
  <span class="c1">// Get a certain read in data&#39;s shape.</span>
  <span class="n">DDim</span> <span class="nf">shape</span><span class="p">(</span><span class="kt">size_t</span> <span class="n">idx</span><span class="p">)</span> <span class="k">const</span><span class="p">;</span>
  <span class="c1">// Get shapes of all read in data.</span>
  <span class="n">std</span><span class="o">::</span><span class="n">vector</span><span class="o">&lt;</span><span class="n">DDim</span><span class="o">&gt;</span> <span class="n">shapes</span><span class="p">()</span> <span class="k">const</span> <span class="p">{</span> <span class="k">return</span> <span class="n">shapes_</span><span class="p">;</span> <span class="p">}</span>
  <span class="c1">// Set shapes of read in data.</span>
  <span class="kt">void</span> <span class="n">set_shapes</span><span class="p">(</span><span class="k">const</span> <span class="n">std</span><span class="o">::</span><span class="n">vector</span><span class="o">&lt;</span><span class="n">DDim</span><span class="o">&gt;&amp;</span> <span class="n">shapes</span><span class="p">)</span> <span class="p">{</span> <span class="n">shapes_</span> <span class="o">=</span> <span class="n">shapes</span><span class="p">;</span> <span class="p">}</span>

  <span class="k">virtual</span> <span class="o">~</span><span class="n">ReaderBase</span><span class="p">()</span> <span class="p">{}</span>

 <span class="k">protected</span><span class="o">:</span>
  <span class="n">std</span><span class="o">::</span><span class="n">vector</span><span class="o">&lt;</span><span class="n">DDim</span><span class="o">&gt;</span> <span class="n">shapes_</span><span class="p">;</span>
<span class="p">};</span>
</pre></div>
</div>
</div>
<div class="section" id="filereader-and-decoratedreader">
<span id="filereader-and-decoratedreader"></span><h3><code class="docutils literal"><span class="pre">FileReader</span></code> and <code class="docutils literal"><span class="pre">DecoratedReader</span></code><a class="headerlink" href="#filereader-and-decoratedreader" title="Permalink to this headline"></a></h3>
<p>These two classes are derived from the <code class="docutils literal"><span class="pre">ReaderBase</span></code> and will further be derived by respective specific readers. That is to say, in our design, there are two kinds of readers: file readers and decorated readers. A file reader reads from a file of some specific format, and yield only one instance of data at a time. e.g. RecordIO reader, jpg reader, .... A decorated reader takes another reader(both file reader and decorated reader are OK) as its &#8216;underlying reader&#8217;. It gets data from its underlying reader, does some process on them(shuffling, or batching), then yields processed data. The output data of a decorated reader can be a single instance or a batch. <code class="docutils literal"><span class="pre">ShuffleReader</span></code> and <code class="docutils literal"><span class="pre">BatchReader</span></code> are both decorated readers.</p>
<p>All the readers share exactly the same interfaces defined in <code class="docutils literal"><span class="pre">ReaderBase</span></code>. So they can be decorated for more than one time: We can <strong>shuffle</strong> a reader&#8217;s outputs and then <strong>batch</strong> the shuffle outputs. The interface consistency also allows related ops use readers without knowing what they are exactly.</p>
</div>
<div class="section" id="readerholder">
<span id="readerholder"></span><h3><code class="docutils literal"><span class="pre">ReaderHolder</span></code><a class="headerlink" href="#readerholder" title="Permalink to this headline"></a></h3>
<p>Different readers belong to different class types. It leads to a problem: How can we drop them into <code class="docutils literal"><span class="pre">Variable</span></code>s and fetch them out by a unified method? For example, if a Variable holds a <code class="docutils literal"><span class="pre">BatchReader</span></code>, we can not get it by the following code:</p>
<div class="highlight-cpp"><div class="highlight"><pre><span></span><span class="n">var</span><span class="o">-&gt;</span><span class="n">Get</span><span class="o">&lt;</span><span class="n">ReaderBase</span><span class="o">&gt;</span><span class="p">(</span><span class="s">&quot;batch_reader&quot;</span><span class="p">);</span>
</pre></div>
</div>
<p>we have to write:</p>
<div class="highlight-cpp"><div class="highlight"><pre><span></span><span class="n">var</span><span class="o">-&gt;</span><span class="n">Get</span><span class="o">&lt;</span><span class="n">BatchReader</span><span class="o">&gt;</span><span class="p">(</span><span class="s">&quot;batch_reader&quot;</span><span class="p">);</span>
</pre></div>
</div>
<p>This requires each time getting a reader from a variable we must know the reader&#8217;s type exactly. It is nearly impossible.</p>
<p>To solve this problem, we introduce <code class="docutils literal"><span class="pre">ReaderHolder</span></code> as a wrapper. It acts as an empty decorator of <code class="docutils literal"><span class="pre">ReaderBase</span></code>, which erases reader&#8217;s type. With <code class="docutils literal"><span class="pre">ReaderHolder</span></code> we are able to fetch all types of readers by <code class="docutils literal"><span class="pre">var-&gt;Get&lt;ReaderHolder&gt;(&quot;...&quot;)</span></code> and regard the obtained object as a reader.</p>
</div>
</div>
<div class="section" id="related-operators">
<span id="related-operators"></span><h2>Related Operators<a class="headerlink" href="#related-operators" title="Permalink to this headline"></a></h2>
<p>To create and invoke readers, some now ops are introduced:</p>
<div class="section" id="createreaderop">
<span id="createreaderop"></span><h3><code class="docutils literal"><span class="pre">CreateReaderOp</span></code><a class="headerlink" href="#createreaderop" title="Permalink to this headline"></a></h3>
<p>Each reader has its creating op. File readers&#8217; creating ops have no input and yield the created file reader as its output. Decorated readers&#8217; creating ops take the underlying readers as inputs and then yield new decorated readers.</p>
</div>
<div class="section" id="readop">
<span id="readop"></span><h3><code class="docutils literal"><span class="pre">ReadOp</span></code><a class="headerlink" href="#readop" title="Permalink to this headline"></a></h3>
<p>A reader is only a Variable. It cannot trigger the reading process by itself. So we add the <code class="docutils literal"><span class="pre">ReadOp</span></code> to execute it. A <code class="docutils literal"><span class="pre">ReadOp</span></code> takes a reader Variable as its input. Each time it runs, it invokes the reader‘s <code class="docutils literal"><span class="pre">ReadNext()</span></code> function and gets a new batch of data(or only one instance of data, if we use file reader directly). The output data of a reader are in the form of <code class="docutils literal"><span class="pre">std::vector&lt;LoDTenosr&gt;</span></code>, so the <code class="docutils literal"><span class="pre">ReadOp</span></code> also needs to split the vector and move LoDTensors to their respective output Variables.</p>
</div>
</div>
</div>


           </div>
          </div>
          <footer>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2016, PaddlePaddle developers.

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'../',
            VERSION:'',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true,
            SOURCELINK_SUFFIX: ".txt",
        };
    </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://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
       
  

  
  
    <script type="text/javascript" src="../_static/js/theme.js"></script>
  
  
  <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
  <script src="https://cdn.jsdelivr.net/perfect-scrollbar/0.6.14/js/perfect-scrollbar.jquery.min.js"></script>
  <script src="../_static/js/paddle_doc_init.js"></script> 

</body>
</html>