Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add missing objects and modules to docs #5439

Merged
merged 1 commit into from
Feb 4, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions docs/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,18 @@ API Reference
api/distributions
api/gp
api/model
api/ode
api/samplers
api/vi
api/smc
api/step_methods
api/inference
api/backends
api/data
api/bart
api/ode
api/tuning
api/math
api/aesaraf
api/shape_utils
api/misc

--------------
API extensions
Expand Down
25 changes: 25 additions & 0 deletions docs/source/api/aesaraf.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
Aesara utils
************

.. currentmodule:: pymc

.. autosummary::
:toctree: generated/

gradient
hessian
hessian_diag
inputvars
cont_inputs
floatX
intX
smartfloatX
jacobian
CallableTensor
join_nonshared_inputs
make_shared_replacements
generator
set_at_rng
at_rng
take_along_axis
pandas_to_array
23 changes: 23 additions & 0 deletions docs/source/api/backends.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
Storage backends
****************

.. currentmodule:: pymc

.. autosummary::
:toctree: generated/

to_inference_data
predictions_to_inference_data

Internal structures
-------------------

.. automodule:: pymc.backends

.. autosummary::
:toctree: generated/

NDArray
point_list_to_multitrace
base.BaseTrace
base.MultiTrace
12 changes: 12 additions & 0 deletions docs/source/api/bart.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Bayesian Additive Regression Trees (BART)
*****************************************

.. currentmodule:: pymc

.. autosummary::
:toctree: generated/

BART
PGBART
bart.plot_dependence
bart.predict
15 changes: 15 additions & 0 deletions docs/source/api/data.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
Data
****

.. currentmodule:: pymc

.. autosummary::
:toctree: generated/

ConstantData
MutableData
get_data
Data
GeneratorAdapter
Minibatch
align_minibatches
113 changes: 0 additions & 113 deletions docs/source/api/inference.rst

This file was deleted.

23 changes: 19 additions & 4 deletions docs/source/api/math.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,27 @@ from aesara.tensor (see there for more details). Doing any kind of math with PyM
variables, or defining custom likelihoods or priors requires you to use these Aesara
expressions rather than NumPy or Python code.

.. currentmodule:: pymc.math
.. currentmodule:: pymc

Functions exposed in pymc namespace
-----------------------------------
.. autosummary::
:toctree: generated/

expand_packed_triangular
logit
invlogit
probit
invprobit
logsumexp

Functions exposed in pymc.math
------------------------------

.. automodule:: pymc.math
.. autosummary::
:toctree: generated/

dot
constant
flatten
Expand Down Expand Up @@ -58,6 +76,3 @@ expressions rather than NumPy or Python code.
logsumexp
invlogit
logit

.. automodule:: pymc.math
:members:
19 changes: 19 additions & 0 deletions docs/source/api/misc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Other utils
***********

.. currentmodule:: pymc

.. autosummary::
:toctree: generated/

find_constrained_prior
DictToArrayBijection

Printing
--------
.. autosummary::
:toctree: generated/

str_for_dist
str_for_model
str_for_potential_or_deterministic
25 changes: 22 additions & 3 deletions docs/source/api/model.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,25 @@
Model
-----

.. currentmodule:: pymc.model
.. automodule:: pymc.model
:members:
Model creation and inspection
-----------------------------

.. currentmodule:: pymc
.. autosummary::
:toctree: generated/

Model
model_to_graphviz
modelcontext

Others
------

.. autosummary::
:toctree: generated/

Deterministic
Potential
set_data
Point
compile_fn
7 changes: 3 additions & 4 deletions docs/source/api/ode.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,10 @@
Ordinary differential equations (ODEs)
**************************************

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

.. currentmodule:: pymc.ode
.. automodule:: pymc.ode

.. autosummary::
:toctree: generated/

.. automodule:: pymc.ode
:members: DifferentialEquation
DifferentialEquation
71 changes: 65 additions & 6 deletions docs/source/api/samplers.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,72 @@
====
Samplers
====
========

This submodule contains functions for MCMC sampling.
This submodule contains functions for MCMC and forward sampling.


.. currentmodule:: pymc.sampling
.. currentmodule:: pymc

.. autosummary::
:toctree: generated/

.. automodule:: pymc.sampling
:members:
sample
sample_prior_predictive
sample_posterior_predictive
sample_posterior_predictive_w
iter_sample
init_nuts
draw

Step methods
************

.. currentmodule:: pymc

HMC family
----------

.. autosummary::
:toctree: generated/

NUTS
HamiltonianMC

Metropolis family
-----------------

.. autosummary::
:toctree: generated/

BinaryGibbsMetropolis
BinaryMetropolis
CategoricalGibbsMetropolis
CauchyProposal
DEMetropolis
DEMetropolisZ
LaplaceProposal
Metropolis
MultivariateNormalProposal
NormalProposal
PoissonProposal
UniformProposal

MLDA family
-----------

.. autosummary::
:toctree: generated/

MLDA
DEMetropolisZMLDA
MetropolisMLDA
RecursiveDAProposal

Other step methods
------------------

.. autosummary::
:toctree: generated/

CompoundStep
EllipticalSlice
Slice
Loading