stan-dev / docs

Documentation for the Stan language and CmdStan
https://mc-stan.org/docs/
Other
38 stars 113 forks source link

Update Stan users guide chapter on HMMs #838

Open charlesm93 opened 3 days ago

charlesm93 commented 3 days ago

Summary:

The section on HMMs (under Time-Series models: https://mc-stan.org/docs/stan-users-guide/time-series.html#hmms.section) in the Stan users guide currently doesn't use Stan's dedicated functions for HMMs (described here: https://mc-stan.org/docs/functions-reference/hidden_markov_models.html).

I'll update the section and point users towards the convenient functions we have.

charlesm93 commented 3 days ago

I've taken a closer look at the user guide's section on HMMs, and I find that it treats specific class of HMMs, rather than provide general guidance.

First, the section focuses on the case where the likelihood (observational distribution) is categorical. Then, it considers:

I'm not sure that the supervised case is particularly interesting, since we can compute the posterior analytically. Its main interest is setting up the semi-supervised example.

If I look at the HMM suite we developed, its use-case seems a bit orthogonal, in that:

So I think it can make sense to keep the existing example and add an example which uses the HMM suite. I'll base myself on the case study @bbbales2 put together after we released the functions (https://mc-stan.org/users/documentation/case-studies/hmm-example.html).

Two organizational questions:

My answer to both questions is yes. But I'm leaving it up for discussion.

@bob-carpenter