Get Started: explaining code.zip contents, and plots axis options#1514
Conversation
|
Hey!
Thank you for investing so much of your attention to this. 🙌
I’ll work on the PR to improve it, of course. I’ll start by reviewing the PR, figuring out where the 200+ lines came from, clean up the text according to your input, and ping you for a review later in the day.
Qq: how do I trigger the review app myself and get the link to it? Does it deploy attomatically, or should I do some magic comment on the pr?
Nate
(650) 933-7237
…On Wed, Jul 1 2020 at 11:39 AM, Jorge Orpinel < ***@***.*** > wrote:
***@***.**** commented on this pull request.
In content/docs/start/experiments.md (
#1514 (comment) ) :
> And finally, we can compare `ROC` curves with a single command!
```dvc
+$ dvc plots modify prc.json -x recall -y precision
+$ git commit
-am "Update plots format"
+
$ dvc plots diff
file:///Users/dvc/example-get-started/plots.html
```
Well, we could just add -x and -y to the plots diff command, actually. See
https://dvc.org/doc/command-reference/plots/diff#options
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub (
#1514 (comment) ) , or
unsubscribe (
https://github.com/notifications/unsubscribe-auth/AAAKU4M56DERMGNRXDZUC63RZN7EJANCNFSM4ONCDTDA
).
|
|
Sure @xnutsive take your time.
Can't when the PR comes from a fork. We have to do it for you. But you can easily run the app locally! See https://dvc.org/doc/user-guide/contributing/docs |
natikgadzhi
changed the title
natikgadzhi
force-pushed
the
xnutsive/get-started-updates
branch
from
2cf3466 to
6bf7b4d
Compare
| If you report more than one metric to the `plots` file, you can provide | ||
| metric names to `dvc plots diff` command with `-x` and `-y` options. | ||
| See more here: [`dvc plots diff` options](https://dvc.org/doc/command-reference/plots/diff#options). |
There was a problem hiding this comment.
Probably not needed. WDYT @shcheklein ?
If keeping this, I'd put it in a block quote (>) and start "The -x and -y options select which data series..." or something like that but it's going to be difficult to write it in a way that doesn't require further explanations (for example what is a data series?) so again, probably best to avoid this...
There was a problem hiding this comment.
Maybe just "> See dvc plots diff for more info on its options, such as -x and -y used above."
There was a problem hiding this comment.
Notice that there's no need to make manual links from DVC commands. they get auto-linked when put in back ticks `.
There was a problem hiding this comment.
The goal of this paragraph, when I wrote this, was to:
- Explain how to plot different metrics if needed, and explain that that's actually possible, spark interest to experiment with different metrics like that.
- Give an example of how to do this (actually, the example plot above does this in an implicit way).
You guys probably have a better judgement on whether it's a good idea to explain this in the get started series.
There was a problem hiding this comment.
I think we want to keep the GS as simple and focused as possible. Users with interest on this can click on the dvc plots link that already exists above and learn everything about metrics and plots. We also don't talk about dvc plots show, for example... No way to cover all these options in GS directly. I personally vote to remove this note altogether but I'm OK with a very short one like I suggested above, since this is the very bottom of the doc anyway.
There was a problem hiding this comment.
Yep, I would omit it as well. In other places if explain options we explain them in the <details> section. Otherwise PR looks great to me!
|
@xnutsive the Ci checks are failing. I think it's the formatting since Restyled is also failing. Please follow the formatting explained in the contribution guide 🙂 or we can merge the Restyled PR copy instead. |
|
@jorgeorpinel, that was my bad — hooks didn't run because I removed yarn, and I didn't pay attention. Fixed both the formatting, and the content. Thanks for being patient. ;) |
jorgeorpinel
left a comment
jorgeorpinel
left a comment
There was a problem hiding this comment.
Np. no rush here.
Approved!
|
thanks @xnutsive ! |
3 participants
ls -Rto show that the code.zip already has params.yaml.dvc plots modifydetails to experiments guide.❗ Please read the guidelines in the Contributing to the Documentation list if you make any substantial changes to the documentation or JS engine.
🐛 Please make sure to mention
Fix #issue(if applicable) in the description of the PR. This causes GitHub to close it automatically when the PR is merged.Please choose to allow us to edit your branch when creating the PR.
Thank you for the contribution - we'll try to review it as soon as possible. 🙏