|
|
|
--- |
|
--- |
|
language: |
|
- de |
|
tags: |
|
- text-classification |
|
- pytorch |
|
metrics: |
|
- accuracy |
|
- f1-score |
|
--- |
|
# xlm-roberta-large-german-parlspeech-cap-v3 |
|
## Model description |
|
An `xlm-roberta-large` model fine-tuned on german training data containing parliamentary speeches (oral questions, interpellations, bill debates, other plenary speeches, urgent questions) labeled with [major topic codes](https://www.comparativeagendas.net/pages/master-codebook) from the [Comparative Agendas Project](https://www.comparativeagendas.net/). |
|
|
|
## How to use the model |
|
This snippet prints the three most probable labels and their corresponding softmax scores: |
|
```python |
|
import torch |
|
from transformers import AutoModelForSequenceClassification, AutoTokenizer |
|
|
|
model = AutoModelForSequenceClassification.from_pretrained("poltextlab/xlm-roberta-large-german-parlspeech-cap-v3") |
|
tokenizer = AutoTokenizer.from_pretrained("xlm-roberta-large") |
|
|
|
sentence = "This is an example." |
|
|
|
inputs = tokenizer(sentence, |
|
return_tensors="pt", |
|
max_length=512, |
|
padding="do_not_pad", |
|
truncation=True |
|
) |
|
|
|
logits = model(**inputs).logits |
|
|
|
probs = torch.softmax(logits, dim=1).tolist()[0] |
|
probs = {model.config.id2label[index]: round(probability, 2) for index, probability in enumerate(probs)} |
|
top3_probs = dict(sorted(probs.items(), key=lambda item: item[1], reverse=True)[:3]) |
|
|
|
print(top3_probs) |
|
``` |
|
|
|
## Model performance |
|
The model was evaluated on a test set of 1501 examples.<br> |
|
Model accuracy is **0.72**. |
|
| label | precision | recall | f1-score | support | |
|
|:-------------|------------:|---------:|-----------:|----------:| |
|
| 0 | 0.77 | 0.65 | 0.7 | 62 | |
|
| 1 | 0.77 | 0.8 | 0.78 | 152 | |
|
| 2 | 0.68 | 0.83 | 0.75 | 46 | |
|
| 3 | 0.71 | 0.8 | 0.75 | 51 | |
|
| 4 | 0.53 | 0.61 | 0.57 | 51 | |
|
| 5 | 0.45 | 0.54 | 0.49 | 28 | |
|
| 6 | 0.7 | 0.79 | 0.74 | 101 | |
|
| 7 | 0.76 | 0.78 | 0.77 | 65 | |
|
| 8 | 0.89 | 0.75 | 0.81 | 88 | |
|
| 9 | 0.85 | 0.87 | 0.86 | 105 | |
|
| 10 | 0.62 | 0.58 | 0.6 | 77 | |
|
| 11 | 0.72 | 0.45 | 0.55 | 40 | |
|
| 12 | 0.9 | 0.81 | 0.85 | 32 | |
|
| 13 | 0.53 | 0.61 | 0.57 | 44 | |
|
| 14 | 0.75 | 0.82 | 0.79 | 152 | |
|
| 15 | 0.63 | 0.53 | 0.58 | 32 | |
|
| 16 | 0.75 | 0.41 | 0.53 | 22 | |
|
| 17 | 0.73 | 0.81 | 0.77 | 175 | |
|
| 18 | 0.67 | 0.6 | 0.64 | 161 | |
|
| 19 | 0 | 0 | 0 | 8 | |
|
| 20 | 0.67 | 0.22 | 0.33 | 9 | |
|
| macro avg | 0.67 | 0.63 | 0.64 | 1501 | |
|
| weighted avg | 0.72 | 0.72 | 0.72 | 1501 | |
|
|
|
### Fine-tuning procedure |
|
This model was fine-tuned with the following key hyperparameters: |
|
|
|
- **Number of Training Epochs**: 10 |
|
- **Batch Size**: 8 |
|
- **Learning Rate**: 5e-06 |
|
- **Early Stopping**: enabled with a patience of 2 epochs |
|
|
|
## Inference platform |
|
This model is used by the [CAP Babel Machine](https://babel.poltextlab.com), an open-source and free natural language processing tool, designed to simplify and speed up projects for comparative research. |
|
|
|
## Cooperation |
|
Model performance can be significantly improved by extending our training sets. We appreciate every submission of CAP-coded corpora (of any domain and language) at poltextlab{at}poltextlab{dot}com or by using the [CAP Babel Machine](https://babel.poltextlab.com). |
|
|
|
## Reference |
|
Sebők, M., Máté, Á., Ring, O., Kovács, V., & Lehoczki, R. (2024). Leveraging Open Large Language Models for Multilingual Policy Topic Classification: The Babel Machine Approach. Social Science Computer Review, 0(0). https://doi.org/10.1177/08944393241259434 |
|
|
|
## Debugging and issues |
|
This architecture uses the `sentencepiece` tokenizer. In order to use the model before `transformers==4.27` you need to install it manually. |
|
|
|
If you encounter a `RuntimeError` when loading the model using the `from_pretrained()` method, adding `ignore_mismatched_sizes=True` should solve the issue. |
|
|
