python-pebl-doc 1.0.2-3 / usr / share / doc / python-pebl / html / paramref.html

This file is indexed.

/usr/share/doc/python-pebl/html/paramref.html is in python-pebl-doc 1.0.2-3.

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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
<!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>Configuration Parameters Reference &mdash; 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="top" title="Pebl 1.0.1 documentation" href="index.html" />
    <link rel="next" title="API Reference" href="apiref.html" />
    <link rel="prev" title="Developer’s Guide" href="devguide.html" /> 
  </head>
  <body>
    <div class="related">
      <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="apiref.html" title="API Reference"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="devguide.html" title="Developer’s Guide"
             accesskey="P">previous</a> |</li>
        <li><a href="index.html">Pebl 1.0.1 documentation</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="configuration-parameters-reference">
<h1>Configuration Parameters Reference<a class="headerlink" href="#configuration-parameters-reference" title="Permalink to this headline"></a></h1>
<p>Here are the configuration parameters supported by pebl. These can set in a
configuration file or via the config.set() function.</p>
<div class="section" id="data">
<h2>data<a class="headerlink" href="#data" title="Permalink to this headline"></a></h2>
<dl class="confparam">
<dt id="confparam-data.discretize">
<tt class="descname">data.discretize</tt><a class="headerlink" href="#confparam-data.discretize" title="Permalink to this definition"></a></dt>
<dd><p>Number of bins used to discretize data. Specify 0 to indicate that data should not be discretized.
default=0</p>
</dd></dl>

<dl class="confparam">
<dt id="confparam-data.filename">
<tt class="descname">data.filename</tt><a class="headerlink" href="#confparam-data.filename" title="Permalink to this definition"></a></dt>
<dd><p>File to read data from.
default=None</p>
</dd></dl>

<dl class="confparam">
<dt id="confparam-data.text">
<tt class="descname">data.text</tt><a class="headerlink" href="#confparam-data.text" title="Permalink to this definition"></a></dt>
<dd><p>The text of a dataset included in config file.
default=</p>
</dd></dl>

</div>
<div class="section" id="learner">
<h2>learner<a class="headerlink" href="#learner" title="Permalink to this headline"></a></h2>
<dl class="confparam">
<dt id="confparam-learner.numtasks">
<tt class="descname">learner.numtasks</tt><a class="headerlink" href="#confparam-learner.numtasks" title="Permalink to this definition"></a></dt>
<dd><p>Number of learner tasks to run.
default=1</p>
</dd></dl>

<dl class="confparam">
<dt id="confparam-learner.type">
<tt class="descname">learner.type</tt><a class="headerlink" href="#confparam-learner.type" title="Permalink to this definition"></a></dt>
<dd><blockquote>
<div>Type of learner to use.</div></blockquote>
<dl class="docutils">
<dt>The following learners are included with pebl:</dt>
<dd><ul class="first simple">
<li>greedy.GreedyLearner</li>
<li>simanneal.SimulatedAnnealingLearner</li>
<li>exhaustive.ListLearner</li>
</ul>
<p class="last">default=greedy.GreedyLearner</p>
</dd>
</dl>
</dd></dl>

</div>
<div class="section" id="greedy">
<h2>greedy<a class="headerlink" href="#greedy" title="Permalink to this headline"></a></h2>
<dl class="confparam">
<dt id="confparam-greedy.max_iterations">
<tt class="descname">greedy.max_iterations</tt><a class="headerlink" href="#confparam-greedy.max_iterations" title="Permalink to this definition"></a></dt>
<dd><p>Maximum number of iterations to run.
default=1000</p>
</dd></dl>

<dl class="confparam">
<dt id="confparam-greedy.max_time">
<tt class="descname">greedy.max_time</tt><a class="headerlink" href="#confparam-greedy.max_time" title="Permalink to this definition"></a></dt>
<dd><p>Maximum learner runtime in seconds.
default=0</p>
</dd></dl>

<dl class="confparam">
<dt id="confparam-greedy.max_unimproved_iterations">
<tt class="descname">greedy.max_unimproved_iterations</tt><a class="headerlink" href="#confparam-greedy.max_unimproved_iterations" title="Permalink to this definition"></a></dt>
<dd><p>Maximum number of iterations without score improvement before a restart.
default=500</p>
</dd></dl>

<dl class="confparam">
<dt id="confparam-greedy.seed">
<tt class="descname">greedy.seed</tt><a class="headerlink" href="#confparam-greedy.seed" title="Permalink to this definition"></a></dt>
<dd><p>Starting network for a greedy search.
default=</p>
</dd></dl>

</div>
<div class="section" id="simanneal">
<h2>simanneal<a class="headerlink" href="#simanneal" title="Permalink to this headline"></a></h2>
<dl class="confparam">
<dt id="confparam-simanneal.delta_temp">
<tt class="descname">simanneal.delta_temp</tt><a class="headerlink" href="#confparam-simanneal.delta_temp" title="Permalink to this definition"></a></dt>
<dd><p>Change in temp between steps.
default=0.5</p>
</dd></dl>

<dl class="confparam">
<dt id="confparam-simanneal.max_iters_at_temp">
<tt class="descname">simanneal.max_iters_at_temp</tt><a class="headerlink" href="#confparam-simanneal.max_iters_at_temp" title="Permalink to this definition"></a></dt>
<dd><p>Max iterations at any temperature.
default=100</p>
</dd></dl>

<dl class="confparam">
<dt id="confparam-simanneal.seed">
<tt class="descname">simanneal.seed</tt><a class="headerlink" href="#confparam-simanneal.seed" title="Permalink to this definition"></a></dt>
<dd><p>Starting network for a greedy search.
default=</p>
</dd></dl>

<dl class="confparam">
<dt id="confparam-simanneal.start_temp">
<tt class="descname">simanneal.start_temp</tt><a class="headerlink" href="#confparam-simanneal.start_temp" title="Permalink to this definition"></a></dt>
<dd><p>Starting temperature for a run.
default=100.0</p>
</dd></dl>

</div>
<div class="section" id="listlearner">
<h2>listlearner<a class="headerlink" href="#listlearner" title="Permalink to this headline"></a></h2>
<dl class="confparam">
<dt id="confparam-listlearner.networks">
<tt class="descname">listlearner.networks</tt><a class="headerlink" href="#confparam-listlearner.networks" title="Permalink to this definition"></a></dt>
<dd><p>List of networks to score.
default=</p>
</dd></dl>

</div>
<div class="section" id="localscore-cache">
<h2>localscore_cache<a class="headerlink" href="#localscore-cache" title="Permalink to this headline"></a></h2>
<dl class="confparam">
<dt id="confparam-localscore_cache.maxsize">
<tt class="descname">localscore_cache.maxsize</tt><a class="headerlink" href="#confparam-localscore_cache.maxsize" title="Permalink to this definition"></a></dt>
<dd><p>Max number of localscores to cache. Default=-1 means unlimited size.
default=-1</p>
</dd></dl>

</div>
<div class="section" id="result">
<h2>result<a class="headerlink" href="#result" title="Permalink to this headline"></a></h2>
<dl class="confparam">
<dt id="confparam-result.filename">
<tt class="descname">result.filename</tt><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">
<tt class="descname">result.format</tt><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.size">
<tt class="descname">result.size</tt><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>

<dl class="confparam">
<dt id="confparam-gibbs.burnin">
<tt class="descname">gibbs.burnin</tt><a class="headerlink" href="#confparam-gibbs.burnin" title="Permalink to this definition"></a></dt>
<dd><p>Burn-in period for the gibbs sampler (specified as a multiple of the number of missing values)
default=10</p>
</dd></dl>

<dl class="confparam">
<dt id="confparam-gibbs.max_iterations">
<tt class="descname">gibbs.max_iterations</tt><a class="headerlink" href="#confparam-gibbs.max_iterations" title="Permalink to this definition"></a></dt>
<dd><p>Stopping criteria for the gibbs sampler.</p>
<blockquote>
<div><p>The number of Gibb&#8217;s sampler iterations to run. Should be a valid
python expression using the variable n (number of missing values).
Examples:</p>
<blockquote>
<div><ul class="simple">
<li>n**2  (for n-squared iterations)</li>
<li>100   (for 100 iterations)</li>
</ul>
</div></blockquote>
</div></blockquote>
<p>default=n**2</p>
</dd></dl>

</div>
<div class="section" id="taskcontroller">
<h2>taskcontroller<a class="headerlink" href="#taskcontroller" title="Permalink to this headline"></a></h2>
<dl class="confparam">
<dt id="confparam-taskcontroller.type">
<tt class="descname">taskcontroller.type</tt><a class="headerlink" href="#confparam-taskcontroller.type" title="Permalink to this definition"></a></dt>
<dd><p>The task controller to use.
default=serial</p>
</dd></dl>

</div>
<div class="section" id="multiprocess">
<h2>multiprocess<a class="headerlink" href="#multiprocess" title="Permalink to this headline"></a></h2>
<dl class="confparam">
<dt id="confparam-multiprocess.poolsize">
<tt class="descname">multiprocess.poolsize</tt><a class="headerlink" href="#confparam-multiprocess.poolsize" title="Permalink to this definition"></a></dt>
<dd><p>Number of processes to run concurrently (0 means no limit)
default=0</p>
</dd></dl>

</div>
<div class="section" id="xgrid">
<h2>xgrid<a class="headerlink" href="#xgrid" title="Permalink to this headline"></a></h2>
<dl class="confparam">
<dt id="confparam-xgrid.controller">
<tt class="descname">xgrid.controller</tt><a class="headerlink" href="#confparam-xgrid.controller" title="Permalink to this definition"></a></dt>
<dd><p>Hostname or IP of the Xgrid controller.
default=</p>
</dd></dl>

<dl class="confparam">
<dt id="confparam-xgrid.grid">
<tt class="descname">xgrid.grid</tt><a class="headerlink" href="#confparam-xgrid.grid" title="Permalink to this definition"></a></dt>
<dd><p>Id of the grid to use at the Xgrid controller.
default=0</p>
</dd></dl>

<dl class="confparam">
<dt id="confparam-xgrid.password">
<tt class="descname">xgrid.password</tt><a class="headerlink" href="#confparam-xgrid.password" title="Permalink to this definition"></a></dt>
<dd><p>Password for the Xgrid controller.
default=</p>
</dd></dl>

<dl class="confparam">
<dt id="confparam-xgrid.peblpath">
<tt class="descname">xgrid.peblpath</tt><a class="headerlink" href="#confparam-xgrid.peblpath" title="Permalink to this definition"></a></dt>
<dd><p>Full path to the pebl script on Xgrid agents
default=pebl</p>
</dd></dl>

<dl class="confparam">
<dt id="confparam-xgrid.pollinterval">
<tt class="descname">xgrid.pollinterval</tt><a class="headerlink" href="#confparam-xgrid.pollinterval" title="Permalink to this definition"></a></dt>
<dd><p>Time (in secs) to wait between polling the Xgrid controller.
default=60.0</p>
</dd></dl>

</div>
<div class="section" id="ipython1">
<h2>ipython1<a class="headerlink" href="#ipython1" title="Permalink to this headline"></a></h2>
<dl class="confparam">
<dt id="confparam-ipython1.controller">
<tt class="descname">ipython1.controller</tt><a class="headerlink" href="#confparam-ipython1.controller" title="Permalink to this definition"></a></dt>
<dd><p>IPython1 TaskController (default is 127.0.0.1:10113)
default=127.0.0.1:10113</p>
</dd></dl>

</div>
<div class="section" id="ec2">
<h2>ec2<a class="headerlink" href="#ec2" title="Permalink to this headline"></a></h2>
<dl class="confparam">
<dt id="confparam-ec2.config">
<tt class="descname">ec2.config</tt><a class="headerlink" href="#confparam-ec2.config" title="Permalink to this definition"></a></dt>
<dd><p>EC2 config file. This is kept seperate from pebl config because it contains
authentication keys, etc.
default=</p>
</dd></dl>

<dl class="confparam">
<dt id="confparam-ec2.max_count">
<tt class="descname">ec2.max_count</tt><a class="headerlink" href="#confparam-ec2.max_count" title="Permalink to this definition"></a></dt>
<dd><p>Maximum number of EC2 instances to create (default=0 means the same number as ec2.min_count).
default=0</p>
</dd></dl>

<dl class="confparam">
<dt id="confparam-ec2.min_count">
<tt class="descname">ec2.min_count</tt><a class="headerlink" href="#confparam-ec2.min_count" title="Permalink to this definition"></a></dt>
<dd><p>Minimum number of EC2 instances to create (default=1).
default=1</p>
</dd></dl>

</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h3><a href="index.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">Configuration Parameters Reference</a><ul>
<li><a class="reference internal" href="#data">data</a></li>
<li><a class="reference internal" href="#learner">learner</a></li>
<li><a class="reference internal" href="#greedy">greedy</a></li>
<li><a class="reference internal" href="#simanneal">simanneal</a></li>
<li><a class="reference internal" href="#listlearner">listlearner</a></li>
<li><a class="reference internal" href="#localscore-cache">localscore_cache</a></li>
<li><a class="reference internal" href="#result">result</a></li>
<li><a class="reference internal" href="#taskcontroller">taskcontroller</a></li>
<li><a class="reference internal" href="#multiprocess">multiprocess</a></li>
<li><a class="reference internal" href="#xgrid">xgrid</a></li>
<li><a class="reference internal" href="#ipython1">ipython1</a></li>
<li><a class="reference internal" href="#ec2">ec2</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="devguide.html"
                        title="previous chapter">Developer&#8217;s Guide</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="apiref.html"
                        title="next chapter">API Reference</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="_sources/paramref.txt"
           rel="nofollow">Show Source</a></li>
  </ul>
<div id="searchbox" style="display: none">
  <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">
      <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="apiref.html" title="API Reference"
             >next</a> |</li>
        <li class="right" >
          <a href="devguide.html" title="Developer’s Guide"
             >previous</a> |</li>
        <li><a href="index.html">Pebl 1.0.1 documentation</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2008, Abhik Shah.
      Last updated on Aug 18, 2015.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
    </div>
  </body>
</html>

APT Browse - Built by Thomas Orozco.