Skip to content

Commit

Permalink
Update the IP to NOT display tag accuracy/provider
Browse files Browse the repository at this point in the history
Signed-off-by: Olga Bulat <obulat@gmail.com>
  • Loading branch information
obulat committed May 23, 2024
1 parent 452c386 commit 5323d54
Showing 1 changed file with 30 additions and 30 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -75,13 +75,7 @@ the tags by generation type, there will probably be duplicates between the
source and the generated tags. However, each section individually will still be
normalized to prevent duplicates.

The generated tags section should split the tags by different providers into
subsections, and should use the provider of the tag as the section label. For
instance, if there are tags by both `recognition` and `clarifai`, there will be
two subsections in the Generated tags section: tags generated by `recognition`
and tags generated by `clarifai`. In the future, if there are more providers,
there could be more tag sections. The tags in each subsection will be ordered by
their accuracy.
The generated tags section will have a link to the "About tags" page.

There is no need to create a separate component for machine-generated tags, the
slot in the `VTag` component will enable us to display the additional accuracy
Expand All @@ -92,7 +86,8 @@ information.
We should add a page to explain the users the difference between where the
Openverse tags come from, the difference between the source and generated tags,
and a short description of the machine-generated tag providers. This page should
be linked from the Generated tags section.
be linked from the Generated tags section. This page will not be added to the
header navigation.

## Dependencies

Expand All @@ -118,28 +113,33 @@ result pages of the Nuxt frontend.

<!-- Describe any alternatives considered and why they were not chosen or recommended. -->

We have the provider (currently, it will be "clarifai" and "rekognition") and
the accuracy data for the machine-generated tags.

There are several options of displaying these properties.

1. Do not display this data. The two tags sections will be identical.
2. The generated tags will have a tooltip that displays the tag's provider and
its accuracy.
3. Display generated tags in sections by provider so that we don't duplicate the
tag provider on each tag. Then, on each tag, display the accuracy.

The first option is the simplest to implement, however, it fails to provide the
fullest information to the users. The second option provides the accuracy and
provider information to the user, however it is not very accessible. Different
browsers and screen readers treat the tooltips differently. We have enough room
on the page to display this data in full, using the third option: labelling all
the tags generated by a single provider with a "by provider" heading, and adding
the accuracy to the tag's inner content. This way, the user will see the
provider and the accuracy of the tag without any additional actions. As a bonus,
if a tag is generated by multiple providers, the user will see that different
providers generate the same tag, and will be able to see the difference in
accuracy between the providers.
This project states that it is important to clearly distinguish the
source-generated tags from the machine-generated tags.

In addition to tag name, the machine-generated tags provide additional data
points: their provider (currently, it will be "clarifai" and "rekognition") and
their accuracy. This project aims to describe this data in a technical way on
the "About tags" page, without displaying each individual tag's additional data,
to prevent from overloading the users with too much information. Once we have
more user data on how users relate to machine-generated tags, we will reconsider
displaying this data on the single result page.

Two other options were considered for displaying the machine-generated tags, but
were discarded as they would be less user-friendly.

1. Display the tag's provider and accuracy in a tooltip. This option would
provide the user all the information about the tag without cluttering the UI.
However, this option is not good for accessibility. Different browsers and
screen readers treat the tooltips differently.
2. Display one section per each machine-generated tag provider, and label
sections with relevant heading, e.g. "Machine-Generated Tags: Rekognition".
In each section, list the tags in the order of their accuracy. Each tag would
display the tag name and the tag accuracy. This way, the user will see the
data without additional actions such as hovering. We have enough room on the
page to display this data in full. As a bonus, if a tag is generated by
multiple providers, the user will see that different providers generate the
same tag, and will be able to see the difference in accuracy between the
providers.

## Design

Expand Down

0 comments on commit 5323d54

Please sign in to comment.