[WIP] cmd-ref: document exp init #3015

skshetry · 2021-11-11T13:25:45Z

dberenbaum · 2021-11-11T19:09:17Z

@jorgeorpinel What sections do you think are needed for the cmd-ref? We will definitely want a user guide for this, but since we are trying to keep the cmd-ref more narrow, maybe we can eliminate some of these sections.

content/docs/command-reference/exp/index.md

jorgeorpinel

GH seems to have a bug where I can't leave single comments, only review comments... Sorry for the noise.

jorgeorpinel · 2021-11-11T19:23:03Z

content/docs/command-reference/exp/index.md

@@ -37,6 +38,7 @@ positional arguments:
    push                Push a local experiment to a Git remote.
    pull                Pull an experiment from a Git remote.
    remove              Remove local experiments.
+    init                Initialize experiments.


Uninformative and sounds like a requirement (like dvc init). How can we better describe what this does for the user? (I need to read the rest of the changes before I can suggest something.)

For the help output maybe a short form of a specific desc.

Codify a project variation and run it as an experiment

p.s. and re "sounds like a requirement (like dvc init)" - can we still reconsider the name? 😅
Maybe dvc exp new

jorgeorpinel

More noise... Ignore these.

jorgeorpinel

On the command description

content/docs/command-reference/exp/index.md

@@ -37,6 +38,7 @@ positional arguments:
    push                Push a local experiment to a Git remote.
    pull                Pull an experiment from a Git remote.
    remove              Remove local experiments.
+    init                Initialize experiments.


content/docs/command-reference/exp/init.md

jorgeorpinel · 2021-11-11T19:30:18Z

content/docs/command-reference/exp/init.md

+### The `command` argument
+
+The `command` argument is optional, if you are using `--interactive` mode. The
+`command` sent to `dvc exp init` can be anything your terminal would accept and


Should we put this under Options like for targets in https://dvc.org/doc/command-reference/repro#options (and other places I think) ? That was an initiative of @skshetry actually 🙂

Let's keep it as it is for now, as we also need to do something for stage add/run?

Why keep it as a section here when we moved it in repro ? We had lots of good reasons (which you proposed), what's different?

do something for stage add/run

Out of scope but we can create an issue.

Because it's better to do it at the same time for all commands. I am going with what we have right now, let's handle it later?

p.s. we don't always make changes for all commands at once, we can take them as they come. BTW I actually like a section better than having it under Options, I'm just confused since we discussed this a lot for repro and you (and Ivan) strongly argued for putting it under Options I think 🤷 now it's unclear which one is inconsistent.

Because it's better to do it at the same time for all commands. I am going with what we have right now, let's handle it later?

#3071 (review)

jorgeorpinel

Noise

content/docs/command-reference/exp/init.md

jorgeorpinel

Couple small fixes (committing...)

content/docs/command-reference/exp/init.md

jorgeorpinel · 2021-11-11T19:36:11Z

content/docs/command-reference/exp/init.md

+## Setting up custom config/Sharing configs
+
+## Non-interactive mode
+
+## Guided/Interactive mode
+
+## Examples
+
+#### Default stage
+
+#### Dvclive stage


@jorgeorpinel What sections do you think are needed for the cmd-ref? We will definitely want a user guide for this, but since we are trying to keep the cmd-ref more narrow, maybe we can eliminate some of these sections.

@dberenbaum yes we can keep it much leaner now and leave much of the details for a guide. But it's good to have a proposed structure in advance so thanks @skshetry

For now each proposed section can be a short paragraph in the description without any subtitle structure. Let's just mention the features without explaining exactly how they work as the guide will do that. For now just awareness + the help output will have to suffice I think.

jorgeorpinel

Noise

content/docs/command-reference/exp/init.md

dberenbaum · 2021-11-11T19:25:02Z

content/docs/command-reference/exp/init.md

+data, parameters, source code, models, metrics and plots, which can be
+customized through config.


Suggested change

data, parameters, source code, models, metrics and plots, which can be

customized through config.

data, parameters, source code, models, metrics and plots. The defaults

can be customized through config to reuse across projects.

How do you customize "through config"? dvc config? Config files? Which one(s). Thanks

Both? But I am not sure we need to specify that, as dvc config operates on config files, it's just a helper for that.

OK. My point is that need to be a bit more specific and/or link to what that config looks like (how it's setup). Also, separate Q:

to reuse across projects

Does that mean using user/system config? I think all these details should be somewhere else, maybe a separate subsection for now and link there from here? Thanks

yeah, I have a section below with the title Setting up custom config/Sharing configs. Just need to hyperlink it, and fill that section.

Hi @skshetry is there some more info on exp init configuration files in the wiki or somewhere? Did anything change in the config command? Thanks

content/docs/command-reference/exp/init.md

Co-authored-by: Restyled.io <[email protected]>

skshetry · 2021-12-02T17:35:45Z

content/docs/command-reference/exp/init.md

+## Non-interactive mode
+
+## Guided/Interactive mode
+


I don't really want to show all the prompts. And I think most of the information are already mentioned elsewhere, so I am thinking of leaving these fields.

Good call. If we ever make a detailed guide we can include all prompts but it's probably unnecessary (and a lot to maintain) either way.

content/docs/command-reference/exp/init.md

dberenbaum · 2021-12-06T18:09:50Z

What's the status on this @skshetry @jorgeorpinel? I can take over if needed. This should get merged today.

dberenbaum

Merging this since we need some reference available.

* cmd-ref: document exp init * Restyle [WIP] cmd-ref: document exp init (#3016) Co-authored-by: Restyled.io <[email protected]> * Apply suggestions from code review * Restyled by prettier (#3018) Co-authored-by: Restyled.io <[email protected]> * Update content/docs/command-reference/exp/index.md * Restyled by prettier (#3048) Co-authored-by: Restyled.io <[email protected]> * updates * document config * cmd-ref exp init: updates for initial merge Co-authored-by: restyled-io[bot] <32688539+restyled-io[bot]@users.noreply.github.com> Co-authored-by: Restyled.io <[email protected]> Co-authored-by: Jorge Orpinel <[email protected]> Co-authored-by: dberenbaum <[email protected]>

restyled-io bot mentioned this pull request Nov 11, 2021

Restyle [WIP] cmd-ref: document exp init #3016

Merged

shcheklein temporarily deployed to dvc-org-exp-init-doc-dd9iqakf8 November 11, 2021 13:26 Inactive

skshetry self-assigned this Nov 11, 2021

shcheklein temporarily deployed to dvc-org-exp-init-doc-dd9iqakf8 November 11, 2021 13:26 Inactive

jorgeorpinel reviewed Nov 11, 2021

View reviewed changes

content/docs/command-reference/exp/index.md Outdated Show resolved Hide resolved

jorgeorpinel reviewed Nov 11, 2021

View reviewed changes

content/docs/command-reference/exp/init.md Outdated Show resolved Hide resolved

jorgeorpinel reviewed Nov 11, 2021

View reviewed changes

content/docs/command-reference/exp/init.md Outdated Show resolved Hide resolved

restyled-io bot mentioned this pull request Nov 11, 2021

Restyle [WIP] cmd-ref: document exp init #3018

Merged

jorgeorpinel temporarily deployed to dvc-org-exp-init-doc-dd9iqakf8 November 11, 2021 19:33 Inactive

jorgeorpinel reviewed Nov 11, 2021

View reviewed changes

content/docs/command-reference/exp/init.md Outdated Show resolved Hide resolved

dberenbaum reviewed Nov 11, 2021

View reviewed changes

shcheklein temporarily deployed to dvc-org-exp-init-doc-dd9iqakf8 November 27, 2021 00:30 Inactive

restyled-io bot mentioned this pull request Nov 29, 2021

Restyle [WIP] cmd-ref: document exp init #3048

Merged

jorgeorpinel temporarily deployed to dvc-org-exp-init-doc-dd9iqakf8 November 29, 2021 23:00 Inactive

iterative deleted a comment from dberenbaum Dec 1, 2021

jorgeorpinel added the p1-important Active priorities to deal within next sprints label Dec 1, 2021

skshetry and others added 4 commits December 2, 2021 18:51

cmd-ref: document exp init

9bbfa37

Restyle [WIP] cmd-ref: document exp init (#3016)

d5aacac

Co-authored-by: Restyled.io <[email protected]>

Apply suggestions from code review

b35d5a6

Restyled by prettier (#3018)

4d00bb8

Co-authored-by: Restyled.io <[email protected]>

jorgeorpinel and others added 2 commits December 2, 2021 18:51

Update content/docs/command-reference/exp/index.md

7d701ba

Restyled by prettier (#3048)

e78d569

Co-authored-by: Restyled.io <[email protected]>

shcheklein temporarily deployed to dvc-org-exp-init-doc-dd9iqakf8 December 2, 2021 14:12 Inactive

updates

229baf5

skshetry force-pushed the exp-init-doc branch from cc2123c to 229baf5 Compare December 2, 2021 14:48

shcheklein temporarily deployed to dvc-org-exp-init-doc-dd9iqakf8 December 2, 2021 14:48 Inactive

document config

91d06dc

shcheklein temporarily deployed to dvc-org-exp-init-doc-dd9iqakf8 December 2, 2021 16:53 Inactive

skshetry commented Dec 2, 2021

View reviewed changes

content/docs/command-reference/exp/init.md Outdated Show resolved Hide resolved

cmd-ref exp init: updates for initial merge

16f3f4e

shcheklein temporarily deployed to dvc-org-exp-init-doc-dd9iqakf8 December 6, 2021 20:52 Inactive

dberenbaum mentioned this pull request Dec 6, 2021

cmd-ref: exp init stage name #3064

Closed

dberenbaum approved these changes Dec 7, 2021

View reviewed changes

dberenbaum merged commit 03db469 into master Dec 7, 2021

dberenbaum deleted the exp-init-doc branch December 7, 2021 11:43

This was referenced Dec 7, 2021

ref: exp init improvements #3071

Merged

guide: DVC Experiments Overview #2909

Merged

guide: Experiment Management (phase 2) #2911

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] cmd-ref: document exp init #3015

[WIP] cmd-ref: document exp init #3015

skshetry commented Nov 11, 2021

dberenbaum commented Nov 11, 2021

jorgeorpinel left a comment

jorgeorpinel Nov 11, 2021 •

edited

Loading

This comment was marked as resolved.

jorgeorpinel Nov 11, 2021 •

edited

Loading

jorgeorpinel left a comment •

edited

Loading

jorgeorpinel left a comment

This comment was marked as resolved.

jorgeorpinel Nov 11, 2021

skshetry Nov 22, 2021

jorgeorpinel Dec 1, 2021

skshetry Dec 2, 2021

jorgeorpinel Dec 10, 2021 •

edited

Loading

jorgeorpinel Dec 10, 2021

jorgeorpinel left a comment

jorgeorpinel left a comment

jorgeorpinel Nov 11, 2021

jorgeorpinel left a comment

dberenbaum Nov 11, 2021

jorgeorpinel Nov 12, 2021

skshetry Nov 22, 2021 •

edited by jorgeorpinel

Loading

jorgeorpinel Dec 1, 2021 •

edited

Loading

skshetry Dec 2, 2021

jorgeorpinel Dec 10, 2021

skshetry Dec 2, 2021

jorgeorpinel Dec 10, 2021 •

edited

Loading

dberenbaum commented Dec 6, 2021

dberenbaum left a comment

		data, parameters, source code, models, metrics and plots, which can be
		customized through config.

[WIP] cmd-ref: document exp init #3015

[WIP] cmd-ref: document exp init #3015

Conversation

skshetry commented Nov 11, 2021

dberenbaum commented Nov 11, 2021

jorgeorpinel left a comment

Choose a reason for hiding this comment

jorgeorpinel Nov 11, 2021 • edited Loading

Choose a reason for hiding this comment

This comment was marked as resolved.

jorgeorpinel Nov 11, 2021 • edited Loading

Choose a reason for hiding this comment

jorgeorpinel left a comment • edited Loading

Choose a reason for hiding this comment

jorgeorpinel left a comment

Choose a reason for hiding this comment

This comment was marked as resolved.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jorgeorpinel Dec 10, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jorgeorpinel left a comment

Choose a reason for hiding this comment

jorgeorpinel left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jorgeorpinel left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

skshetry Nov 22, 2021 • edited by jorgeorpinel Loading

Choose a reason for hiding this comment

jorgeorpinel Dec 1, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jorgeorpinel Dec 10, 2021 • edited Loading

Choose a reason for hiding this comment

dberenbaum commented Dec 6, 2021

dberenbaum left a comment

Choose a reason for hiding this comment

jorgeorpinel Nov 11, 2021 •

edited

Loading

jorgeorpinel Nov 11, 2021 •

edited

Loading

jorgeorpinel left a comment •

edited

Loading

jorgeorpinel Dec 10, 2021 •

edited

Loading

skshetry Nov 22, 2021 •

edited by jorgeorpinel

Loading

jorgeorpinel Dec 1, 2021 •

edited

Loading

jorgeorpinel Dec 10, 2021 •

edited

Loading