neulab / explainaboard_web

MIT License
8 stars 2 forks source link

Add Metric Description in System Submit Drawer Page #495

Closed noelchen90 closed 1 year ago

noelchen90 commented 1 year ago

This PR adds Metric Description link in system submit drawer page. This is part of #426 UI Optimization plan, bullet point number 14.

14.They (test users) were not familiar with some of the metrics. They would love to have more explanations (e.g. what is lexical diversity). (proposed by Ying)

The New Look

Next Steps

I will add link to metric description in the Analysis page as well.

noelchen90 commented 1 year ago

@lyuyangh Thank you for your suggestion! I feel like the question mark kind of hint is answering "Why do we need metrics?" instead of "What metrics do we support?" or "What are these metrics?" So I think it is better to add an explicit hyperlink next to the dropdown.

I have changed it to <Form.Item /> in my new commit! The new link also directs to a new tab instead of redirecting the current page.

pfliu-nlp commented 1 year ago

@noelchen90 thanks for this PR. I'm thinking about if it's possible to pop up a tooltip when the user mouse over each metric in the dropdown button. (and the tooltip will display the description of that mouse-over metric.

1667935696346
noelchen90 commented 1 year ago

Thanks for the feedbacks @neubig, @pfliu-nlp ! @neubig -- I think that is a great idea. One thing I noticed with one of the users was that he doesn't tend to hover on the tooltips unless the name is not clear (which in our case, I think all the names in our system submission page are all self-explanatory). But nonetheless, giving a tooltip is still important. @pfliu-nlp I will give it a try, but I'm not sure if it will be too messy, or not convenient for old users. I feel like the metric descriptions are for new users or users who are new with a task. I am assuming they will only click on the link for the first 2-3 times.

noelchen90 commented 1 year ago

@neubig I just modified according to your suggestion, this is the new look.

截圖 2022-11-08 下午3 41 52
pfliu-nlp commented 1 year ago

Thanks for the quick update! @noelchen90

Regarding > "but I'm not sure if it will be too messy, or not convenient for old users. I feel like the metric descriptions are for new users or users who are new with a task. I am assuming they will only click on the link for the first 2-3 times."

Personally, as an older user, I'm actually happy to see the explanation of the metric details. Also, many older users w.r.t some task are new users w.r.t evaluate metrics. And I'm sure some older users even don't know the clear definition of the metric they used every day.

noelchen90 commented 1 year ago

@lyuyangh thank you for the suggestions. Regarding this question,

do we have some programmatic way of getting the metric descriptions?

@pfliu-nlp and I are thinking of saving the metric descriptions in the backend and calling it from there. I haven't started implementing this, but Pengfei has given me some directions. This will be for another PR

noelchen90 commented 1 year ago

@lyuyangh thanks for catching this. The error message does show up now after putting it one layer down. I also added required={true} in the parent <Form.Item /> so that the asterisk still appears.

noelchen90 commented 1 year ago

Noted! I will add this minor change before I merge it!