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

live: Revisit output names #246

Closed
Tracked by #223
daavoo opened this issue Apr 28, 2022 · 6 comments
Closed
Tracked by #223

live: Revisit output names #246

daavoo opened this issue Apr 28, 2022 · 6 comments

Comments

@daavoo
Copy link
Contributor

daavoo commented Apr 28, 2022

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 iterative/vscode-dvc#1618 (comment)

@dberenbaum
Copy link
Collaborator

Related conversation: iterative/dvc.org#3147 (comment)

@dberenbaum
Copy link
Collaborator

dberenbaum commented Sep 9, 2022

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

@daavoo
Copy link
Contributor Author

daavoo commented Sep 9, 2022

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.

@dberenbaum
Copy link
Collaborator

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

@dberenbaum
Copy link
Collaborator

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

@daavoo
Copy link
Contributor Author

daavoo commented Sep 27, 2022

Would be nice to also address iterative/dvc.org#3994 (comment)

daavoo added a commit that referenced this issue Oct 5, 2022
@daavoo daavoo closed this as completed Oct 17, 2022
daavoo added a commit that referenced this issue Oct 18, 2022
* live: Revisit output names and structure.

Applied #246 (comment)

Closes #246

* Rename `log_plot` to `log_sklearn_plot`.

* Rename `plot` -> `sklearn`

* Rename `sklearn` -> `sklearn_plot`
daavoo added a commit that referenced this issue Oct 31, 2022
* live: Revisit output names and structure.

Applied #246 (comment)

Closes #246

* Rename `log_plot` to `log_sklearn_plot`.

* Rename `plot` -> `sklearn`

* Rename `sklearn` -> `sklearn_plot`
daavoo added a commit that referenced this issue Nov 4, 2022
* live: Revisit output names and structure.

Applied #246 (comment)

Closes #246

* Rename `log_plot` to `log_sklearn_plot`.

* Rename `plot` -> `sklearn`

* Rename `sklearn` -> `sklearn_plot`
daavoo added a commit that referenced this issue Nov 4, 2022
* live: Revisit output names and structure.

Applied #246 (comment)

Closes #246

* Rename `log_plot` to `log_sklearn_plot`.

* Rename `plot` -> `sklearn`

* Rename `sklearn` -> `sklearn_plot`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants