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

start: improvements #2474

Closed
2 tasks done
flippedcoder opened this issue May 13, 2021 · 4 comments · Fixed by #3997
Closed
2 tasks done

start: improvements #2474

flippedcoder opened this issue May 13, 2021 · 4 comments · Fixed by #3997
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: start Content of /doc/start status: stale You've been groomed!

Comments

@flippedcoder
Copy link
Contributor

flippedcoder commented May 13, 2021

  • Remove the Sharing experiments section from Get Started > Experiments

We should remove the Sharing experiments section since it adds more complexity to the Get Started tutorial than there needs to be since users have to set up a Git remote as well as a DVC remote. We don't go over this at any other point in the tutorial.

If a user clones the get started repo, it works fine, but if they are following along there are some roadblocks they might run into with getting things set up. For example, I ran into a weird credentials issue with my Git remote and ended up working with @dberenbaum to do a crazy workaround.

Overall, it clouds up the purpose of this section which is running experiments.

  • Update the git add command for Get Started > Metrics, Parameters, and Plots

In the Comparing iterations section, users can get empty Old and Change values when they run dvc metrics diff because the dvc.lock and dvc.yaml are missing from the git add.

We need to update the command to be git add dvc.lock dvc.yaml scores.json prc.json roc.json.

@dberenbaum

This comment was marked as outdated.

@jorgeorpinel

This comment was marked as resolved.

@jorgeorpinel jorgeorpinel changed the title Get Started tutorial improvements start: improvements May 13, 2021
@jorgeorpinel
Copy link
Contributor

May also be good to see if we can consolidate with #1943.

@jorgeorpinel

This comment was marked as outdated.

jorgeorpinel added a commit that referenced this issue Sep 27, 2022
dberenbaum added a commit that referenced this issue Sep 27, 2022
* start: update git add

To close #2474

* Update content/docs/start/data-management/metrics-parameters-plots.md

Co-authored-by: Dave Berenbaum <dave@iterative.ai>
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: start Content of /doc/start status: stale You've been groomed!
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants