Icelandic NER API

This project is a minor modification to https://github.com/ditadi/ner

A dockerized and deployable Named Entity Recognition tool for Icelandic, using a ELECTRA-base Icelandic language model fined tuned for NER on the MIM-GOLD-NER corpus.

1. Make sure that Docker is properly installed
2. downlaod the zipped pytorch models directory and extract to directory ./src/bert/

3. run the following commands starting in root directory of the project to deploy locally

cd src/bert
make build
make run

Link to OpenAPI documentation

API calls

All the API calls use post and input/outputs are in a json format. Further details about the api calls are automatically generated when the container is run and can be found in /docs or /redoc

HTTP METHOD	Description
/predict	Takes in Icelandic text and returns text with icelandic named entetiy recognition

Testing

test files can be found in tests/. There are two tests that can be performed.

1. Normal api tests: this is where you test the api from the running docker image
2. ELG api tests: this is where you run docker-compose up and get an instance as if you where running the docker container on ELG. To submit a api call you then need to call /process/service.

Acknowledgements

Reykjavik University

This ELG API was developed in EU's CEF project: Microservices at your service

Underlying tool

The underlying Named Entity Recognizer is NER for AISC ML Ops by dmitriy, which is licensed under this MIT license. The original Icelandic NER API in the master branch of this repository was a minor modification to the underlying tool. Then the project was updated to conform to the ELG API standard. This version of Icelandic NER API is copied into the docker image when it is built.