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: update exp init intro. #3440

Closed
wants to merge 7 commits into from
Closed

Conversation

jorgeorpinel
Copy link
Contributor

extracted from #3430 (review) (by @dberenbaum )

@shcheklein shcheklein temporarily deployed to dvc-org-jorgeorpinel-pa-bhtspp April 12, 2022 05:01 Inactive
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-org-jorgeorpinel-pa-bhtspp April 12, 2022 05:03 Inactive
@jorgeorpinel jorgeorpinel requested a review from dberenbaum April 12, 2022 05:06
`dvc exp init` helps you get started with DVC Experiments quickly. It creates an
experiment pipeline in a dvc.yaml file, which assumes standard locations for the
inputs (source code, data, and <abbr>parameters</abbr>) and outputs (model,
<abbr>metrics</abbr>, and <abbr>plots</abbr>) of your model training command.
Copy link
Contributor Author

@jorgeorpinel jorgeorpinel Apr 12, 2022

Choose a reason for hiding this comment

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

@daavoo feel free to add the metrics (and plots if you can) tooltip files in this PR (if you have time soon, otherwise no worries).

@iterative iterative deleted a comment from dberenbaum Apr 29, 2022
Copy link
Contributor Author

@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.

A few more copy edits... (committing)

content/docs/command-reference/exp/init.md Outdated Show resolved Hide resolved
content/docs/command-reference/exp/init.md Outdated Show resolved Hide resolved
@jorgeorpinel
Copy link
Contributor Author

WDYT now @dberenbaum ?

@jorgeorpinel jorgeorpinel requested review from dberenbaum and daavoo and removed request for dberenbaum April 29, 2022 21:26
@gatsby-cloud
Copy link

gatsby-cloud bot commented Apr 29, 2022

Gatsby Cloud Build Report

dvc.org

🎉 Your build was successful! See the Deploy preview here.

Build Details

View the build logs here.

🕐 Build time: 1m

Performance

Lighthouse report

Metric Score
Performance 🔶 60
Accessibility 💚 98
Best Practices 🔶 83
SEO 💚 93

🔗 View full report

Comment on lines +21 to +22
`dvc exp init` helps you get started with DVC Experiments quickly. It prepares
an experiment in `dvc.yaml`, which assumes standard locations for the inputs
Copy link
Contributor

@dberenbaum dberenbaum May 2, 2022

Choose a reason for hiding this comment

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

Suggested change
`dvc exp init` helps you get started with DVC Experiments quickly. It prepares
an experiment in `dvc.yaml`, which assumes standard locations for the inputs
`dvc exp init` helps you get started with DVC Experiments quickly. It codifies
your experiment structure in `dvc.yaml`, which assumes standard locations for the inputs

Feel free to reword, but I think "prepares an experiment" makes it sound like it's something you do for every experiment instead of a framework for all your experiments.

Copy link
Contributor

Choose a reason for hiding this comment

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

Actually, I think it's hard to separate this from #3430. These look they will inevitably conflict.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Overlap is OK, we can solve conflicts 🙂

Copy link
Contributor Author

@jorgeorpinel jorgeorpinel May 11, 2022

Choose a reason for hiding this comment

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

Hmmm wait yeah you're right. This is now included completely in #3430 (review)... Closing this PR then.

@jorgeorpinel jorgeorpinel deleted the jorgeorpinel-patch-3 branch June 17, 2022 03:48
@jorgeorpinel jorgeorpinel added A: docs Area: user documentation (gatsby-theme-iterative) C: ref Content of /doc/*-reference labels Mar 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: ref Content of /doc/*-reference
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants