Skip to content

metrics: info on non-output usage #3387

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Mar 31, 2022
Merged

metrics: info on non-output usage #3387

merged 4 commits into from
Mar 31, 2022

Conversation

pared
Copy link
Contributor

@pared pared commented Mar 24, 2022 •
edited by jorgeorpinel
Loading

@shcheklein shcheklein temporarily deployed to dvc-org-1909-metrics-d8xzz233f March 24, 2022 13:07 Inactive
@shcheklein shcheklein temporarily deployed to dvc-org-1909-metrics-d8xzz233f March 24, 2022 13:09 Inactive
jorgeorpinel
jorgeorpinel reviewed Mar 29, 2022
View reviewed changes
content/docs/command-reference/metrics/index.md Outdated
Comment on lines 72 to 74
> - even though `dvc metrics` subcommands use the metrics files specifed in
> `dvc.yaml` by default, they can be used on any file, as long as they are
> specified via `targets` argument
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmmmm. I see. I think instead of changing this note we should incorporate the information to the paragraph before the summary.json sample block.

Copy link
Contributor

@jorgeorpinel jorgeorpinel Mar 29, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I.e. starting in line 50 change

`dvc metrics` subcommands by default use the metrics files specified in
`dvc.yaml` ...

to something like

`dvc metrics` subcommands can be used on any
[valid metrics files](#supported-file-formats). By default they use the
ones listed in `dvc.yaml` ...

jorgeorpinel
jorgeorpinel suggested changes Mar 29, 2022
View reviewed changes
Copy link
Contributor

@jorgeorpinel jorgeorpinel left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

BTW I see that this info. is already in https://dvc.org/doc/command-reference/metrics/show and diff 🙂 (around targets):

image

So please just address the comment above so we can wrap this up. Thanks

@jorgeorpinel jorgeorpinel mentioned this pull request Mar 29, 2022
Closed
@jorgeorpinel jorgeorpinel added the p2-nice-to-have Less of a priority at the moment. We don't usually deal with this immediately. label Mar 29, 2022
@shcheklein shcheklein temporarily deployed to dvc-org-1909-metrics-d8xzz233f March 31, 2022 10:50 Inactive
pared
pared commented Mar 31, 2022
View reviewed changes
content/docs/command-reference/metrics/index.md Outdated
`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`
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I changed if any tp if there are any - sounded better to me, but it might be just me, I can roll this back :)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, thanks. This works perfectly in terms of meaning. I'll rephrase the wording a little for readability.

jorgeorpinel
jorgeorpinel reviewed Mar 31, 2022
View reviewed changes
@restyled-io restyled-io bot mentioned this pull request Mar 31, 2022
Merged
@jorgeorpinel jorgeorpinel requested a deployment to dvc-org-1909-metrics-d8xzz233f March 31, 2022 21:20 Abandoned
@jorgeorpinel jorgeorpinel requested a deployment to dvc-org-1909-metrics-d8xzz233f March 31, 2022 21:21 Abandoned
jorgeorpinel
jorgeorpinel approved these changes Mar 31, 2022
View reviewed changes
Copy link
Contributor

@jorgeorpinel jorgeorpinel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks again @pared !

@jorgeorpinel jorgeorpinel temporarily deployed to dvc-org-1909-metrics-d8xzz233f March 31, 2022 21:22 Inactive
@jorgeorpinel jorgeorpinel merged commit 0aa071a into master Mar 31, 2022
@jorgeorpinel jorgeorpinel deleted the 1909_metrics branch March 31, 2022 21:23
iesahin pushed a commit that referenced this pull request Apr 11, 2022
@pared @jorgeorpinel
@restyled-io @restyled-commits @iesahin
metrics: info on non-output usage (#3387)
9b4a538 
* metrics: info on non-output usage

Fixes: #1909

* Update content/docs/command-reference/metrics/index.md

* Update content/docs/command-reference/metrics/show.md

Co-authored-by: Paweł Redzyński <[email protected]>

* Restyled by prettier (#3412)

Co-authored-by: Restyled.io <[email protected]>

Co-authored-by: Jorge Orpinel <[email protected]>
Co-authored-by: restyled-io[bot] <32688539+restyled-io[bot]@users.noreply.github.com>
Co-authored-by: Restyled.io <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jorgeorpinel jorgeorpinel jorgeorpinel approved these changes

Assignees

@pared pared

Labels
p2-nice-to-have Less of a priority at the moment. We don't usually deal with this immediately.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

metrics: document behavior of accepting any parsable file
3 participants
@pared @jorgeorpinel @shcheklein