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

term: call metrics "metrics" and plots "plots" #1442

Closed
1 task done
jorgeorpinel opened this issue Jun 17, 2020 · 6 comments
Closed
1 task done

term: call metrics "metrics" and plots "plots" #1442

jorgeorpinel opened this issue Jun 17, 2020 · 6 comments
Labels
A: docs Area: user documentation (gatsby-theme-iterative) duplicate This issue or pull request already exists. status: stale You've been groomed! type: discussion Requires active participation to reach a conclusion.

Comments

@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Jun 17, 2020

There's a couple issues with terminology around the concept of metrics.

Conceptually, regular (scalar) metrics and plots (continuous metrics) are both metrics, so we have phrases like "Type of metrics" as well as using the term "metrics" in the plots command references. I think this is confusing.

Instead of having to explain that there are types of metrics and one we call just metrics in most places and the other we call "plots" (but still use "metric files"), we could just skip this explanation altogether and only call metrics metrics, and plots plots. This includes "metrics file" and "plots file".

Why even merge these 2 concepts into one? Sure, we can mention the word "metrics" once or twice in the plots cmd ref index, but that should be enough. The commands themselves do very different things anyway and the format requirements for each kind of file are very different.

Keep in mind that metrics and plots are also 2 kinds of special outputs, and this will be explained in the dvc run cmd ref (see #1420).


  • Additionally (extracted from cmd ref: dvc run 1.0 update #1420 (review)), we ended up with complicated rules as to which terms to use for singular and plural "metrics file" and "metric files". I think we should not say singular "metric" at all because sometimes there's not enough context and it sounds like we're talking about int'l distance units (as in kilometers). Using plural "metrics" always is an easier rule we'll always remember, same as "plots", because that's the name of the commands themselves.

p.s. this may also affect the core repo (output strings).

@jorgeorpinel jorgeorpinel added type: discussion Requires active participation to reach a conclusion. A: docs Area: user documentation (gatsby-theme-iterative) labels Jun 17, 2020
@jorgeorpinel

This comment has been minimized.

@dmpetrov
Copy link
Member

This is the right direction. We need to come up with clear separation. Metrics & plots files are the best that I can think of right now.

@jorgeorpinel
Copy link
Contributor Author

jorgeorpinel commented Oct 11, 2020

I think the terms are fine, even when plots are metrics technically. We just probably don't need to stress that and keep saying "types of metrics: scalar metrics which we just call metrics and continuous ones that we call plots". We can just remove these confusing explanations I think, and make the difference implicit by only using the term "(DVC) metrics" for scalars and "(DVC) plots" for continuous/charts.

The same overlap exists between other concepts technically, like "remote storage" and "cache" but we never (no longer at least) call remote storage "remote cache" or explain that there can be multiple caches, one local or external for your project, and distributed backups (possibly partial) in remote storage...

This kind of explanations while correct, may complicate the docs unnecessarily. Some things we can leave as implicit/contextual knowledge I think. Or add a buried/hidden note about these technicalities in a single doc somewhere.

@jorgeorpinel
Copy link
Contributor Author

@dberenbaum @iesahin let's discuss this one? Still relevant, even more with image file plots support... (see https://dvc.org/doc/command-reference/plots)

Rel. #2572

@dberenbaum
Copy link
Collaborator

@jorgeorpinel Do you think the discussion in #2956 addresses this?

@jorgeorpinel
Copy link
Contributor Author

jorgeorpinel commented Mar 24, 2022

Ah yes, it's the same discussion. Closing here since that one is more current (I updated its description a bit).

@jorgeorpinel jorgeorpinel added duplicate This issue or pull request already exists. status: stale You've been groomed! labels Mar 24, 2022
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) duplicate This issue or pull request already exists. status: stale You've been groomed! type: discussion Requires active participation to reach a conclusion.
Projects
None yet
Development

No branches or pull requests

3 participants