-
Notifications
You must be signed in to change notification settings - Fork 386
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
Comments
This comment has been minimized.
This comment has been minimized.
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. |
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. |
@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 |
@jorgeorpinel Do you think the discussion in #2956 addresses this? |
Ah yes, it's the same discussion. Closing here since that one is more current (I updated its description a bit). |
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.
The text was updated successfully, but these errors were encountered: