Skip to content

Commit 5ce488c

Browse files
yathomasirenovate[bot]
authored andcommitted
run fix
1 parent f681317 commit 5ce488c

32 files changed

+116
-129
lines changed

packages/example/content/docs/command-reference/add.md

+6-7
Original file line numberDiff line numberDiff line change
@@ -350,11 +350,10 @@ When you want to add a large dataset that is outside of your
350350
it into the <abbr>workspace</abbr> first. But you may not have enough local
351351
storage space.
352352

353-
You can however set up an [external cache] that can handle the data. To avoid
354-
ever making a local copy, target the outside data with `dvc add` while
355-
specifying an `--out` (`-o`) path inside of your project. This way the data will
356-
be transferred to the <abbr>cache</abbr> directly, and then [linked] into your
357-
workspace.
353+
You can however set up an [external cache] that can handle the data. To avoid ever
354+
making a local copy, target the outside data with `dvc add` while specifying an `--out`
355+
(`-o`) path inside of your project. This way the data will be transferred to the
356+
<abbr>cache</abbr> directly, and then [linked] into your workspace.
358357

359358
Let's add a `data.xml` file via HTTP, putting it in `./data.xml`:
360359

@@ -389,8 +388,8 @@ dataset, but you still want to track it in the <abbr>project</abbr> so it can be
389388
[pulled](/doc/command-reference/plots) later.
390389

391390
As long as you have setup [remote storage] that can handle the data, this can be
392-
achieved with the `--to-remote` flag. It creates a `.dvc` file without
393-
downloading anything, transferring a target directly to a DVC remote instead:
391+
achieved with the `--to-remote` flag. It creates a `.dvc` file without downloading
392+
anything, transferring a target directly to a DVC remote instead:
394393

395394
Let's add a `data.xml` file via HTTP straight to remote:
396395

packages/example/content/docs/command-reference/commit.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,8 @@ Some scenarios for `dvc commit` include:
5050
versions without having to execute stage commands.
5151

5252
- Sometimes after executing a <abbr>stage</abbr>, we realize that not all of its
53-
dependencies or outputs are defined in `dvc.yaml`. It is possible to [add the
54-
missing deps/outs] without having to re-execute stages, and `dvc commit` is
53+
dependencies or outputs are defined in `dvc.yaml`. It is possible to [add
54+
the missing deps/outs] without having to re-execute stages, and `dvc commit` is
5555
needed to finalize the operation (see link).
5656

5757
- It's also possible to execute stage commands by hand (without `dvc repro`), or

packages/example/content/docs/command-reference/exp/branch.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@ positional arguments:
1717

1818
Makes a given Git [`branch`] containing the target `experiment`. This makes the
1919
experiment into a [regular commit], or several in the case of [checkpoint
20-
experiments] (one per checkpoint).
20+
experiments]
21+
(one per checkpoint).
2122

2223
The new `branch` will be based on the experiment's parent commit (`HEAD` at the
2324
time that the experiment was run). Note that DVC **does not** switch into the

packages/example/content/docs/command-reference/exp/init.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ Repository structure assumed by default:
3737
```
3838

3939
> Note that `dvc exp init` expects at least a `params.yaml` file present. DVC
40-
> reads it to find parameters to include in the [stage definition]. It can
41-
> however be omitted when using the `--explicit` and/or `-i` flags.
40+
> reads it to find parameters to include in the [stage definition]. It can however
41+
> be omitted when using the `--explicit` and/or `-i` flags.
4242
4343
You must always provide a command that runs your experiment(s). It can be given
4444
either directly [as an argument](#the-command-argument), or by using the
@@ -48,8 +48,8 @@ wrapped as a <abbr>stage</abbr> that `dvc exp run` can execute.
4848
Different types of stages are supported, such as `dl` (deep learning) which uses
4949
[DVCLive](/doc/dvclive) to monitor [checkpoints] during training of ML models.
5050

51-
> `dvc exp init` is intended as a quick way to start running [DVC Experiments].
52-
> See the `dvc.yaml` specification for complex data pipelines.
51+
> `dvc exp init` is intended as a quick way to start running [DVC Experiments]. See
52+
> the `dvc.yaml` specification for complex data pipelines.
5353
5454
[stage definition]:
5555
/doc/user-guide/project-structure/pipelines-files#stage-entries

packages/example/content/docs/command-reference/exp/run.md

+8-10
Original file line numberDiff line numberDiff line change
@@ -33,25 +33,23 @@ directories, etc.
3333
Use the `--set-param` (`-S`) option as a shortcut to change
3434
<abbr>parameter</abbr> values [on-the-fly] before running the experiment.
3535

36-
It's possible to [queue experiments] for later execution with the `--queue`
37-
flag. To actually run them, use `dvc exp run --run-all`. Queued experiments are
38-
run sequentially by default, but can be run in parallel using the `--jobs`
39-
option.
36+
It's possible to [queue experiments] for later execution with the `--queue` flag.
37+
To actually run them, use `dvc exp run --run-all`. Queued experiments are run sequentially
38+
by default, but can be run in parallel using the `--jobs` option.
4039

4140
> ⚠️ Parallel runs are experimental and may be unstable. Make sure you're using
4241
> a number of jobs that your environment can handle (no more than the CPU
4342
> cores).
4443
45-
It's also possible to run special [checkpoint experiments] that log the
46-
execution progress (useful for deep learning ML). The `--rev` and `--reset`
47-
options have special uses for these.
44+
It's also possible to run special [checkpoint experiments] that log the execution
45+
progress (useful for deep learning ML). The `--rev` and `--reset` options have special
46+
uses for these.
4847

4948
> 📖 See the [Running Experiments] guide for more details on all these features.
5049
5150
[Review] your experiments with `dvc exp show`. Successful ones can be [made
52-
persistent] by restoring them via `dvc exp branch` or `dvc exp apply` and
53-
committing them to the Git repo. Unnecessary ones can be [cleared] with
54-
`dvc exp gc`.
51+
persistent] by restoring them via `dvc exp branch` or `dvc exp apply` and committing
52+
them to the Git repo. Unnecessary ones can be [cleared] with `dvc exp gc`.
5553

5654
[on-the-fly]: #example-modify-parameters-on-the-fly
5755
[queue experiments]:

packages/example/content/docs/command-reference/gc.md

+11-12
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@ details.
2525
The data kept is determined by reading the <abbr>DVC files</abbr> in the set of
2626
commits of the given scope.
2727

28-
> Note that `dvc gc` tries to fetch missing [`.dir` files] from remote storage
29-
> to local cache in order to determine which files should exist inside cached
30-
> directories. These files may be missing if the cache was previously garbage
31-
> collected, in a newly cloned copy of the repo, etc.
28+
> Note that `dvc gc` tries to fetch missing [`.dir` files] from remote storage to
29+
> local cache in order to determine which files should exist inside cached directories.
30+
> These files may be missing if the cache was previously garbage collected, in a
31+
> newly cloned copy of the repo, etc.
3232
3333
Unless the `--cloud` option is used, any files collected from the cache can be
3434
restored using `dvc fetch`, as long as they have been previously uploaded with
@@ -96,15 +96,14 @@ project we want to clear.
9696

9797
> \* Not including [DVC experiments]
9898
99-
- `--all-experiments` keep cached objects referenced in all [DVC experiments],
100-
as well as in the workspace (implying `-w`). This preserves the project's
101-
[experimental](/doc/user-guide/experiment-management) data (including
102-
checkpoints). See also `dvc exp gc`.
99+
- `--all-experiments` keep cached objects referenced in all [DVC experiments], as
100+
well as in the workspace (implying `-w`). This preserves the project's [experimental](/doc/user-guide/experiment-management)
101+
data (including checkpoints). See also `dvc exp gc`.
103102

104-
- `-p <paths>`, `--projects <paths>` - if a single remote or a single [cache is
105-
shared] among different projects, this option can be used to specify a list of
106-
them (each project is a path) to keep data that is currently referenced from
107-
them.
103+
- `-p <paths>`, `--projects <paths>` - if a single remote or a single [cache
104+
is shared] among different projects, this option can be used to specify a list
105+
of them (each project is a path) to keep data that is currently referenced
106+
from them.
108107

109108
- `-c`, `--cloud` - remove files in remote storage in addition to local cache.
110109
**This option is dangerous.** The default remote is used unless a specific one

packages/example/content/docs/command-reference/import-url.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -368,8 +368,8 @@ dataset, but you still want to track it in the <abbr>project</abbr> so it can be
368368
[pulled](/doc/command-reference/plots) later.
369369

370370
As long as you have setup [remote storage] that can handle the data, this can be
371-
achieved with the `--to-remote` flag. It creates an import `.dvc` file without
372-
downloading anything, transferring a target directly to a DVC remote instead.
371+
achieved with the `--to-remote` flag. It creates an import `.dvc` file without downloading
372+
anything, transferring a target directly to a DVC remote instead.
373373

374374
Let's import a `data.xml` file via HTTP straight to remote:
375375

packages/example/content/docs/command-reference/pull.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,9 @@ positional arguments:
2020

2121
The `dvc push` and `dvc pull` commands are the means for uploading and
2222
downloading data to and from remote storage (S3, SSH, GCS, etc.). These commands
23-
are similar to `git push` and `git pull`, respectively. [Data sharing] across
24-
environments and preserving data versions (input datasets, intermediate results,
25-
models, [metrics](/doc/command-reference/metrics), etc.) remotely are the most
26-
common use cases for these commands.
23+
are similar to `git push` and `git pull`, respectively. [Data sharing] across environments
24+
and preserving data versions (input datasets, intermediate results, models, [metrics](/doc/command-reference/metrics),
25+
etc.) remotely are the most common use cases for these commands.
2726

2827
`dvc pull` downloads tracked data from
2928
[remote storage](/doc/command-reference/remote) to the <abbr>cache</abbr>, and

packages/example/content/docs/command-reference/push.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,9 @@ positional arguments:
2020

2121
The `dvc push` and `dvc pull` commands are the means for uploading and
2222
downloading data to and from remote storage (S3, SSH, GCS, etc.). These commands
23-
are similar to `git push` and `git pull`, respectively. [Data sharing] across
24-
environments, and preserving data versions (input datasets, intermediate
25-
results, models, [metrics](/doc/command-reference/metrics), etc.) remotely are
26-
the most common use cases for these commands.
23+
are similar to `git push` and `git pull`, respectively. [Data sharing] across environments,
24+
and preserving data versions (input datasets, intermediate results, models, [metrics](/doc/command-reference/metrics),
25+
etc.) remotely are the most common use cases for these commands.
2726

2827
`dvc push` uploads data from the <abbr>cache</abbr> to
2928
[remote storage](/doc/command-reference/remote).

packages/example/content/docs/command-reference/remote/modify.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -890,8 +890,8 @@ by HDFS. Read more about by expanding the WebHDFS section in
890890
$ dvc remote modify myremote kerberos true
891891
```
892892

893-
- `kerberos_principal` - [Kerberos principal] to use, in case you have multiple
894-
ones (for example service accounts). Only used if `kerberos` is `true`.
893+
- `kerberos_principal` - [Kerberos principal] to use, in case you have multiple ones
894+
(for example service accounts). Only used if `kerberos` is `true`.
895895

896896
```dvc
897897
$ dvc remote modify myremote kerberos_principal myprincipal

packages/example/content/docs/command-reference/status.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ Searches for changes in the existing tracked data and pipelines. In local mode,
2323
it shows which files or directories have changed in the <abbr>workspace</abbr>
2424
(thus could be [added](/doc/command-reference/add) or
2525
[reproduced](/doc/command-reference/repro) again). In remote mode, it reports
26-
the differences between <abbr>cache</abbr> vs. [remote storage] (`dvc push` or
27-
`dvc pull` could be used to synchronize these).
26+
the differences between <abbr>cache</abbr> vs. [remote storage] (`dvc push` or `dvc pull`
27+
could be used to synchronize these).
2828

2929
| Mode | Option | Description |
3030
| ------ | ----------------- | --------------------------------------------------------------------------------------------------------------------------- |
@@ -138,8 +138,8 @@ that.
138138
`.dvc` files to inspect. If there are no directories among the targets, this
139139
option has no effect.
140140

141-
- `-r <name>`, `--remote <name>` - name of the [remote storage] to compare
142-
against (see `dvc remote list`). Implies `--cloud`.
141+
- `-r <name>`, `--remote <name>` - name of the [remote storage] to compare against
142+
(see `dvc remote list`). Implies `--cloud`.
143143

144144
- `--json` - prints the command's output in easily parsable JSON format, instead
145145
of a human-readable table.

packages/example/content/docs/contributing/docs.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,9 @@ Make sure you have [Python](https://www.python.org/downloads/) 3.7+, a recent
6060
LTS version of [Node.js](https://nodejs.org/en/) (`>=14.0.0`, `<=16.x`), and
6161
install [Yarn](https://yarnpkg.com/):
6262

63-
> In Windows, you may need to install [Visual Studio Build Tools], and the
64-
> [Windows SDK] first.
63+
> In Windows, you may need to install [Visual Studio Build Tools], and the [Windows
64+
>
65+
> > SDK] first.
6566
6667
[windows sdk]:
6768
https://developer.microsoft.com/en-us/windows/downloads/windows-10-sdk/

packages/example/content/docs/gto/command-reference/show.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,5 @@ Model Registries work.
145145
for each version. -1 for all [default: -1]
146146
- `--vs <integer>`, `--versions-per-stage <integer>` - Show N last versions for
147147
each stage. -1 for all. Applied after 'assignments-per-version' [default: 1]
148-
- `--sort <text>` - Order assignments by timestamp or semver [default:
149-
timestamp]
148+
- `--sort <text>` - Order assignments by timestamp or semver [default: timestamp]
150149
- `-h`, `--help` - Show this message and exit.

packages/example/content/docs/gto/install.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ manager like [pip](https://pypi.org/project/pip/) or
1616

1717
<admon type="info">
1818

19-
We **strongly** recommend creating a [virtual environment] or using [pipx] to
20-
encapsulate your local environment.
19+
We **strongly** recommend creating a [virtual environment] or using [pipx] to encapsulate
20+
your local environment.
2121

2222
[virtual environment]: https://python.readthedocs.io/en/stable/library/venv.html
2323
[pipx]:

packages/example/content/docs/gto/use-cases/model-registry.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,11 @@ ML model registries give your team key capabilities:
2525
[mp]: https://dvc.org/doc/start/metrics-parameters-plots
2626
[experiments]: https://dvc.org/doc/user-guide/experiment-management
2727

28-
Many of these benefits are built into DVC: Your [modeling process] and
29-
[performance data][mp] become **codified** in Git-based <abbr>DVC
30-
repositories</abbr>, making it possible to reproduce and manage models with
31-
standard Git workflows (along with code). Large model files are stored
32-
separately and efficiently, and can be pushed to [remote storage] -- a scalable
33-
access point for [sharing].
28+
Many of these benefits are built into DVC: Your [modeling process] and [performance
29+
data][mp] become **codified** in Git-based <abbr>DVC repositories</abbr>, making
30+
it possible to reproduce and manage models with standard Git workflows (along with
31+
code). Large model files are stored separately and efficiently, and can be pushed
32+
to [remote storage] -- a scalable access point for [sharing].
3433

3534
<admon type="info">
3635

packages/example/content/docs/ref/ci.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,7 @@ Any [generic option](/doc/ref) in addition to:
1414

1515
- `--unshallow`: Fetch as much as possible, converting a shallow repository to a
1616
complete one.
17-
- `--user-email=<address>`: Git user email for commits [default:
18-
17+
- `--user-email=<address>`: Git user email for commits [default: `[email protected]`].
1918
- `--user-name=<...>`: Git user name for commits [default: `Olivaw[bot]`].
2019

2120
## Examples

packages/example/content/docs/ref/pr.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,7 @@ Any [generic option](/doc/ref) in addition to:
2222
- `--md`: Produce output in markdown format (`[CML Pull/Merge Request](url)`
2323
instead of `url`).
2424
- `--remote=<name or URL>`: Git remote name or URL [default: `origin`].
25-
- `--user-email=<address>`: Git user email for commits [default:
26-
25+
- `--user-email=<address>`: Git user email for commits [default: `[email protected]`].
2726
- `--user-name=<...>`: Git user name for commits [default: `Olivaw[bot]`].
2827

2928
## Examples

packages/example/content/docs/ref/runner.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ Any [generic option](/doc/ref) in addition to:
4747
- `--cloud-startup-script=<...>`: Run the provided
4848
[Base64](https://linux.die.net/man/1/base64)-encoded Linux shell script during
4949
the instance initialization.
50-
- `--cloud-ssh-private=<key>`: Private SSH RSA key [default: *auto-generate
51-
throwaway key*]. Only supported on AWS and Azure; intended for debugging
50+
- `--cloud-ssh-private=<key>`: Private SSH RSA key [default:
51+
*auto-generate throwaway key*]. Only supported on AWS and Azure; intended for debugging
5252
purposes.
5353
- `--cloud-aws-security-group=<...>`:
5454
[AWS security group](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html)

packages/example/content/docs/ref/tensorboard-dev.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,7 @@ Any [generic option](/doc/ref) in addition to:
1818
- `--description=<...>`: TensorBoard experiment description (markdown format, up
1919
to 600 characters).
2020
- `--md`: Produce output in markdown format (`[title](url)`).
21-
- `-t=<...>`, `--title=<...>`: Title for markdown output [default: *value of
22-
`--name`*].
21+
- `-t=<...>`, `--title=<...>`: Title for markdown output [default: *value of `--name`*].
2322
- `--rm-watermark`: Don't inject a watermark into the comment. Will break some
2423
CML functionality which needs to distinguish CML reports from other comments.
2524

packages/example/content/docs/start/experiments/index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ the [`example-dvc-experiments`][ede] project.
2424
## ⚙️ Initializing a project with DVC experiments
2525

2626
If you already have a DVC project, that's great. You can start to use `dvc exp`
27-
commands right away to run experiments in your project. (See the [User Guide]
28-
for detailed information.) Here, we briefly discuss how to structure an ML
29-
project with DVC experiments using `dvc exp init`.
27+
commands right away to run experiments in your project. (See the [User Guide] for
28+
detailed information.) Here, we briefly discuss how to structure an ML project with
29+
DVC experiments using `dvc exp init`.
3030

3131
[user guide]: /doc/user-guide/experiment-management/experiments-overview
3232

packages/example/content/docs/start/experiments/visualization.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ try these yourself, please refer to the project. [README] about how to install.
1414

1515
## Creating plots from tabular data
1616

17-
A useful plot to show the classification performance is the [confusion matrix].
18-
In order to produce it, DVC expects a CSV **plots file** in the form:
17+
A useful plot to show the classification performance is the [confusion matrix]. In
18+
order to produce it, DVC expects a CSV **plots file** in the form:
1919

2020
```csv
2121
actual,predicted
@@ -99,8 +99,8 @@ workflow:
9999
- DVC can generate HTML files that includes interactive plots from data series
100100
in JSON, YAML, CSV, or TSV format.
101101

102-
- DVC can keep track of image files produced as [plot outputs] from the
103-
training/evaluation scripts.
102+
- DVC can keep track of image files produced as [plot outputs] from the training/evaluation
103+
scripts.
104104

105105
- [DVCLive] integrations can produce plots automatically during training.
106106

packages/example/content/docs/studio/user-guide/prepare-repositories.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,10 @@ Git repositories in two ways:
1515
track their version info in Git.
1616

1717
DVC also enables you to [store and share your data and model files], [create
18-
data registries], [create data pipelines], connect them with
19-
[CML](https://cml.dev) for [CI/CD in machine learning], and so on. Find more
20-
about the features and benefits of DVC [here](/doc/start).
18+
data
19+
registries], [create data pipelines], connect them with [CML](https://cml.dev)
20+
for [CI/CD in machine learning], and so on. Find more about the features and
21+
benefits of DVC [here](/doc/start).
2122

2223
Refer to the [DVC documentation](https://dvc.org/doc) to initialize a DVC
2324
repository.

0 commit comments

Comments
 (0)