genindex.html 14.9 KB
Newer Older
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



<!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>Index &mdash; PaddlePaddle  documentation</title>
  

  
  

  

  
  
    

  

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

  
  
        <link rel="index" title="Index"
              href="#"/>
        <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">
66
        <a class="fork-on-github" href="https://github.com/PaddlePaddle/Paddle" target="_blank"><i class="fa fa-github"></i>Fork me on Github</a>
67 68 69 70 71 72 73 74 75 76 77 78
        <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">
79
          <li><a href="/">Home</a></li>
80 81 82 83 84 85 86 87
        </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="howto/index_en.html">HOW TO</a></li>
<li class="toctree-l1"><a class="reference internal" href="api/index_en.html">API</a></li>
88
<li class="toctree-l1"><a class="reference internal" href="mobile/index_en.html">MOBILE</a></li>
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
</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/build_and_install/index_en.html">Install and Build</a><ul>
112 113
<li class="toctree-l3"><a class="reference internal" href="getstarted/build_and_install/pip_install_en.html">Install Using pip</a></li>
<li class="toctree-l3"><a class="reference internal" href="getstarted/build_and_install/docker_install_en.html">Run in Docker Containers</a></li>
114
<li class="toctree-l3"><a class="reference internal" href="howto/dev/build_en.html">Build using Docker</a></li>
115
<li class="toctree-l3"><a class="reference internal" href="getstarted/build_and_install/build_from_source_en.html">Build from Sources</a></li>
116 117 118 119 120 121 122 123 124 125 126
</ul>
</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/usage/cmd_parameter/index_en.html">Set Command-line Parameters</a><ul>
<li class="toctree-l3"><a class="reference internal" href="howto/usage/cmd_parameter/use_case_en.html">Use Case</a></li>
<li class="toctree-l3"><a class="reference internal" href="howto/usage/cmd_parameter/arguments_en.html">Argument Outline</a></li>
<li class="toctree-l3"><a class="reference internal" href="howto/usage/cmd_parameter/detail_introduction_en.html">Detail Description</a></li>
</ul>
</li>
127 128 129 130 131 132 133
<li class="toctree-l2"><a class="reference internal" href="howto/usage/cluster/cluster_train_en.html">Distributed Training</a><ul>
<li class="toctree-l3"><a class="reference internal" href="howto/usage/cluster/fabric_en.html">fabric</a></li>
<li class="toctree-l3"><a class="reference internal" href="howto/usage/cluster/openmpi_en.html">openmpi</a></li>
<li class="toctree-l3"><a class="reference internal" href="howto/usage/cluster/k8s_en.html">kubernetes</a></li>
<li class="toctree-l3"><a class="reference internal" href="howto/usage/cluster/k8s_aws_en.html">kubernetes on AWS</a></li>
</ul>
</li>
134
<li class="toctree-l2"><a class="reference internal" href="howto/dev/new_layer_en.html">Write New Layers</a></li>
135
<li class="toctree-l2"><a class="reference internal" href="howto/dev/contribute_to_paddle_en.html">Contribute Code</a></li>
136
<li class="toctree-l2"><a class="reference internal" href="howto/dev/write_docs_en.html">Contribute Documentation</a></li>
137 138 139 140
<li class="toctree-l2"><a class="reference internal" href="howto/deep_model/rnn/index_en.html">RNN Models</a><ul>
<li class="toctree-l3"><a class="reference internal" href="howto/deep_model/rnn/rnn_config_en.html">RNN Configuration</a></li>
</ul>
</li>
141 142 143 144
<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="api/index_en.html">API</a><ul>
145 146 147
<li class="toctree-l2"><a class="reference internal" href="api/v2/model_configs.html">Model Configuration</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/v2/config/activation.html">Activation</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/v2/config/layer.html">Layers</a></li>
148
<li class="toctree-l3"><a class="reference internal" href="api/v2/config/evaluators.html">Evaluators</a></li>
149 150 151 152 153 154
<li class="toctree-l3"><a class="reference internal" href="api/v2/config/optimizer.html">Optimizer</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/v2/config/pooling.html">Pooling</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/v2/config/networks.html">Networks</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/v2/config/attr.html">Parameter Attribute</a></li>
</ul>
</li>
155 156 157 158 159 160
<li class="toctree-l2"><a class="reference internal" href="api/v2/data.html">Data Reader Interface and DataSets</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/v2/data/data_reader.html">Data Reader Interface</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/v2/data/image.html">Image Interface</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/v2/data/dataset.html">Dataset</a></li>
</ul>
</li>
161
<li class="toctree-l2"><a class="reference internal" href="api/v2/run_logic.html">Training and Inference</a></li>
162 163 164 165 166 167 168 169 170 171 172 173 174
<li class="toctree-l2"><a class="reference internal" href="api/v2/fluid.html">Fluid</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/v2/fluid/layers.html">Layers</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/v2/fluid/data_feeder.html">DataFeeder</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/v2/fluid/executor.html">Executor</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/v2/fluid/initializer.html">Initializer</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/v2/fluid/evaluator.html">Evaluator</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/v2/fluid/nets.html">Nets</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/v2/fluid/optimizer.html">Optimizer</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/v2/fluid/param_attr.html">ParamAttr</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/v2/fluid/profiler.html">Profiler</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/v2/fluid/regularizer.html">Regularizer</a></li>
</ul>
</li>
175 176
</ul>
</li>
177 178
<li class="toctree-l1"><a class="reference internal" href="mobile/index_en.html">MOBILE</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mobile/cross_compiling_for_android_en.html">Build PaddlePaddle for Android</a></li>
179
<li class="toctree-l2"><a class="reference internal" href="mobile/cross_compiling_for_ios_en.html">Build PaddlePaddle for iOS</a></li>
180 181 182
<li class="toctree-l2"><a class="reference internal" href="mobile/cross_compiling_for_raspberry_en.html">Build PaddlePaddle for Raspberry Pi</a></li>
</ul>
</li>
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
</ul>

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

      









<div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
      
    <li>Index</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">
            

<h1 id="index">Index</h1>

<div class="genindex-jumpbox">
216 217 218
 <a href="#B"><strong>B</strong></a>
 | <a href="#C"><strong>C</strong></a>
 | <a href="#L"><strong>L</strong></a>
219
 | <a href="#M"><strong>M</strong></a>
220 221 222 223
 | <a href="#P"><strong>P</strong></a>
 | <a href="#R"><strong>R</strong></a>
 | <a href="#S"><strong>S</strong></a>
 | <a href="#T"><strong>T</strong></a>
224 225
 
</div>
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
<h2 id="B">B</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api/v2/data/image.html#paddle.v2.image.batch_images_from_tar">batch_images_from_tar() (in module paddle.v2.image)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="C">C</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api/v2/data/image.html#paddle.v2.image.center_crop">center_crop() (in module paddle.v2.image)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="L">L</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
245
      <li><a href="api/v2/fluid/regularizer.html#paddle.v2.fluid.regularizer.L1DecayRegularizer">L1DecayRegularizer (class in paddle.v2.fluid.regularizer)</a>
246
</li>
247
      <li><a href="api/v2/data/image.html#paddle.v2.image.left_right_flip">left_right_flip() (in module paddle.v2.image)</a>
248 249 250
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
251 252
      <li><a href="api/v2/data/image.html#paddle.v2.image.load_and_transform">load_and_transform() (in module paddle.v2.image)</a>
</li>
253 254 255 256 257 258 259
      <li><a href="api/v2/data/image.html#paddle.v2.image.load_image">load_image() (in module paddle.v2.image)</a>
</li>
      <li><a href="api/v2/data/image.html#paddle.v2.image.load_image_bytes">load_image_bytes() (in module paddle.v2.image)</a>
</li>
  </ul></td>
</tr></table>

260 261 262 263 264 265 266 267
<h2 id="M">M</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api/v2/fluid/evaluator.html#paddle.v2.fluid.evaluator.Evaluator.metrics">metrics (paddle.v2.fluid.evaluator.Evaluator attribute)</a>
</li>
  </ul></td>
</tr></table>

268 269
<h2 id="P">P</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
270
  <td style="width: 33%; vertical-align: top;"><ul>
271
      <li><a href="api/v2/fluid/regularizer.html#module-paddle.v2.fluid.regularizer">paddle.v2.fluid.regularizer (module)</a>
272 273
</li>
  </ul></td>
274
  <td style="width: 33%; vertical-align: top;"><ul>
275 276
      <li><a href="api/v2/data/image.html#module-paddle.v2.image">paddle.v2.image (module)</a>
</li>
277 278 279 280 281
      <li><a href="api/v1/data_provider/pydataprovider2_en.html#paddle.trainer.PyDataProvider2.provider">provider() (in module paddle.trainer.PyDataProvider2)</a>
</li>
  </ul></td>
</tr></table>

282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
<h2 id="R">R</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api/v2/data/image.html#paddle.v2.image.random_crop">random_crop() (in module paddle.v2.image)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api/v2/data/image.html#paddle.v2.image.resize_short">resize_short() (in module paddle.v2.image)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="S">S</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api/v2/data/image.html#paddle.v2.image.simple_transform">simple_transform() (in module paddle.v2.image)</a>
298 299 300 301
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api/v2/fluid/evaluator.html#paddle.v2.fluid.evaluator.Evaluator.states">states (paddle.v2.fluid.evaluator.Evaluator attribute)</a>
302 303 304 305 306 307 308 309 310 311 312 313
</li>
  </ul></td>
</tr></table>

<h2 id="T">T</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api/v2/data/image.html#paddle.v2.image.to_chw">to_chw() (in module paddle.v2.image)</a>
</li>
  </ul></td>
</tr></table>

314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349


           </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',
350 351
            HAS_SOURCE:  true,
            SOURCELINK_SUFFIX: ".txt",
352 353 354 355 356
        };
    </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>
357
      <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
358 359 360 361 362 363 364 365 366 367 368 369 370
       
  

  
  
    <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>
371
</html>