overview.html



<!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>V2 API Overview &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="next" title="Model Configuration" href="v2/model_configs.html"/>
        <link rel="prev" title="API" href="index_en.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 class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">V2 API Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="v2/model_configs.html">Model Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="v2/data.html">Data Reader Interface and DataSets</a></li>
<li class="toctree-l1"><a class="reference internal" href="v2/run_logic.html">Training and Inference</a></li>
<li class="toctree-l1"><a class="reference internal" href="fluid/index.html">Fluid</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 class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">V2 API Overview</a></li>
<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>
<li class="toctree-l1"><a class="reference internal" href="v2/run_logic.html">Training and Inference</a></li>
<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>
</ul>

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

      
<div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
      
    <li>V2 API Overview</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="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,
it has several easy to use methods</p>
<ul class="simple">
<li><cite>paddle.train</cite></li>
<li><cite>paddle.test</cite></li>
<li><cite>paddle.infer</cite></li>
</ul>
<p>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>
</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',
            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>