pytorch-lightning: Document exceptions
📚 Documentation
This is only a suggestion, but I find it useful to have what exceptions functions/classes can raise in the docs, so I’d like to suggest adding the Raises: section to public functions/classes.
Progress
dirname $(grep -rl "raise " pytorch_lightning)|sort|uniq|awk '{print "- [ ] "$1}'
- pytorch_lightning/accelerators (#9558)
- pytorch_lightning/callbacks
- pytorch_lightning/callbacks/progress
- pytorch_lightning/core
- pytorch_lightning/core/mixins
- pytorch_lightning/loggers
- pytorch_lightning/loops
- pytorch_lightning/loops/dataloader
- pytorch_lightning/loops/epoch
- pytorch_lightning/loops/optimization
- pytorch_lightning/overrides
- pytorch_lightning/plugins
- pytorch_lightning/plugins/environments
- pytorch_lightning/plugins/io
- pytorch_lightning/plugins/precision
- pytorch_lightning/plugins/training_type
- pytorch_lightning/profiler
- pytorch_lightning/trainer
- pytorch_lightning/trainer/connectors
- pytorch_lightning/trainer/connectors/logger_connector
- pytorch_lightning/tuner
- pytorch_lightning/utilities
About this issue
- Original URL
- State: closed
- Created 3 years ago
- Reactions: 1
- Comments: 20 (20 by maintainers)
If it is not conflicting with someone else, I could work on
/utilities/*@akihironitta Just submitted the PR for functional. #6273
@akihironitta There are no changes required for
pytorch_lightning/distributed/*. And ifcluster_environmentsis the filepytorch_lightning/plugins/environments/cluster_environment.py, then if that doesn’t require any changes. I couldn’t find any folderpytorch_lightning/cluster_environmentsas specified@akihironitta I’m doing metrics/functional as well
@akihironitta There doesn’t seem to be any errors or exceptions in
overridesfolder@akihironitta @dipam7 I submitted a PR for metrics/regression #6202 @akihironitta can you please review it?
@akihironitta Just submitted a PR #6190 if you can take a look
@akihironitta Hey, I’m currently looking at metrics/classification. I think that would be the easiest for me to do. I’ll comment here when I move on to other submodules.
@akihironitta Please have a look at my PR #6171, and if there are any exceptions I have missed.
I am new to PyTorch lightning and I can work on this issue!
@akihironitta Done! 😃