regularizer.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>regularizer &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="up" title="Fluid" href="index.html"/>
        <link rel="next" title="io" href="io.html"/>
        <link rel="prev" title="profiler" href="profiler.html"/> 

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

</head>

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

  <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
          

          </a>

          
<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 class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
                <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../overview.html">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 current"><a class="reference internal" href="index.html">Fluid</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="layers.html">layers</a></li>
<li class="toctree-l2"><a class="reference internal" href="data_feeder.html">data_feeder</a></li>
<li class="toctree-l2"><a class="reference internal" href="executor.html">executor</a></li>
<li class="toctree-l2"><a class="reference internal" href="initializer.html">initializer</a></li>
<li class="toctree-l2"><a class="reference internal" href="evaluator.html">evaluator</a></li>
<li class="toctree-l2"><a class="reference internal" href="nets.html">nets</a></li>
<li class="toctree-l2"><a class="reference internal" href="optimizer.html">optimizer</a></li>
<li class="toctree-l2"><a class="reference internal" href="param_attr.html">param_attr</a></li>
<li class="toctree-l2"><a class="reference internal" href="profiler.html">profiler</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">regularizer</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#append-regularization-ops">append_regularization_ops</a></li>
<li class="toctree-l3"><a class="reference internal" href="#l1decay">L1Decay</a></li>
<li class="toctree-l3"><a class="reference internal" href="#l2decay">L2Decay</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="io.html">io</a></li>
</ul>
</li>
</ul>

            
        </div>
      </div>
    </nav>

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

      
      <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>


      <div class="wy-nav-content">
        <div class="rst-content">
          

<div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
    <li><a href="../index_en.html">Docs</a> &raquo;</li>
      
          <li><a href="index.html">Fluid</a> &raquo;</li>
      
    <li>regularizer</li>
      <li class="wy-breadcrumbs-aside">
        
          
            <a href="../_sources/fluid/regularizer.rst.txt" rel="nofollow"> View page source</a>
          
        
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="regularizer">
<h1>regularizer<a class="headerlink" href="#regularizer" title="Permalink to this headline">¶</a></h1>
<div class="section" id="append-regularization-ops">
<h2>append_regularization_ops<a class="headerlink" href="#append-regularization-ops" title="Permalink to this headline">¶</a></h2>
<dl class="function">
<dt>
<code class="descclassname">paddle.fluid.regularizer.</code><code class="descname">append_regularization_ops</code><span class="sig-paren">(</span><em>parameters_and_grads</em>, <em>regularization=None</em><span class="sig-paren">)</span></dt>
<dd><p>Create and add backward regularization Operators</p>
<p>Creates and adds backward regularization operators in the BlockDesc.
This will add gradients of the regularizer function to the gradients
of the parameters and return these modified gradients. This is the
same as implementing weight decay in optimizers for regularization.</p>
<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>parameters_and_grads</strong> &#8211; A list of (parameters, gradients) pairs
that need to be regularized.</li>
<li><strong>regularization</strong> &#8211; A global regularizer. If the parameter is not
set. It will be applied with regularizer.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">list of (parameters, gradients) pair with the regularized gradient</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><code class="xref py py-exc docutils literal"><span class="pre">Exception</span></code> &#8211; Unknown regularization type</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</div>
<div class="section" id="l1decay">
<h2>L1Decay<a class="headerlink" href="#l1decay" title="Permalink to this headline">¶</a></h2>
<dl class="attribute">
<dt>
<code class="descclassname">paddle.fluid.regularizer.</code><code class="descname">L1Decay</code></dt>
<dd><p>alias of <code class="xref py py-class docutils literal"><span class="pre">L1DecayRegularizer</span></code></p>
</dd></dl>

</div>
<div class="section" id="l2decay">
<h2>L2Decay<a class="headerlink" href="#l2decay" title="Permalink to this headline">¶</a></h2>
<dl class="attribute">
<dt>
<code class="descclassname">paddle.fluid.regularizer.</code><code class="descname">L2Decay</code></dt>
<dd><p>alias of <code class="xref py py-class docutils literal"><span class="pre">L2DecayRegularizer</span></code></p>
</dd></dl>

</div>
</div>


           </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="io.html" class="btn btn-neutral float-right" title="io" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="profiler.html" class="btn btn-neutral" title="profiler" 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
        };
    </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 type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>
   

</body>
</html>