fix(dvclive): Note on DVC_STUDIO_URL and DVC_STUDIO_TOKEN env variablesgit
#5012
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
Link Check ReportAll 1 links passed! |
shcheklein
reviewed
Nov 30, 2023
| @@ -15,3 +15,10 @@ os.environ[env.DVCLIVE_OPEN] = "True" | |||
| of DVCLive. Defaults to `WARNING`. | |||
| - `DVCLIVE_OPEN`: If True, DVCLive will try to automatically open the HTML | |||
| generated by `Live.make_report()` in the default browser. Defaults to `False`. | |||
| - `DVC_STUDIO_TOKEN`: If set to a valid Studio auth token, and you're running | |||
There was a problem hiding this comment.
Note: this one overrides the token taken from DVC config. So, when you run it within a repo it's not needed if DVC is connected with Studio, same with VS Code extension.
There was a problem hiding this comment.
Noted! I'll update the wording on this in a little bit.
|
I think it's related to #4914. These are technically DVC env vars, not DVCLive. Maybe we need to go ahead and add that finally and link between the pages? @natikgadzhi Is there anywhere else in the dvclive docs you think we need to highlight how to connect to Studio? |
Merged
|
Closing as stale + it's absorbed by #5030 |
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.
Summary
Just noticed we have the env vars page for DVCLive, but it did not list the studio url and studio token vars. Added them to the list, and added the link to live tracking page in the Studio section.