From 7af0a873550d1c17253acaa58fca54d54993e1c1 Mon Sep 17 00:00:00 2001 From: Ricardo Vieira Date: Mon, 24 Jun 2024 10:49:15 +0200 Subject: [PATCH] Add own section for CustomDist in distributions API --- docs/source/api/distributions.rst | 1 + docs/source/api/distributions/custom.rst | 20 ++++++++++++++++++++ docs/source/api/distributions/utilities.rst | 1 - 3 files changed, 21 insertions(+), 1 deletion(-) create mode 100644 docs/source/api/distributions/custom.rst diff --git a/docs/source/api/distributions.rst b/docs/source/api/distributions.rst index ca3a09cbaa9..3384b8157d0 100644 --- a/docs/source/api/distributions.rst +++ b/docs/source/api/distributions.rst @@ -14,6 +14,7 @@ Distributions distributions/timeseries distributions/truncated distributions/censored + distributions/custom distributions/simulator distributions/transforms distributions/utilities diff --git a/docs/source/api/distributions/custom.rst b/docs/source/api/distributions/custom.rst new file mode 100644 index 00000000000..a2e95c909aa --- /dev/null +++ b/docs/source/api/distributions/custom.rst @@ -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 diff --git a/docs/source/api/distributions/utilities.rst b/docs/source/api/distributions/utilities.rst index 39a2a46f97a..61cfb1a3149 100644 --- a/docs/source/api/distributions/utilities.rst +++ b/docs/source/api/distributions/utilities.rst @@ -7,7 +7,6 @@ Distribution utilities :toctree: generated/ Continuous - CustomDist Discrete Distribution SymbolicRandomVariable