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.

Sign up for GitHub

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

Jump to bottom

guide: --json/csv examples in Listing/Comparing Experiments #2860

Closed
iesahin opened this issue Sep 28, 2021 · 6 comments · Fixed by #2862
Closed

guide: --json/csv examples in Listing/Comparing Experiments #2860

iesahin opened this issue Sep 28, 2021 · 6 comments · Fixed by #2862
Assignees
@iesahin
Labels
C: guide Content of /doc/user-guide p2-nice-to-have Less of a priority at the moment. We don't usually deal with this immediately.

Comments

@iesahin
Copy link
Contributor

iesahin commented Sep 28, 2021

I'll add an example with jq to the UG after testing it.

Originally posted by @iesahin in #2740 (comment)
@iesahin iesahin added C: guide Content of /doc/user-guide p2-nice-to-have Less of a priority at the moment. We don't usually deal with this immediately. labels Sep 28, 2021
@iesahin iesahin self-assigned this Sep 28, 2021
@skshetry
Copy link
Member

If iterative/dvc#6647 gets merged, we'll be prettifying json by default unless you meant to use jq for filtering.

@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Sep 28, 2021 •
edited
Loading

What about --csv? Per #2740 (comment)

@iesahin
Copy link
Contributor Author

iesahin commented Sep 29, 2021

I believe JSON is supposed to be used by other commands. Some kind of filtering may be possible, e.g., experiments with a metric higher than a certain threshold.

@jorgeorpinel jorgeorpinel changed the title guide: Add --show-json usage and example to Comparing Experiments guide: --show-json usage and example in Comparing Experiments Sep 29, 2021
@jorgeorpinel jorgeorpinel changed the title guide: --show-json usage and example in Comparing Experiments guide: --show-json/csv usage and examples in Listing/Comparing Experiments Sep 29, 2021
@jorgeorpinel jorgeorpinel changed the title guide: --show-json/csv usage and examples in Listing/Comparing Experiments guide: --show-json/csv examples in Listing/Comparing Experiments Sep 29, 2021
@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Sep 29, 2021 •
edited
Loading

I believe JSON is supposed to be used by other commands

Yes, that's fine but CSV will also have some use cases (otherwise why does it exist) so let's include it too?

From #2740 (comment) :

I would prefer example outputs for both --json and --csv over a usage example, since what would be less obvious to users is the format of those JSON and CSV outputs

@jorgeorpinel jorgeorpinel changed the title guide: --show-json/csv examples in Listing/Comparing Experiments guide: --json/csv examples in Listing/Comparing Experiments Oct 1, 2021
@iesahin
Copy link
Contributor Author

iesahin commented Oct 4, 2021

There are now examples for these options in #2737

@jorgeorpinel
Copy link
Contributor

Great! I think you mean #2862 though? Please link that PR to close this issue if so @iesahin. Thanks

@iesahin iesahin mentioned this issue Oct 5, 2021
Merged
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@iesahin iesahin

Labels
C: guide Content of /doc/user-guide p2-nice-to-have Less of a priority at the moment. We don't usually deal with this immediately.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

guide: Comparing Experiments iterative/dvc.org
3 participants
@iesahin @jorgeorpinel @skshetry