-
Notifications
You must be signed in to change notification settings - Fork 406
Closed
Labels
C: guideContent of /doc/user-guideContent of /doc/user-guidetype: enhancementSomething is not clear, small updates, improvement suggestionsSomething is not clear, small updates, improvement suggestions
Description
Extracted from #2862 (review) etc.
Rel. https://dvc.org/doc/user-guide/experiment-management/comparing-experiments
General
- Needs detailed copy editing. E.g. missing "the", disjointed paragraphs, unnecessary scrolling blocks, etc. (another e.g.)
- UG: Write a synopsis section to Comparing Experiments #3160 ?
- Review "baseline" concept. Apply to explanations and branch names?
Per guide: Comparing Experiments #2862 (review) - Cover
exp showfirst (exp listlater).
Per guide: Comparing Experiments #2862 (comment)
Specific ideas
- Address guide: revisit Exp Sharing #2908 (review) .
- Cover
deps/dependenciescolumn. See Dvc exp show deps #3220 - Absorb #list-experiment-names-to-use-in-scripts into #list-experiments-in-the-workspace.
- Consider tabs when commands are used as alternatives in specific example tasks (e.g.
exp showvsexp diff). - Include/mention
--only-changedper ref:exp show --only-changed#2966 . - Avoid terms "git ref" and "attached". (Use "based on" for consistency?)
-
--sort/order-by/no-timestampsections may be too detailed. Hide or just mention + link to ref. - Merge JSON and CSV sections more somehow (tabs?).
- Shorten JSON/CSV output sample blocks and remove corresponding schema descriptions (comprehensive examples are enough). (See guide: Comparing Experiments #2862 (review) and below.)
- Format CSV samples if possible (even if that's not how they're output exactly)
- Clarify
exp diffsections to separate cases: workspace vs.HEAD, rev A vs rev B, etc. (See guide: Comparing Experiments #2862 (review) and below.) - Distinguish experiments that ran vs queued ones (
exo show/list).
Metadata
Metadata
Assignees
Labels
C: guideContent of /doc/user-guideContent of /doc/user-guidetype: enhancementSomething is not clear, small updates, improvement suggestionsSomething is not clear, small updates, improvement suggestions