File tree Expand file tree Collapse file tree 4 files changed +20
-8
lines changed Expand file tree Collapse file tree 4 files changed +20
-8
lines changed Original file line number Diff line number Diff line change @@ -42,9 +42,12 @@ class Censored(SymbolicDistribution):
42
42
43
43
Parameters
44
44
----------
45
- dist: PyMC unnamed distribution
46
- PyMC distribution created via the `.dist()` API, which will be censored. This
47
- distribution must be univariate and have a logcdf method implemented.
45
+ dist: unnamed distribution
46
+ Univariate distribution created via the `.dist()` API, which will be censored.
47
+ This distribution must have a logcdf method implemented for sampling.
48
+
49
+ .. warning:: dist will be cloned, rendering it independent of the one passed as input.
50
+
48
51
lower: float or None
49
52
Lower (left) censoring point. If `None` the distribution will not be left censored
50
53
upper: float or None
Original file line number Diff line number Diff line change @@ -66,12 +66,15 @@ class Mixture(SymbolicDistribution):
66
66
w : tensor_like of float
67
67
w >= 0 and w <= 1
68
68
the mixture weights
69
- comp_dists : iterable of PyMC distributions or single batched distribution
70
- Distributions should be created via the `.dist()` API. If single distribution is
71
- passed, the last size dimension (not shape) determines the number of mixture
69
+ comp_dists : iterable of unnamed distributions or single batched distribution
70
+ Distributions should be created via the `.dist()` API. If a single distribution
71
+ is passed, the last size dimension (not shape) determines the number of mixture
72
72
components (e.g. `pm.Poisson.dist(..., size=components)`)
73
73
:math:`f_1, \ldots, f_n`
74
74
75
+ .. warning:: comp_dists will be cloned, rendering them independent of the ones passed as input.
76
+
77
+
75
78
Examples
76
79
--------
77
80
.. code-block:: python
Original file line number Diff line number Diff line change @@ -1271,10 +1271,13 @@ class LKJCholeskyCov:
1271
1271
larger values put more weight on matrices with few correlations.
1272
1272
n: int
1273
1273
Dimension of the covariance matrix (n > 1).
1274
- sd_dist: pm.Distribution
1274
+ sd_dist: unnamed distribution
1275
1275
A positive scalar or vector distribution for the standard deviations, created
1276
1276
with the `.dist()` API. Should have `shape[-1]=n`. Scalar distributions will be
1277
1277
automatically resized to ensure this.
1278
+
1279
+ .. warning:: sd_dist will be cloned, rendering it independent of the one passed as input.
1280
+
1278
1281
compute_corr: bool, default=True
1279
1282
If `True`, returns three values: the Cholesky decomposition, the correlations
1280
1283
and the standard deviations of the covariance matrix. Otherwise, only returns
Original file line number Diff line number Diff line change @@ -147,9 +147,12 @@ class GaussianRandomWalk(distribution.Continuous):
147
147
innovation drift, defaults to 0.0
148
148
sigma : tensor_like of float, optional
149
149
sigma > 0, innovation standard deviation, defaults to 1.0
150
- init : Univariate PyMC distribution
150
+ init : unnamed distribution
151
151
Univariate distribution of the initial value, created with the `.dist()` API.
152
152
Defaults to Normal with same `mu` and `sigma` as the GaussianRandomWalk
153
+
154
+ .. warning:: init will be cloned, rendering them independent of the ones passed as input.
155
+
153
156
steps : int
154
157
Number of steps in Gaussian Random Walks (steps > 0).
155
158
"""
You can’t perform that action at this time.
0 commit comments