Document various performance tips and tricks
Open
Beginner friendly
Nobody has claimed this yet.
documentation
- Dominant language
- R
- Stars
- 160
- Forks
- 69
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 15
Description
In the upcoming release we have the option of turning off range checks to improve performance. Should we explicitly mention this option in the compile method doc?
Contributor guide
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 locating the compile method documentation in CmdStanR and review the upcoming release option for turning off range checks. Update the documentation to explain the option and its performance implication, then verify that the generated or rendered documentation clearly includes it.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 64/100