python-pebl-doc 1.0.2-4 / usr / share / doc / python-pebl / html / result.html

This file is indexed.

/usr/share/doc/python-pebl/html/result.html is in python-pebl-doc 1.0.2-4.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
<!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>result – Learner results &#8212; Pebl 1.0.1 documentation</title>
    
    <link rel="stylesheet" href="_static/default.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    './',
        VERSION:     '1.0.1',
        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>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="top" title="Pebl 1.0.1 documentation" href="index.html" />
    <link rel="up" title="API Reference" href="apiref.html" />
    <link rel="next" title="taskcontroller.multiprocess – Multiprocess task controller" href="taskcontroller/multiprocess.html" />
    <link rel="prev" title="prior – Prior models" href="prior.html" />
   
  <link rel="stylesheet" href="_static/custom.css" type="text/css" />
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  </head>
  <body role="document">
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="module-pebl.result">
<span id="result-learner-results"></span><h1><code class="xref py py-mod docutils literal"><span class="pre">result</span></code> &#8211; Learner results<a class="headerlink" href="#module-pebl.result" title="Permalink to this headline"></a></h1>
<p>This module includes a few classes and functions for working with results of
any Pebl learner.</p>
<div class="section" id="configuration-parameters">
<h2>Configuration Parameters<a class="headerlink" href="#configuration-parameters" title="Permalink to this headline"></a></h2>
<dl class="confparam">
<dt id="confparam-result.filename">
<code class="descname">result.filename</code><a class="headerlink" href="#confparam-result.filename" title="Permalink to this definition"></a></dt>
<dd><p>The name of the result output file
default=result.pebl</p>
</dd></dl>

<dl class="confparam">
<dt id="confparam-result.format">
<code class="descname">result.format</code><a class="headerlink" href="#confparam-result.format" title="Permalink to this definition"></a></dt>
<dd><p>The format for the pebl result file (pickle or html)
default=pickle</p>
</dd></dl>

<dl class="confparam">
<dt id="confparam-result.outdir">
<code class="descname">result.outdir</code><a class="headerlink" href="#confparam-result.outdir" title="Permalink to this definition"></a></dt>
<dd><p>Directory for html report.
default=result</p>
</dd></dl>

<dl class="confparam">
<dt id="confparam-result.size">
<code class="descname">result.size</code><a class="headerlink" href="#confparam-result.size" title="Permalink to this definition"></a></dt>
<dd><p>Number of top-scoring networks to save. Specify 0 to indicate that all scored networks should be saved.
default=1000</p>
</dd></dl>

</div>
<div class="section" id="learner-result">
<h2>Learner Result<a class="headerlink" href="#learner-result" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="pebl.result.LearnerResult">
<em class="property">class </em><code class="descclassname">pebl.result.</code><code class="descname">LearnerResult</code><span class="sig-paren">(</span><em>learner_=None</em>, <em>size=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pebl.result.LearnerResult" title="Permalink to this definition"></a></dt>
<dd><p>Class for storing any and all output of a learner.</p>
<p>This is a mutable container for networks and scores. In the future, it will
also be the place to collect statistics related to the learning task.</p>
<dl class="method">
<dt id="pebl.result.LearnerResult.add_network">
<code class="descname">add_network</code><span class="sig-paren">(</span><em>net</em>, <em>score</em><span class="sig-paren">)</span><a class="headerlink" href="#pebl.result.LearnerResult.add_network" title="Permalink to this definition"></a></dt>
<dd><p>Add a network and score to the results.</p>
</dd></dl>

<dl class="attribute">
<dt id="pebl.result.LearnerResult.posterior">
<code class="descname">posterior</code><a class="headerlink" href="#pebl.result.LearnerResult.posterior" title="Permalink to this definition"></a></dt>
<dd><p>Returns a posterior object for this result.</p>
</dd></dl>

<dl class="method">
<dt id="pebl.result.LearnerResult.start_run">
<code class="descname">start_run</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pebl.result.LearnerResult.start_run" title="Permalink to this definition"></a></dt>
<dd><p>Indicates that the learner is starting a new run.</p>
</dd></dl>

<dl class="method">
<dt id="pebl.result.LearnerResult.stop_run">
<code class="descname">stop_run</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pebl.result.LearnerResult.stop_run" title="Permalink to this definition"></a></dt>
<dd><p>Indicates that the learner is stopping a run.</p>
</dd></dl>

<dl class="method">
<dt id="pebl.result.LearnerResult.tofile">
<code class="descname">tofile</code><span class="sig-paren">(</span><em>filename=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pebl.result.LearnerResult.tofile" title="Permalink to this definition"></a></dt>
<dd><p>Save the result to a python pickle file.</p>
<p>The result can be later read using the result.fromfile function.</p>
</dd></dl>

<dl class="method">
<dt id="pebl.result.LearnerResult.tohtml">
<code class="descname">tohtml</code><span class="sig-paren">(</span><em>outdir=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pebl.result.LearnerResult.tohtml" title="Permalink to this definition"></a></dt>
<dd><p>Create a html report of the result.</p>
<p>outdir is a directory to create html files inside.</p>
</dd></dl>

</dd></dl>

</div>
<div class="section" id="functions">
<h2>Functions<a class="headerlink" href="#functions" title="Permalink to this headline"></a></h2>
<dl class="function">
<dt id="pebl.result.merge">
<code class="descclassname">pebl.result.</code><code class="descname">merge</code><span class="sig-paren">(</span><em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#pebl.result.merge" title="Permalink to this definition"></a></dt>
<dd><p>Returns a merged result object.</p>
<p>Example:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">merge</span><span class="p">(</span><span class="n">result1</span><span class="p">,</span> <span class="n">result2</span><span class="p">,</span> <span class="n">result3</span><span class="p">)</span>
<span class="n">results</span> <span class="o">=</span> <span class="p">[</span><span class="n">result1</span><span class="p">,</span> <span class="n">result2</span><span class="p">,</span> <span class="n">result3</span><span class="p">]</span>
<span class="n">merge</span><span class="p">(</span><span class="n">results</span><span class="p">)</span>
<span class="n">merge</span><span class="p">(</span><span class="o">*</span><span class="n">results</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>

<dl class="function">
<dt id="pebl.result.fromfile">
<code class="descclassname">pebl.result.</code><code class="descname">fromfile</code><span class="sig-paren">(</span><em>filename</em><span class="sig-paren">)</span><a class="headerlink" href="#pebl.result.fromfile" title="Permalink to this definition"></a></dt>
<dd><p>Loads a learner result from file.</p>
</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="#"><code class="docutils literal"><span class="pre">result</span></code> &#8211; Learner results</a><ul>
<li><a class="reference internal" href="#configuration-parameters">Configuration Parameters</a></li>
<li><a class="reference internal" href="#learner-result">Learner Result</a></li>
<li><a class="reference internal" href="#functions">Functions</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="index.html">Documentation overview</a><ul>
  <li><a href="apiref.html">API Reference</a><ul>
      <li>Previous: <a href="prior.html" title="previous chapter"><code class="docutils literal"><span class="pre">prior</span></code> &#8211; Prior models</a></li>
      <li>Next: <a href="taskcontroller/multiprocess.html" title="next chapter"><code class="docutils literal"><span class="pre">taskcontroller.multiprocess</span></code> &#8211; Multiprocess task controller</a></li>
  </ul></li>
  </ul></li>
</ul>
</div>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="_sources/result.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">
      <div><input type="text" name="q" /></div>
      <div><input type="submit" value="Go" /></div>
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="footer">
      &copy;2016, Abhik Shah.
      
      |
      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.8</a>
      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
      
      |
      <a href="_sources/result.txt"
          rel="nofollow">Page source</a>
    </div>

    

    
  </body>
</html>

APT Browse - Built by Thomas Orozco.