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

4504: Existence of the configuration option explained #1941

Merged
merged 13 commits into from
Nov 16, 2020
4 changes: 3 additions & 1 deletion content/docs/command-reference/fetch.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,9 @@ The default remote is used (see

- `-j <number>`, `--jobs <number>` - parallelism level for DVC to download data
from remote storage. The default value is `4 * cpu_count()`. For SSH remotes,
the default is `4`. Using more jobs may improve the overall transfer speed.
the default is `4`. Note that the default value can be set using the `jobs`
config option with `dvc remote modify`. Using more jobs may improve the
overall transfer speed.

- `-a`, `--all-branches` - fetch cache for all Git branches instead of just the
current workspace. This means DVC may download files needed to reproduce
Expand Down
4 changes: 3 additions & 1 deletion content/docs/command-reference/gc.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,9 @@ The default remote is cleaned (see `dvc config core.remote`) unless the
- `-j <number>`, `--jobs <number>` - parallelism level for DVC to access data
from remote storage. This only applies when the `--cloud` option is used, or a
`--remote` is given. The default value is `4 * cpu_count()`. For SSH remotes,
the default is `4`. Using more jobs may improve the overall transfer speed.
the default is `4`. Note that the default value can be set using the `jobs`
config option with `dvc remote modify`. Using more jobs may improve the
overall connection speed.

> For now only some phases of garbage collection are parallel.

Expand Down
4 changes: 3 additions & 1 deletion content/docs/command-reference/pull.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,9 @@ used to see what files `dvc pull` would download.

- `-j <number>`, `--jobs <number>` - parallelism level for DVC to download data
from remote storage. The default value is `4 * cpu_count()`. For SSH remotes,
the default is `4`. Using more jobs may improve the overall transfer speed.
the default is `4`. Note that the default value can be set using the `jobs`
config option with `dvc remote modify`. Using more jobs may improve the
overall transfer speed.

- `-h`, `--help` - prints the usage/help message, and exit.

Expand Down
4 changes: 3 additions & 1 deletion content/docs/command-reference/push.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,9 @@ in the cache (compared to the default remote.) It can be used to see what files

- `-j <number>`, `--jobs <number>` - parallelism level for DVC to upload data to
remote storage. The default value is `4 * cpu_count()`. For SSH remotes, the
default is `4`. Using more jobs may improve the overall transfer speed.
default is `4`. Note that the default value can be set using the `jobs` config
option with `dvc remote modify`. Using more jobs may improve the overall
transfer speed.

- `-h`, `--help` - prints the usage/help message, and exit.

Expand Down
9 changes: 9 additions & 0 deletions content/docs/command-reference/remote/modify.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,15 @@ The following config options are available for all remote types:
$ dvc remote modify localremote url /home/user/dvcstore
```

- `jobs` - change the default number of processes for
[remote storage](/doc/command-reference/remote) synchronization operations
(see the `--jobs` option of `dvc push`, `dvc pull`, `dvc fetch`, `dvc status`,
and `dvc gc`). Accepts positive integers. The default is typically `4`.

```dvc
$ dvc remote modify myremote jobs 8
```

- `verify` - upon downloading <abbr>cache</abbr> files (`dvc pull`, `dvc fetch`)
DVC will recalculate the file hashes upon download (e.g. `dvc pull`) to make
sure that these haven't been modified, or corrupted during download. It may
Expand Down
5 changes: 3 additions & 2 deletions content/docs/command-reference/status.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,8 +142,9 @@ that.
- `-j <number>`, `--jobs <number>` - parallelism level for DVC to retrieve
information from remote storage. This only applies when the `--cloud` option
is used, or a `--remote` is given. The default value is `4 * cpu_count()`. For
SSH remotes, the default is `4`. Using more jobs may improve the overall
transfer speed.
SSH remotes, the default is `4`. Note that the default value can be set using
the `jobs` config option with `dvc remote modify`. Using more jobs may improve
the overall connection speed.

- `-h`, `--help` - prints the usage/help message, and exit.

Expand Down