This repo is created to track status of work on pyprobml notebooks and make review process easy using review-nb bot. Please follow below steps:
- First create an issue before stating any figure. Issue title can be like this
Fig2.10 (book1) gauss_2d_plot.ipyb
- Then fork this repo and create a new branch with meaningful name.
- After your notebook is ready for review, create a PR (with same title of issue) on this repo so we can review/discuss them and add comments in PR itself. Before opening a PR, make sure it is
pyprobml-review
repo and not the originalpyprobml
repo. We will soon shift to the original repo! - You should add latexified figures in your PR (see this gist for example). You can use overleaf latex template to render latexified figures
- Once confirmed by one of the reviewers, you can create a PR on main repo.
There are some changes which we need to keep in mind and update code accordingly. see this reference notebook to compare these changes.
- We do not need to add try...except when package is available in requirement.txt
- Now probml-utils became local installable pip package. path of probml-utils is given in requirement.txt
- The way of working of
latexify()
is slighly changed, basically we do not need to put it under conditionif LATEXIFY
. I recommend to seeplotting.py
file in probml-utils repo to understand these changes. - In orrder to save figure we need to save path in
FIG_DIR
environment variable. if this path is not set, code will run but it will not save any figure.