Skip to content

Commit

Permalink
Fix type headers in docstrings (#1943)
Browse files Browse the repository at this point in the history
* Add type header and backticks to AbstractMixtureModel docstrings

* Fix type header for MixtureModel docstring
  • Loading branch information
abhro authored Feb 5, 2025
1 parent 1e6801d commit e470421
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions src/mixtures/mixturemodel.jl
Original file line number Diff line number Diff line change
@@ -1,19 +1,21 @@
# finite mixture models

"""
AbstractMixtureModel <: Distribution
All subtypes of `AbstractMixtureModel` should implement the following methods:
All subtypes of `AbstractMixtureModel` should implement the following methods:
- ncomponents(d): the number of components
- `ncomponents(d)`: the number of components
- component(d, k): return the k-th component
- `component(d, k)`: return the k-th component
- probs(d): return a vector of prior probabilities over components.
- `probs(d)`: return a vector of prior probabilities over components.
"""
abstract type AbstractMixtureModel{VF<:VariateForm,VS<:ValueSupport,C<:Distribution} <: Distribution{VF, VS} end

"""
MixtureModel{VF<:VariateForm,VS<:ValueSupport,C<:Distribution,CT<:Real}
MixtureModel{VF<:VariateForm,VS<:ValueSupport,C<:Distribution,CT<:Real}
A mixture of distributions, parametrized on:
* `VF,VS` variate and support
* `C` distribution family of the mixture
Expand Down

0 comments on commit e470421

Please sign in to comment.