-
Notifications
You must be signed in to change notification settings - Fork 394
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
guide: consolidate Exp Sharing intro (#2711)
* guide: summarize Sharing Exps intro * ref: link from exp push/pull to Exp Sharing guide * Update content/docs/user-guide/experiment-management/sharing-experiments.md * guide: link from Exp Mgmt index to Sharing * guide: ~~isolate~~ from link to Exp Sharing per #2711 (review) * Update content/docs/user-guide/experiment-management/sharing-experiments.md Co-authored-by: David de la Iglesia Castro <[email protected]> * guide: mention only SSH Git URLs support exp sharing per #2711 (review) * guide: update dvc remote example in sharing exps * yarn format some files per https://app.circleci.com/pipelines/github/iterative/dvc.org/10086/workflows/9b1bf89f-a432-49f2-9a20-72fe77dd4102/jobs/10145 Co-authored-by: David de la Iglesia Castro <[email protected]>
- Loading branch information
1 parent
fb4663c
commit d1422b1
Showing
5 changed files
with
31 additions
and
31 deletions.
There are no files selected for viewing
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
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
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
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
46 changes: 20 additions & 26 deletions
46
content/docs/user-guide/experiment-management/sharing-experiments.md
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,39 +1,33 @@ | ||
# Sharing Experiments | ||
|
||
There are two types of remotes that can store experiments. Git remotes are | ||
distributed copies of the Git repository, for example on GitHub or GitLab. | ||
|
||
[DVC remotes](/doc/command-reference/remote) on the other hand are | ||
storage-specific locations (e.g. Amazon S3 or Google Drive) which we can | ||
configure with `dvc remote`. DVC uses them to store and fetch large files that | ||
don't normally fit inside Git repos. | ||
|
||
DVC needs both kinds of remotes for backing up and sharing experiments. | ||
|
||
Experiment files that are normally tracked in Git (like code versions) are | ||
shared using Git remotes, and files or directories tracked with DVC (like | ||
datasets) are shared using DVC remotes. | ||
|
||
> See [Git remotes guide] and `dvc remote add` for information on setting them | ||
> up. | ||
Two types of _remotes_ are needed to upload experiments for sharing. | ||
[Git remotes](https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes) | ||
are distributed copies of the Git repository, hosted for example on GitHub or | ||
GitLab. Small files like experimental code and | ||
[DVC metafiles](/doc/user-guide/project-structure) files will go there. | ||
[DVC remotes](/doc/command-reference/remote) on the other hand are data storage | ||
locations (e.g. Amazon S3 or Google Drive). You can use them to back up and | ||
[share data](/doc/use-cases/sharing-data-and-model-files) files and directories | ||
that don't fit inside Git repos. | ||
|
||
> See this [Git remotes guide] and `dvc remote add` for info. on setting them | ||
> up. | ||
> ⚠️ Note that only [SSH Git URLs] support DVC experiment sharing. | ||
[ssh git urls]: | ||
https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols#_the_protocols | ||
[git remotes guide]: | ||
https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes | ||
|
||
Normally, there should already be a Git remote called `origin` when you clone a | ||
repo. Use `git remote -v` to list your Git remotes: | ||
You can list your remotes with `git remote -v` and `dvc remote list`: | ||
|
||
```dvc | ||
$ git remote -v | ||
origin https://github.com/iterative/get-started-experiments (fetch) | ||
origin https://github.com/iterative/get-started-experiments (push) | ||
``` | ||
origin [email protected]:iterative/get-started-experiments.git (fetch) | ||
origin [email protected]:iterative/get-started-experiments.git (push) | ||
Similarly, you can see the DVC remotes in you project using `dvc remote list`: | ||
|
||
```dvc | ||
$ dvc remote list | ||
storage https://remote.dvc.org/get-started-experiments | ||
storage s3://mybucket/my-dvc-store | ||
``` | ||
|
||
## Uploading experiments to remotes | ||
|