pytorch eurovoc text-classification en dataset:EuropeanParliament/cellar_eurovoc arxiv:2010.12871 license:eupl-1.1 endpoints_compatible region:us
---
datasets:
- EuropeanParliament/cellar_eurovoc
language:
- en
license: eupl-1.1
metrics:
- type: f1
  value: 0.72
  name: micro F1
  args:
    threshold: 0.34
- type: NDCG@3
  value: 0.84
  name: NDCG@5
- type: NDCG@5
  value: 0.8
  name: NDCG@5
- type: NDCG@10
  value: 0.83
  name: NDCG@10
pipeline_tag: text-classification
tags:
- eurovoc
widget:
- text: The Union condemns the continuing grave human rights violations by the Myanmar
    armed forces, including torture, sexual and gender-based violence, the persecution
    of civil society actors, human rights defenders and journalists, and attacks on
    the civilian population, including ethnic and religious minorities.
---

# Eurovoc Multilabel Classifer

[EuroVoc](https://op.europa.eu/fr/web/eu-vocabularies) is a large multidisciplinary multilingual hierarchical thesaurus of more than 7000 classes covering the activities of EU institutions.
Given the number of legal documents produced every day and the huge mass of pre-existing documents to be classiﬁed high quality automated or semi-automated classiﬁcation methods are most welcome in this domain.

This model based on BERT Deep Neural Network was trained on more than 200,000 documents to achieve that task and is used in a production environment via the huggingface inference endpoint.


## Architecture

![architecture](img/architecture.png)

7331 Eurovoc labels

## Usage 

```python
from eurovoc import EurovocTagger
model = EurovocTagger.from_pretrained("EuropeanParliament/eurovoc_en")
```

## Metrics


### Eurlex57k Dataset

| Metric     | Value    | Threshold Value |
|------------|----------|-----------------|
| Micro F1   | 0.7233   | 0.34            |
| NDCG@3     | 0.8438   | -               |
| NDCG@5     | 0.8079   | -               |
| NDCG@10    | 0.833    | -               |

These values are in line with the state of the art in the field, see the publication [Large Scale Legal Text Classification Using Transformer Models](https://arxiv.org/pdf/2010.12871.pdf).


## Inference Endpoint

Member of the [European Parliament HuggingFace Organisation](https://huggingface.co/EuropeanParliament) can access to our inference endpoint.

### Payload example 

```json 
{
  "inputs": "The Union condemns the continuing grave human rights violations by the Myanmar armed forces, including torture, sexual and gender-based violence, the persecution of civil society actors, human rights defenders and journalists, and attacks on the civilian population, including ethnic and religious minorities. ",
  "topk": 10,
  "threshold": 0.16
}

```

result: 

```json 
{'results': [{'label': 'international sanctions', 'score': 0.9994925260543823},
             {'label': 'economic sanctions', 'score': 0.9991770386695862},
             {'label': 'natural person', 'score': 0.9591936469078064},
             {'label': 'EU restrictive measure', 'score': 0.8388392329216003},
             {'label': 'legal person', 'score': 0.45630475878715515},
             {'label': 'Burma/Myanmar', 'score': 0.43375277519226074}]}
```

Only six results, because the following one score is less that 0.16

Default value, topk = 5 and threshold = 0.16


## Author(s)

Sébastien Campion <sebastien.campion@europarl.europa.eu> 
