Complete revamp

[gdalle]

Breaking changes

• Bump version to 0.4.0
• Replace obs_distribution(hmm, i) (returning a single distribution) with obs_distributions(hmm) (returning a vector of distributions)
• Change return of forward_backward: it is now (\gamma, logL)
• Rename a few things:
  • initial_distribution(hmm) into initialization(hmm)
  • check_loglikelihood_increasing into loglikelihood_increasing
• Remove RequiredInterfaces.jl

Other changes

• Forward-backward now uses a vector of AbstractMatrix for \xi so that it can imitate the type and structure of the original transition matrix (e.g. sparse)
• Add specific Storage types for each inference algorithm to simplify initialization
• Simplify a few things with eltype(hmm, obs)
• Better docs with DocStringExtensions.jl
• Shorten tests with HMMTest submodule, add Categorical distributions

[codecov]

Codecov Report

Attention: 10 lines in your changes are missing coverage. Please review.

Comparison is base (145df1c) 93.29% compared to head (c68f8e9) 93.43%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #59      +/-   ##
==========================================
+ Coverage   93.29%   93.43%   +0.14%     
==========================================
  Files          18       17       -1     
  Lines         537      503      -34     
==========================================
- Hits          501      470      -31     
+ Misses         36       33       -3     

Files	Coverage Δ
ext/HiddenMarkovModelsChainRulesCoreExt.jl	100.00% <100.00%> (ø)
ext/HiddenMarkovModelsHMMBaseExt.jl	50.00% <100.00%> (ø)
src/HMMTest.jl	100.00% <100.00%> (ø)
src/HiddenMarkovModels.jl	100.00% <100.00%> (ø)
src/inference/forward.jl	98.03% <100.00%> (+5.88%)	⬆️
src/types/abstract_hmm.jl	95.83% <100.00%> (+5.83%)	⬆️
src/types/hmm.jl	90.00% <100.00%> (ø)
src/utils/mul.jl	100.00% <100.00%> (ø)
src/utils/probvec.jl	100.00% <ø> (ø)
src/utils/transmat.jl	93.33% <ø> (ø)
... and 7 more

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.