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

fix(deps): update all non-major dependencies #272

Merged
merged 2 commits into from
Sep 9, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
run fix
yathomasi committed Sep 9, 2024
commit 82c85f620130ffc0b3fed92f53f5e665c8bde1b4
13 changes: 6 additions & 7 deletions packages/example/content/docs/command-reference/add.md
Original file line number Diff line number Diff line change
@@ -350,11 +350,10 @@ When you want to add a large dataset that is outside of your
it into the <abbr>workspace</abbr> first. But you may not have enough local
storage space.

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

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

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

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

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

4 changes: 2 additions & 2 deletions packages/example/content/docs/command-reference/commit.md
Original file line number Diff line number Diff line change
@@ -50,8 +50,8 @@ Some scenarios for `dvc commit` include:
versions without having to execute stage commands.

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

- It's also possible to execute stage commands by hand (without `dvc repro`), or
Original file line number Diff line number Diff line change
@@ -17,7 +17,8 @@ positional arguments:

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

The new `branch` will be based on the experiment's parent commit (`HEAD` at the
time that the experiment was run). Note that DVC **does not** switch into the
8 changes: 4 additions & 4 deletions packages/example/content/docs/command-reference/exp/init.md
Original file line number Diff line number Diff line change
@@ -37,8 +37,8 @@ Repository structure assumed by default:
```

> Note that `dvc exp init` expects at least a `params.yaml` file present. DVC
> reads it to find parameters to include in the [stage definition]. It can
> however be omitted when using the `--explicit` and/or `-i` flags.
> reads it to find parameters to include in the [stage definition]. It can however
> be omitted when using the `--explicit` and/or `-i` flags.

You must always provide a command that runs your experiment(s). It can be given
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.
Different types of stages are supported, such as `dl` (deep learning) which uses
[DVCLive](/doc/dvclive) to monitor [checkpoints] during training of ML models.

> `dvc exp init` is intended as a quick way to start running [DVC Experiments].
> See the `dvc.yaml` specification for complex data pipelines.
> `dvc exp init` is intended as a quick way to start running [DVC Experiments]. See
> the `dvc.yaml` specification for complex data pipelines.

[stage definition]:
/doc/user-guide/project-structure/pipelines-files#stage-entries
18 changes: 8 additions & 10 deletions packages/example/content/docs/command-reference/exp/run.md
Original file line number Diff line number Diff line change
@@ -33,25 +33,23 @@ directories, etc.
Use the `--set-param` (`-S`) option as a shortcut to change
<abbr>parameter</abbr> values [on-the-fly] before running the experiment.

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

> ⚠️ Parallel runs are experimental and may be unstable. Make sure you're using
> a number of jobs that your environment can handle (no more than the CPU
> cores).

It's also possible to run special [checkpoint experiments] that log the
execution progress (useful for deep learning ML). The `--rev` and `--reset`
options have special uses for these.
It's also possible to run special [checkpoint experiments] that log the execution
progress (useful for deep learning ML). The `--rev` and `--reset` options have special
uses for these.

> 📖 See the [Running Experiments] guide for more details on all these features.

[Review] your experiments with `dvc exp show`. Successful ones can be [made
persistent] by restoring them via `dvc exp branch` or `dvc exp apply` and
committing them to the Git repo. Unnecessary ones can be [cleared] with
`dvc exp gc`.
persistent] by restoring them via `dvc exp branch` or `dvc exp apply` and committing
them to the Git repo. Unnecessary ones can be [cleared] with `dvc exp gc`.

[on-the-fly]: #example-modify-parameters-on-the-fly
[queue experiments]:
23 changes: 11 additions & 12 deletions packages/example/content/docs/command-reference/gc.md
Original file line number Diff line number Diff line change
@@ -25,10 +25,10 @@ details.
The data kept is determined by reading the <abbr>DVC files</abbr> in the set of
commits of the given scope.

> Note that `dvc gc` tries to fetch missing [`.dir` files] from remote storage
> to local cache in order to determine which files should exist inside cached
> directories. These files may be missing if the cache was previously garbage
> collected, in a newly cloned copy of the repo, etc.
> Note that `dvc gc` tries to fetch missing [`.dir` files] from remote storage to
> local cache in order to determine which files should exist inside cached directories.
> These files may be missing if the cache was previously garbage collected, in a
> newly cloned copy of the repo, etc.

Unless the `--cloud` option is used, any files collected from the cache can be
restored using `dvc fetch`, as long as they have been previously uploaded with
@@ -96,15 +96,14 @@ project we want to clear.

> \* Not including [DVC experiments]

- `--all-experiments` keep cached objects referenced in all [DVC experiments],
as well as in the workspace (implying `-w`). This preserves the project's
[experimental](/doc/user-guide/experiment-management) data (including
checkpoints). See also `dvc exp gc`.
- `--all-experiments` keep cached objects referenced in all [DVC experiments], as
well as in the workspace (implying `-w`). This preserves the project's [experimental](/doc/user-guide/experiment-management)
data (including checkpoints). See also `dvc exp gc`.

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

- `-c`, `--cloud` - remove files in remote storage in addition to local cache.
**This option is dangerous.** The default remote is used unless a specific one
Original file line number Diff line number Diff line change
@@ -368,8 +368,8 @@ dataset, but you still want to track it in the <abbr>project</abbr> so it can be
[pulled](/doc/command-reference/plots) later.

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

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

7 changes: 3 additions & 4 deletions packages/example/content/docs/command-reference/pull.md
Original file line number Diff line number Diff line change
@@ -20,10 +20,9 @@ positional arguments:

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

`dvc pull` downloads tracked data from
[remote storage](/doc/command-reference/remote) to the <abbr>cache</abbr>, and
7 changes: 3 additions & 4 deletions packages/example/content/docs/command-reference/push.md
Original file line number Diff line number Diff line change
@@ -20,10 +20,9 @@ positional arguments:

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

`dvc push` uploads data from the <abbr>cache</abbr> to
[remote storage](/doc/command-reference/remote).
Original file line number Diff line number Diff line change
@@ -890,8 +890,8 @@ by HDFS. Read more about by expanding the WebHDFS section in
$ dvc remote modify myremote kerberos true
```

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

```dvc
$ dvc remote modify myremote kerberos_principal myprincipal
8 changes: 4 additions & 4 deletions packages/example/content/docs/command-reference/status.md
Original file line number Diff line number Diff line change
@@ -23,8 +23,8 @@ Searches for changes in the existing tracked data and pipelines. In local mode,
it shows which files or directories have changed in the <abbr>workspace</abbr>
(thus could be [added](/doc/command-reference/add) or
[reproduced](/doc/command-reference/repro) again). In remote mode, it reports
the differences between <abbr>cache</abbr> vs. [remote storage] (`dvc push` or
`dvc pull` could be used to synchronize these).
the differences between <abbr>cache</abbr> vs. [remote storage] (`dvc push` or `dvc pull`
could be used to synchronize these).

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

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

- `--json` - prints the command's output in easily parsable JSON format, instead
of a human-readable table.
5 changes: 3 additions & 2 deletions packages/example/content/docs/contributing/docs.md
Original file line number Diff line number Diff line change
@@ -60,8 +60,9 @@ Make sure you have [Python](https://www.python.org/downloads/) 3.7+, a recent
LTS version of [Node.js](https://nodejs.org/en/) (`>=14.0.0`, `<=16.x`), and
install [Yarn](https://yarnpkg.com/):

> In Windows, you may need to install [Visual Studio Build Tools], and the
> [Windows SDK] first.
> In Windows, you may need to install [Visual Studio Build Tools], and the [Windows
>
> > SDK] first.

[windows sdk]:
https://developer.microsoft.com/en-us/windows/downloads/windows-10-sdk/
Original file line number Diff line number Diff line change
@@ -145,6 +145,5 @@ Model Registries work.
for each version. -1 for all [default: -1]
- `--vs <integer>`, `--versions-per-stage <integer>` - Show N last versions for
each stage. -1 for all. Applied after 'assignments-per-version' [default: 1]
- `--sort <text>` - Order assignments by timestamp or semver [default:
timestamp]
- `--sort <text>` - Order assignments by timestamp or semver [default: timestamp]
- `-h`, `--help` - Show this message and exit.
4 changes: 2 additions & 2 deletions packages/example/content/docs/gto/install.md
Original file line number Diff line number Diff line change
@@ -16,8 +16,8 @@ manager like [pip](https://pypi.org/project/pip/) or

<admon type="info">

We **strongly** recommend creating a [virtual environment] or using [pipx] to
encapsulate your local environment.
We **strongly** recommend creating a [virtual environment] or using [pipx] to encapsulate
your local environment.

[virtual environment]: https://python.readthedocs.io/en/stable/library/venv.html
[pipx]:
11 changes: 5 additions & 6 deletions packages/example/content/docs/gto/use-cases/model-registry.md
Original file line number Diff line number Diff line change
@@ -25,12 +25,11 @@ ML model registries give your team key capabilities:
[mp]: https://dvc.org/doc/start/metrics-parameters-plots
[experiments]: https://dvc.org/doc/user-guide/experiment-management

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

<admon type="info">

3 changes: 1 addition & 2 deletions packages/example/content/docs/ref/ci.md
Original file line number Diff line number Diff line change
@@ -14,8 +14,7 @@ Any [generic option](/doc/ref) in addition to:

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

## Examples
3 changes: 1 addition & 2 deletions packages/example/content/docs/ref/pr.md
Original file line number Diff line number Diff line change
@@ -22,8 +22,7 @@ Any [generic option](/doc/ref) in addition to:
- `--md`: Produce output in markdown format (`[CML Pull/Merge Request](url)`
instead of `url`).
- `--remote=<name or URL>`: Git remote name or URL [default: `origin`].
- `--user-email=<address>`: Git user email for commits [default:
`[email protected]`].
- `--user-email=<address>`: Git user email for commits [default: `[email protected]`].
- `--user-name=<...>`: Git user name for commits [default: `Olivaw[bot]`].

## Examples
4 changes: 2 additions & 2 deletions packages/example/content/docs/ref/runner.md
Original file line number Diff line number Diff line change
@@ -47,8 +47,8 @@ Any [generic option](/doc/ref) in addition to:
- `--cloud-startup-script=<...>`: Run the provided
[Base64](https://linux.die.net/man/1/base64)-encoded Linux shell script during
the instance initialization.
- `--cloud-ssh-private=<key>`: Private SSH RSA key [default: *auto-generate
throwaway key*]. Only supported on AWS and Azure; intended for debugging
- `--cloud-ssh-private=<key>`: Private SSH RSA key [default:
*auto-generate throwaway key*]. Only supported on AWS and Azure; intended for debugging
purposes.
- `--cloud-aws-security-group=<...>`:
[AWS security group](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html)
3 changes: 1 addition & 2 deletions packages/example/content/docs/ref/tensorboard-dev.md
Original file line number Diff line number Diff line change
@@ -18,8 +18,7 @@ Any [generic option](/doc/ref) in addition to:
- `--description=<...>`: TensorBoard experiment description (markdown format, up
to 600 characters).
- `--md`: Produce output in markdown format (`[title](url)`).
- `-t=<...>`, `--title=<...>`: Title for markdown output [default: *value of
`--name`*].
- `-t=<...>`, `--title=<...>`: Title for markdown output [default: *value of `--name`*].
- `--rm-watermark`: Don't inject a watermark into the comment. Will break some
CML functionality which needs to distinguish CML reports from other comments.

6 changes: 3 additions & 3 deletions packages/example/content/docs/start/experiments/index.md
Original file line number Diff line number Diff line change
@@ -24,9 +24,9 @@ the [`example-dvc-experiments`][ede] project.
## ⚙️ Initializing a project with DVC experiments

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

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

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

## Creating plots from tabular data

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

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

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

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

Original file line number Diff line number Diff line change
@@ -15,9 +15,10 @@ Git repositories in two ways:
track their version info in Git.

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

Refer to the [DVC documentation](https://dvc.org/doc) to initialize a DVC
repository.
15 changes: 7 additions & 8 deletions packages/example/content/docs/use-cases/experiment-tracking.md
Original file line number Diff line number Diff line change
@@ -11,10 +11,9 @@ resume a line of work.
(usually with notebooks or speadsheets)_

DVC provides a layer of [experiment management] features out-of-the-box (no need
for special servers or websites). Running **DVC Experiments** in your workspace
captures relevant changesets automatically (input data, source code,
hyperparameters, artifacts, etc.). This is possible because your entire ML
pipeline is [codified with DVC].
for special servers or websites). Running **DVC Experiments** in your workspace captures
relevant changesets automatically (input data, source code, hyperparameters, artifacts,
etc.). This is possible because your entire ML pipeline is [codified with DVC].

Other tools tend to focus on experiment navigation by saving metrics and
artifacts that result from your pipelines, along with fragile links to code
@@ -98,10 +97,10 @@ whether you're using Jupyter notebooks or Scala, CSV data frames or HDFS.

---

To complete your stack, we also offer [Iterative Studio], an advanced web
interface to collaborate on DVC projects online, including full experiment
management support. You can also integrate with CI/CD using [CML], and run your
experiments there straight from Studio!
To complete your stack, we also offer [Iterative Studio], an advanced web interface
to collaborate on DVC projects online, including full experiment management support.
You can also integrate with CI/CD using [CML], and run your experiments there straight
from Studio!

[shared]: /doc/user-guide/experiment-management/sharing-experiments
[iterative studio]: /doc/studio
Original file line number Diff line number Diff line change
@@ -27,13 +27,13 @@ to

![](/img/storage-layers.png) _Data storage middleware for multiple projects_

You can have a single storage for all you projects by setting up a [shared DVC
cache] in a near location (network, external drive, etc.). This de-duplicates
files across datasets and prevents repetitive transfers by
You can have a single storage for all you projects by setting up a [shared
DVC cache] in a near location (network, external drive, etc.). This
de-duplicates files across datasets and prevents repetitive transfers by
[linking](/doc/user-guide/large-dataset-optimization) your working files and
directories. Data security policies can be implemented reliably, as data never
leaves the central storage. DVC can also help you back up and [share data and ML
models] on external/remote locations.
leaves the central storage. DVC can also help you back up and [share data and
ML models] on external/remote locations.

Now that your team shares a primary storage, it can be managed independently as
part of your infrastructure; provisioned depending on data access speed and cost
@@ -45,8 +45,8 @@ without having to change the directory structures or code of your projects.

### What's next?

For details about how DVC caches your files and directories, see [Structure of
the cache directory]. If you're completely new to DVC, see our
For details about how DVC caches your files and directories, see [Structure
of the cache directory]. If you're completely new to DVC, see our
[Get Started](/doc/start) pages to get familiar with the main features that
structured storage and
[data versioning](/doc/use-cases/versioning-data-and-model-files) allow. And
Original file line number Diff line number Diff line change
@@ -24,8 +24,8 @@ them using the `--rev` and `--reset` options of `dvc exp run` (see also the
### ⚙️ How are checkpoints captured?

Instead of a single reference like [regular experiments], checkpoint experiments
have multiple commits under the custom Git reference (in `.git/refs/exps`),
similar to a branch.
have multiple commits under the custom Git reference (in `.git/refs/exps`), similar
to a branch.

[regular experiments]:
/doc/user-guide/experiment-management/experiments-overview
Original file line number Diff line number Diff line change
@@ -58,12 +58,12 @@ Experiments workflow.
It will create a simple `dvc.yaml` metafile, which codifies your planned
experiments. This includes the locations for expected <abbr>dependencies</abbr>
(data, parameters, source code) and <abbr>outputs</abbr> (ML models,
<abbr>metrics</abbr>, etc.). These assume [sane defaults] but can be customized
with the options of `dvc exp init`.
<abbr>metrics</abbr>, etc.). These assume [sane defaults] but can be customized with
the options of `dvc exp init`.

💡 We recommend adding the `-i` flag to use its [interactive mode]. This will
ask you how to run the experiments, and guide you through customizing the
aforementioned locations (optional).
💡 We recommend adding the `-i` flag to use its [interactive mode]. This will ask
you how to run the experiments, and guide you through customizing the aforementioned
locations (optional).

You can review the resulting changes to your repo (and commit them to Git) to
begin using DVC Experiments. Now you can move on to [running experiments][run]
Original file line number Diff line number Diff line change
@@ -59,8 +59,8 @@ main alternatives:
- **Hybrid** - combining an intuitive directory structure with a good repo
branching strategy tends to be the best option for complex projects.
Completely independent experiments live in separate directories (and can be
generated with [`foreach` stages], for example), while their progress can be
found in different branches.
generated with [`foreach` stages], for example), while their progress can be found
in different branches.

- **Labels** - in general, you can record experiments in a separate system and
structure them using custom labeling. This is typical in dedicated experiment
Original file line number Diff line number Diff line change
@@ -33,10 +33,10 @@ Reproduced experiment(s): exp-44136
> preparing the experiment, which can take some time. `dvc exp gc` can clean up
> unnecessary ones.
DVC observes the [dependency graph] between stages, so it only runs the ones
with changed dependencies or outputs missing from the <abbr>cache</abbr>. You
can limit this to certain [reproduction targets] or even single stages
(`--single-item` flag).
DVC observes the [dependency graph] between stages, so it only runs the ones with
changed dependencies or outputs missing from the <abbr>cache</abbr>. You can limit
this to certain [reproduction targets] or even single stages (`--single-item`
flag).

<abbr>DVC projects</abbr> actually support more than one pipeline, in one or
more `dvc.yaml` files. The `--all-pipelines` option lets you run them all at
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
# Sharing Experiments

In a regular Git workflow, <abbr>DVC repository</abbr> versions are typically
synchronized among team members. And [DVC Experiments] are internally connected
to this commit history. But to avoid cluttering everyone's copies of the repo,
by default experiments will only exist in the local environment where they were
[created].
synchronized among team members. And [DVC Experiments] are internally connected to
this commit history. But to avoid cluttering everyone's copies of the repo, by default
experiments will only exist in the local environment where they were [created].

You must explicitly save or share experiments individually on other locations.
This is done similarly to [sharing regular project versions], by synchronizing
with DVC and Git remotes. But DVC takes care of pushing and pulling to/from Git
remotes in the case of experiments.
This is done similarly to [sharing regular project versions], by synchronizing with
DVC and Git remotes. But DVC takes care of pushing and pulling to/from Git remotes
in the case of experiments.

```
┌────────────────┐ ┌────────────────┐
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# How to Share Many Experiments

`dvc exp push` and `dvc exp pull` allow us to [share experiments] between
repositories via existing DVC and Git remotes. These however work on individual
experiments.
`dvc exp push` and `dvc exp pull` allow us to [share experiments] between repositories
via existing DVC and Git remotes. These however work on individual experiments.

Here's a simple shell loop to push or pull all experiments (Linux):

Original file line number Diff line number Diff line change
@@ -46,8 +46,8 @@ their remote URLs or external paths to `dvc add`, or put them in `dvc.yaml`

DVC requires that the project's <abbr>cache</abbr> is configured in the same
external location as the data that will be tracked (external outputs). This
avoids transferring files to the local environment and enables [file links]
within the external storage.
avoids transferring files to the local environment and enables [file links] within
the external storage.

[file links]:
/doc/user-guide/large-dataset-optimization#file-link-types-for-the-dvc-cache
@@ -185,8 +185,7 @@ custom cache location for local paths outside of your project.

> Except for external data on different storage devices or partitions mounted on
> the same file system (e.g. `/mnt/raid/data`). In that case please setup an
> external cache in that same drive to enable [file links] and avoid copying
> data.
> external cache in that same drive to enable [file links] and avoid copying data.
```dvc
$ dvc add --external /home/shared/existing-data
9 changes: 4 additions & 5 deletions packages/example/content/docs/user-guide/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -100,9 +100,8 @@ Git remote, for _write_ (`dvc exp push`) or _read_ (`dvc exp list`,
`dvc exp pull`) permissions.

DVC does not currently support authentication with [Git credentials]. This means
that unless the Git server allows unauthenticated HTTP write/read, you should
use an [SSH Git URL] for Git remotes used for listing, pulling or pushing
experiments.
that unless the Git server allows unauthenticated HTTP write/read, you should use
an [SSH Git URL] for Git remotes used for listing, pulling or pushing experiments.

[git credentials]: https://git-scm.com/docs/gitcredentials
[ssh git url]:
@@ -113,8 +112,8 @@ experiments.
You may encounter this error when using DVC on different Python versions with
the same <abbr>DVC project</abbr> directory, for example having created the
project on Python 3.8. in one environment and later attempting to update it from
a Python 3.7 env. This is due to temporary [internal directories] that can be
incompatible with older Python versions once created.
a Python 3.7 env. This is due to temporary [internal directories] that can be incompatible
with older Python versions once created.

In these rare situations, it is safe to remove the corresponding tmp directory
and retry the DVC command. Specifically, one of: