<commit_before>
ixa-pipe-nerc
=============

ixa-pipe-nerc is a multilingual Sequence Labeler for tasks such as Named Entity
Recognition (NERC), Opinion Target Extraction (OTE) and SuperSense Tagging (SST).
**Current version is 1.6.0**

ixa-pipe-nerc is part of IXA pipes, a multilingual set of NLP tools developed
by the IXA NLP Group [http://ixa2.si.ehu.es/ixa-pipes].

Please go to [http://ixa2.si.ehu.es/ixa-pipes] for general information about the IXA
pipes tools but also for **official releases, including source code and binary
packages for all the tools in the IXA pipes toolkit**.

This document is intended to be the **usage guide of ixa-pipe-nerc**. If you really need to clone
and install this repository instead of using the releases provided in
[http://ixa2.si.ehu.es/ixa-pipes], please scroll down to the end of the document for
the [installation instructions](#installation).

**NOTICE!!**: ixa-pipe-nerc is now in [Maven Central](http://search.maven.org/)
for easy access to its API.

## TABLE OF CONTENTS

1. [Overview of ixa-pipe-nerc](#overview)
  + [Available features](#features)
  + [NERC distributed models](#nerc-models)
  + [OTE distributed models](#ote-models)
2. [Usage of ixa-pipe-nerc](#cli-usage)
  + [NERC tagging](#tagging)
  + [Opinion Target Extraction (OTE)](#ote)
  + [Server mode](#server)
  + [Training your own models](#training)
  + [Evaluation](#evaluation)
3. [API via Maven Dependency](#api)
4. [Git installation](#installation)

## OVERVIEW

ixa-pipe-nerc provides:

+ **NERC** for Basque, English, Spanish, Dutch, German and Italian. The named entity types are based on:
   + **CONLL**: LOCATION, MISC, ORGANIZATION and PERSON. See [CoNLL 2002](http://www.clips.ua.ac.be/conll2002/ner/) and [CoNLL 2003](http://www.clips.ua.ac.be/conll2003/ner/) for more information.
   + **SONAR-1**: for Dutch, six main types, including CoNLL types plus PRODUCT and EVENT.
   + **Ancora**: for Spanish, six main types, including CoNLL types plus DATE and NUMBER.
+ **Opinion Target Extraction** (OTE) for English. The models are trained on the SemEval 2014 and 2015 datasets;
  **ixa-pipe-nerc was the best system** in [SemEval 2015 OTE subtask within task 12](http://alt.qcri.org/semeval2015/task12/).
+ **SuperSense Tagging** (SST) for English. The models are trained on Semcor.

Every model is self-contained, that is, the prop files are not needed to use them.
You will find for each model a properties file describing its training although it is
not needed to run the model. Please see the traininParams.properties template file<commit_msg>update evalita entities type<commit_after>
ixa-pipe-nerc
=============

ixa-pipe-nerc is a multilingual Sequence Labeler for tasks such as Named Entity
Recognition (NERC), Opinion Target Extraction (OTE) and SuperSense Tagging (SST).
**Current version is 1.6.0**

ixa-pipe-nerc is part of IXA pipes, a multilingual set of NLP tools developed
by the IXA NLP Group [http://ixa2.si.ehu.es/ixa-pipes].

Please go to [http://ixa2.si.ehu.es/ixa-pipes] for general information about the IXA
pipes tools but also for **official releases, including source code and binary
packages for all the tools in the IXA pipes toolkit**.

This document is intended to be the **usage guide of ixa-pipe-nerc**. If you really need to clone
and install this repository instead of using the releases provided in
[http://ixa2.si.ehu.es/ixa-pipes], please scroll down to the end of the document for
the [installation instructions](#installation).

**NOTICE!!**: ixa-pipe-nerc is now in [Maven Central](http://search.maven.org/)
for easy access to its API.

## TABLE OF CONTENTS

1. [Overview of ixa-pipe-nerc](#overview)
  + [Available features](#features)
  + [NERC distributed models](#nerc-models)
  + [OTE distributed models](#ote-models)
2. [Usage of ixa-pipe-nerc](#cli-usage)
  + [NERC tagging](#tagging)
  + [Opinion Target Extraction (OTE)](#ote)
  + [Server mode](#server)
  + [Training your own models](#training)
  + [Evaluation](#evaluation)
3. [API via Maven Dependency](#api)
4. [Git installation](#installation)

## OVERVIEW

ixa-pipe-nerc provides:

+ **NERC** for Basque, English, Spanish, Dutch, German and Italian. The named entity types are based on:
   + **CONLL**: LOCATION, MISC, ORGANIZATION and PERSON. See [CoNLL 2002](http://www.clips.ua.ac.be/conll2002/ner/) and [CoNLL 2003](http://www.clips.ua.ac.be/conll2003/ner/) for more information.
   + **Evalita 2009**: LOCATION, GPE, ORGANIZATION and PERSON.
   + **SONAR-1**: for Dutch, six main types, including CoNLL types plus PRODUCT and EVENT.
   + **Ancora**: for Spanish, six main types, including CoNLL types plus DATE and NUMBER.
+ **Opinion Target Extraction** (OTE) for English. The models are trained on the SemEval 2014 and 2015 datasets;
  **ixa-pipe-nerc was the best system** in [SemEval 2015 OTE subtask within task 12](http://alt.qcri.org/semeval2015/task12/).
+ **SuperSense Tagging** (SST) for English. The models are trained on Semcor.

Every model is self-contained, that is, the prop files are not needed to use them.
You will find for each model a properties file describing its training although it is
not needed to run the model. Please see the traininParams.properties template file
{'fraction_non_alphanumeric': 0.11902942300343905, 'fraction_numerical': 0.018723729461215134, 'mean_word_length': 4.487421383647798, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 4, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2510071', 'n_tokens_mistral': 1759, 'n_tokens_neox': 1610, 'n_words': 643}