Lightning-AI / Lightning-AI/pytorch-lightning
TensorBoardLogger does not document .add_image() function
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 31.4k
- Forks
- 3.8k
- Avg merge
- 6d 7h
- Merged PRs (30d)
- 6
Description
### 📚 Documentation
Several tutorials, such as https://lightning.ai/docs/pytorch/stable/visualize/logging_intermediate.html , show the use of the .add_image() function for TensorBoardLogger. This function needs documentation at
https://lightning.ai/docs/pytorch/stable/api/lightning.pytorch.loggers.tensorboard.html
cc @lantiga @borda
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 TensorBoardLogger API page linked in the issue and compare it with the linked intermediate-logging tutorial's use of .add_image(). Document the function on that API page, with completion confirmed when the function is described alongside the other TensorBoardLogger methods.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, pytorch
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100