customStackTrace.html 9.3 KB
Newer Older
Y
Yu Yang 已提交
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 66 67 68 69 70 71 72 73 74 75 76 77 78 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 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
<!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" />
    
    <title>CustomStackTrace &mdash; PaddlePaddle  documentation</title>
    
    <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" />
    <link rel="up" title="Source Code Documents" href="../index.html" />
    <link rel="next" title="enumeration_wrapper" href="enum.html" />
    <link rel="prev" title="API" href="../api/api.html" /> 
  </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="enum.html" title="enumeration_wrapper"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="../api/api.html" title="API"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../../index.html">PaddlePaddle  documentation</a> &raquo;</li>
          <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Source Code Documents</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="customstacktrace">
<h1>CustomStackTrace<a class="headerlink" href="#customstacktrace" title="Permalink to this headline"></a></h1>
<div class="section" id="class-customstacktrace">
<h2>class CustomStackTrace<a class="headerlink" href="#class-customstacktrace" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt>
<span class="target" id="paddleclasspaddle_1_1CustomStackTrace"></span><em class="property">template </em>&lt;<em class="property">typename</em> T&gt;</dt>
<dt id="_CPPv2N6paddle16CustomStackTraceE">
<span id="paddle::CustomStackTrace"></span><em class="property">class </em><code class="descclassname">paddle::</code><code class="descname">CustomStackTrace</code><a class="headerlink" href="#_CPPv2N6paddle16CustomStackTraceE" title="Permalink to this definition"></a></dt>
<dd><p>A ThreadLocal stack for tracing train/test process. (More details of ThreadLocal can be find in the comments of ThreadLocal class.)</p>
<p>For example.  <div class="highlight-python"><div class="highlight"><pre><span></span>paddle::CustomStackTrace&lt;std::string&gt; stack;
PASS_TEST=0;
for (auto&amp; layer : layers){
  stack.push(layer-&gt;getName());
  layer-&gt;forward(passType);
}
for (auto&amp; layer : layers){
  layer-&gt;backward(passType);
  stack.pop(layer-&gt;getName());
}

if(passType == PASS_TEST) {
  stack.clear();
}
else {
  stack.dump([](const std::string&amp; layername){
    LOG(INFO) &lt;&lt; &quot;LayerName: &quot; &lt;&lt; layername;
  })
}
</pre></div>
</div>
</p>
<div class="breathe-sectiondef container">
<p class="breathe-sectiondef-title rubric">Public Functions</p>
<dl class="function">
<dt id="_CPPv2N6paddle16CustomStackTrace3popERK1T">
<span id="paddle::CustomStackTrace::pop__TCR"></span><span class="target" id="paddleclasspaddle_1_1CustomStackTrace_1a909f7e09c7b2a72231f05901f875164e"></span>void <code class="descname">pop</code><span class="sig-paren">(</span><em class="property">const</em> T &amp;<em>ip</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle16CustomStackTrace3popERK1T" title="Permalink to this definition"></a></dt>
<dd><p>Pop out an item from the top of the stack. For safety the item will be poped should equal to ip. </p>
</dd></dl>

<dl class="function">
<dt>
<em class="property">template </em>&lt;<em class="property">typename</em> Callback&gt;</dt>
<dt id="_CPPv2N6paddle16CustomStackTrace4dumpE8Callback">
<span id="paddle::CustomStackTrace::dump__Callback"></span><span class="target" id="paddleclasspaddle_1_1CustomStackTrace_1aa7d21ed7ba9663459026e94058da9278"></span>void <code class="descname">dump</code><span class="sig-paren">(</span>Callback <em>callback</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle16CustomStackTrace4dumpE8Callback" title="Permalink to this definition"></a></dt>
<dd><p>Empty the stack by sequence from top to button. </p>
<p><dl class="docutils">
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">callback</span></code> - <p>A function deal with each item while dumping. It must have and only have a in parameter which is the stack item. </p>
</li>
</ul>
</dd>
</dl>
</p>
</dd></dl>

<dl class="function">
<dt id="_CPPv2N6paddle16CustomStackTrace5clearEv">
<span id="paddle::CustomStackTrace::clear"></span><span class="target" id="paddleclasspaddle_1_1CustomStackTrace_1af2c8f589407dc9b154c0b23d13547308"></span>void <code class="descname">clear</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle16CustomStackTrace5clearEv" title="Permalink to this definition"></a></dt>
<dd><p>Only empty the stack. </p>
</dd></dl>

<dl class="function">
<dt id="_CPPv2N6paddle16CustomStackTrace4pushERK1T">
<span id="paddle::CustomStackTrace::push__TCR"></span><span class="target" id="paddleclasspaddle_1_1CustomStackTrace_1aff95af48dce604eb7006401cbce54459"></span>void <code class="descname">push</code><span class="sig-paren">(</span><em class="property">const</em> T &amp;<em>ip</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N6paddle16CustomStackTrace4pushERK1T" title="Permalink to this definition"></a></dt>
<dd><p>Push item ip to the top of the stack. </p>
</dd></dl>

</div>
</dd></dl>

</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h3><a href="../../index.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">CustomStackTrace</a><ul>
<li><a class="reference internal" href="#class-customstacktrace">class CustomStackTrace</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="../api/api.html"
                        title="previous chapter">API</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="enum.html"
                        title="next chapter">enumeration_wrapper</a></p>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../../_sources/source/utils/customStackTrace.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">
      <input type="text" name="q" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</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="enum.html" title="enumeration_wrapper"
             >next</a> |</li>
        <li class="right" >
          <a href="../api/api.html" title="API"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../../index.html">PaddlePaddle  documentation</a> &raquo;</li>
          <li class="nav-item nav-item-1"><a href="../index.html" >Source Code Documents</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &copy; Copyright 2016, PaddlePaddle developers.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.5.
    </div>
  </body>
</html>