[NESTED] guide: Exp implementation details, naming into Overview #3006
Conversation
jorgeorpinel
commented
Nov 4, 2021
jorgeorpinel
commented
| Experiments will have an auto-generated ID like `exp-bfe64` by default. A custom | ||
| name can be given instead (using the `--name`/`-n` option of `dvc exp run`). | ||
|
|
||
| > ID or name can be used to reference experiments with `dvc exp` subcommands. |
There was a problem hiding this comment.
@iesahin I'm not 100% sure this is right or consistent with the language you've used in other guides. Are exp-abcde called "IDs" or "auto-generated names"? Are the Git hashes called IDs instead? The hashes don't exist for queued experiments so it may be confusing to call those IDs.
We should make sure this terminology makes sense and is consistent 🙂 - let's figure it out here and I'll apply everywhere else.
There was a problem hiding this comment.
I was using ID and name interchangeably to tell exp-abc123 like names, which can be specified with --name option to dvc exp run. Unfortunately, there are places that we need to tell refs/exps/abc123eeefff333/ IDs as commit IDs.
You're right that we should avoid ID to denote the former, and call the latter commit ID instead. Could this be the naming convention?
There was a problem hiding this comment.
"commit ID" may also be confusing though. We already have a term for that I think? I.e. SHA or commit hash.
Maybe we only need "SHA/hash" and "name"? Avoid "ID" completely. WDYT?
There was a problem hiding this comment.
Could we put "experiment name" to the glossary? When we mention it for the first time, we can link to it.
I'll try to avoid ID completely.
Commit hash = SHA-256 of Git commits
Experiment name = exp-123ab like names in experiments.
There was a problem hiding this comment.
Can we have a wiki page about these notes, and review time to time? @jorgeorpinel
| Experiments will have an auto-generated ID like `exp-bfe64` by default. A custom | ||
| name can be given instead (using the `--name`/`-n` option of `dvc exp run`). |
There was a problem hiding this comment.
Also (@iesahin), Running Experiments doesn't cover --name so I had to mention the command directly from here. It'd be ideal if there's a section there to link from here instead...
There was a problem hiding this comment.
Added a check box about this to #2768 for now.
|
@jorgeorpinel let's merge this, to then review the main one. It's hard otherwise. Probably not the best case to use nesting (it's better when changes do not overlap much / independent by their nature - not when they both change the same files for the same reason). |
Are you sure @shcheklein ? It's going to make reviewing #2909 harder. We could leave this unmerged until the main one is approved instead. Agree that so far nesting hasn't been more helpful than the complications it introduces. I'll stop trying 😓 |
* guide: add DVC Experiments page and links + some copy edits * guide: remove checkpoint related changes * guide: remove `dvc experiments` long cmd autolinks per #2901 * guide: move run-cache section back to Exp Mgmt index bottom per #2909 (review) * guide: Exp Mgmt/ DVC Exps -> Exps Overview per #2909 (review) * guide: clear separation between Exp Mgmt index and Overview page rel #2909 (comment) * guide: single guide for Persisting Exps content and fix links * guide: begin extracting Exp details from Running to Overview rel #2909 (comment) * guide: make ToC entry for Run Cache section rel #2909 (comment) * Update content/docs/user-guide/experiment-management/index.md Co-authored-by: Ivan Shcheklein <[email protected]> * [NESTED] guide: Exp implementation details, naming into Overview (#3006) * guide: bring exp implementation details and naming from ref. per #2909 (review) * guide: copy edits to exp naming info. * guide: emphasize dvc exps are not part of Git tree in overview rel #2909 (review) * guide: ID->name in dvc exps overview per #2909 (review) * guide: ID->name in other exp guides rel #2909 (review) * guide: Visualize->Review in exp/overview/basic-workflow per #2909 (review) * guide: don't say "cleans the slate" in exp/overview/basic-workflow per #2909 (review) * giude: soften params description in exps index per #2909 (review) * guide: generalize dvc exps basic workflow * guide: Properties section in DVC Exps overview page * guide: exp init section in Exp Overview page * guide: clarify dvc exp implementation * guide: expand on Exp Overview motivation per #2909 (comment) * guide: direct language in Exp Overview/ workflow intro per #2909 (comment) * guide: mention metrics in exp init intro (Exp Overview) per #2909 (comment) * guide: intro exp init before giving specific examples of what it does per #2909 (comment) * guide: hint forach stages for hybrid exp org pattern rel. #2909 (comment) * guide: exp mgmt index copy edits * guide: mention label-based exp organization rel. https://docs.google.com/presentation/d/1C_owNoC72GvrpyMGlonHEYJ9I2rl2SLHkZQDMx0eT7A/edit#slide=id.gcb78e52e40_0_635 * guide: hide exp naming section in overview page and other details per #2909 (comment) et al. * guide: mention `exp init -i` in Overview per #2909 (comment) * guide: typo fix per #2909 (comment) * ref: exp apply copy edits per #2909 (review) * ref: mention init before exp init per #2909 (review) * guide: correct info aboug exp init in Exp Overview per pending comments in #2909 (review) * ref: link from exp init to corresponding guide * guide: make exp intro more concrete per #2909 (comment) * guide: rewrite exp init section of Exps Overview page per #2909 (review) * ref: roll back unrelated ref changes (moved to ref/exp-misc) * guide: roll back unrelated changes (moved to #3080) Co-authored-by: Ivan Shcheklein <[email protected]>
* guide: add DVC Experiments page and links + some copy edits * guide: remove checkpoint related changes * guide: remove `dvc experiments` long cmd autolinks per #2901 * guide: move run-cache section back to Exp Mgmt index bottom per #2909 (review) * guide: Exp Mgmt/ DVC Exps -> Exps Overview per #2909 (review) * guide: clear separation between Exp Mgmt index and Overview page rel #2909 (comment) * guide: single guide for Persisting Exps content and fix links * guide: begin extracting Exp details from Running to Overview rel #2909 (comment) * guide: make ToC entry for Run Cache section rel #2909 (comment) * Update content/docs/user-guide/experiment-management/index.md Co-authored-by: Ivan Shcheklein <[email protected]> * [NESTED] guide: Exp implementation details, naming into Overview (#3006) * guide: bring exp implementation details and naming from ref. per #2909 (review) * guide: copy edits to exp naming info. * guide: emphasize dvc exps are not part of Git tree in overview rel #2909 (review) * guide: ID->name in dvc exps overview per #2909 (review) * guide: ID->name in other exp guides rel #2909 (review) * guide: Visualize->Review in exp/overview/basic-workflow per #2909 (review) * guide: don't say "cleans the slate" in exp/overview/basic-workflow per #2909 (review) * giude: soften params description in exps index per #2909 (review) * guide: generalize dvc exps basic workflow * guide: Properties section in DVC Exps overview page * guide: exp init section in Exp Overview page * guide: clarify dvc exp implementation * guide: expand on Exp Overview motivation per #2909 (comment) * guide: direct language in Exp Overview/ workflow intro per #2909 (comment) * guide: mention metrics in exp init intro (Exp Overview) per #2909 (comment) * guide: intro exp init before giving specific examples of what it does per #2909 (comment) * guide: hint forach stages for hybrid exp org pattern rel. #2909 (comment) * guide: exp mgmt index copy edits * guide: mention label-based exp organization rel. https://docs.google.com/presentation/d/1C_owNoC72GvrpyMGlonHEYJ9I2rl2SLHkZQDMx0eT7A/edit#slide=id.gcb78e52e40_0_635 * guide: hide exp naming section in overview page and other details per #2909 (comment) et al. * guide: mention `exp init -i` in Overview per #2909 (comment) * guide: typo fix per #2909 (comment) * ref: exp apply copy edits per #2909 (review) * ref: mention init before exp init per #2909 (review) * guide: correct info aboug exp init in Exp Overview per pending comments in #2909 (review) * ref: link from exp init to corresponding guide * guide: make exp intro more concrete per #2909 (comment) * guide: rewrite exp init section of Exps Overview page per #2909 (review) * ref: roll back unrelated ref changes (moved to ref/exp-misc) * guide: roll back unrelated changes (moved to #3080) Co-authored-by: Ivan Shcheklein <[email protected]>
