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

ref: Document dvc exp init #2974

Closed
iesahin opened this issue Oct 27, 2021 · 5 comments · Fixed by #3015
Closed

ref: Document dvc exp init #2974

iesahin opened this issue Oct 27, 2021 · 5 comments · Fixed by #3015
Assignees
Labels
C: ref Content of /doc/*-reference

Comments

@iesahin
Copy link
Contributor

iesahin commented Oct 27, 2021

It looks the help text is there:

$ dvc exp init --help
usage: dvc experiments init [-h] [-q | -v] [--run] [--interactive] [-f] [--explicit] [--name NAME] [--code CODE] [--data DATA] [--models MODELS]
                            [--params PARAMS] [--metrics METRICS] [--plots PLOTS] [--live LIVE] [--type {default,live}]
                            ...

Initialize experiments.
Documentation: <https://man.dvc.org/exp/init>

positional arguments:
  command               Command to execute.

optional arguments:
  -h, --help            show this help message and exit
  -q, --quiet           Be quiet.
  -v, --verbose         Be verbose.
  --run                 Run the experiment after initializing it
  --interactive, -i     Prompt for values that are not provided
  -f, --force           Overwrite existing stage
  --explicit            Only use the path values explicitly provided
  --name NAME, -n NAME  Name of the stage to create
  --code CODE           Path to the source file or directory which your experiments depend (default: src)
  --data DATA           Path to the data file or directory which your experiments depend (default: data)
  --models MODELS       Path to the model file or directory for your experiments (default: models)
  --params PARAMS       Path to the parameters file for your experiments (default: params.yaml)
  --metrics METRICS     Path to the metrics file for your experiments (default: metrics.json)
  --plots PLOTS         Path to the plots file or directory for your experiments (default: plots)
  --live LIVE           Path to log dvclive outputs for your experiments (default: dvclive)
  --type {default,live}
                        Select type of stage to create (default: default)

We don't have a dvc exp init ref page as of now.

@iesahin iesahin assigned iesahin, pmrowla and skshetry and unassigned iesahin Oct 27, 2021
@iesahin iesahin added C: ref Content of /doc/*-reference status/triage status: research Writing concrete steps for the issue and removed status/triage labels Oct 27, 2021
@skshetry
Copy link
Member

skshetry commented Oct 27, 2021

It's not documented yet. On release, it'll be listed on dvc exp --help. If user know about the command name, then it does not make sense to hide it. Of course, I should have skipped this entry on the changelog.

@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Nov 3, 2021

Yeah I think we need a larger epic to document the upgraded Experiments release actually. Let's plan it tomorrow? Cc @dberenbaum

@jorgeorpinel jorgeorpinel removed the status: research Writing concrete steps for the issue label Nov 3, 2021
@iesahin
Copy link
Contributor Author

iesahin commented Nov 9, 2021

What's the approximate release schedule for dvc exp init? @dberenbaum @skshetry

@dberenbaum
Copy link
Collaborator

November 18th

@jorgeorpinel
Copy link
Contributor

So we did not get started on this yet for several reasons, but we should soon! @dberenbaum @skshetry at this point are you available to work on a cmd ref draft? Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C: ref Content of /doc/*-reference
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants