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

metrics: document behavior of accepting any parsable file #1909

Closed
pared opened this issue Nov 5, 2020 · 3 comments · Fixed by #3387
Closed

metrics: document behavior of accepting any parsable file #1909

pared opened this issue Nov 5, 2020 · 3 comments · Fixed by #3387
Assignees
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: ref Content of /doc/*-reference type: enhancement Something is not clear, small updates, improvement suggestions

Comments

@pared
Copy link
Contributor

pared commented Nov 5, 2020

After iterative/dvc#4446 dvc metrics commands accept any viable target, metric file does not have to be specified in dvc.yaml.
plots has this functionality already documented it #1800.
Related to #1809, iterative/dvc#4761

@pared pared added A: docs Area: user documentation (gatsby-theme-iterative) type: enhancement Something is not clear, small updates, improvement suggestions p2-nice-to-have Less of a priority at the moment. We don't usually deal with this immediately. website: ux Website UI/UX labels Nov 5, 2020
@jorgeorpinel jorgeorpinel added p1-important Active priorities to deal within next sprints and removed p2-nice-to-have Less of a priority at the moment. We don't usually deal with this immediately. website: ux Website UI/UX labels Nov 11, 2020
@jorgeorpinel
Copy link
Contributor

Is this still relevant @pared @dberenbaum ? Thanks

@jorgeorpinel jorgeorpinel added C: ref Content of /doc/*-reference and removed p1-important Active priorities to deal within next sprints labels Mar 24, 2022
@pared
Copy link
Contributor Author

pared commented Mar 24, 2022

@jorgeorpinel yes, it is
in https://dvc.org/doc/command-reference/metrics#description we imply that one needs to mark the output as metric in order to use dvc metrics command on it. This is not a requirement. I don't think that's super important to mention that it works on files not specified as metrics, though it would be good to mention it. It shouldn't be a big change, sorry for leaving it to hang for so long.

@jorgeorpinel
Copy link
Contributor

Looks like this is already mostly done per #3387 (review) but thanks for #3387 as well! Lmk if you need help finishing that one up. Closing this.

pared added a commit that referenced this issue Mar 31, 2022
pared added a commit that referenced this issue Mar 31, 2022
jorgeorpinel added a commit that referenced this issue Mar 31, 2022
* 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]>
iesahin pushed a commit that referenced this issue Apr 11, 2022
* 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
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: ref Content of /doc/*-reference type: enhancement Something is not clear, small updates, improvement suggestions
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants