From 7f937234933f801fc9efee036c1ee956e7d40b2c Mon Sep 17 00:00:00 2001 From: Ruslan Kuprieiev <ruslan@iterative.ai> Date: Tue, 23 Jun 2020 04:05:13 +0300 Subject: [PATCH] docs: add --run-cache for fetch/pull/push Related to https://github.com/iterative/dvc.org/issues/1289 --- content/docs/command-reference/fetch.md | 7 ++++++- content/docs/command-reference/pull.md | 3 +++ content/docs/command-reference/push.md | 7 +++++-- 3 files changed, 14 insertions(+), 3 deletions(-) diff --git a/content/docs/command-reference/fetch.md b/content/docs/command-reference/fetch.md index a6315a3d66..ff51fdc807 100644 --- a/content/docs/command-reference/fetch.md +++ b/content/docs/command-reference/fetch.md @@ -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] [targets [targets ...]] positional arguments: @@ -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. + - `-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 diff --git a/content/docs/command-reference/pull.md b/content/docs/command-reference/pull.md index 159f393106..f43a24d976 100644 --- a/content/docs/command-reference/pull.md +++ b/content/docs/command-reference/pull.md @@ -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 + 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 diff --git a/content/docs/command-reference/push.md b/content/docs/command-reference/push.md index 788f53b4af..4159ef49be 100644 --- a/content/docs/command-reference/push.md +++ b/content/docs/command-reference/push.md @@ -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: @@ -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