Skip to content

Commit 1005d20

Browse files
OriolAbriltwiecki
OriolAbril
authored and
twiecki
committed
add missing objects and modules to docs
1 parent 3da9795 commit 1005d20

24 files changed

+398
-163
lines changed

‎docs/source/api.rst

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,18 @@ API Reference
1010
api/distributions
1111
api/gp
1212
api/model
13-
api/ode
1413
api/samplers
14+
api/vi
1515
api/smc
16-
api/step_methods
17-
api/inference
16+
api/backends
17+
api/data
18+
api/bart
19+
api/ode
20+
api/tuning
21+
api/math
22+
api/aesaraf
23+
api/shape_utils
24+
api/misc
1825

1926
--------------
2027
API extensions

‎docs/source/api/aesaraf.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
Aesara utils
2+
************
3+
4+
.. currentmodule:: pymc
5+
6+
.. autosummary::
7+
:toctree: generated/
8+
9+
gradient
10+
hessian
11+
hessian_diag
12+
inputvars
13+
cont_inputs
14+
floatX
15+
intX
16+
smartfloatX
17+
jacobian
18+
CallableTensor
19+
join_nonshared_inputs
20+
make_shared_replacements
21+
generator
22+
set_at_rng
23+
at_rng
24+
take_along_axis
25+
pandas_to_array

‎docs/source/api/backends.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
Storage backends
2+
****************
3+
4+
.. currentmodule:: pymc
5+
6+
.. autosummary::
7+
:toctree: generated/
8+
9+
to_inference_data
10+
predictions_to_inference_data
11+
12+
Internal structures
13+
-------------------
14+
15+
.. automodule:: pymc.backends
16+
17+
.. autosummary::
18+
:toctree: generated/
19+
20+
NDArray
21+
point_list_to_multitrace
22+
base.BaseTrace
23+
base.MultiTrace

‎docs/source/api/bart.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Bayesian Additive Regression Trees (BART)
2+
*****************************************
3+
4+
.. currentmodule:: pymc
5+
6+
.. autosummary::
7+
:toctree: generated/
8+
9+
BART
10+
PGBART
11+
bart.plot_dependence
12+
bart.predict

‎docs/source/api/data.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
Data
2+
****
3+
4+
.. currentmodule:: pymc
5+
6+
.. autosummary::
7+
:toctree: generated/
8+
9+
ConstantData
10+
MutableData
11+
get_data
12+
Data
13+
GeneratorAdapter
14+
Minibatch
15+
align_minibatches

‎docs/source/api/inference.rst

Lines changed: 0 additions & 113 deletions
This file was deleted.

‎docs/source/api/math.rst

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,27 @@ from aesara.tensor (see there for more details). Doing any kind of math with PyM
77
variables, or defining custom likelihoods or priors requires you to use these Aesara
88
expressions rather than NumPy or Python code.
99

10-
.. currentmodule:: pymc.math
10+
.. currentmodule:: pymc
1111

12+
Functions exposed in pymc namespace
13+
-----------------------------------
1214
.. autosummary::
15+
:toctree: generated/
16+
17+
expand_packed_triangular
18+
logit
19+
invlogit
20+
probit
21+
invprobit
22+
logsumexp
23+
24+
Functions exposed in pymc.math
25+
------------------------------
26+
27+
.. automodule:: pymc.math
28+
.. autosummary::
29+
:toctree: generated/
30+
1331
dot
1432
constant
1533
flatten
@@ -58,6 +76,3 @@ expressions rather than NumPy or Python code.
5876
logsumexp
5977
invlogit
6078
logit
61-
62-
.. automodule:: pymc.math
63-
:members:

‎docs/source/api/misc.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Other utils
2+
***********
3+
4+
.. currentmodule:: pymc
5+
6+
.. autosummary::
7+
:toctree: generated/
8+
9+
find_constrained_prior
10+
DictToArrayBijection
11+
12+
Printing
13+
--------
14+
.. autosummary::
15+
:toctree: generated/
16+
17+
str_for_dist
18+
str_for_model
19+
str_for_potential_or_deterministic

‎docs/source/api/model.rst

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,25 @@
11
Model
22
-----
33

4-
.. currentmodule:: pymc.model
5-
.. automodule:: pymc.model
6-
:members:
4+
Model creation and inspection
5+
-----------------------------
6+
7+
.. currentmodule:: pymc
8+
.. autosummary::
9+
:toctree: generated/
10+
11+
Model
12+
model_to_graphviz
13+
modelcontext
14+
15+
Others
16+
------
17+
18+
.. autosummary::
19+
:toctree: generated/
20+
21+
Deterministic
22+
Potential
23+
set_data
24+
Point
25+
compile_fn

‎docs/source/api/ode.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,10 @@
22
Ordinary differential equations (ODEs)
33
**************************************
44

5-
This submodule contains tools used to perform inference on ordinary differential equations.
65

7-
.. currentmodule:: pymc.ode
6+
.. automodule:: pymc.ode
87

98
.. autosummary::
9+
:toctree: generated/
1010

11-
.. automodule:: pymc.ode
12-
:members: DifferentialEquation
11+
DifferentialEquation

‎docs/source/api/samplers.rst

Lines changed: 65 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,72 @@
1-
====
21
Samplers
3-
====
2+
========
43

5-
This submodule contains functions for MCMC sampling.
4+
This submodule contains functions for MCMC and forward sampling.
65

76

8-
.. currentmodule:: pymc.sampling
7+
.. currentmodule:: pymc
98

109
.. autosummary::
10+
:toctree: generated/
1111

12-
.. automodule:: pymc.sampling
13-
:members:
12+
sample
13+
sample_prior_predictive
14+
sample_posterior_predictive
15+
sample_posterior_predictive_w
16+
iter_sample
17+
init_nuts
18+
draw
19+
20+
Step methods
21+
************
22+
23+
.. currentmodule:: pymc
24+
25+
HMC family
26+
----------
27+
28+
.. autosummary::
29+
:toctree: generated/
30+
31+
NUTS
32+
HamiltonianMC
33+
34+
Metropolis family
35+
-----------------
36+
37+
.. autosummary::
38+
:toctree: generated/
39+
40+
BinaryGibbsMetropolis
41+
BinaryMetropolis
42+
CategoricalGibbsMetropolis
43+
CauchyProposal
44+
DEMetropolis
45+
DEMetropolisZ
46+
LaplaceProposal
47+
Metropolis
48+
MultivariateNormalProposal
49+
NormalProposal
50+
PoissonProposal
51+
UniformProposal
52+
53+
MLDA family
54+
-----------
55+
56+
.. autosummary::
57+
:toctree: generated/
58+
59+
MLDA
60+
DEMetropolisZMLDA
61+
MetropolisMLDA
62+
RecursiveDAProposal
63+
64+
Other step methods
65+
------------------
66+
67+
.. autosummary::
68+
:toctree: generated/
69+
70+
CompoundStep
71+
EllipticalSlice
72+
Slice

0 commit comments

Comments
 (0)