Update GP-Latent example to V4 #371
Conversation
…misc text improvements, verify convergence
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
|
ty @twiecki, if it's all good, do you mind hitting the big green merge button? I dont have write access it seems |
There was a problem hiding this comment.
The table of contents is messed up:
IMO, the first heading Gaussian Processes: Latent Variable Implementation should be the only level 1 heading. Then Latent variable implementation, example 1..., example 2..., Authors should be level 2 and so on.
Note: When there is a single level 1 heading at the top of the file, it is excluded from the toc so everything looks better, see for example: https://pymcio--371.org.readthedocs.build/projects/examples/en/371/generalized_linear_models/GLM-simpsons-paradox.html
| --- | ||
|
|
||
| ```{raw-cell} |
There was a problem hiding this comment.
This should not be a raw cell, it should be markdown cell. It is not rendering correctly in the preview due to that: https://pymcio--371.org.readthedocs.build/projects/examples/en/371/gaussian_processes/GP-Latent.html. The title is not shown, neither are the notebook badges and the tags are not recognized.
| ```{code-cell} ipython3 | ||
| %load_ext watermark | ||
| %watermark -n -u -v -iv -w | ||
| ``` | ||
|
|
||
| ```{raw-cell} |
There was a problem hiding this comment.
This should not be a raw cell either. There should not be any raw cells in the notebook
| --- | ||
|
|
||
| ```{raw-cell} | ||
| (notebook_name)= |
There was a problem hiding this comment.
The target should not be literally notebook_name but the actual name of the notebook. The text within the parenthesis is what will be used to reference this notebook from other places in the docs, it needs to be unique to this notebook. https://docs.pymc.io/en/latest/contributing/jupyter_style.html#first-cell
There was a problem hiding this comment.
Hmm right where it says it in that big red box labeled important that I managed to miss
…ally name notebook
|
Thanks for the review @OriolAbril! |
|
Hey @OriolAbril, I noticed today that the changes made in this PR were accidentally overwritten by something else a day later (history: https://github.com/pymc-devs/pymc-examples/commits/main/examples/gaussian_processes/GP-Latent.ipynb). If you look at the version of this notebook in What's the best way to fix this? I can open a new PR and copy over the final state of this PR into it, but that sounds like bad git practices. Any recommendation? |
|
Actually, I found some code that was commented that should be deleted. I can PR a fix for that that will fix everything else. |
|
I think a new PR is perfectly fine, even needed. Having updated notebooks can never be trumped by trying to enforce some git good practices imo. Thanks for catching this by the way. |
Update GP-Latent to V4
Addresses issue #72. Is a replacement for PR #237. Upgrades the notebook to V4. Tried to follow the style guide and passed pre-commit locally, but please let me know what's not correct. I also cleaned up some of the text and example models a bit.
Helpful links