Star experiments in table

[maxagin]

Description: We want to be able to label/mark a single experiment in the table to be able to find it easter.
Original inspiration - gmail stars.
This task is a part of the bigger story #1720

User story

Iterating on get started repo recently I got lost quickly with all the combinations. Since the dataset name is the same, size in that case was not signalling to me much, etc. I had "good enough" iterations, but it was impossible to put some label, pin, group, save filter, etc.

TODO

• Be able to add and remove the mark/s (star) from exp/s
• Checkpoints can have stars.
• Select a few checkpoints to remove stars.
• Horizontal scroll. To keep the “stars” section (and exp title?) fixed at the left side
• If a row with checkpoints is folded, we need a sort of way to show that there are checkpoints with stars hidden

• Check how does it impact other panels, quick pick, etc?

Related: Quick Pick + Star Experiments #2106

Figma specs

[maxagin]

Here is a first draft. Let's check if the concept is answering all the needs.

[shcheklein]

I like starts since bc of its simplicity. Alternative / complimentary ideas:

• pins (and they go up to the top of the screen)
• custom labels (similar to GH labels)

any other ideas?

[maxagin]

go up to the top of the screen

I feel like this may be a bit too much - flying sections. Also if the starred sections are fixed at the top and the user starred 15 sections the significant part of the view will be blocked.

custom labels

Question: one or multiple colors? The colors added automatically, every new label - new color?

[maxagin]

Another idea: when row is selected (checkbox) - able to choose one of the options.
Actually just more advanced than stars - multiple options.

[shcheklein]

If we do a full menu like this it can be part of the right-click menu that we already have I think. Overall, too advanced I think.

[maxagin]

Overall, too advanced I think.

Yeah. The symbols (stars) may serve the purpose. I would say the advanced is handy, only if we have the scenarios that explicitly show usefulness of this functionality.

[shcheklein]

Okay, we can start with stars. It's some improvement. I'm a bit worried that we are taking some space from the table with this.

I would though make it part of a bigger user story - "help navigate in a lot of experiments". Improvements like these starts, sticky headers (you mentioned them, and I think it should be p1!), things like renaming experiments (and naming them properly when we run them) + ability to add some context to an experiment (labels, comments, etc). This ticket is one of the items, but a bigger epic/story is needed to discuss all the other things together with the DVC team.

[maxagin]

I'm a bit worried that we are taking some space from the table with this.

a. This way or another we will need this space for row controls (probably)
b. Currently there is already some empty space and this is enough

I would though make it part of a bigger user story

I had the same feeling after finding that I can actually merge 3 tasks to one. Well at list use the same UI. This is a global concept. Will try to find a way to collect and maybe visualize the ideas.

[shcheklein]

Anyways, let's finalize this one (starts and extras if needed to control them, .e.g. do we need a toggle to show starts only? how does it impact other panels, quick pick, etc). It's not a top priority atm, but it would be good to have it in Figma with all the details to hand if off, wdyt?

[maxagin]

After the discussion with @dberenbaum : Need to be able to remove all stars at once.

[maxagin]

Need to be able to remove all stars at once.

@shcheklein wdyt? Does it make sense to you?

[shcheklein]

@shcheklein wdyt? Does it make sense to you?

yep, sounds fine. I would also say that we need to be able to show only "stars".

[maxagin]

be able to show only "stars".

Good. @shcheklein this is already included at Questions, considerations #1676 (comment) - "Do we need a toggle to show starts only?"

[maxagin]

@shcheklein yesterday I have added summary to this ticket, let me know if you have any comments

[shcheklein]

@maxagin yep, looks like a good start! thanks 🙏

Now if we are migrating the discussion about the high level stuff into the #1720 , I would hide the first 4 comments and move the most important summary from them into the #1720 as a motivation / discussion.

[maxagin]

The specs are published. Please review and let me know your thoughts and comments - Figma specs

[shcheklein]

for example, include actions with the stars
for the checkpoints as there are no actions that can be taken

looks like a contradiction? Or I'm missing something ...

[maxagin]

You are right. This is my bad, this is the only action (in the context menu), for now, that can be associated with the stars and yes if we want to remove multiple stars by selecting rows, then the checkboxes will be in every row of the table. Great !

[maxagin]

Check how does it impact other panels, quick pick, etc?

@shcheklein I do not see how this may impact the quick pick or the sidebar. Am I missing something?
@wolmir any ideas in regards to this?

[shcheklein]

Some ideas:

• show stars / or highlight in some other way starred experiments in the table
• quick pick - show quick find a starred experiment and select it in the table
• quick pick - start / unstar - not sure how much it is needed tbh
• ribbon - do we want to also show starts?
• in the existing dropdowns / menus where we can see the list of the experiments - do we want to see stars or not
• filter - show only starred? (overall we need to see if need to have some toggles for this, sorts, etc)

[maxagin]

highlight in some other way starred experiments in the table

@shcheklein Why do we want to do this, if we already have the star on this exp?

quick pick - show quick find a starred experiment and select it in the table

Adding this to TODO

quick pick - start / unstar

Possible scenario: show quick find exp + star this exp. Adding it to TODO

ribbon - do we want to also show starts?

How about the checkpoints?
How about the checkboxes? Is there a case when we would like to apply an action for expS in the plots webview?

in the existing dropdowns / menus where we can see the list of the experiments - do we want to see stars or not

I do not recall we have any menus with expS. Example, please.

filter - show only starred? (overall we need to see if need to have some toggles for this, sorts, etc)

I think this belongs to a different development phase. I have recently created a special ticket for it: https://github.com/iterative/design/issues/18
WDYT?

[wolmir]

@shcheklein Should the user be able to star experiments while some of them are running?

Currently we disable the context-menu in this case

[shcheklein]

It's fine to keep the menu disabled for simplicity (probably we'll have the remove action available soon though) but it's also fine to allow stars on all the experiments in any state. Again, for simplicity. Unless it creates more problems with implementation.

[maxagin]

I have updated the Figma specs. Also nested stars concept is included (first version). Please share your comments.

[wolmir]

@maxagin @shcheklein
Demo of single experiment selection

Screen.Recording.2022-06-23.at.17.24.29.mov

[maxagin]

Great! Thank you @wolmir . Minor: The colours I have used have better contrast than in the theme you're using. But this is fine for now.

[maxagin]

@wolmir can you show how it looks in different themes? Thanks

[wolmir]

@maxagin

Screen.Recording.2022-06-23.at.17.37.48.mov

Screen.Recording.2022-06-23.at.17.39.47.mov

[maxagin]

@wolmir I have made some adjustments, basically just changed the icon star. Now it is an empty star, which gives more contrast. The specs are updated. Let me know if you have any questions. Thanks !

[maxagin]

@wolmir this is also will be fixed soon.

[wolmir]

@wolmir this is also will be fixed soon.

Sure, but my plan is to make a PR for the table stars only, and then a separate one for the ribbons, if that's ok

[maxagin]

@wolmir yeah... but the attachment above is from stars Figma, but never mind I will share soon the fix for the selected row star, which will also have an only empty symbol.

[maxagin]

@wolmir here we are. Figma is updated. Thanks

[maxagin]

@wolmir the Figma was fully updated.

[maxagin]

@wolmir have you had a chance to work on the nested stars? Stars for the checkpoints?

[wolmir]

I worked on them, yes

[wolmir]

@maxagin @shcheklein Demo with ctx-menu options:

@maxagin I'm using the old stars icon, but I'll update it

Screen.Recording.2022-06-26.at.14.50.21.mov

[wolmir]

First PR for this story is up

[shcheklein]

@wolmir @maxagin anything else left here? move to smaller tickets?

[maxagin]

@wolmir do you want to create a ticket for those two that are left so we could close this one?

• quick pick - show quick find a starred experiment and select it in the table
• quick pick - start / unstar. Possible scenario: show quick find exp + star this exp

[maxagin]

@wolmir just a reminder if you missed the message above:

@wolmir do you want to create a ticket for those two that are left so we could close this one?

quick pick - show quick find a starred experiment and select it in the table
quick pick - start / unstar. Possible scenario: show quick find exp + star this exp

[wolmir]

Thanks @maxagin !

Created the new issue here: #2106