dvclive icon indicating copy to clipboard operation
dvclive copied to clipboard

live: Revisit output names

Open daavoo opened this issue 2 years ago • 1 comments

can we rename it? is it a default name? it's a bit confusing to have dvclive dir, dvclive/scalars which are actually plots and dvclive.json that is actually scalars ... how can we improve this naming? cc @dberenbaum @daavoo wdyt?

Originally posted by @shcheklein in https://github.com/iterative/vscode-dvc/pull/1618#discussion_r859418877

daavoo avatar Apr 28 '22 07:04 daavoo

Related conversation: https://github.com/iterative/dvc.org/pull/3147#discussion_r789079337

dberenbaum avatar May 02 '22 19:05 dberenbaum

My take:

  • scalars seems too technical to me. Can we rename to trends to align with VS Code and Studio?
  • dvclive.json we can probably rename to metrics.json. We have also discussed moving it inside dvclive/metrics.json, which I think makes sense although I think there are a few technical hurdles to overcome for how to track everything inside dvclive.

Edit: If we move more inside dvclive, we could also add a subdir for plots so it looks like:

$ tree dvclive
├── metrics.json # renamed from "dvclive.json" and moved inside the dir
├── plots # align subdir names with VS Code
│   ├── data_series # renamed from "plots"
│   │   └── roc.json
│   ├── images
│   │   └── img.png
│   └── trends # renamed from "scalars"
│       └── acc.tsv
└── report.html

dberenbaum avatar Sep 09 '22 00:09 dberenbaum

Can we rename to trends to align with VS Code and Studio?

It sounds appealing and more clear than scalars.

However, trends in VSCode are based on DVC checkpoints, and in Studio are based on commits. The .tsv files we would be saving in plots/trends would be shown as Data Series in VScode and as Plots in Studio.

I don't know if this would be confusing for users or not.

dvclive.json we can probably rename to metrics.json. We have also discussed moving it inside dvclive/metrics.json, which I think makes sense although I think there are a few technical hurdles to overcome for how to track everything inside dvclive.

Moving dvclive.json to dvclive/metrics.json + creating a plots folder sounds good.

daavoo avatar Sep 09 '22 08:09 daavoo

Okay, maybe we can hold off on trends for now or think of another name.

dberenbaum avatar Sep 09 '22 15:09 dberenbaum

Okay, maybe we can hold off on trends for now or think of another name.

How about metrics, so that it looks like:

$ tree dvclive
├── metrics.json # renamed from "dvclive.json" and moved inside the dir
├── params.yaml # new
├── plots # align subdir names with VS Code
│   ├── data_series # renamed from "plots"
│   │   └── roc.json
│   ├── images
│   │   └── img.png
│   └── metrics # renamed from "scalars"
│       └── acc.tsv
└── report.html

dberenbaum avatar Sep 26 '22 20:09 dberenbaum

Would be nice to also address https://github.com/iterative/dvc.org/pull/3994#discussion_r980294156

daavoo avatar Sep 27 '22 18:09 daavoo