-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
metrics & plots: help output improvements [qa] #3924
Comments
* update metrics * remove metrics add\remove\modify * cmd ref: copy edits and more relevant updates to metrics for DVC 1.0 release, as well as other related cmd refs * cmd ref: update plot similarly to previous commit for metrics * cmd ref: more updates to metrics subcommands for 1.0 release... WIP * cmd ref: remove deprecated metrics subcommands from nav * cmd ref: update all metrics ref examples * cmd ref: more updates to metrics and plots * cmd ref: lower case bullets text * cmd ref: put types of metrics/plots before description, and avoid terms "scalar" and "continuous" * cmd ref: update metrics scmds per iterative/dvc/issues/3924 Co-authored-by: Jorge Orpinel <jorge@orpinel.com>
p.s. sorry I don't currently have the capacity to work on this, otherwise I would've sent a PR instead. |
NOTE: We also have |
We are just merging everything when ready at this point, even if we're early compared to the actual core 1.0 release. |
And yes, similar changes apply to |
* cmd ref: add note that move creates dirs * cmd ref: improve structure of add ref desc. * grammar: add some commas * term: checksum -> hash value in dvcignore guide * style: lower case bullet text * cmd ref: remove some redundancy in metrics index * cmd ref: update plots refs synopsis and descriptions per iterative/dvc/issues/3924 et al. * Add plots modify cmd * typo: CSV->csv * term: working tree -> workspace per iterative/dvc/pull/3914 * cmd ref: couple improvements to add ref per #1382 (review) and #1382 (review) * Update config/prismjs/dvc-commands.js * cmd ref: update plots modify description * cmd ref: add plots modify to nav, with a few more improvements * cmd ref: plots --show-json -> --show-vega per iterative/dvc#3891 (comment) * rename x-lab to x-label * cmd ref: review descriptions of plots index, show, and diff * cmd ref: review and update old plots cmds options per iterative/dvc#3948 et al. * cmd ref: a couple more option updates per #1382 (review) * cmd ref: emphasize add works with any large file/dir per #1382 (review) * cmd ref: updae plots modify top half (definition, description) per #1382 (review) al. * cmd ref: improve all plot cmd option descriptions * Update content/docs/command-reference/plots/modify.md * cmd ref: review examples (mainly images) in plots modify per #1382 (comment) et al. * cmd ref: rephrase info about how data arrays are injected to plot templates per #1382 (review) * cmd ref: update info on how targets for for plots show/diff per #1382 (review) * cmd ref: double check all plots examples per #1382 (comment) * cmd ref: remove info about plots show --select * cmd ref: update add desc per #1382 (review) * cmd ref: re-explain dvc add for dirs per #1382 (review) * cmd ref: improve description about targets in plots diff per #1382 (review) * cmd ref: make emoji note in plots index per #1382 (review) * cmd ref: remove ineffective CSV code block highlighting from plots refs per #1382 (review) * get started: improve intro in index * glossary: remove external deps entry (no need) * cmd ref: add info about column indexing for headerless tables per #1382 (comment) * cmd ref: update template metavar for plots subcommands per #1382 (review) * cmd ref: mention YAML is supported for plots per #1382 (comment) * cmd ref: rename template metavar again in plots per #1382 (comment) * cmd ref: clarify plots modify --no-csv-header per #1382 (review) * cmd ref: add note about plots modify in show and diff * cmd ref: update all plots options again * cmd ref: more updates to plots et al. per Ivan's review * cmd ref: multiple plots diff --targets allowed * cmd ref: update note about detault metrics in index per #1382 (review) * cmd ref: emphasize add --recursive is rarely needed per #1382 (review) * cmd ref: plots diff: update revisions arg desc per #1382 (review) * cmd ref: mention column names and numbers in plots {cmd} -x and -y per #1382 (review) * cmd ref: emphasize that metrics diff is not a real diff per #1382 (review) * cmd ref: simplify note on plots targets per #1382 (review) * cmd ref: how to id colmns in plots modify --no-csv-header per #1382 (review) * cmd ref: add default target behavior to plots show and diff rel: #1382 (review) * cmd ref: rename plots option --no-header per iterative/dvc/pull/4001 * cmd ref: term: prop->property (plots) per #1382 (comment) * cmd ref: more details on metrics index per #1382 (review) and #1382 (review) * cmd ref: more details on plots index per #1382 (review) and #1382 (review) * cmd ref: note about disply props in plots modify per #1382 (review) and #1382 (review) Co-authored-by: Dmitry Petrov <dmitry.petrov@nevesomo.com>
* cmd ref: add note that move creates dirs * cmd ref: improve structure of add ref desc. * grammar: add some commas * term: checksum -> hash value in dvcignore guide * style: lower case bullet text * cmd ref: remove some redundancy in metrics index * cmd ref: update plots refs synopsis and descriptions per iterative/dvc/issues/3924 et al. * Add plots modify cmd * typo: CSV->csv * term: working tree -> workspace per iterative/dvc/pull/3914 * cmd ref: couple improvements to add ref per #1382 (review) and #1382 (review) * Update config/prismjs/dvc-commands.js * cmd ref: update plots modify description * cmd ref: add plots modify to nav, with a few more improvements * cmd ref: plots --show-json -> --show-vega per iterative/dvc#3891 (comment) * rename x-lab to x-label * cmd ref: review descriptions of plots index, show, and diff * cmd ref: review and update old plots cmds options per iterative/dvc#3948 et al. * cmd ref: a couple more option updates per #1382 (review) * cmd ref: emphasize add works with any large file/dir per #1382 (review) * cmd ref: updae plots modify top half (definition, description) per #1382 (review) al. * cmd ref: improve all plot cmd option descriptions * Update content/docs/command-reference/plots/modify.md * cmd ref: review examples (mainly images) in plots modify per #1382 (comment) et al. * cmd ref: rephrase info about how data arrays are injected to plot templates per #1382 (review) * cmd ref: update info on how targets for for plots show/diff per #1382 (review) * cmd ref: double check all plots examples per #1382 (comment) * cmd ref: remove info about plots show --select * cmd ref: update add desc per #1382 (review) * cmd ref: re-explain dvc add for dirs per #1382 (review) * cmd ref: improve description about targets in plots diff per #1382 (review) * cmd ref: make emoji note in plots index per #1382 (review) * cmd ref: remove ineffective CSV code block highlighting from plots refs per #1382 (review) * get started: improve intro in index * glossary: remove external deps entry (no need) * cmd ref: update add for 1.0 (1) up to... before Examples * cmd ref: 1.0 updates for add (2) - examples * cmd ref: remove note about comments in add example per #1411 (review) Co-authored-by: Dmitry Petrov <dmitry.petrov@nevesomo.com>
Please provide information about your setup
DVC 1.0.0a6+283718
Report
add
andremove
targets
: "Metric filesor directories (see -R)to show" Unify metrics behavior with dirs #3935show
: "Generate plot from a metrics file."diff
: "Plot differences in metrics between commits."See plots show: targets are required but help output indicates otherwise [qa] #3925targets
: why is it printed as optional? The command actually requires it.UPPER_CASE
to<type_format>
. Probably:<path>
<path>
<field>
<text>
<text>
<path>
revisions
: "Git commits to plot from/to"UPDATE: Similar updates apply to
plots modify
now that it has been added.EXTRA: Additionally it would be nice to reorder the command parameters to match the order in the Options sections of the corresponding published cmd refs.
The text was updated successfully, but these errors were encountered: