inception2corpus 0.0.4

A CLI for retrieving a corpus annotated with named entities from INCEpTION to an archived, reusable and versionable corpus.

inception2corpus-CLI

A CLI for retrieving a corpus annotated with named entities from INCEpTION instance to an archived and reusable corpus in context of any NER project.

This tool was created in the context of the NER4Archives project (INRIA/Archives nationales); it is adaptable and reusable for any other project under the terms of the MIT license.

The CLI launches a linear process, called a "pipeline", which executes the components in the following order:

• Fetch curated documents from INCEpTION instance (XMI - check state of document in Inception > "Monitoring" window);

• Re-tokenize curated documents;
• Convert XMI to CONLL files;
• Merge CONLL files in one;
• Provides a report containing statistics and metadata about the corpus;
• Reduce (get only sentences annotated and reject other) and serialize dataset in 2 (train/dev) and 3 sets (train/dev/test) according to a ratio defined by the user

At the end of the execution of the program, an output_annotated_corpus folder/ is provided in the root tool's folder, for more details see this section.

🛠️ Installation

MacOSx / Linux

1. In ./inception2corpus-CLI/ location, open a terminal

2. Check if Python 3.7 or higher is installed

python --version

if not, install it here

3. Create a code environment with virtualenv and correct Python version

virtualenv --python=/usr/bin/python3.7 venv

4. Activate this code environment

source venv/bin/activate

5. Finally, install the required packages

pip install -r requirements.txt

Windows

1. In ./inception2corpus-CLI/ location, open a terminal (powershell)

2. Check if Python 3.7 or higher is installed

python --version

if not, install it here

3. Create a code environment with virtualenv and correct Python version

py -m venv venv

4. Activate this code environment

.\venv\Scripts\activate

5. Finally, install the required packages

pip install -r .\requirements.txt

⚠️ Configuration before launch the tool

• Do not delete the temp_files/ folder, leave it
• Do not delete the i2c_lib/ folder, leave it
• Go to the USER_VAR_ENV.yml file and fill it with the correct information.

▶️ Usage

First activate (Cf. Installation section) code env and then follow:

method 1) In terminal, run:

python inception2corpus.py

method 2) In terminal, run:

chmod +x inception2corpus.py

then

./inception2corpus.py

📁 Full output folder description

./output_annotated_corpus folder/
 |
 |- output_annotated_corpus folder.zip/
 |           |
 |           |- data_split_n2/ : The all_reduced.conll divided into 2 sets (train, dev)
 |           |
 |           |- data_split_n3/ : The all_reduced.conll divided into 3 sets (train, dev, test)
 |           |
 |           |- data_split_n3_idx/ : The all_reduced.conll divided into 3 sets (train, dev, test) with sentences ID
 |           |
 |           |- data_split_n2_idx/ : The all_reduced.conll divided into 2 sets (train, dev) with sentences ID
 |           |
 |           |- XMI_curated/ : Original XMI to import into INCEpTION
 |           |
 |           |- all.conll : All documents in CONLL format
 |           |- all_reduced.conll : All documents in CONLL format reduced to only annotated sentences
 |
 |- meta_corpus.json : corpus metadata and statistics