Add metric description link in analysis drawer

neulab / explainaboard_web

MIT License

8 stars 2 forks source link

Add metric description link in analysis drawer #496

Closed noelchen90 closed 1 year ago

noelchen90 commented 1 year ago

This PR is related to #426 UI Optimization 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)

Changes

add "Metric Description" link on the Analysis Drawer page
this button directs to https://github.com/neulab/ExplainaBoard/blob/main/docs/supported_metrics.md on a new tab

The New Look

pfliu-nlp commented 1 year ago

Hi @noelchen90, thanks for prototyping this! How about introducing the legend where the descriptions of metrics can be displayed?

from: https://echarts.apache.org/examples/zh/editor.html?c=dataset-series-layout-by

(also, the metric legends should be vertically aligned)

noelchen90 commented 1 year ago

Hi @neubig , I had an offline discussion with @pfliu-nlp and we came up with the following design (This is just a demo, not implemented yet).

On each tab, we will add a tooltip that shows the metric description.

I think this is better than just adding a link because the user doesn't need any additional click, and this seems like a reasonable place to put it. Let me know what you think!

noelchen90 commented 1 year ago

I will be starting another branch for adding metric descriptions to the backend. Regarding this PR, I will be closing it and implement the feature mentioned in the comment above.