forked from pymc-devs/pymc-doc
/
objects.html
161 lines (151 loc) · 7.04 KB
/
objects.html
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
<!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>PyMC objects — pymc v2.1.alpha documentation</title>
<link rel="stylesheet" href="_static/pymcdoc.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '2.1.alpha',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="pymc v2.1.alpha documentation" href="index.html" />
<link rel="up" title="API documentation" href="api.html" />
<link rel="prev" title="API documentation" href="api.html" />
</head>
<body>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
<img src="_static/banner21.png" alt="PyMC logo" />
</div>
<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="modindex.html" title="Global Module Index"
accesskey="M">modules</a> |</li>
<li class="right" >
<a href="api.html" title="API documentation"
accesskey="P">previous</a> |</li>
<li><a href="http://code.google.com/p/pymc/">PyMC home</a> | </li>
<li><a href="index.html">User Guide</a> | </li>
<li><a href="api.html">API Documentation</a>»</li>
<li><a href="api.html" accesskey="U">API documentation</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="index.html">
<img class="logo" src="_static/icon_small.png" alt="Logo"/>
</a></p>
<h4>Previous topic</h4>
<p class="topless"><a href="api.html"
title="previous chapter">API documentation</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/objects.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" size="18" />
<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="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="pymc-objects">
<span id="module-pymc.PyMCObjects"></span><h1>PyMC objects<a class="headerlink" href="#pymc-objects" title="Permalink to this headline">¶</a></h1>
<p>Here we document the basic PyMC objects.</p>
<dl class="class">
<dt id="pymc.PyMCObjects.Node">
<em class="property">
class </em><tt class="descclassname">pymc.PyMCObjects.</tt><tt class="descname">Node</tt><big>(</big><em>doc</em>, <em>name</em>, <em>parents</em>, <em>cache_depth</em>, <em>verbose=0</em><big>)</big><a class="headerlink" href="#pymc.PyMCObjects.Node" title="Permalink to this definition">¶</a></dt>
<dd><p>The base class for Stochastic, Deterministic and Potential.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<dl class="docutils">
<dt>doc <span class="classifier-delimiter">:</span> <span class="classifier">string</span></dt>
<dd>The docstring for this node.</dd>
<dt>name <span class="classifier-delimiter">:</span> <span class="classifier">string</span></dt>
<dd>The name of this node.</dd>
<dt>parents <span class="classifier-delimiter">:</span> <span class="classifier">dictionary</span></dt>
<dd>A dictionary containing the parents of this node.</dd>
<dt>cache_depth <span class="classifier-delimiter">:</span> <span class="classifier">integer</span></dt>
<dd>An integer indicating how many of this node’s
value computations should be ‘memorized’.</dd>
<dt>verbose (optional) <span class="classifier-delimiter">:</span> <span class="classifier">integer</span></dt>
<dd>Level of output verbosity: 0=none, 1=low, 2=medium, 3=high</dd>
</dl>
<div class="admonition-see-also admonition seealso">
<p class="first admonition-title">See also</p>
<dl class="last docutils">
<dt><tt class="xref docutils literal"><span class="pre">Stochastic</span></tt></dt>
<dd>The class defining <em>random</em> variables, or unknown parameters.</dd>
<dt><tt class="xref docutils literal"><span class="pre">Deterministic</span></tt></dt>
<dd>The class defining deterministic values, ie the result of a function.</dd>
<dt><tt class="xref docutils literal"><span class="pre">Potential</span></tt></dt>
<dd>An arbitrary log-probability term to multiply into the joint
distribution.</dd>
<dt><tt class="xref docutils literal"><span class="pre">Variable</span></tt></dt>
<dd>The base class for <tt class="xref docutils literal"><span class="pre">Stochastics</span></tt> and <tt class="xref docutils literal"><span class="pre">Deterministics</span></tt>.</dd>
</dl>
</div>
</dd></dl>
</div>
</div>
</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="modindex.html" title="Global Module Index"
>modules</a> |</li>
<li class="right" >
<a href="api.html" title="API documentation"
>previous</a> |</li>
<li><a href="http://code.google.com/p/pymc/">PyMC home</a> | </li>
<li><a href="index.html">User Guide</a> | </li>
<li><a href="api.html">API Documentation</a>»</li>
<li><a href="api.html" >API documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2008, Chris Fonnesbeck, Anand Patil, David Huard.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.7.
</div>
</body>
</html>