qurator-spk
/
neat
mirror of https://github.com/qurator-spk/neat.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Update User_Guide.md

Browse Source
pull/40/head
Clemens Neudecker 5 years ago committed by GitHub
parent e96c00e291
commit 93c5afc8c2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File

8
docs/User_Guide.md
Unescape Escape View File

@ -9,8 +9,8 @@
### 2. User Guide ### 2. User Guide
#### Technical Requirements #### Technical Requirements
[neath](https://github.com/qurator-spk/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. [neath](https://github.com/qurator-spk/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 #### Data format
The input data format is based on the format used in the [GermEval2014 Named Entity Recognition Shared Task](https://sites.google.com/site/germeval2014ner/data). Text is encoded as one token per line, with name spans encoded in the BIO-scheme, provided as tab-separated values: The data format is based on the format used in the [GermEval2014 Named Entity Recognition Shared Task](https://sites.google.com/site/germeval2014ner/data). 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 first column contains either a `#`, which signals the source the sentence is cited from, or
* the token position within the sentence ``>=1`` * the token position within the sentence ``>=1``
* sentence boundaries are indicated by ``0`` * sentence boundaries are indicated by ``0``
@ -80,9 +80,11 @@ We also provide some [Python tools](https://github.com/qurator-spk/neath/tree/ma
Provided facsimile images are available online via the [iiif.io](https://iiif.io/) Image API, [neath](https://github.com/qurator-spk/neath) supports the embedding of facsimile snippets into its interface to help with data annotation and correction. Provided facsimile images are available online via the [iiif.io](https://iiif.io/) Image API, [neath](https://github.com/qurator-spk/neath) supports the embedding of facsimile snippets into its interface to help with data annotation and correction.
This further requires that OCR with word segmentation is applied to the image to determine bounding boxes for tokens. This further requires that OCR with word segmentation is applied to the image to determine bounding boxes for tokens.
The iiif-image-url contained in the source ``#`` can then be used as a replacement for ``url_id`` in combination with the token bounding boxes as ``left,right,top,bottom`` to obtain the facsimile snippet url and display the image. The iiif-image-url contained in the source ``#`` can then be used as a replacement for ``url_id`` in combination with the token bounding boxes as ``left,right,top,bottom`` to obtain the facsimile snippet url and display the image in the leftmost column.
![Screenshot](./../assets/snippet.png)
Clicking on the facsimile snippet opens up a new tab with a larger context. Clicking on the facsimile snippet opens up a new tab with a larger context.
![Screenshot](./../assets/context_window.jpg)
#### Tagging #### Tagging
* adding a tag * adding a tag
* removing a tag * removing a tag

Write Preview
Loading…
Cancel
Save