doc for `fixed_param` should mention it's not necessary
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 198
- Forks
- 81
- PR merge metrics
- No merged PRs in 30d
Description
CmdStanPy automatically resolves whether it needs fixed_param = True or not depending on the number of parameters in the model. This isn't clear in the documentation, which makes it sound like this is required. This caused someone to open an issue against my tutorial because they read the CmdStanPy doc:
https://github.com/bob-carpenter/stan-getting-started/issues/6
My response there shows that you don't need fixed_param = True.
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
Review the CmdStanPy documentation for fixed_param and compare its wording with the linked tutorial issue and response. Update the documentation so users understand that CmdStanPy determines whether fixed_param = True is needed based on the model's parameter count, then verify that the revised explanation no longer implies it is always required.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 70/100