Skip to content

Commit b233972

Browse files
committed
DOC Add math to docs. Fix other doc string problems.
1 parent fffd959 commit b233972

File tree

4 files changed

+156
-94
lines changed

4 files changed

+156
-94
lines changed

docs/source/api.rst

Lines changed: 63 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,6 @@ Plots
8686
-----
8787

8888
.. currentmodule:: pymc3.plots
89-
:members:
9089

9190
.. automodule:: pymc3.plots
9291
:members:
@@ -95,7 +94,6 @@ Stats
9594
-----
9695

9796
.. currentmodule:: pymc3.stats
98-
:members:
9997

10098
.. automodule:: pymc3.stats
10199
:members:
@@ -104,7 +102,6 @@ Diagnostics
104102
-----------
105103

106104
.. currentmodule:: pymc3.diagnostics
107-
:members:
108105

109106
.. automodule:: pymc3.diagnostics
110107
:members:
@@ -117,8 +114,7 @@ Inference
117114
Sampling
118115
^^^^^^^^
119116

120-
.. currentomdule:: pymc3.sampling
121-
:members:
117+
.. currentmodule:: pymc3.sampling
122118

123119
.. automodule:: pymc3.sampling
124120
:members:
@@ -131,7 +127,6 @@ NUTS
131127
""""
132128

133129
.. currentmodule:: pymc3.step_methods.nuts
134-
:members:
135130

136131
.. automodule:: pymc3.step_methods.nuts
137132
:members:
@@ -140,7 +135,6 @@ Metropolis
140135
""""""""""
141136

142137
.. currentmodule:: pymc3.step_methods.metropolis
143-
:members:
144138

145139
.. automodule:: pymc3.step_methods.metropolis
146140
:members:
@@ -149,7 +143,6 @@ Slice
149143
"""""
150144

151145
.. currentmodule:: pymc3.step_methods.slicer
152-
:members:
153146

154147
.. automodule:: pymc3.step_methods.slicer
155148
:members:
@@ -158,7 +151,6 @@ Hamiltonian Monte Carlo
158151
"""""""""""""""""""""""
159152

160153
.. currentmodule:: pymc3.step_methods.hmc
161-
:members:
162154

163155
.. automodule:: pymc3.step_methods.hmc
164156
:members:
@@ -171,7 +163,6 @@ ADVI
171163
""""
172164

173165
.. currentmodule:: pymc3.variational.advi
174-
:members:
175166

176167
.. automodule:: pymc3.variational.advi
177168
:members:
@@ -180,7 +171,6 @@ ADVI minibatch
180171
""""""""""""""
181172

182173
.. currentmodule:: pymc3.variational.advi_minibatch
183-
:members:
184174

185175
.. automodule:: pymc3.variational.advi_minibatch
186176
:members:
@@ -189,7 +179,6 @@ Backends
189179
--------
190180

191181
.. currentmodule:: pymc3.backends
192-
:members:
193182

194183
.. automodule:: pymc3.backends
195184
:members:
@@ -198,7 +187,6 @@ ndarray
198187
^^^^^^^
199188

200189
.. currentmodule:: pymc3.backends.ndarray
201-
:members:
202190

203191
.. automodule:: pymc3.backends.ndarray
204192
:members:
@@ -207,7 +195,6 @@ sqlite
207195
^^^^^^
208196

209197
.. currentmodule:: pymc3.backends.sqlite
210-
:members:
211198

212199
.. automodule:: pymc3.backends.sqlite
213200
:members:
@@ -216,7 +203,6 @@ text
216203
^^^^
217204

218205
.. currentmodule:: pymc3.backends.text
219-
:members:
220206

221207
.. automodule:: pymc3.backends.text
222208
:members:
@@ -225,22 +211,78 @@ tracetab
225211
^^^^^^^^
226212

227213
.. currentmodule:: pymc3.backends.tracetab
228-
:members:
229214

230215
.. automodule:: pymc3.backends.tracetab
231216
:members:
232217

233218

234-
235-
236-
237-
238219
GLM
239220
---
240221

241222
.. currentmodule:: pymc3.glm.glm
242-
:members:
243223

244224
.. automodule:: pymc3.glm.glm
245225
:members:
246226

227+
Math
228+
----
229+
230+
This submodule contains various mathematical functions. Most of them
231+
are imported directly from theano.tensor (see there for more
232+
details). Doing any kind of math with PyMC3 random variables, or
233+
defining custom likelihoods or priors requires you to use these theano
234+
expressions rather than NumPy or Python code.
235+
236+
.. currentmodule:: pymc3.math
237+
.. autosummary::
238+
dot
239+
constant
240+
flatten
241+
zeros_like
242+
ones_like
243+
stack
244+
concatenate
245+
sum
246+
prod
247+
lt
248+
gt
249+
le
250+
ge
251+
eq
252+
neq
253+
switch
254+
clip
255+
where
256+
and_
257+
or_
258+
abs_
259+
exp
260+
log
261+
cos
262+
sin
263+
tan
264+
cosh
265+
sinh
266+
tanh
267+
sqr
268+
sqrt
269+
erf
270+
erfinv
271+
dot
272+
maximum
273+
minimum
274+
sgn
275+
ceil
276+
floor
277+
det
278+
matrix_inverse
279+
extract_diag
280+
matrix_dot
281+
trace
282+
sigmoid
283+
logsumexp
284+
invlogit
285+
logit
286+
287+
.. automodule:: pymc3.math
288+
:members:

0 commit comments

Comments
 (0)