Skip to content

Reorganize docs API entries #7030

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.

Sign up for GitHub

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

Merged
merged 6 commits into from
Nov 29, 2023
Merged

Reorganize docs API entries #7030

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2d7cb0b
Remove old import from autosummary doc pages
Nov 23, 2023
eaaef54
Fix small error
Nov 23, 2023
726c67e
Correct place for model_to_networkx & model_to_graphviz
Nov 23, 2023
b01e778
Correct currentmodule source for pytensorf.rst
Nov 23, 2023
feb9f2c
Update docs/source/api/model/core.rst
kataev Nov 24, 2023
4cd807c
Fix sampling & jax docs imports
Nov 28, 2023
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
4 changes: 0 additions & 4 deletions docs/source/api/math.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,11 +67,7 @@ Functions exposed in pymc.math
sgn
ceil
floor
det
matrix_inverse
extract_diag
matrix_dot
trace
sigmoid
logsumexp
invlogit
Expand Down
13 changes: 11 additions & 2 deletions docs/source/api/model/core.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ Model creation and inspection
:toctree: generated/

Model
model_to_graphviz
model_to_networkx
modelcontext

Others
Expand All @@ -22,3 +20,14 @@ Others
set_data
Point
compile_fn


Graph visualization
-------------------

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

model_to_networkx
model_to_graphviz
2 changes: 1 addition & 1 deletion docs/source/api/pytensorf.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
PyTensor utils
**************

.. currentmodule:: pymc
.. currentmodule:: pymc.pytensorf

.. autosummary::
:toctree: generated/
Expand Down
30 changes: 22 additions & 8 deletions docs/source/api/samplers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,39 @@ Samplers
This submodule contains functions for MCMC and forward sampling.


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

.. autosummary::
:toctree: generated/

sample
sample_prior_predictive
sample_posterior_predictive
sample_posterior_predictive_w
sampling.jax.sample_blackjax_nuts
sampling.jax.sample_numpyro_nuts
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did these go somewhere else?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You right, problem was in sampling.jax which doesn't import.
I split tables a little bit.

init_nuts
draw


.. currentmodule:: pymc.sampling.mcmc

.. autosummary::
:toctree: generated/

sample
init_nuts

.. currentmodule:: pymc.sampling.jax

.. autosummary::
:toctree: generated/

sample_blackjax_nuts
sample_numpyro_nuts


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

.. currentmodule:: pymc

HMC family
----------
.. currentmodule:: pymc.step_methods.hmc

.. autosummary::
:toctree: generated/
Expand All @@ -34,6 +46,7 @@ HMC family

Metropolis family
-----------------
.. currentmodule:: pymc.step_methods

.. autosummary::
:toctree: generated/
Expand All @@ -53,6 +66,7 @@ Metropolis family

Other step methods
------------------
.. currentmodule:: pymc.step_methods

.. autosummary::
:toctree: generated/
Expand Down
2 changes: 1 addition & 1 deletion pymc/distributions/transforms.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ def __getattr__(name):
warnings.warn(f"{name} has been deprecated, use ordered instead.", FutureWarning)
return ordered

if name in ("univariate_sum_to_1, multivariate_sum_to_1"):
if name in ("univariate_sum_to_1", "multivariate_sum_to_1"):
warnings.warn(f"{name} has been deprecated, use sum_to_1 instead.", FutureWarning)
return sum_to_1

Expand Down