-
Notifications
You must be signed in to change notification settings - Fork 407
studio: Add DVC Studio commands to documentation #4981
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
Closed
Closed
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
7e35b6a
Add DVC Studio commands to documentation
amritghimire 3b08615
Refactor DVC Studio documentation and add new command login
amritghimire 5b8117f
Add 'studio logout' and 'studio token' to DVC Studio docs
amritghimire 8acab78
Update usage details in DVC Studio login docs
amritghimire 79e784f
Extend DVC Studio login documentation with scopes
amritghimire a63995a
Merge branch 'main' into studio
amritghimire File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| # studio | ||
|
|
||
| Set of commands to authorize DVC with Studio and save the token to global [DVC | ||
| configuration]: [login](/doc/command-reference/studio/login), | ||
| [logout](/doc/command-reference/studio/logout), | ||
| [token](/doc/command-reference/studio/token), | ||
|
|
||
| [dvc configuration]: | ||
| /doc/user-guide/project-structure/configuration#config-file-locations | ||
|
|
||
| ## Synopsis | ||
|
|
||
| ```usage | ||
| usage: dvc studio [-h] [-q | -v] {login,logout,token} ... | ||
|
|
||
| positional arguments: | ||
| {login,logout,token} Use `dvc studio CMD --help` to display command-specific help. | ||
| login Authenticate DVC with Studio host | ||
| logout Logout user from Studio | ||
| token View the token dvc uses to contact Studio | ||
|
|
||
| options: | ||
| -h, --help show this help message and exit | ||
| -q, --quiet Be quiet. | ||
| -v, --verbose Be verbose. | ||
| ``` | ||
|
|
||
| ## Description | ||
|
|
||
| `dvc studio` authorize dvc with Studio and set the token. When this is set, DVC | ||
| uses this to share live experiments and notify Studio about pushed experiments. | ||
|
|
||
| ## Options | ||
|
|
||
| - `-h`, `--help` - show this help message and exit | ||
| - `-q`, `--quiet` - Be quiet | ||
| - `-v`, `--verbose` - Be verbose | ||
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| ## studio login | ||
|
|
||
| Authorize DVC with Studio to save the token to global [DVC configuration]. | ||
|
|
||
| [dvc configuration]: | ||
| /doc/user-guide/project-structure/configuration#config-file-locations | ||
|
|
||
| ## Synopsis | ||
|
|
||
| ```usage | ||
| usage: dvc studio login [-h] [-q | -v] [-H <hostname>] [-s <scopes>] [-n <name>] [-d] | ||
| ``` | ||
|
|
||
| ## Description | ||
|
|
||
| By default, this command authorize dvc with Studio with default scopes and a | ||
| random name as token name. | ||
|
|
||
| ## Options | ||
|
|
||
| - `-h`, `--help` - show this help message and exit | ||
| - `-q`, `--quiet` - Be quiet. | ||
| - `-v`, `--verbose` - Be verbose. | ||
| - `-H <hostname>`, `--hostname <hostname>` - The hostname of the Studio instance | ||
| to authenticate with. | ||
| - `-s <scopes>`, `--scopes <scopes>` - The scopes for the authentication token. | ||
| - `-n NAME`, `--name <name>` - The name of the authentication token. It will be | ||
| used to identify token shown in Studio profile. | ||
| - `-d`, `--use-device-code` - Use authentication flow based on user code. You | ||
| will be presented with user code to enter in browser. DVC will also use this | ||
| if it cannot launch browser on your behalf. | ||
|
|
||
| ## Available scopes | ||
|
|
||
| - `EXPERIMENTS` - Experiment operations | ||
| - `DATASETS` - Dataset operations | ||
| - `MODELS` - Model registry operations |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| ## studio logout | ||
|
|
||
| This command helps to log out user from DVC Studio. | ||
|
|
||
| ## Synopsis | ||
|
|
||
| ```usage | ||
| usage: dvc studio logout [-h] [-q | -v] | ||
| ``` | ||
|
|
||
| ## Description | ||
|
|
||
| `dvc logout` removes the studio token stored from global [DVC configuration]. | ||
|
|
||
| [dvc configuration]: | ||
| /doc/user-guide/project-structure/configuration#config-file-locations | ||
|
|
||
| ## Options | ||
|
|
||
| - `-h`, `--help` - show this help message and exit | ||
| - `-q`, `--quiet` - Be quiet. | ||
| - `-v`, `--verbose` - Be verbose. |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| ## studio token | ||
|
|
||
| This command helps to log out user from DVC Studio. | ||
|
|
||
| ## Synopsis | ||
|
|
||
| ```usage | ||
| usage: dvc studio token [-h] [-q | -v] | ||
| ``` | ||
|
|
||
| ## Description | ||
|
|
||
| `dvc token` shows the studio token stored in global [DVC configuration]. | ||
|
|
||
| [dvc configuration]: | ||
| /doc/user-guide/project-structure/configuration#config-file-locations | ||
|
|
||
| ## Options | ||
|
|
||
| - `-h`, `--help` - show this help message and exit | ||
| - `-q`, `--quiet` - Be quiet. | ||
| - `-v`, `--verbose` - Be verbose. |
This file contains hidden or 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
let's review here in the code carefully if it's authorize or authenticate.
E.g. here https://cli.github.com/manual/gh_auth_login and here https://learn.microsoft.com/en-us/cli/azure/authenticate-azure-cli it is authenticate.
We should be careful about this terminology.