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

guide: consolidate Exp Sharing intro #2711

Merged
merged 13 commits into from
Aug 18, 2021
Merged
Show file tree
Hide file tree
Changes from 10 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
6 changes: 4 additions & 2 deletions content/docs/command-reference/exp/pull.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,10 @@ positional arguments:

## Description

The `dvc exp push` and `dvc exp pull` commands are the means for sharing
experiments across <abbr>repository</abbr> copies via Git (and DVC) remotes.
The `dvc exp push` and `dvc exp pull` commands are the means for
[sharing experiments] across <abbr>repository</abbr> copies via Git and DVC remotes.

[sharing experiments]: /doc/user-guide/experiment-management/sharing-experiments

> Plain `git push` and `git fetch` don't work with `dvc experiments` because
> these are saved under custom Git references. See **How does DVC track
Expand Down
7 changes: 5 additions & 2 deletions content/docs/command-reference/exp/push.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,11 @@ positional arguments:

## Description

The `dvc exp push` and `dvc exp pull` commands are the means for sharing
experiments across <abbr>repository</abbr> copies via Git (and DVC) remotes.
The `dvc exp push` and `dvc exp pull` commands are the means for
[sharing experiments] across <abbr>repository</abbr> copies via Git and DVC
remotes.

[sharing experiments]: /doc/user-guide/experiment-management/sharing-experiments

> Plain `git push` and `git fetch` don't work with `dvc experiments` because
> these are saved under custom Git references. See **How does DVC track
Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/exp/run.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ option.
Experiments are custom
[Git references](https://git-scm.com/book/en/v2/Git-Internals-Git-References)
(found in `.git/refs/exps`) with a single commit based on `HEAD` (not checked
out by DVC). Note that these commits are not pushed to the Git remote by default
out by DVC). Note that these commits are not pushed to Git remotes by default
(see `dvc exp push`).

</details>
Expand Down
2 changes: 1 addition & 1 deletion content/docs/dvclive/api-reference/init.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ all existing `.tsv` files, `{path}.json` and `{path.html}`.

## Exceptions

- `dvclive.error.DvcLiveError` - If the directory `path` can't be created.
None

[`dvclive.log()`]: /doc/dvclive/api-reference/log
[`dvclive.next_step()`]: /doc/dvclive/api-reference/next_step
3 changes: 2 additions & 1 deletion content/docs/dvclive/api-reference/log.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ environment variables (when used alongside `DVC`).

## Exceptions

- `dvclive.error.DvcLiveError` - If the provided `val` has not supported type.
- `dvclive.error.InvalidMetricTypeError` - thrown if the provided `val` does not
have a supported type

[`dvclive.init()`]: /doc/dvclive/api-reference/init
2 changes: 2 additions & 0 deletions content/docs/user-guide/experiment-management/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,14 @@ The `dvc experiments` features are designed to support these main approaches:
them in batches.
1. Make experiments [persistent] by committing them to your
<abbr>repository</abbr> history.
1. Easily [share and isolate] experiments using Git and DVC remotes.
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved

[experiments]: /doc/user-guide/experiment-management/dvc-experiments
[queue]: /doc/command-reference/exp/run#queueing-and-parallel-execution
[checkpoints]: /doc/user-guide/experiment-management/checkpoints
[persistent]:
/doc/user-guide/experiment-management/dvc-experiments#persistent-experiments
[share and isolate]: /doc/user-guide/experiment-management/sharing-experiments

> 👨‍💻 See [Get Started: Experiments](/doc/start/experiments) for a hands-on
> introduction to DVC experiments.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,37 +1,27 @@
# 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.

[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)
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved
```

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
```
Expand Down
2 changes: 1 addition & 1 deletion src/components/Blog/Feed/Item/styles.module.css
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@
@media (--lg-scr) {
.big & {
max-height: 314px;
padding: 30px;
padding: 30px 30px 30px 0;
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion src/components/DownloadButton/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { logEvent } from '../../utils/front/ga'

import styles from './styles.module.css'

const VERSION = `2.5.4`
const VERSION = `2.6.2`

enum OS {
UNKNOWN = '...',
Expand Down