Skip to content

Commit

Permalink
clarify run-cachec flags behavior (#5310)
Browse files Browse the repository at this point in the history
  • Loading branch information
shcheklein committed Sep 23, 2024
1 parent 9b7704b commit 9ca815b
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 12 deletions.
7 changes: 4 additions & 3 deletions content/docs/command-reference/exp/pull.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,10 @@ used.
- `-r <name>`, `--remote <name>` - name of the `dvc remote` to pull cached files
from.

- `--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.
- `--run-cache`, `--no-run-cache` - whether to download 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. Default
is `--no-run-cache`.

- `-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
4 changes: 2 additions & 2 deletions content/docs/command-reference/exp/push.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,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`, `--no-run-cache` - uploads all available history of [stage
runs] to the `dvc remote`.
- `--run-cache`, `--no-run-cache` - whether to upload all available history of
[stage runs] to the `dvc remote`. Default is `--no-run-cache`.

- `-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
5 changes: 3 additions & 2 deletions content/docs/command-reference/fetch.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,9 @@ 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`, `--no-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` - whether to download all available history of
[stage runs] from the remote repository. See the same option in `dvc push`. Default
is ``--no-run-cache`.

- `-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
6 changes: 3 additions & 3 deletions content/docs/command-reference/pull.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,10 +115,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`, `--no-run-cache` - downloads all available history of [stage
runs] from the `dvc remote` (to the cache only, like `dvc fetch --run-cache`).
- `--run-cache`, `--no-run-cache` - whether to download 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`.
workspace) and update `dvc.lock`. Default is `--no-run-cache`.

- `--allow-missing` - allows the command to succeed even if some files or
directories are missing.
Expand Down
4 changes: 2 additions & 2 deletions content/docs/command-reference/push.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,9 +90,9 @@ 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`, `--no-run-cache` - uploads all available history of
- `--run-cache`, `--no-run-cache` - whether to upload all available history of
[stage runs](/doc/user-guide/project-structure/internal-files#run-cache) to
the `dvc remote`.
the `dvc remote`. Default is `--no-run-cache`.

- `-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

0 comments on commit 9ca815b

Please sign in to comment.