---
# System prepended metadata

title: User Interface Guide

---


# User Interface Guide
 
 
The project is based on a custom [Prodigy](https://spacy.io/universe/project/prodigy) implementation and spreadsheet filling.

There is a [Video](https://youtu.be/6uJeQH-x5bQ?list=PLz2B-3dKNCh78zoDPMF9e1Sun020VDuXB) guidance on how to use the above. Nonetheless, here is a written guide that you can have for your convenience whilst annotating 😌.


> **Note**
Please use the <u>Chrome</u> browser on any operating system, because the Javascript code has been tested on Chrome only, thank you for your understanding.



## Multi-User session
To do the annotation one should access the website \*\*\*.\*\*\*.\*\*\*.\*\*\*/9080 and insert your username in there.

When you log in to session  \*\*\*.\*\*\*.\*\*\*.\*\*\*/9080, you should insert your username given by Filippos Ventirozos. Hence, let's suppose your username is Alex then you should type in the URL instead  \*\*\*.\*\*\*.\*\*\*.\*\*\*/9080/?session=Alex

## Methodology

The Annotation process can be thought of like three steps. The Named Entity, Relation Extraction and Table Annotation. For the first two, you would press the second and the first button respectively in the below Image (Labelling Dock), then for the Table Annotation you would press the PSV Button.

#### Labelling dock
![](https://i.imgur.com/j0oP6iq.png)

![](https://i.imgur.com/NYczTqf.png)

#### PSV Button
![](https://i.imgur.com/tVvlirS.png)


#### 1. Named Entity Spanning
The annotator should firstly use the top part of Prodigy to mark the spans of the Named Entities. The annotator joins together under one common span if the tokens are adjacent and belong under the same Named Entity.

#### 2. Relation Extraction
Then one would do the Relation Extraction. The direction matters in some cases, but not all. The annotator would annotate by clicking first the span from which they want the arrow/link to start and the span to where they want the arrow to finish.

One can use the below interactive node-graph to see what they have annotated so far. Feel free to press the "Refresh" button on the bottom right corner of the graph pane to update the visuals.

#### 3. Table Annotation
Then one should download the pipe separated values (PSV) file by pressing the bottom "PSV" button. And continue the Table Annotation. 

---
## Buttons 🖥

In your annotation session in Prodigy, you will notice some square-shaped buttons at the bottom of your screen. You can find that you can use also keyboard shortcuts. You can find that by hovering atop of them.

### Accept
![](https://i.imgur.com/3wiNZ63.png)

You should press this button once you have finished with the whole process of the Annotation with the particular recipe. Including any post annotation process [[#3 Table Annotation 👏]].


### Undo
![](https://i.imgur.com/ghmQqY1.png)

Should you press the above button by accident, you can use the undo, and go back to what you have been annotating. You can also select a particular recipe to revisit from the history list in the left pane. See below:
![](https://i.imgur.com/Sfss0rF.png)

### Reject
![](https://i.imgur.com/ZQ87AzN.png)

Always read first, the recipe. If there is a word missing, or a grammatical mistake press the reject button.
In addition, if there is a tokenisation error (words joined together which didn't suppose) press the reject button as well.

### Skip
![](https://i.imgur.com/hZXFl4t.png)

In case a recipe is tricky and you haven't familiarised with the Special Cases (in blockquotes) sections you can press the skip button 😉. You can come to that recipe at a later stage.

## Good Practises

Before you Annotate make sure:
1. The graph is working by pressing the RESET button, bottom right of the graph pane.
2. The PSV button works.
3. There are no tokenisation issues.
4. Remeber to insert your username in the URL.

If any of the above occurs, press the Reject button, and please let me know.



