Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(dvclive): Note on DVC_STUDIO_URL and DVC_STUDIO_TOKEN env variablesgit #5012

Closed
wants to merge 3 commits into from
Closed
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions content/docs/dvclive/env.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noted! I'll update the wording on this in a little bit.

the script from within a repository connected to a project in your Studio
account, DVCLive will automatically send live params, metrics, and plots at
every step of training during the tracked experiment.
[See more on live tracking in Studio](https://dvc.org/doc/studio/user-guide/experiments/live-metrics-and-plots).
- `DVC_STUDIO_URL`: If set, DVCLive will use this URL to send live metrics to.
Defaults to `https://studio.iterative.ai`.
Loading