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.

Sign up for GitHub

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

docs: add --run-cache for fetch/pull/push #1481

Merged
merged 1 commit into from
Jun 23, 2020
Merged

docs: add --run-cache for fetch/pull/push #1481

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 6 additions & 1 deletion content/docs/command-reference/fetch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ Get tracked files or directories from

```usage
usage: dvc fetch [-h] [-q | -v] [-j <number>]
[-r <name>] [-a] [-T] [-d] [-R] [--all-commits]
[-r <name>] [-a] [-T]
[--all-commits] [-d] [-R]
[--run-cache]
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved
[targets [targets ...]]

positional arguments:
Expand Down Expand Up @@ -77,6 +79,9 @@ or `-T` options are used).
[remote storage](/doc/command-reference/remote) to fetch from (see
`dvc remote list`).

- `--run-cache` - downloads all available history of stage runs from the remote
repository.
Comment on lines +82 to +83
Copy link
Contributor

Choose a reason for hiding this comment

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

Is there a way to know how big this is? Or to list all the checkpoints that have been saved between each commit or with timestamps, or something like that? Thanks

Copy link
Contributor Author

@efiop efiop Jun 23, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

Nope, it is pretty primitive for now.


- `-d`, `--with-deps` - determines files to download by tracking dependencies to
the `targets`. If none are provided, this option is ignored. By traversing all
stage dependencies, DVC searches backward from the target stages in the
Expand Down
3 changes: 3 additions & 0 deletions content/docs/command-reference/pull.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,9 @@ reflinks or hardlinks to put it in the workspace without copying. See
[remote storage](/doc/command-reference/remote) to pull from (see
`dvc remote list`).

- `--run-cache` - downloads all available history of stage runs from the remote
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved
repository.

- `-j <number>`, `--jobs <number>` - number of threads to run simultaneously to
handle the downloading of files from the remote. The default value is
`4 * cpu_count()`. For SSH remotes, the default is just `4`. Using more jobs
Expand Down
7 changes: 5 additions & 2 deletions content/docs/command-reference/push.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Upload tracked files or directories to
## Synopsis

```usage
usage: dvc push [-h] [-q | -v] [-j <number>]
[-r <name>] [-a] [-T] [-d] [-R] [--all-commits]
usage: dvc push [-h] [-q | -v] [-j <number>] [-r <name>] [-a] [-T]
[--all-commits] [-d] [-R] [--run-cache]
[targets [targets ...]]

positional arguments:
Expand Down Expand Up @@ -102,6 +102,9 @@ the target [stage files](/doc/command-reference/run), through the corresponding
[remote storage](/doc/command-reference/remote) to push from (see
`dvc remote list`).

- `--run-cache` - uploads all available history of stage runs to the remote
repository.

- `-j <number>`, `--jobs <number>` - number of threads to run simultaneously to
handle the uploading of files from the remote. The default value is
`4 * cpu_count()`. For SSH remotes, the default is just `4`. Using more jobs
Expand Down