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

Move CustomDist logic to dedicated module and docs section #7363

Merged
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
1 change: 1 addition & 0 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ jobs:

- |
tests/distributions/test_censored.py
tests/distributions/test_custom.py
tests/distributions/test_simulator.py
tests/sampling/test_deterministic.py
tests/sampling/test_forward.py
Expand Down
1 change: 1 addition & 0 deletions docs/source/api/distributions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Distributions
distributions/timeseries
distributions/truncated
distributions/censored
distributions/custom
distributions/simulator
distributions/transforms
distributions/utilities
20 changes: 20 additions & 0 deletions docs/source/api/distributions/custom.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
**********
CustomDist
**********

..
Manually follow the template in _templates/distribution.rst.
If at any point, multiple objects are listed here,
the pattern should instead be modified to that of the
other API files such as api/distributions/continuous.rst

.. currentmodule:: pymc

.. autoclass:: CustomDist

.. rubric:: Methods

.. autosummary::
:toctree: classmethods

CustomDist.dist
1 change: 0 additions & 1 deletion docs/source/api/distributions/utilities.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ Distribution utilities
:toctree: generated/

Continuous
CustomDist
Discrete
Distribution
SymbolicRandomVariable
Expand Down
3 changes: 1 addition & 2 deletions pymc/distributions/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
Wald,
Weibull,
)
from pymc.distributions.custom import CustomDist, DensityDist
from pymc.distributions.discrete import (
Bernoulli,
BetaBinomial,
Expand All @@ -66,8 +67,6 @@
)
from pymc.distributions.distribution import (
Continuous,
CustomDist,
DensityDist,
DiracDelta,
Discrete,
Distribution,
Expand Down
Loading
Loading