pymc-devs / pymc-devs/pymc-examples
Port NBs to v4
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 398
- Forks
- 325
- Avg merge
- 9d 15m
- Merged PRs (30d)
- 1
Description
There are quite a few NBs that still need porting here in ToDo or Best Practices (v3): https://github.com/pymc-devs/pymc-examples/projects/1#card-75796525
How?
Run the scripts/rerun.py script (https://github.com/pymc-devs/pymc-examples/blob/main/scripts/rerun.py) which attempts to auto-update the code and rerun the NB. If it runs without error (which should be the default) it will commit the updated NB to a branch you specified. If not, you need to fix the NB manually, rerun it, and commit yourself.
After, create a PR to this repo.
Here are the docs from the rerun.py script:
This script/module may be used to re-run, commit & push notebooks
from the CLI or from another Python script (via import rerun).
Run python rerun.py -h to show the CLI help.
The example below does the following:
- Re-runs the BEST notebook
- Commits changes to a branch "rerun-best"
- Push that branch to a remote named "mine"
Assuming you did something like:git add remote mine https://github.com/yourgithubusername/pymc-examples
python scripts/rerun.py --fp_notebook=examples/case_studies/BEST.ipynb --commit_to=rerun-best --push_to=mine
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 with the ToDo or Best Practices (v3) cards in the linked project and read scripts/rerun.py, using its CLI help and notebook example. Run it on each selected notebook, fix any notebooks that fail to rerun, commit the updates, and open a pull request.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook, python
- Domain
- documentation
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100