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

user guide: DVC Files and Directories - 1.0 updates #1370

Merged
merged 42 commits into from
Jun 15, 2020
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
44b9b17
get-started: update index for DVC 1.0
jorgeorpinel May 28, 2020
cd800fa
user-guide: DVC File guide update (1)
jorgeorpinel May 28, 2020
92b3bf3
user-guide: change DVC Metafile Formats guide link URL
jorgeorpinel May 28, 2020
1008321
glossary: update DVC-file terminology for tooltips
jorgeorpinel May 28, 2020
bf050eb
user-guide: full draft of new DVC Metafiles Format doc
jorgeorpinel May 28, 2020
85ceb01
term: don't use "meta"
jorgeorpinel Jun 2, 2020
5e79613
Merge branch 'master' into refactor/get-started-1.0
jorgeorpinel Jun 2, 2020
7f9ed2c
user-guide: merge files and dirs + metafiles guides
jorgeorpinel Jun 2, 2020
bf44d1f
install: remove InteliJ plugin info
jorgeorpinel Jun 2, 2020
f928526
term: avoid "metafile"
jorgeorpinel Jun 3, 2020
04cf1e6
get-started: DVC-file -> .dvc file/dvc.yaml (incomplete)
jorgeorpinel Jun 3, 2020
5f6113b
cmd ref: include note about targets not being previously tracked in add
jorgeorpinel Jun 7, 2020
a7ef618
Merge branch 'master' into refactor/get-started-1.0 and
jorgeorpinel Jun 7, 2020
5a605d4
get-started: remove unnecessary unlock (unfreeze) cmd from ex.
jorgeorpinel Jun 7, 2020
3185804
Merge branch 'master' into refactor/get-started-1.0 and
jorgeorpinel Jun 9, 2020
a011e23
user guide: review some links to DVC files & dirs guide
jorgeorpinel Jun 9, 2020
d7ceede
user guide: review links to files&dirs guide
jorgeorpinel Jun 9, 2020
2b08a54
cmd ref: update destroy desc. and link to DVC files/dirs guide
jorgeorpinel Jun 9, 2020
8fbf129
user guide: term locked->frozen in files&dirs guide
jorgeorpinel Jun 9, 2020
bdab8ae
user guide: update and reorg all YAML structure fields
jorgeorpinel Jun 9, 2020
ead834a
user guide: reinstate info about meta fields and
jorgeorpinel Jun 10, 2020
5a97a2d
user guide: term metric->metrics + add plots field
jorgeorpinel Jun 10, 2020
e957993
user guide: mark optional fields in dvc.yaml and .dvc files
jorgeorpinel Jun 11, 2020
f32ffd5
user guide: metrics are now a regular outs field in dvc.yaml and
jorgeorpinel Jun 11, 2020
910e6db
user guide: meta fields always preserved in dvc.yaml
jorgeorpinel Jun 11, 2020
92572d4
Merge branch 'master' into refactor/get-started-1.0 +
jorgeorpinel Jun 12, 2020
3986283
user guide: bring more links from old guide
jorgeorpinel Jun 12, 2020
caa5d84
server:add dvc files & dirs page redirect
jorgeorpinel Jun 12, 2020
4e8705d
Merge branch 'master' into refactor/get-started-1.0
jorgeorpinel Jun 12, 2020
72d09bf
user guide: fix more links to new files&dirs and details around them
jorgeorpinel Jun 12, 2020
2462c83
Update content/docs/user-guide/basic-concepts/external-dependency.md
jorgeorpinel Jun 13, 2020
c66d4eb
user guide: imrovements to files & dirs guide
jorgeorpinel Jun 13, 2020
7a24add
Merge branch 'refactor/get-started-1.0' of github.com:iterative/dvc.o…
jorgeorpinel Jun 13, 2020
de1f12c
user guide: md5 is optional et al.
jorgeorpinel Jun 14, 2020
b805512
user guide: update fields in dvc.yaml
jorgeorpinel Jun 14, 2020
137f044
user guide: rename dvc.yaml file section
jorgeorpinel Jun 14, 2020
ed786b0
user guide: remove "optional" from files&dirs guide
jorgeorpinel Jun 14, 2020
c69e008
user guide: make meta and ocmment notes part of prev p
jorgeorpinel Jun 14, 2020
e1db7e1
user guide: remove some periods
jorgeorpinel Jun 14, 2020
d4705d6
user guide: don't use term "output" so much
jorgeorpinel Jun 14, 2020
ac556c3
user guide: few more improvements for iterative/dvc.org/pull/1370
jorgeorpinel Jun 14, 2020
cd7bca0
user guide: more unnecessary periods removed
jorgeorpinel Jun 14, 2020
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
2 changes: 1 addition & 1 deletion content/docs/api-reference/get_url.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ specified by its `path` in a `repo` (<abbr>DVC project</abbr>), is stored.

The URL is formed by reading the project's
[remote configuration](/doc/command-reference/config#remote) and the
[DVC-file](/doc/user-guide/dvc-file-format) where the given `path` is found
[DVC-file](/doc/user-guide/dvc-metafile-formats) where the given `path` is found
(`outs` field). The URL schema returned depends on the
[type](/doc/command-reference/remote/add#supported-storage-types) of the
`remote` used (see the [Parameters](#parameters) section).
Expand Down
22 changes: 11 additions & 11 deletions content/docs/command-reference/add.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# add

Track data files or directories with DVC, by creating a corresponding
[DVC-file](/doc/user-guide/dvc-file-format).
[DVC-file](/doc/user-guide/dvc-metafile-formats).

## Synopsis

Expand All @@ -17,7 +17,7 @@ positional arguments:

The `dvc add` command is analogous to `git add`, in that it makes DVC aware of
the target data, as a first step to version it. It creates a
[DVC-file](/doc/user-guide/dvc-file-format) to track the added data.
[DVC-file](/doc/user-guide/dvc-metafile-formats) to track the added data.

The `targets` are files or directories to add with this command, that are turned
into <abbr>data artifacts</abbr> of the <abbr>project</abbr>. By default, these
Expand Down Expand Up @@ -48,8 +48,8 @@ Under the hood, a few actions are taken for each file (or directory) in
appropriate.

Summarizing, the result is that the target data is replaced small DVC-files can
be tracked with Git. See [DVC-File Format](/doc/user-guide/dvc-file-format) for
more details.
be tracked with Git. See [DVC-File Format](/doc/user-guide/dvc-metafile-formats)
for more details.

> Note that DVC-files created by this command are considered _orphan stage
> files_ because they have no _dependencies_, only outputs. These are always
Expand Down Expand Up @@ -125,8 +125,8 @@ To track the changes with git run:
git add .gitignore data.xml.dvc
```

As shown above, a [DVC-file](/doc/user-guide/dvc-file-format) has been created
for `data.xml`. Let's explore the result:
As shown above, a [DVC-file](/doc/user-guide/dvc-metafile-formats) has been
created for `data.xml`. Let's explore the result:

```dvc
$ tree
Expand Down Expand Up @@ -194,11 +194,11 @@ Saving information to 'pics.dvc'.
...
```

There are no [DVC-files](/doc/user-guide/dvc-file-format) generated within this
directory structure, but the images are all added to the <abbr>cache</abbr>. DVC
prints a message mentioning that MD5 hash values are computed for each file. A
single `pics.dvc` DVC-file is generated for the top-level directory, and it
contains:
There are no [DVC-files](/doc/user-guide/dvc-metafile-formats) generated within
this directory structure, but the images are all added to the
<abbr>cache</abbr>. DVC prints a message mentioning that MD5 hash values are
computed for each file. A single `pics.dvc` DVC-file is generated for the
top-level directory, and it contains:

```yaml
md5: df06d8d51e6483ed5a74d3979f8fe42e
Expand Down
6 changes: 3 additions & 3 deletions content/docs/command-reference/checkout.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ positional arguments:

## Description

[DVC-files](/doc/user-guide/dvc-file-format) act as pointers to specific version
of data files or directories tracked by DVC. This command synchronizes the
workspace data with the versions specified in the current DVC-files.
[DVC-files](/doc/user-guide/dvc-metafile-formats) act as pointers to specific
version of data files or directories tracked by DVC. This command synchronizes
the workspace data with the versions specified in the current DVC-files.

`dvc checkout` is useful, for example, when using Git in the
<abbr>project</abbr>, after `git clone`, `git checkout`, or any other operation
Expand Down
10 changes: 5 additions & 5 deletions content/docs/command-reference/commit.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# commit

Record changes to DVC-tracked files in the <abbr>project</abbr>, by updating
[DVC-files](/doc/user-guide/dvc-file-format) and saving <abbr>outputs<abbr> to
the <abbr>cache</abbr>.
[DVC-files](/doc/user-guide/dvc-metafile-formats) and saving <abbr>outputs<abbr>
to the <abbr>cache</abbr>.

## Synopsis

Expand Down Expand Up @@ -66,8 +66,8 @@ cache. This is where the `dvc commit` command comes into play. It performs that
last step (saving the data in cache).

Note that it's best to avoid the last two scenarios. They essentially
force-update the [DVC-files](/doc/user-guide/dvc-file-format) and save data to
cache. They are still useful, but keep in mind that DVC can't guarantee
force-update the [DVC-files](/doc/user-guide/dvc-metafile-formats) and save data
to cache. They are still useful, but keep in mind that DVC can't guarantee
reproducibility in those cases.

## Options
Expand Down Expand Up @@ -226,7 +226,7 @@ the new instance of `model.pkl` is there.
It is also possible to execute the commands that are executed by `dvc repro` by
hand. You won't have DVC helping you, but you have the freedom to run any
command you like, even ones not defined in a
[DVC-file](/doc/user-guide/dvc-file-format). For example:
[DVC-file](/doc/user-guide/dvc-metafile-formats). For example:

```dvc
$ python src/featurization.py data/prepared data/features
Expand Down
16 changes: 8 additions & 8 deletions content/docs/command-reference/fetch.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ of the project, but without placing them in the <abbr>workspace</abbr>. This
makes the data files available for linking (or copying) into the workspace.
(Refer to [dvc config cache.type](/doc/command-reference/config#cache).) Along
with `dvc checkout`, it's performed automatically by `dvc pull` when the target
[DVC-files](/doc/user-guide/dvc-file-format) are not already in the cache:
[DVC-files](/doc/user-guide/dvc-metafile-formats) are not already in the cache:

```
Controlled files Commands
Expand All @@ -49,7 +49,7 @@ on DVC remotes.) These necessary data or model files are listed as
[stage](/doc/command-reference/run)) so they are required to
[reproduce](/doc/tutorials/get-started/data-pipelines#reproduce) the
corresponding [pipeline](/doc/command-reference/pipeline). (See
[DVC-File Format](/doc/user-guide/dvc-file-format) for more information on
[DVC-File Format](/doc/user-guide/dvc-metafile-formats) for more information on
dependencies and outputs.)

`dvc fetch` ensures that the files needed for a DVC-file to be
Expand Down Expand Up @@ -276,12 +276,12 @@ $ tree .dvc/cache
```

Fetching using `--with-deps` starts with the target
[DVC-file](/doc/user-guide/dvc-file-format) (`train.dvc` stage) and searches
backwards through its pipeline for data to download into the project's cache.
All the data for the second and third stages ("featurize" and "train") has now
been downloaded to the cache. We could now use `dvc checkout` to get the data
files needed to reproduce this pipeline up to the third stage into the workspace
(with `dvc repro train.dvc`).
[DVC-file](/doc/user-guide/dvc-metafile-formats) (`train.dvc` stage) and
searches backwards through its pipeline for data to download into the project's
cache. All the data for the second and third stages ("featurize" and "train")
has now been downloaded to the cache. We could now use `dvc checkout` to get the
data files needed to reproduce this pipeline up to the third stage into the
workspace (with `dvc repro train.dvc`).

> Note that in this example project, the last stage file `evaluate.dvc` doesn't
> add any more data files than those form previous stages, so at this point all
Expand Down
9 changes: 5 additions & 4 deletions content/docs/command-reference/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The `path` argument is used to specify the location of the target to be
downloaded within the source repository at `url`. `path` can specify any file or
directory in the source repo, including those tracked by DVC, or by Git. Note
that DVC-tracked targets should be found in a
[DVC-file](/doc/user-guide/dvc-file-format) of the project.
[DVC-file](/doc/user-guide/dvc-metafile-formats) of the project.

⚠️ The project should have a default
[DVC remote](/doc/command-reference/remote), containing the actual data for this
Expand Down Expand Up @@ -181,9 +181,10 @@ The `model.monograms.pkl` file now contains the older version of the model. To
get the most recent one, we use a similar command, but with
`-o model.bigrams.pkl` and `--rev bigrams-experiment` (or even without `--rev`
since that tag has the latest model version anyway). In fact, in this case using
`dvc pull` with the corresponding [DVC-files](/doc/user-guide/dvc-file-format)
should suffice, downloading the file as just `model.pkl`. We can then rename it
to make its variant explicit:
`dvc pull` with the corresponding
[DVC-files](/doc/user-guide/dvc-metafile-formats) should suffice, downloading
the file as just `model.pkl`. We can then rename it to make its variant
explicit:

```dvc
$ dvc pull train.dvc
Expand Down
12 changes: 6 additions & 6 deletions content/docs/command-reference/import-url.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ while `out` can be used to specify the directory and/or file name desired for
the downloaded data. If an existing directory is specified, the file or
directory will be placed inside.

[DVC-files](/doc/user-guide/dvc-file-format) support references to data in an
external location, see
[DVC-files](/doc/user-guide/dvc-metafile-formats) support references to data in
an external location, see
[External Dependencies](/doc/user-guide/external-dependencies). In such a
DVC-file, the `deps` field stores the remote URL, and the `outs` field contains
the corresponding local path in the <abbr>workspace</abbr>. It records enough
Expand Down Expand Up @@ -102,8 +102,8 @@ $ dvc run -d https://example.com/path/to/data.csv \
wget https://example.com/path/to/data.csv -O data.csv
```

Both methods generate a [DVC-files](/doc/user-guide/dvc-file-format) with an
external dependency, but the one created by `dvc import-url` preserves the
Both methods generate a [DVC-files](/doc/user-guide/dvc-metafile-formats) with
an external dependency, but the one created by `dvc import-url` preserves the
connection to the data source. We call this an _import stage_.

Note that import stages are considered always locked, meaning that if you run
Expand Down Expand Up @@ -188,8 +188,8 @@ The `etag` field in the DVC-file contains the
If the remote file changes, its ETag will be different. This metadata allows DVC
to determine whether its necessary to download it again.

> See [DVC-File Format](/doc/user-guide/dvc-file-format) for more details on the
> text format above.
> See [DVC-File Format](/doc/user-guide/dvc-metafile-formats) for more details
> on the text format above.

You may want to get out of and remove the `example-get-started/` directory after
trying this example (especially if trying out the following one).
Expand Down
17 changes: 9 additions & 8 deletions content/docs/command-reference/import.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Download a file or directory tracked by DVC or by Git into the
<abbr>workspace</abbr>. It also creates a
[DVC-file](/doc/user-guide/dvc-file-format) with information about the data
[DVC-file](/doc/user-guide/dvc-metafile-formats) with information about the data
source, which can later be used to [update](/doc/command-reference/update) the
import.

Expand Down Expand Up @@ -44,7 +44,7 @@ The `path` argument is used to specify the location of the target to be
downloaded within the source repository at `url`. `path` can specify any file or
directory in the source repo, including those tracked by DVC, or by Git. Note
that DVC-tracked targets should be found in a
[DVC-file](/doc/user-guide/dvc-file-format) of the project.
[DVC-file](/doc/user-guide/dvc-metafile-formats) of the project.

⚠️ The project should have a default
[DVC remote](/doc/command-reference/remote), containing the actual data for this
Expand Down Expand Up @@ -112,9 +112,10 @@ Importing 'data/data.xml ([email protected]:iterative/example-get-started)'

In contrast with `dvc get`, this command doesn't just download the data file,
but it also creates an import stage
([DVC-file](/doc/user-guide/dvc-file-format)) with a link to the data source (as
explained in the description above). (This import stage can later be used to
[update](/doc/command-reference/update) the import.) Check `data.xml.dvc`:
([DVC-file](/doc/user-guide/dvc-metafile-formats)) with a link to the data
source (as explained in the description above). (This import stage can later be
used to [update](/doc/command-reference/update) the import.) Check
`data.xml.dvc`:

```yaml
md5: 7de90e7de7b432ad972095bc1f2ec0f8
Expand Down Expand Up @@ -152,8 +153,8 @@ Importing
```

When using this option, the import stage
([DVC-file](/doc/user-guide/dvc-file-format)) will also have a `rev` subfield
under `repo`:
([DVC-file](/doc/user-guide/dvc-metafile-formats)) will also have a `rev`
subfield under `repo`:

```yaml
deps:
Expand Down Expand Up @@ -184,7 +185,7 @@ If you take a look at our
[dataset registry](https://github.com/iterative/dataset-registry)
<abbr>project</abbr>, you'll see that it's organized into different directories
such as `tutorial/ver` and `use-cases/`, and these contain
[DVC-files](/doc/user-guide/dvc-file-format) that track different datasets.
[DVC-files](/doc/user-guide/dvc-metafile-formats) that track different datasets.
Given this simple structure, its data files can be easily shared among several
other projects using `dvc get` and `dvc import`. For example:

Expand Down
8 changes: 4 additions & 4 deletions content/docs/command-reference/init.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ sub-projects to mitigate the issues of initializing in the Git repository root:

- Not enough isolation/granularity - commands like `dvc pull`, `dvc checkout`,
and others analyze the whole repository to look for
[DVC-files](/doc/user-guide/dvc-file-format) to download files and
[DVC-files](/doc/user-guide/dvc-metafile-formats) to download files and
directories, to reproduce <abbr>pipelines</abbr>, etc. It can be expensive in
the large repositories with a lot of projects.

Expand Down Expand Up @@ -126,9 +126,9 @@ include:
- SCM other than Git is being used. Even though there are DVC features that
require DVC to be run in the Git repo, DVC can work well with other version
control systems. Since DVC relies on simple text
[DVC-files](/doc/user-guide/dvc-file-format) to manage <abbr>pipelines</abbr>,
data, etc, they can be added into any SCM thus providing large data files and
directories versioning.
[DVC-files](/doc/user-guide/dvc-metafile-formats) to manage
<abbr>pipelines</abbr>, data, etc, they can be added into any SCM thus
providing large data files and directories versioning.

- There is no need to keep the history at all, e.g. having a deployment
automation like running a data pipeline using `cron`.
Expand Down
16 changes: 8 additions & 8 deletions content/docs/command-reference/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ etc.) doesn't have DVC initialized (no `.dvc/` directory present).
Namely:

**Checkout**: For any commit hash, branch or tag, `git checkout` retrieves the
[DVC-files](/doc/user-guide/dvc-file-format) corresponding to that version. The
project's DVC-files in turn refer to data stored in <abbr>cache</abbr>, but not
necessarily in the <abbr>workspace</abbr>. Normally, it would be necessary to
use `dvc checkout` to synchronize workspace and DVC-files.
[DVC-files](/doc/user-guide/dvc-metafile-formats) corresponding to that version.
The project's DVC-files in turn refer to data stored in <abbr>cache</abbr>, but
not necessarily in the <abbr>workspace</abbr>. Normally, it would be necessary
to use `dvc checkout` to synchronize workspace and DVC-files.

This hook automates `dvc checkout` after `git checkout`.

Expand Down Expand Up @@ -153,7 +153,7 @@ $ dvc pull --all-branches --all-tags
## Example: Checkout both Git and DVC

Switching from one Git commit to another (with `git checkout`) may change the
set of [DVC-files](/doc/user-guide/dvc-file-format) in the
set of [DVC-files](/doc/user-guide/dvc-metafile-formats) in the
<abbr>workspace</abbr>. This would mean that the currently present data files
and directories no longer matches project's version (which can be fixed with
`dvc checkout`).
Expand Down Expand Up @@ -206,9 +206,9 @@ project's <abbr>cache</abbr> and the data files currently in the workspace. Git
changed the DVC-files in the workspace, which changed references to data files.
`dvc status` first informed us that the data files in the workspace no longer
matched the hash values in the corresponding
[DVC-files](/doc/user-guide/dvc-file-format). Running `dvc checkout` then brings
them up to date, and a second `dvc status` tells us that the data files now do
match the DVC-files.
[DVC-files](/doc/user-guide/dvc-metafile-formats). Running `dvc checkout` then
brings them up to date, and a second `dvc status` tells us that the data files
now do match the DVC-files.

```dvc
$ git checkout master
Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/lock.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# lock

Lock a [DVC-file](/doc/user-guide/dvc-file-format)
Lock a [DVC-file](/doc/user-guide/dvc-metafile-formats)
([stage](/doc/command-reference/run)). Use `dvc unlock` to unlock the file.

## Synopsis
Expand Down
10 changes: 5 additions & 5 deletions content/docs/command-reference/metrics/add.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ positional arguments:

## Description

Sets the `metric` field in the [DVC-file](/doc/user-guide/dvc-file-format) that
defines the given `path` as an <abbr>output</abbr>, marking `path` as a metric
file to track.
Sets the `metric` field in the [DVC-file](/doc/user-guide/dvc-metafile-formats)
that defines the given `path` as an <abbr>output</abbr>, marking `path` as a
metric file to track.

Note that outputs can also be marked as metrics via the `-m` or `-M` options of
`dvc run`. We recommend using `-M` option to keep metrics in Git history.
Expand Down Expand Up @@ -65,8 +65,8 @@ $ dvc run -O metrics.json \

Even when we named this output file `metrics.json`, DVC won't know that it's a
metric if we don't specify so. The content of stage file `metrics.json.dvc` (a
[DVC-file](/doc/user-guide/dvc-file-format)) should look like this: (Notice the
`metric: false` field.)
[DVC-file](/doc/user-guide/dvc-metafile-formats)) should look like this: (Notice
the `metric: false` field.)

```yaml
md5: 906ea9489e432c85d085b248c712567b
Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/metrics/diff.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ difference (delta) from the previous value of metrics (with 3-digit accuracy).
They're calculated between two commits (hash, branch, tag, or any
[Git revision](https://git-scm.com/docs/revisions)) for all metrics in the
<abbr>project</abbr>, found by examining all of the
[DVC-files](/doc/user-guide/dvc-file-format) in both references.
[DVC-files](/doc/user-guide/dvc-metafile-formats) in both references.

## Options

Expand Down
9 changes: 5 additions & 4 deletions content/docs/command-reference/metrics/modify.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,11 @@ positional arguments:

## Description

This command finds a corresponding [DVC-file](/doc/user-guide/dvc-file-format)
for the provided metric file (`path` is defined among the <abbr>outputs</abbr>
of the DVC-file), and updates the default formatting of the metric. See the
[options](#options) below and `dvc metrics show` for more info.
This command finds a corresponding
[DVC-file](/doc/user-guide/dvc-metafile-formats) for the provided metric file
(`path` is defined among the <abbr>outputs</abbr> of the DVC-file), and updates
the default formatting of the metric. See the [options](#options) below and
`dvc metrics show` for more info.

If `path` isn't tracked by DVC (described in one of the <abbr>workspace</abbr>
DVC-files), the following error will be raised:
Expand Down
9 changes: 5 additions & 4 deletions content/docs/command-reference/metrics/remove.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,10 @@ positional arguments:

## Description

This command finds a corresponding [DVC-file](/doc/user-guide/dvc-file-format)
for the provided metric file (`path` is defined among the <abbr>outputs</abbr>
of the DVC-file), and resets the `metric` field for the file.
This command finds a corresponding
[DVC-file](/doc/user-guide/dvc-metafile-formats) for the provided metric file
(`path` is defined among the <abbr>outputs</abbr> of the DVC-file), and resets
the `metric` field for the file.

This does not remove or delete the file in question. It only unmarks it as a
metric file. It also keeps the file as an output of the corresponding DVC-file.
Expand Down Expand Up @@ -81,7 +82,7 @@ $ dvc metrics remove metrics.json
```

Let's check the outputs field (`outs`) of same
[DVC-file](/doc/user-guide/dvc-file-format) again:
[DVC-file](/doc/user-guide/dvc-metafile-formats) again:

```yaml
outs:
Expand Down
Loading