Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
Added Studio docs #2455
Added Studio docs #2455
Changes from 7 commits
76acd79
d8dc64b
a4e1813
54a6b21
a7665b4
aff29ea
0cb54e8
9ffd9af
4462653
6ec82c3
49e66fe
82550d1
15f1b71
9865910
b241ae8
5d7b96b
782a384
7774313
30af001
5284553
83e223a
23369fa
5c39c9d
756347c
ce22026
7eb44e3
1b14980
4ba41b1
997f022
0640323
6a96e64
8d14bc3
2fb4a5d
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why not markdown?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wanted to specify width, coz it's a small image and get stretched otherwise. How do I do it in markdown?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm I think the intention is for the image itself to be resized to be 300 pixels wide rather than specify this in markdown. Not sure though. @jorgeorpinel suggestions?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think @casperdcl is right — making the image that size is the best solution.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is about retina-like display support. Unlike the blog engine, DVC.org doesn't process images properly. And effective you have to put extra white-background and do 2xWidth to them not look blurry and at the same moment be smaller then the viewport, or even of the same size but not blurry. E.g. https://dvc.org/doc/use-cases/versioning-data-and-model-files here images are wrong (not enough width to properly render them on the retina-like displays).
In blog we have a special logic and additional Markdown support for this (check the contributors guide).
@tapadipti
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually, seeing /doc/studio/visualize-experiments I'm not getting why we want the image to be so small.
These images are really small, hard to tell what's going on in there. It's already a bit of a problem in the Create a View page, but here they're quite unreadable:
Why not let them take the full width (already not a huge space) like in /doc/studio/create-view#share-a-view? Just cut out unnecessary parts and make them a bit long, e.g. use something like this for the first one:
Idk about retina display (maybe a separate issue?) but the images in the Versioning use case look OK on my screen. They top one is 1026 px wide BTW, and only 14 KB (in case that's the concern here).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
they are blurry on retina screens ... as I mentioned blog engine has a lot of specific mechanics to handle all of this properly. Including making them clickable (to read). Let's not address this for now here.
I agree though that it's fine to keep images bigger. Again, not a top priority. Let's focus on fixing bugs, something that we can quickly commit and move on. Everything else move to checkboxes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TBH I haven't found anything that would prevent a merge here. Maybe for now we can keep some unresolved reviews and I'll move them to issues/checkboxes/PRs when this is merged?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we mention it's visual? Maybe something like
DVC Studio is a comprehensive and interactive web application to manage and collaborate on Machine Learning projects visually.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the overall document explains about the tool being visual. So maybe we can skip it in this sentence. What do you think?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is the opening sentence so I consider it pretty important. We'll address later 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should probably be moved down after or even merged with Invite collaborators.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added to new ticket #2468
This comment was marked as resolved.
Sorry, something went wrong.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should "compare" be reflected in the sidebar label?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ideally yes. But that will make the sidebar item too long. Any suggestions on how to keep it short?
This comment was marked as resolved.
Sorry, something went wrong.
This comment was marked as resolved.
Sorry, something went wrong.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah my initial review only focused on the overall structure with that same idea. And before reading all the content I was pretty confused by the titles. Isn't a "View" a visualization?
Reading into the View page, it's defined as "an interactive representation of the experiments run in your ML project," which sounds the same as visualizing experiments.
After reading the content in this page in detail I see that we mean specific experiments, which makes total sense. But before that this was confusing.
But yes I see now that it's not low-hanging fruit, so let's just leave this unresolved for now and we'll revisit later. Thanks
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added to new ticket #2468