data_sources.html 8.7 KB
Newer Older
Y
Yu Yang 已提交
1 2 3 4 5 6 7 8
<!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" />
    
9
    <title>DataSources &#8212; PaddlePaddle  documentation</title>
Y
Yu Yang 已提交
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
    
    <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" />
Y
Yu Yang 已提交
28
    <link rel="up" title="Model Config Interface" href="index.html" />
Y
Yu Yang 已提交
29
    <link rel="next" title="Layers" href="layers_index.html" />
Y
Yu Yang 已提交
30
    <link rel="prev" title="BaseSGDOptimizer" href="optimizers.html" /> 
Y
Yu Yang 已提交
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
  </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="layers_index.html" title="Layers"
             accesskey="N">next</a> |</li>
        <li class="right" >
Y
Yu Yang 已提交
46
          <a href="optimizers.html" title="BaseSGDOptimizer"
Y
Yu Yang 已提交
47
             accesskey="P">previous</a> |</li>
48 49 50
        <li class="nav-item nav-item-0"><a href="../../../index.html">PaddlePaddle  documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../../index.html" >User Interface</a> &#187;</li>
          <li class="nav-item nav-item-2"><a href="index.html" accesskey="U">Model Config Interface</a> &#187;</li> 
Y
Yu Yang 已提交
51 52 53 54 55 56 57 58 59 60
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="module-paddle.trainer_config_helpers.data_sources">
<span id="datasources"></span><h1>DataSources<a class="headerlink" href="#module-paddle.trainer_config_helpers.data_sources" title="Permalink to this headline"></a></h1>
61
<p>Data Sources are helpers to define paddle training data or testing data.</p>
Y
Yu Yang 已提交
62
<dl class="function">
63 64
<dt id="paddle.trainer_config_helpers.data_sources.define_py_data_sources2">
<code class="descclassname">paddle.trainer_config_helpers.data_sources.</code><code class="descname">define_py_data_sources2</code><span class="sig-paren">(</span><em>train_list</em>, <em>test_list</em>, <em>module</em>, <em>obj</em>, <em>args=None</em><span class="sig-paren">)</span><a class="headerlink" href="#paddle.trainer_config_helpers.data_sources.define_py_data_sources2" title="Permalink to this definition"></a></dt>
Y
Yu Yang 已提交
65 66 67
<dd><p>Define python Train/Test data sources in one method. If train/test use
the same Data Provider configuration, module/obj/args contain one argument,
otherwise contain a list or tuple of arguments. For example:</p>
68 69 70 71 72 73 74
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="n">define_py_data_sources2</span><span class="p">(</span><span class="n">train_list</span><span class="o">=</span><span class="s2">&quot;train.list&quot;</span><span class="p">,</span>
                        <span class="n">test_list</span><span class="o">=</span><span class="s2">&quot;test.list&quot;</span><span class="p">,</span>
                        <span class="n">module</span><span class="o">=</span><span class="s2">&quot;data_provider&quot;</span>
                        <span class="c1"># if train/test use different configurations,</span>
                        <span class="c1"># obj=[&quot;process_train&quot;, &quot;process_test&quot;]</span>
                        <span class="n">obj</span><span class="o">=</span><span class="s2">&quot;process&quot;</span><span class="p">,</span>
                        <span class="n">args</span><span class="o">=</span><span class="p">{</span><span class="s2">&quot;dictionary&quot;</span><span class="p">:</span> <span class="n">dict_name</span><span class="p">})</span>
Y
Yu Yang 已提交
75 76 77
</pre></div>
</div>
<p>The related data provider can refer to
78
<a class="reference external" href="../../data_provider/pydataprovider2.html#dataprovider-for-the-sequential-model">here</a>.</p>
Y
Yu Yang 已提交
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
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>train_list</strong> (<em>basestring</em>) &#8211; Train list name.</li>
<li><strong>test_list</strong> (<em>basestring</em>) &#8211; Test list name.</li>
<li><strong>module</strong> (<em>basestring or tuple or list</em>) &#8211; python module name. If train and test is different, then
pass a tuple or list to this argument.</li>
<li><strong>obj</strong> (<em>basestring or tuple or list</em>) &#8211; python object name. May be a function name if using
PyDataProviderWrapper. If train and test is different, then pass
a tuple or list to this argument.</li>
<li><strong>args</strong> (<em>string or picklable object or list or tuple.</em>) &#8211; The best practice is using dict() to pass arguments into
DataProvider, and use <code class="code docutils literal"><span class="pre">&#64;init_hook_wrapper</span></code> to receive
arguments. If train and test is different, then pass a tuple
or list to this argument.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">None</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">None</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h4>Previous topic</h4>
  <p class="topless"><a href="optimizers.html"
Y
Yu Yang 已提交
118
                        title="previous chapter">BaseSGDOptimizer</a></p>
Y
Yu Yang 已提交
119 120 121 122 123 124 125 126 127 128 129 130 131
  <h4>Next topic</h4>
  <p class="topless"><a href="layers_index.html"
                        title="next chapter">Layers</a></p>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../../../_sources/ui/api/trainer_config_helpers/data_sources.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">
132 133
      <div><input type="text" name="q" /></div>
      <div><input type="submit" value="Go" /></div>
Y
Yu Yang 已提交
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
</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="layers_index.html" title="Layers"
             >next</a> |</li>
        <li class="right" >
Y
Yu Yang 已提交
156
          <a href="optimizers.html" title="BaseSGDOptimizer"
Y
Yu Yang 已提交
157
             >previous</a> |</li>
158 159 160
        <li class="nav-item nav-item-0"><a href="../../../index.html">PaddlePaddle  documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../../index.html" >User Interface</a> &#187;</li>
          <li class="nav-item nav-item-2"><a href="index.html" >Model Config Interface</a> &#187;</li> 
Y
Yu Yang 已提交
161 162 163
      </ul>
    </div>
    <div class="footer" role="contentinfo">
164 165
        &#169; Copyright 2016, PaddlePaddle developers.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
Y
Yu Yang 已提交
166 167 168
    </div>
  </body>
</html>