guide: "Comparing Experiments" improvements
See original GitHub issueExtracted from https://github.com/iterative/dvc.org/pull/2862#pullrequestreview-781399419 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.)
- #3160 ?
- Review “baseline” concept. Apply to explanations and branch names? Per https://github.com/iterative/dvc.org/pull/2862#pullrequestreview-781399419
- Cover
exp show
first (exp list
later). Per https://github.com/iterative/dvc.org/pull/2862#discussion_r730339949
Specific ideas
- Address https://github.com/iterative/dvc.org/pull/2908#pullrequestreview-775523131 .
- Cover
deps/dependencies
column. See #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 show
vsexp diff
). - Include/mention
--only-changed
per https://github.com/iterative/dvc.org/pull/2966 . - Avoid terms “git ref” and “attached”. (Use “based on” for consistency?)
-
--sort/order-by/no-timestamp
sections 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 https://github.com/iterative/dvc.org/pull/2862#pullrequestreview-783758097 and below.)
- Format CSV samples if possible (even if that’s not how they’re output exactly)
- Clarify
exp diff
sections to separate cases: workspace vs.HEAD
, rev A vs rev B, etc. (See https://github.com/iterative/dvc.org/pull/2862#pullrequestreview-783894016 and below.) - Distinguish experiments that ran vs queued ones (
exo show/list
).
Issue Analytics
- State:
- Created 2 years ago
- Comments:9 (9 by maintainers)
Top Results From Across the Web
Designing comparative experiments | Nature Methods
This generalizes the t-test for comparing three or more levels while maintaining better power than comparing all sets of two levels.
Read more >A Step-by-Step Guide to Smart Business Experiments
A Step-by-Step Guide to Smart Business Experiments · 1. Focus on individuals and think short term. · 2. Keep it simple. · 3....
Read more >How to Improve Validity of a Scientific Investigation - Study.com
There are a number of ways of improving the validity of an experiment, including controlling more variables, improving measurement technique, ...
Read more >Guide to Experimental Design | Overview, 5 steps & Examples
Experimental design is the process of planning an experiment to test a hypothesis. The choices you make affect the validity of your results....
Read more >A practical guide to product experimentation | by Yifei Huang
With properly executed controlled experiments, on the other hand, one can establish a quantified and causal relationship between the inputs ...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
In https://github.com/iterative/dvc.org/pull/3220 new type of column
depencendies
/deps
is included. Should we add a checklist here ?I’ve added #3160 to write a synopsis section.