This is a web service for EstNLTK's CoreferenceTagger v1.
Before setting up the web service, you need to obtain the coreference model and stanza's parsing model for Estonian.
-
You can download the coreference model from https://entu.keeleressursid.ee/api2/file-24972. Unpack the zipped content into root directory. After all necessary model files have been assembled, the local directory
coreferenceshould have the following structure:coreference/ └── model_2021-01-04 ├── estonian_configuration_files │ ├── estonian_cases.xml │ ├── estonian_catalog.xml │ ├── estonian_embeddings.xml │ ├── estonian_sentence_context.xml │ ├── estonian_syntactic_functions.xml │ └── estonian_tag_set.xml ├── estonian_resources │ ├── estonian_abstractness_lexicon │ │ └── abstractness_ET.txt │ ├── estonian_embeddings │ │ └── lemmas.cbow.s100.w2v.bin │ ├── estonian_global_mention_scores │ │ └── estonian_mentions_score.txt │ ├── estonian_mentions │ │ └── estonian_mentions.txt │ └── estonian_training_data_preprocessed │ ├── estonian-computed-features.txt │ └── estonian_training_corpus-sklearn.txt └── model_readme.md -
Install stanza and download stanza's Estonian model via command:
python -c "import stanza; stanza.download('et', model_dir='stanza_resources')"
After downloading, the local directory stanza_resources should have the following content:
stanza_resources/
├── et
│ ├── default.zip
│ ├── depparse
│ │ └── edt.pt
│ ├── lemma
│ │ └── edt.pt
│ ├── pos
│ │ └── edt.pt
│ ├── pretrain
│ │ └── edt.pt
│ └── tokenize
│ └── edt.pt
└── resources.json
The configuration follows the configuration used in https://github.com/liisaratsep/berttaggernazgul .
The Docker image can be built with 3 configurations that can be defined by a build argument NAURON_MODE. By default, the image contains a Gunicorn + Flask API running CoreferenceTagger. The GATEWAY configuration creates an image that only contains the API which posts requests to a RabbitMQ message queue server. The WORKER configuration creates a worker that picks up requests from the message queue and processes them.
The RabbitMQ server configuration can be defined with environment variables MQ_HOST, MQ_PORT, MQ_USERNAME and MQ_PASSWORD. The web server can be configured with the default Gunicorn parameters by using the GUNICORN_ prefix.
Docker compose configuration to run separate a gateway and worker containers with RabbitMQ:
TODO
To quickly test if the webservice has been set up properly and appears to run OK, try the following curl query:
curl http://127.0.0.1:5000/estnltk/tagger/coreference_v1 -H "Content-Type: application/json" -d '{"text": "Piilupart Donald, kes kunagi ei anna järele, läks uuele ringile. Ta kärkis ja paukus, kuni muusika vaikis ja pasadoobel seiskus. Mis sa tühja mässad, küsis rahvas.", "meta": {}, "layers": "{}", "output_layer": "coreference_v1"}'
Expected result:
{"ambiguous":false,"attributes":[],"meta":{},"name":"coreference_v1","relations":[{"annotations":[{}],"named_spans":{"mention":[10,16],"pronoun":[18,21]}},{"annotations":[{}],"named_spans":{"mention":[10,16],"pronoun":[65,67]}},{"annotations":[{}],"named_spans":{"mention":[10,16],"pronoun":[133,135]}}],"secondary_attributes":[],"serialisation_module":"relations_v0","span_names":["pronoun","mention"]}