overview.html 9.0 KB
Newer Older
1 2


3 4


5 6 7 8 9 10 11 12
<!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">
  
13
  <title>V2 API Overview &mdash; PaddlePaddle  documentation</title>
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
  

  
  

  

  
  
    

  

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

  
33

34 35 36 37 38 39 40
  
        <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="next" title="Model Configuration" href="v2/model_configs.html"/>
        <link rel="prev" title="API" href="index_en.html"/> 
41 42 43 44 45 46 47 48 49 50
<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>

51 52 53 54 55 56 57 58

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

</head>

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

59 60 61 62 63 64 65 66 67 68 69 70 71
  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search">
          

          
            <a href="index_en.html" class="icon icon-home"> PaddlePaddle
          

          
72 73
          </a>

74 75 76 77 78 79
          
            
            
          

          
80 81 82 83 84 85
<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>
86
</div>
87 88

          
89 90 91 92
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
93 94 95
<nav class="doc-menu-vertical" role="navigation">

<ul class="current">
96
<li class="toctree-l1 current"><a class="current reference internal" href="#">V2 API Overview</a></li>
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
<li class="toctree-l1"><a class="reference internal" href="v2/model_configs.html">Model Configuration</a><ul>
<li class="toctree-l2"><a class="reference internal" href="v2/config/activation.html">Activation</a></li>
<li class="toctree-l2"><a class="reference internal" href="v2/config/layer.html">Layers</a></li>
<li class="toctree-l2"><a class="reference internal" href="v2/config/evaluators.html">Evaluators</a></li>
<li class="toctree-l2"><a class="reference internal" href="v2/config/optimizer.html">Optimizer</a></li>
<li class="toctree-l2"><a class="reference internal" href="v2/config/pooling.html">Pooling</a></li>
<li class="toctree-l2"><a class="reference internal" href="v2/config/networks.html">Networks</a></li>
<li class="toctree-l2"><a class="reference internal" href="v2/config/attr.html">Parameter Attribute</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="v2/data.html">Data Reader Interface and DataSets</a><ul>
<li class="toctree-l2"><a class="reference internal" href="v2/data/data_reader.html">Data Reader Interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="v2/data/image.html">Image Interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="v2/data/dataset.html">Dataset</a></li>
</ul>
</li>
113
<li class="toctree-l1"><a class="reference internal" href="v2/run_logic.html">Training and Inference</a></li>
114 115 116 117 118 119 120 121 122 123 124 125 126 127
<li class="toctree-l1"><a class="reference internal" href="fluid/index.html">Fluid</a><ul>
<li class="toctree-l2"><a class="reference internal" href="fluid/layers.html">layers</a></li>
<li class="toctree-l2"><a class="reference internal" href="fluid/data_feeder.html">data_feeder</a></li>
<li class="toctree-l2"><a class="reference internal" href="fluid/executor.html">executor</a></li>
<li class="toctree-l2"><a class="reference internal" href="fluid/initializer.html">initializer</a></li>
<li class="toctree-l2"><a class="reference internal" href="fluid/evaluator.html">evaluator</a></li>
<li class="toctree-l2"><a class="reference internal" href="fluid/nets.html">nets</a></li>
<li class="toctree-l2"><a class="reference internal" href="fluid/optimizer.html">optimizer</a></li>
<li class="toctree-l2"><a class="reference internal" href="fluid/param_attr.html">param_attr</a></li>
<li class="toctree-l2"><a class="reference internal" href="fluid/profiler.html">profiler</a></li>
<li class="toctree-l2"><a class="reference internal" href="fluid/regularizer.html">regularizer</a></li>
<li class="toctree-l2"><a class="reference internal" href="fluid/io.html">io</a></li>
</ul>
</li>
128 129
</ul>

130 131
</nav>

132 133
        </div>
      </div>
134 135
    </nav>

136
    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
137

138 139 140 141 142
      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
        <a href="index_en.html">PaddlePaddle</a>
      </nav>
143 144


145 146 147 148
      
      <div class="wy-nav-content">
        <div class="rst-content">
          
149

150
 
151 152 153 154 155



<div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
156
    <li><a href="index_en.html">Docs</a> &raquo;</li>
157
      
158
    <li>V2 API Overview</li>
159 160 161 162 163 164 165
      <li class="wy-breadcrumbs-aside">
        
          
            <a href="_sources/overview.rst.txt" rel="nofollow"> View page source</a>
          
        
      </li>
166
  </ul>
167
  <hr/>
168 169 170 171
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
172 173 174 175 176 177
  <div class="section" id="v2-api-overview">
<h1>V2 API Overview<a class="headerlink" href="#v2-api-overview" title="Permalink to this headline"></a></h1>
<p>The PaddlePaddle V2 API is designed to provide a modern user interface for PaddlePaddle V1(the original layer-based platform of PaddlePaddle),
it proposes some high-level concepts such as <a class="reference external" href="http://www.paddlepaddle.org/docs/develop/api/en/v2/config/layer.html">Layers</a> , <a class="reference external" href="http://www.paddlepaddle.org/docs/develop/api/en/v2/config/optimizer.html">Optimizer</a> , <a class="reference external" href="http://www.paddlepaddle.org/docs/develop/api/en/v2/config/evaluators.html">Evaluator</a>  and <a class="reference external" href="http://www.paddlepaddle.org/docs/develop/api/en/v2/data/data_reader.html">Data Reader</a> to make the model configuration more familiar to users.</p>
<p>A model is composed of the computation described by a group of <cite>Layers</cite>, with <cite>Evaluator</cite> to define the error, <cite>Optimizer</cite> to update the parameters and <cite>Data Reader</cite> to feed in the data.</p>
<p>We also provide the <a class="reference external" href="http://www.paddlepaddle.org/docs/develop/api/en/v2/run_logic.html">interface for Training and Inference</a> to help control the training and inference phrase,
178 179
it has several easy to use methods to better expose the internal running details, different <a class="reference external" href="http://www.paddlepaddle.org/docs/develop/api/en/v2/run_logic.html#event">events</a> are available to users by writing some callbacks.</p>
<p>All in all, the V2 API gives a higher abstraction and make PaddlePaddle programs require fiew lines of code.</p>
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
</div>


           </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="v2/model_configs.html" class="btn btn-neutral float-right" title="Model Configuration" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="index_en.html" class="btn btn-neutral" title="API" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <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',
226
            HAS_SOURCE:  true
227 228 229 230 231 232
        };
    </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>
233

234 235 236 237 238 239
  

  
  
    <script type="text/javascript" src="_static/js/theme.js"></script>
  
240 241

  
242
  
243 244 245 246 247 248
  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>
   
249 250 251

</body>
</html>