Document fit! (#88)

* Document fit! * Patch version * Collapse docstrings * fit_in_sequence
gdalle · Feb 22, 2024 · f4b750d · f4b750d
1 parent ba666fb
commit f4b750d
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 3 deletions.
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "HiddenMarkovModels"
 uuid = "84ca31d5-effc-45e0-bfda-5a68cd981f47"
 authors = ["Guillaume Dalle"]
-version = "0.4.0"
+version = "0.4.1"
 
 [deps]
 ArgCheck = "dce04be8-c92d-5529-be00-80e4d2c0e197"

diff --git a/docs/src/api.md b/docs/src/api.md
@@ -1,3 +1,7 @@
+```@meta
+CollapsedDocStrings = true
+```
+
 # API reference
 
 ```@docs

diff --git a/src/types/abstract_hmm.jl b/src/types/abstract_hmm.jl
@@ -92,7 +92,10 @@ function obs_logdensities!(
 end
 
 """
-$(SIGNATURES)
+    StatsAPI.fit!(
+        hmm, fb_storage::ForwardBackwardStorage,
+        obs_seq, [control_seq]; seq_ends,
+    )
 
 Update `hmm` in-place based on information generated during forward-backward.
 

diff --git a/src/utils/fit.jl b/src/utils/fit.jl
@@ -9,7 +9,7 @@ Default behavior:
 
 Override for Distributions.jl (in the package extension)
 
-    dists[i] = fit(eltype(dists), x, w)
+    dists[i] = fit(eltype(dists), turn_into_vector(x), w)
 """
 function fit_in_sequence!(dists::AbstractVector, i::Integer, x, w)
     fit!(dists[i], x, w)