Skip to content

Commit

Permalink
update run-cache docs (#5249)
Browse files Browse the repository at this point in the history
  • Loading branch information
dberenbaum authored May 24, 2024
1 parent 16932dd commit eda0349
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 17 deletions.
9 changes: 5 additions & 4 deletions content/docs/command-reference/exp/pull.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ data from [remote storage].

```usage
usage: dvc exp pull [-h] [-q | -v] [-A] [--rev <commit>] [-n <num>] [-f]
[--no-cache] [-r <name>] [-j <number>] [--run-cache]
[--no-cache] [-r <name>] [-j <number>]
[--run-cache | --no-run-cache]
git_remote [experiment ...]
positional arguments:
Expand Down Expand Up @@ -62,9 +63,9 @@ used.
- `-r <name>`, `--remote <name>` - name of the `dvc remote` to pull cached files
from.

- `--run-cache` - downloads all available history of [stage runs] from the
`dvc remote` (to the cache only, like `dvc fetch --run-cache`). Note that
`dvc exp run <stage_name>` is necessary to checkout these files.
- `--run-cache`, `--no-run-cache` - downloads all available history of [stage
runs] from the `dvc remote` (to the cache only, like `dvc fetch --run-cache`).
Note that `dvc exp run <stage_name>` is necessary to checkout these files.

- `-j <number>`, `--jobs <number>` - parallelism level for DVC to upload data to
remote storage. The default value is `4 * cpu_count()`. Note that the default
Expand Down
7 changes: 4 additions & 3 deletions content/docs/command-reference/exp/push.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ to [remote storage].

```usage
usage: dvc exp push [-h] [-q | -v] [-A] [--rev <commit>] [-n <num>] [-f]
[--no-cache] [-r <name>] [-j <number>] [--run-cache]
[--no-cache] [-r <name>] [-j <number>]
[--run-cache | --no-run-cache]
git_remote [experiment ...]
positional arguments:
Expand Down Expand Up @@ -66,8 +67,8 @@ Studio project URL to view experiments.
- `-r <name>`, `--remote <name>` - name of the `dvc remote` to push cached files
to.

- `--run-cache` - uploads all available history of [stage runs] to the
`dvc remote`.
- `--run-cache`, `--no-run-cache` - uploads all available history of [stage
runs] to the `dvc remote`.

- `-j <number>`, `--jobs <number>` - parallelism level for DVC to upload data to
remote storage. The default value is `4 * cpu_count()`. Note that the default
Expand Down
6 changes: 3 additions & 3 deletions content/docs/command-reference/fetch.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Download files or directories from [remote storage] to the <abbr>cache</abbr>.

```usage
usage: dvc fetch [-h] [-q | -v] [-j <number>] [-r <name>] [-a] [-T]
[--all-commits] [-d] [-R] [--run-cache]
[--all-commits] [-d] [-R] [--run-cache | --no-run-cache]
[--max-size <bytes>] [--type {metrics,plots}]
[targets [targets ...]]
Expand Down Expand Up @@ -86,8 +86,8 @@ The `dvc remote` used is determined in order, based on
directory and its subdirectories for `dvc.yaml` and `.dvc` files to inspect.
If there are no directories among the `targets`, this option has no effect.

- `--run-cache` - downloads all available history of [stage runs] from the
remote repository. See the same option in `dvc push`.
- `--run-cache`, `--no-run-cache` - downloads all available history of [stage
runs] from the remote repository. See the same option in `dvc push`.

- `-j <number>`, `--jobs <number>` - parallelism level for DVC to download data
from remote storage. The default value is `4 * cpu_count()`. Note that the
Expand Down
11 changes: 6 additions & 5 deletions content/docs/command-reference/pull.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ Download tracked files or directories from [remote storage] based on the current

```usage
usage: dvc pull [-h] [-q | -v] [-j <number>] [-r <name>] [-a] [-T]
[-d] [-f] [-R] [--all-commits] [--run-cache] [--allow-missing]
[-d] [-f] [-R] [--all-commits]
[--run-cache | --no-run-cache] [--allow-missing]
[targets [targets ...]]
positional arguments:
Expand Down Expand Up @@ -115,10 +116,10 @@ used to see what files `dvc pull` would download.
- `-r <name>`, `--remote <name>` - name of the `dvc remote` to pull from (see
`dvc remote list`).

- `--run-cache` - downloads all available history of [stage runs] from the
`dvc remote` (to the cache only, like `dvc fetch --run-cache`). Note that
`dvc repro <stage_name>` is necessary to checkout these files (into the
workspace) and update `dvc.lock`.
- `--run-cache`, `--no-run-cache` - downloads all available history of [stage
runs] from the `dvc remote` (to the cache only, like `dvc fetch --run-cache`).
Note that `dvc repro <stage_name>` is necessary to checkout these files (into
the workspace) and update `dvc.lock`.

- `--allow-missing` - allows the command to succeed even if some files or
directories are missing.
Expand Down
5 changes: 3 additions & 2 deletions content/docs/command-reference/push.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ Upload tracked files or directories to [remote storage] based on the current

```usage
usage: dvc push [-h] [-q | -v] [-j <number>] [-r <name>] [-a] [-T]
[--all-commits] [--glob] [-d] [-R] [--run-cache]
[--all-commits] [--glob] [-d] [-R]
[--run-cache | --no-run-cache]
[targets [targets ...]]
positional arguments:
Expand Down Expand Up @@ -89,7 +90,7 @@ in the cache (compared to the default remote.) It can be used to see what files
- `-r <name>`, `--remote <name>` - name of the `dvc remote` to push to (see
`dvc remote list`).

- `--run-cache` - uploads all available history of
- `--run-cache`, `--no-run-cache` - uploads all available history of
[stage runs](/doc/user-guide/project-structure/internal-files#run-cache) to
the `dvc remote`.

Expand Down

0 comments on commit eda0349

Please sign in to comment.