Skip to content

Commit

Permalink
metrics: info on non-output usage
Browse files Browse the repository at this point in the history
Fixes: #1909
  • Loading branch information
pared committed Mar 31, 2022
1 parent a997ec2 commit 272bcf1
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
3 changes: 1 addition & 2 deletions content/docs/command-reference/metrics/diff.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,7 @@ compare. A single specified revision results in comparing it against the
workspace.

> Note that targets don't necessarily have to be defined in `dvc.yaml`. For that
> reason, this command doesn't require an existing DVC project to run in; It
> works in any Git repo.
> reason, this command doesn't require an existing DVC project to run in.
All metrics defined in `dvc.yaml` are used by default, but specific metrics
files can be specified with the `--targets` option.
Expand Down
6 changes: 4 additions & 2 deletions content/docs/command-reference/metrics/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,10 @@ Path Metric HEAD workspace Change
metrics.json AUC 0.763981 0.801807 0.037826
```

`dvc metrics` subcommands by default use the metrics files specified in
`dvc.yaml` (if any), for example `summary.json` below:
`dvc metrics` subcommands can be used on any
[valid metrics files](#supported-file-formats). By default they use the metrics
files specified in `dvc.yaml` (if there are any), for example `summary.json`
below:

```yaml
stages:
Expand Down
3 changes: 1 addition & 2 deletions content/docs/command-reference/metrics/show.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,7 @@ target can even be directories, so that DVC recursively shows all metrics files
inside.

> Note that targets don't necessarily have to be defined in `dvc.yaml`. For that
> reason, this command doesn't require an existing DVC project to run in; It
> works in any Git repo.
> reason, this command doesn't require an existing DVC project to run in.
An alternative way to display metrics is the `dvc metrics diff` command, which
compares them with a previous version.
Expand Down

0 comments on commit 272bcf1

Please sign in to comment.