Skip to content

Latest commit

 

History

History
156 lines (129 loc) · 5.59 KB

README.md

File metadata and controls

156 lines (129 loc) · 5.59 KB
Raw

Python package codecov DOI

e2e-Dutch

Code for e2e coref model in Dutch. The code is based on the original e2e model for English, and modified to work for Dutch. If you make use of this code, please cite it and also cite the original e2e paper.

This code can be used with a pre-trained model for Dutch, trained on the SoNaR-1 dataset. The model file and documentation can be found at 10.5281/zenodo.5153574

Installation

Requirements:

  • Python 3.6 or 3.7
  • pip
  • tensorflow v2.0.0 or higher

In this repository, run:

pip install -r requirements.txt
python setup.py install

Alternatively, you can install directly from Pypi (this might not work for all operating systems):

pip install tensorflow
pip install e2e-Dutch

For developers

If you plan to make changes to the code, or train your own model, make sure to install e2e-Dutch in developers mode:

pip install -r requirements.txt
python setup.py install
pip install pytest pytest-cov

And then run the tests to see whether installation has run correctly:

python -c 'import stanza; stanza.download("nl")'
python -m e2edutch.download -v
python setup.py test

Quick start - Stanza

e2edutch can be used as part of a Stanza pipeline.

Coreferences are added similarly to Stanza's entities:

  • a Document has an attribute clusters that is a List of coreference clusters;
  • a coreference cluster is a List of Stanza Spans.
import stanza
import e2edutch.stanza

stanza.download('nl') # This downloads the stanza models if not yet available

nlp = stanza.Pipeline(lang='nl', processors='tokenize,coref')

doc = nlp('Jan liep met Fido over straat. Hij wilde oversteken maar de hond wilde niet.')
print ([[span.text for span in cluster] for cluster in doc.clusters])
# Output: doc = nlp('Jan liep met Fido over straat. Hij wilde oversteken maar de hond wilde niet.')

The e2e-Dutch model files are automatically downloaded to the stanza resources directory when loading the pipeline.

Quick start

A pretrained model is available to download:

python -m e2edutch.download [-d DATAPATH]

This downloads the model files, the default location is the data directory inside the python package location. It can also be set manually with the DATAPATH argument, or by specifying the enviornment vairable E2E_HOME.

The pretrained model can be used to predict coreferences on a conll 2012 files, jsonlines files, NAF files or plain text files (in the latter case, the stanza package will be used for tokenization).

python -m e2edutch.predict [-h] [-o OUTPUT_FILE] [-f {conll,jsonlines,naf}] [-m MODEL] [-c WORD_COL] [--cfg_file CFG_FILE] [--model_cfg_file MODEL_CFG_FILE] [-v] input_filename

positional arguments:
  input_filename

optional arguments:
  -h, --help            show this help message and exit
  -o OUTPUT_FILE, --output_file OUTPUT_FILE
  -f {conll,jsonlines,naf}, --format_out {conll,jsonlines,naf}
  -m MODEL, --model MODEL
                        model name
  -c WORD_COL, --word_col WORD_COL
  --cfg_file CFG_FILE   config file
  --model_cfg_file MODEL_CFG_FILE
                        model config file
  -v, --verbose

The user-specific configurations (such as data directory, data files, etc) can be provided in a separate config file, the defaults are specified in cfg/defaults.conf. The options model_cfg_file and model are relevant when you want to use a user-specified model instead of the pretrained model to predict (see the section below on how to train a model).

Example

An example of using the predict script:

echo "Jan liep met Fido over straat. Hij wilde oversteken maar de hond wilde niet." > example.txt
python -m e2edutch.predict example.txt

Gives output:

#begin document (example);

example	0	Jan	(0)
example	1	liep	-
example	2	met	-
example	3	Fido	(1)
example	4	over	-
example	5	straat	(2)
example	6	.	-

example	0	Hij	(0)
example	1	wilde	-
example	2	oversteken	-
example	3	maar	-
example	4	de	(3
example	5	hond	3)
example	6	wilde	-
example	7	niet	-
example	8	.	-

#end document

Train your own model

To train a new model:

  • Make sure the model config file (default: e2edutch/cfg/models.conf) describes the model you wish to train
  • Make sure your config file (default: e2edutch/cfg/defaults.conf) includes the data files you want to use for training
  • Run scripts/setup_train.sh e2edutch/cfg/defaults.conf. This script converts the conll2012 data to jsonlines files, and caches the word and contextualized embeddings.
  • If you want to enable the use of a GPU, set the environment variable:
export GPU=0
  • Run the training script:
python -m e2edutch.train <model-name>

Citing this code

If you use this code in your research, please cite it as follows:

@misc{YourReferenceHere,
author = {
            Dafne van Kuppevelt and
            Jisk Attema
         },
title  = {e2e-Dutch},
doi    = {10.5281/zenodo.4146960},
url    = {https://github.com/Filter-Bubble/e2e-Dutch}
}

As the code is largely based on original e2e model for English, please make sure to also cite the original e2e paper.