metadata

language:
  - de
tags:
  - text-classification
  - pytorch
metrics:
  - accuracy
  - f1-score

xlm-roberta-large-german-cap-v3

Model description

An xlm-roberta-large model fine-tuned on german training data labeled with major topic codes from the Comparative Agendas Project.

How to use the model

This snippet prints the three most probable labels and their corresponding softmax scores:

import torch
from transformers import AutoModelForSequenceClassification, AutoTokenizer

model = AutoModelForSequenceClassification.from_pretrained("poltextlab/xlm-roberta-large-german-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 6309 examples.
Model accuracy is 0.69.

label	precision	recall	f1-score	support
0	0.65	0.6	0.62	621
1	0.71	0.68	0.69	473
2	0.79	0.73	0.76	247
3	0.77	0.71	0.74	156
4	0.68	0.58	0.63	383
5	0.79	0.82	0.8	351
6	0.71	0.78	0.74	329
7	0.81	0.79	0.8	216
8	0.78	0.75	0.76	157
9	0.87	0.78	0.83	272
10	0.61	0.68	0.64	315
11	0.61	0.74	0.67	487
12	0.72	0.7	0.71	145
13	0.69	0.6	0.64	346
14	0.75	0.69	0.72	359
15	0.69	0.65	0.67	189
16	0.36	0.47	0.41	55
17	0.68	0.73	0.71	618
18	0.61	0.68	0.64	469
19	0	0	0	18
20	0.73	0.75	0.74	102
21	0	0	0	1
macro avg	0.64	0.63	0.63	6309
weighted avg	0.7	0.69	0.69	6309

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, 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.

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.