3.8 KiB
User Guide
version 0.1
1. Introduction
neath is a simple, browser-based tool for editing and annotating text with named entities to produce a corpus for training/testing/evaluation. It can be used to add or correct named entity BIO-tags in a TSV file and to correct the token text or segmentation (e.g. due to OCR errors).
neath is developed at the Berlin State Library for data annotation in the context of the SoNAR-IDH project and the QURATOR project.
2. User Guide
Technical Requirements
neath runs locally as a pure HTML+JavaScript webpage in your web browser. No software needs to be installed, but JavaScript has to be enabled in the browser. Any fairly recent browser should work, but only Chrome and Firefox are tested.
Data input format
The input data format is based on the format used in the GermEval2014 Named Entity Recognition Shared Task. Text is encoded as one token per line, with name spans encoded in the BIO-scheme, provided as tab-separated values:
- the first column contains either a
#
, which signals the source the sentence is cited from, or the token position within the sentence - sentence boundaries are indicated by
0
- the second column contains the token text
- outer spans are encoded in the third column
- embedded spans are encoded in the fourth column
Example (simple):
No. TOKEN NE-TAG NE-EMB
# https://example.url
1 Donnerstag O O
2 , O O
3 1 O O
4 . O O
5 Januar O O
6 . O O
0 O O
1 Berliner B-ORG B-LOC
2 Tageblatt I-ORG O
3 . O O
0 O O
1 Nr O O
2 . O O
3 1 O O
4 . O O
0 O O
1 Seite O O
2 3 O O
For our purposes we extend this format by adding
- a fifth column for an identifier for the outer span from an authority file (in this case, the GND is used)
- column six for use as a variable
- finally, columns 7+ are used for storing pixel coordinates for facsimile snippets
Example (full):
No. TOKEN NE-TAG NE-EMB GND-ID url_id left,right,top,bottom
# https://example.url/iiif/left,right,top,bottom/full/0/default.jpg
1 Donnerstag O O - 0 174,352,358,390
2 , O O - 0 174,352,358,390
3 1 O O - 0 367,392,361,381
4 . O O - 0 370,397,352,379
5 Januar O O - 0 406,518,358,386
6 . O O - 0 406,518,358,386
0
1 Berliner B-ORG B-LOC 1086206452 0 816,984,358,388
2 Tageblatt I-ORG O 1086206452 0 1005,1208,360,387
3 . O O - 0 1005,1208,360,387
0
1 Nr O O - 0 1237,1288,360,382
2 . O O - 0 1237,1288,360,382
3 1 O O - 0 1304,1326,361,381
4 . O O - 0 1304,1326,361,381
0
1 Seite O O - 0 1837,1926,361,392
2 3 O O - 0 1939,1967,364,385
Data preparation
We also provide some Python tools that help with data wrangling.
Navigation
- use mouse wheel to scroll up and down
- use navigation
<<
and>>
to move faster - show image snippet
Tagging
- adding a tag
- removing a tag
- changing a tag
OCR correction
- editing the token text
Segmentation correction
- merging two tokens
- splitting a token
Data export/Saving progress
neath runs fully locally in the browser. Therefore it can not automatically save any changes you made to disk. You have to use the Save Changes
button in order to so manually from time to time.
If your browser automatically saves all downloads to your Downloads
folder, you might want to configure it so that it instead prompts you where to save.
Configuration option in Firefox:
Configuration option in Chrome: