Fix WandbLogger.watch()
method annotation to accept None for the log parameter
#19237
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a comically small change that fixed an annoyance I was having. The wandb
watch
method has alog
argument which can be a string ("gradients", "parameters", "all") ORNone
. You might provideNone
if you want to callwatch
withlog_graph
but don't want to log the gradients or parameters.However, the WandBLogger
watch
method has a type annotation ofstr
for thelog
parameter which is passed to the underlyingwandb.watch
log
parameter. This PR simply changes that type annotation toOptional[str]
so thatNone
doesn't violate the type annotation.The current WandBLogger docs are kind of more "tutorial style" rather than a full reference of all the methods on the class, so there isn't necessarily a change that needs to be made. However, I'm open to suggestions.
Before submitting
PR review
Anyone in the community is welcome to review the PR.
Before you start reviewing, make sure you have read the review guidelines. In short, see the following bullet-list:
Reviewer checklist
📚 Documentation preview 📚: https://pytorch-lightning--19237.org.readthedocs.build/en/19237/