pymc-devs / pymc-devs/pymc-examples
Confusing docstrings in ModelBuilder Example
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 398
- Forks
- 325
- Avg merge
- 9d 15m
- Merged PRs (30d)
- 1
Description
Notebook title: Using ModelBuilder class for deploying PyMC models
Notebook url: https://github.com/pymc-devs/pymc-examples/blob/main/examples/howto/model_builder.ipynb
Issue description
Comments and docstrings in the example (class LinearModel(ModelBuilder): ...) are confusing and seemingly outdated. In particular, model_config is not a parameter of LinearModel.build_model().
Expected output
N/A
Proposed solution
Update the example, so that it follows closely in-line examples embedded in class ModelBuilder: docstrings. Perhaps, improve both at the same time.
See also: #811
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
Open examples/howto/model_builder.ipynb and review the LinearModel(ModelBuilder) example, then compare its comments and docstrings with the inline examples in the ModelBuilder docstrings at pymc-extras/model_builder.py. Done means the notebook documentation is current and no longer describes model_config as a parameter of LinearModel.build_model().
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- Half a day
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100