`gaussian_dlm_obs` summary does not state if sequential processing is used
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 68/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- tex
- Domain
- documentation
Research direction
Open the gaussian dynamic linear models section at the linked Functions Reference page and compare its first paragraph with stan/math/prim/prob/gaussian_dlm_obs_lpdf.hpp around line 40. Update the summary so it explicitly distinguishes vector V, which uses sequential processing, from diagonal-matrix processing; the documentation is done when that behavior is unambiguous.
Written by the indexing model from the issue text.
Description
When V is a vector sequential processing is used. This should be explicit in the first paragraph. Right now it just says that a more effecient processing can be used when V is a diagonal matrix. So the user does not know if Stan ever does this sequential processing or only if a diagonal matrix is supplied. In fact, it is used only when V is a vector see https://github.com/stan-dev/math/blob/c0de977b5a3c701b1e71c4f7a15d806b0159d4c6/stan/math/prim/prob/gaussian_dlm_obs_lpdf.hpp#L40
- Dominant language
- TeX
- Stars
- 43
- Forks
- 133
- Avg merge
- 11h 32m
- Merged PRs (30d)
- 4
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from stan-dev/docs
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
bug
Difficulty 1/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
agilepathway/label-checker#640 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
BasedHardware/omi#15662 · 1 comment ·
-
documentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
documentation good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
amponce/archive-movie-browser#167 ·
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·