Lightning-AI / Lightning-AI/torchmetrics
Create gallery of realistic examples
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.5k
- Forks
- 526
- Avg merge
- 6d 11h
- Merged PRs (30d)
- 5
Description
## 🚀 Feature
### Motivation
We have some doctests to demonstrate immediate use, which is great but having demos with real-work examples would also be great for new users...
### Pitch
have visual
### Alternatives
We may not use our tutorials as they are optimized for long-running code, so we can try a simpler tool: https://sphinx-gallery.github.io/stable/index.html
### Additional context
having these examples in Python script instead of notebooks directly...
so :green_circle: advantages:
- regularly verified reproducibility
- smaller footprint for the git versioning
and :red_square: disadvantages:
- not so cute view directly in GH
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 by reviewing the existing doctests and tutorials, then compare the proposed Sphinx Gallery approach with Python scripts instead of notebooks. Done would mean a visual gallery of realistic, regularly verified examples with an agreed structure and reproducibility workflow.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100