Skip to content

Commit 44cf068

Browse files
committed
update docstring
1 parent df4534a commit 44cf068

1 file changed

Lines changed: 5 additions & 6 deletions

File tree

src/mofaflex/_core/priors/base.py

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -55,14 +55,13 @@ class Prior(
5555
Subclasses must also implement the `posterior` property to get the summary statistics of the posterior distribution.
5656
5757
This base class provides default behavior for simple usecases, Subclasses can reimplement any combination of
58-
methods to customize aspects. Subclasses can also contain two boolean attributs:
58+
methods to customize aspects. Subclasses can pass two boolean keyword class arguments:
5959
60-
- `_factors`: Indicates whether the subclass is suitable for factors.
61-
- `_weights`: Indicates whether the subclass is suitable for weights.
60+
- `factors`: Indicates whether the subclass is suitable for factors.
61+
- `weights`: Indicates whether the subclass is suitable for weights.
6262
63-
By default, it is assumed that a subclass is suitable for both factors and weights. Generally, specifying these attributes
64-
should only be necessary if a prior is not suitable for either factors or weights and no wrapper class in _core/priors
65-
exists.
63+
By default, it is assumed that a subclass is suitable for both factors and weights. Generally, specifying these arguments
64+
should only be necessary if a prior is not suitable for either factors or weights.
6665
6766
Subclasses can use this to expose properties or methods to the end user through the main model class.
6867
If a prior can be used for both factors and weights, the method or property name should contain `a̲x̲i̲s̲`

0 commit comments

Comments
 (0)