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.

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

[WIP] cmd: experiment #1926

Closed
wants to merge 30 commits into from
Closed

[WIP] cmd: experiment #1926

wants to merge 30 commits into from

Conversation

pmrowla
Copy link
Contributor

@pmrowla pmrowla commented Nov 11, 2020

@pmrowla pmrowla self-assigned this Nov 11, 2020
@shcheklein shcheklein temporarily deployed to dvc-landing-experiments-ixzhup November 11, 2020 08:58 Inactive
A set of commands to generate and compare local _experiments_:
[show](/doc/command-reference/exp/show),
[checkout](/doc/command-reference/exp/show),
[diff](/doc/command-reference/exp/diff), [run](/doc/command-reference/exp/run),
Copy link
Contributor

@jorgeorpinel jorgeorpinel Nov 12, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same: run before diff, prob? Maybe also resume before diff, even, since I think it's closely linked to run.

@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-experiments-ixzhup November 12, 2020 07:32 Inactive
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-experiments-ixzhup November 12, 2020 07:33 Inactive
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-experiments-ixzhup November 12, 2020 07:34 Inactive
@@ -0,0 +1,44 @@
# exp[eriments]

A set of commands to generate and compare local _experiments_:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about

Suggested change
A set of commands to generate and compare local _experiments_:
A set of commands to generate and manage <abbr>experiments</abbr>:

? (which would also need a glossary entry in content\docs\user-guide\basic-concepts)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

p.s. The keyword/term here being "experiment management".

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

BUT this brings up another issue which is: how do we clearly distinguish between regular experiments (e.g. in https://dvc.org/doc/start/experiments) and the special experiments enabled by this feature? Do we need to come up with terminology like "DVC experiment" and use it consistently (along with the tooltip I suggested above)? Cc @shcheklein

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The terminology is definitely an issue, we could maybe use the "ephemeral experiment vs formal/committed experiment" wording that was suggested way back in the original discussion.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Briefly discussed this with Ivan and it turns out there may not be a need to disambiguate: all experiments are experiments, it's just that some are committed. It's more a distinction in the way they are managed, but we can leave that explanation to an "Experiment Management" guide or use case that we should write (not in this PR of course).

Copy link
Contributor

@jorgeorpinel jorgeorpinel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Initial review of nav, titles, and index page.

@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Jan 28, 2021

See https://github.com/iterative/dvc/wiki/Experiments for ref. (may not be complete)

@pmrowla do you know what is missing or outdates in the wiki? Are those things already covered in this PR? Would be great to get help from you to update the wiki or list what else has changed. I can discover some things during QA (doing now) but may miss some things.

@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-experiments-mla0kx January 28, 2021 03:01 Inactive
@pmrowla
Copy link
Contributor Author

pmrowla commented Jan 28, 2021

See https://github.com/iterative/dvc/wiki/Experiments for ref. (may not be complete)

@pmrowla do you know what is missing or outdates in the wiki? Are those things already covered in this PR? Would be great to get help from you to update the wiki or list what else has changed. I can discover some things during QA (doing now) but may miss some things.

For the command reference everything in this PR should be up-to-date with the wiki, but checkpoints usage is going to be changing again this sprint, so there will be at least one more command reference update coming

@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-experiments-mla0kx January 31, 2021 07:42 Inactive
@jorgeorpinel
Copy link
Contributor

OK I'm going to break this PR into several so it's easier to manage. PRs that address my own feedback and other updates coming up finally... See you soon.

Comment on lines +1 to +3
# exp resume

Resume (continue) existing checkpoint experiments.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This ended up as exp run --resume right? Is there a PR or explanation of the differences? That seems outdated in https://github.com/iterative/dvc/wiki/Experiments too. Feel free to suggest in #2200 (options list of exp run).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants