Skip to content

Latest commit

 

History

History
45 lines (34 loc) · 2.53 KB

reuserGuide.md

File metadata and controls

45 lines (34 loc) · 2.53 KB
Raw

Reuser guide

If you are reusing Label, these instructions will be usefull. Also have a look at the project architecture.

Add documents you want to annotate

The courDeCassation/storage-example contains two folders:

  • documents : the documents you want to annotate. Look at courDeCassation/storage-example/documents/123452.json for an example of the fields you are supposed to fill. The only required fields are:
    • dateDecision: the date of the document
    • originalText: the text of the document. Every paragraph has to be separated by \n
    • sourceId: the unique ID of the document, which must also be its name ("{ID}.json")
  • annotations: the initial annotations for a document. If you don't have an automatic annotator, copy/paste the courDeCassation/storage-example/annotations/123452.json content.

The folder used by LABEL is courDeCassation/storage. If you want to reuse the storage-example folder as is, simply rename it to storage.

Edit the annotation settings

  • Open the packages/courDeCassation/settings
  • Edit the file, for each category:
    • anonymization: text with which the annotated text is replaced. %c / %d are respectively iterating letters / numbers
    • color:
      • darkMode: color of the category when in dark mode. The available colors are the shades of MaterialUI
      • lightMode: color of the category when in light mode. The available colors are the shades of MaterialUI
    • iconName: the icon name in the packages/generic/client/src/components/generic/materialUI/Icon.tsx file. All the used icons are Material UI.
    • order: order the category is displayed in the annotator interface
    • text: name of the category displayed in the annotator interfaces

Use the tool to annotate your documents

  • Log in with the following credentials:
  • Select the document you want to annotate - you can pick among max 3 available documents
  • Annotate it with the annotation interface
  • Validate the decision by clicking on "Valider"

Use the tool to review the annotated documents

  • Log in with the following credentials:
  • Select the "Décisions traitées" tab on the left menu
  • Hover the document you want to open, then click on "Ouvrir la décision"
  • Click on the Copy icon on the bottom-right hand corner to copy the anonymzed text in the clipboard