Use best practices for wandb.init() and the Run object #1146
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Deploying docs with
|
| Latest commit: |
356c22e
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://cd87887d.docodile.pages.dev |
| Branch Preview URL: | https://timoffex-avoid-global-run.docodile.pages.dev |
timoffex
force-pushed
the
timoffex/avoid-global-run
branch
from
c2165da to
59c5cab
Compare
8 tasks
mdlinville
reviewed
Mar 6, 2025
There was a problem hiding this comment.
I did a copyedit pass to try to help out. I think @ngrayluna should take a look at the technical changes and may have other feedback. Thanks!
kptkin
reviewed
Mar 6, 2025
kptkin
reviewed
Mar 6, 2025
Co-authored-by: Matt Linville <[email protected]>
timoffex
force-pushed
the
timoffex/avoid-global-run
branch
from
e42eb01 to
737642b
Compare
mdlinville
reviewed
Mar 7, 2025
mdlinville
reviewed
Mar 7, 2025
mdlinville
reviewed
Mar 7, 2025
mdlinville
reviewed
Mar 7, 2025
mdlinville
reviewed
Mar 7, 2025
mdlinville
approved these changes
Mar 12, 2025
There was a problem hiding this comment.
A few more small suggestions for the copy in case they are helpful. I am not sure whether @ngrayluna wants to take another look before we merge?
ngrayluna
approved these changes
Mar 12, 2025
|
Nice. Thanks so much @timoffex! |
|
Ticket for tracking other code blocks that need updating: https://wandb.atlassian.net/browse/DOCS-1336 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
wandb.run) or implicitly (wandb.config,wandb.log, etc.) to use a Run object directly instead.wandb.init()as a context manager by default. This is a best practice from the SDK's perspective because it avoids dangling runs: when thewithblock exits, the run is marked complete (on normal exit) or failed (on exception) and the process waits for its data to finish uploading.This regex finds most places that need to be updated (with some false positives):
Unfortunately, there are quite a few places left to update---523 by my count! This PR just updates some top-level guides for users and integrations, which I think are the most important places to start with.