pymc-devs / pymc-devs/pymc-examples
Examples gallery thumbnails are sometimes poorly representative
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 398
- Forks
- 325
- Avg merge
- 9d 15m
- Merged PRs (30d)
- 1
Description
It seems that the examples gallery auto-generates thumbnails by grabbing the last figure in a notebook. However, this has often resulted in thumbnails that are either un-informative or even mis-informative. For example, the thumbnail for GP-circular is actually a contrasting example the author provided of how not to make a circular GP. In a similar vein, the "Mauna Loa continued" thumbnail is not particularly informative.
Perhaps the notebooks could be tweaked to simply put a more useful figure last, or thumbnails could be specified via a cell metadata tag in the notebooks, or a thumbnail could be uploaded separately from the notebook?
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 at the examples gallery linked in the issue and inspect how thumbnails are generated, then compare the GP-circular and Mauna Loa continued notebooks. Determine which thumbnail-selection approach fits the gallery; done means those examples and other affected notebooks display informative, representative thumbnails.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook, python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 32/100