From 3235decec5bbde1d998fa5d2781bedabfa0d8f4c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Redzy=C5=84ski?= Date: Tue, 22 Sep 2020 13:44:45 +0200 Subject: [PATCH 1/3] metrics: accept any viable target update --- content/docs/command-reference/metrics/diff.md | 3 +++ content/docs/command-reference/metrics/show.md | 10 +++++----- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/content/docs/command-reference/metrics/diff.md b/content/docs/command-reference/metrics/diff.md index daec243ab7..9f22f21f61 100644 --- a/content/docs/command-reference/metrics/diff.md +++ b/content/docs/command-reference/metrics/diff.md @@ -56,6 +56,9 @@ lists all the current metrics without comparisons. $ dvc metrics diff HEAD v1 --targets t1.json t2.json ``` + Note, that when using `--targets` it is possible to `diff` files that are not + specifically marked as metrics. + - `-R`, `--recursive` - determines the metric files to use by searching each target directory and its subdirectories for DVC-files to inspect. If there are no directories among the `targets`, this option is ignored. diff --git a/content/docs/command-reference/metrics/show.md b/content/docs/command-reference/metrics/show.md index 35d4220281..c1bd8293a0 100644 --- a/content/docs/command-reference/metrics/show.md +++ b/content/docs/command-reference/metrics/show.md @@ -22,11 +22,11 @@ Finds and prints all metrics in the project by examining all of its > This kind of metrics can be defined with the `-m` (`--metrics`) and `-M` > (`--metrics-no-cache`) options of `dvc run`. -If `targets` are provided, it will show those specific metric files instead. -With the `-a` or `-T` options, this command shows the different metrics values -across all Git branches or tags, respectively. With the `-R` option, some of the -target can even be directories, so that DVC recursively shows all metric files -inside. +If `targets` are provided, it will show those specific files instead, even if +they are not marked as `metric` type in `dvc.yaml`. With the `-a` or `-T` +options, this command shows the different metrics values across all Git branches +or tags, respectively. With the `-R` option, some of the target can even be +directories, so that DVC recursively shows all metric files inside. An alternative way to display metrics is the `dvc metrics diff` command, which compares them with a previous version. From f7c3f4e5ebceb8a409d720fe40459d2b85ab2e02 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Redzy=C5=84ski?= Date: Fri, 25 Sep 2020 10:23:18 +0200 Subject: [PATCH 2/3] Update content/docs/command-reference/metrics/show.md Co-authored-by: Jorge Orpinel --- content/docs/command-reference/metrics/show.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/command-reference/metrics/show.md b/content/docs/command-reference/metrics/show.md index c1bd8293a0..72a7b5bba5 100644 --- a/content/docs/command-reference/metrics/show.md +++ b/content/docs/command-reference/metrics/show.md @@ -23,7 +23,7 @@ Finds and prints all metrics in the project by examining all of its > (`--metrics-no-cache`) options of `dvc run`. If `targets` are provided, it will show those specific files instead, even if -they are not marked as `metric` type in `dvc.yaml`. With the `-a` or `-T` +they are not found as `metrics` in `dvc.yaml`. With the `-a` or `-T` options, this command shows the different metrics values across all Git branches or tags, respectively. With the `-R` option, some of the target can even be directories, so that DVC recursively shows all metric files inside. From 27d3ec73bc0cd95c31f8e9305c1cd3baeedc2ba9 Mon Sep 17 00:00:00 2001 From: "Restyled.io" Date: Fri, 25 Sep 2020 08:23:29 +0000 Subject: [PATCH 3/3] Restyled by prettier --- content/docs/command-reference/metrics/show.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/content/docs/command-reference/metrics/show.md b/content/docs/command-reference/metrics/show.md index 72a7b5bba5..eb8e9f61b6 100644 --- a/content/docs/command-reference/metrics/show.md +++ b/content/docs/command-reference/metrics/show.md @@ -23,10 +23,10 @@ Finds and prints all metrics in the project by examining all of its > (`--metrics-no-cache`) options of `dvc run`. If `targets` are provided, it will show those specific files instead, even if -they are not found as `metrics` in `dvc.yaml`. With the `-a` or `-T` -options, this command shows the different metrics values across all Git branches -or tags, respectively. With the `-R` option, some of the target can even be -directories, so that DVC recursively shows all metric files inside. +they are not found as `metrics` in `dvc.yaml`. With the `-a` or `-T` options, +this command shows the different metrics values across all Git branches or tags, +respectively. With the `-R` option, some of the target can even be directories, +so that DVC recursively shows all metric files inside. An alternative way to display metrics is the `dvc metrics diff` command, which compares them with a previous version.