Need doc about importance resampling changes
Nobody has claimed this yet.
- Dominant language
- R
- Stars
- 401
- Forks
- 136
- PR merge metrics
- No merged PRs in 30d
Description
@avehtari @bgoodri Currently there is very little doc explaining the new default behavior for optimizing (and soon VB too). It's good to have the new warning messages and the doc for the new arguments, but they don't really explain anything about what actually happens when importance_resampling is TRUE or what the diagnostics mean. Anyone using optimization will now all of a sudden start seeing new warnings and different results, so it would be good to explain it somewhere. A vignette would be great, but even something more minimal for now would be ok.
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.
Research direction
Start by reviewing the existing warning messages and documentation for the importance_resampling arguments and diagnostics. Determine what users of optimization and VB need explained about the changed default behavior, then document the behavior, warnings, diagnostics, and resulting changes in results in a suitable vignette or documentation page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 28/100