Skip to content

--show-md output for metrics, params and dvc diff #3690

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

Closed
dmpetrov opened this issue Apr 28, 2020 · 6 comments · Fixed by #3757
Closed

--show-md output for metrics, params and dvc diff #3690

dmpetrov opened this issue Apr 28, 2020 · 6 comments · Fixed by #3757
Assignees
Labels
feature request Requesting a new feature product: VSCode Integration with VSCode extension
Milestone

Comments

@dmpetrov
Copy link
Member

Today we support JSON output for the diff commands. However, CI/CD systems understand only the MD format. We need to add the MD format support to avoid the conversion.

@dmpetrov dmpetrov added feature request Requesting a new feature product: VSCode Integration with VSCode extension labels Apr 28, 2020
@dmpetrov
Copy link
Member Author

It might be related to #3435

@dmpetrov
Copy link
Member Author

dmpetrov commented May 8, 2020

A bit more clarification: we are interested only in MD format with no HTML like

| Path | Metric | Value | Change|
|------|--------|-------|-------|
|summary.json|accuracy|0.853481| -0.334|

A nice option that can be included:

  1. --no-path - do not show the first path column since the user might decide to output tables per file with separate headers for each of the tables.
  2. --old-value (for metrics only) - to print both the old value and new value in addition to the change. Scenario - in the early stages of a project when metrics change a lot this format is more convenient.
  3. --no-text - now dvc metrics diff output None and diff not supported. it might be better to have empty values instead.

@dmpetrov
Copy link
Member Author

dmpetrov commented May 8, 2020

For dvc diff MD result should show the operation as a column deleted\added\modified. E.g.

Action | Path
added | dir1/file1
added | dir1/file2
deleted | file3

It would be nice to have options like --added-only \ --modified--only \ --deleted-only. It'll help the user to create separate sections in MD file if the separation is important and simplifies the table since the operation type column won't needed.

@efiop
Copy link
Contributor

efiop commented May 9, 2020

It would be nice to have options like --added-only \ --modified--only \ --deleted-only. It'll help the user to create separate sections in MD file if the separation is important and simplifies the table since the operation type column won't needed.

For the record: decided not to go with these, as it seems too out of scope for dvc diff. It is easy to parse from the MD table.

@efiop
Copy link
Contributor

efiop commented May 10, 2020

Keeping open to consider 1,2,3 above.

@efiop efiop reopened this May 10, 2020
@dmpetrov dmpetrov added this to the 1.0 milestone May 13, 2020
@efiop efiop self-assigned this May 22, 2020
efiop added a commit to efiop/dvc that referenced this issue May 22, 2020
efiop added a commit to efiop/dvc that referenced this issue May 22, 2020
efiop added a commit that referenced this issue May 22, 2020
* metrics: diff: add --no-path

Part of #3690

* params: diff: introduce --no-path

* metrics: diff: introduce --old

Part of #3690
@efiop
Copy link
Contributor

efiop commented May 23, 2020

--show-md, --no-path and --old are implemented. --no-text is not clear if needed, as it might make sense to just revisit the defaults in the future. Closing for now.

@efiop efiop closed this as completed May 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature request Requesting a new feature product: VSCode Integration with VSCode extension
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants