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.

Sign up for GitHub

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

Fix type headers in docstrings #1943

Merged
merged 2 commits into from
Feb 5, 2025
+7 −5
Merged

Fix type headers in docstrings #1943

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
49c311c
Add type header and backticks to AbstractMixtureModel docstrings
abhro Jan 25, 2025
a40679c
Fix type header for MixtureModel docstring
abhro Jan 25, 2025
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
12 changes: 7 additions & 5 deletions src/mixtures/mixturemodel.jl
View file
Open in desktop
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
Loading