Edit model card

You need to agree to share your contact information to access this model

This repository is publicly accessible, but you have to accept the conditions to access its files and content.

Our models are intended for academic use only. If you are not affiliated with an academic institution, please provide a rationale for using our models.
If you use our models for your work or research, please cite this paper: 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

Log in or Sign Up to review the conditions and access this model content.

xlm-roberta-large-portuguese-legislative-cap-v3

Model description

An xlm-roberta-large model fine-tuned on portuguese training data containing legislative documents (bills, laws, motions, legislative decrees, hearings, resolutions) 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-portuguese-legislative-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 2095 examples.
Model accuracy is 0.93.

label precision recall f1-score support
0 0.64 0.7 0.67 33
1 0 0 0 6
2 0.76 0.76 0.76 25
3 0.5 0.46 0.48 13
4 0.61 0.9 0.73 31
5 0.9 0.87 0.89 31
6 0.86 0.75 0.8 8
7 0.81 0.93 0.87 14
8 0 0 0 1
9 0.9 0.9 0.9 41
10 0.77 0.75 0.76 55
11 0.36 0.36 0.36 11
12 0.08 0.14 0.11 7
13 0.42 0.5 0.45 10
14 0.8 0.84 0.82 19
15 1 1 1 1472
16 0.83 0.73 0.78 48
17 0.88 0.92 0.9 64
18 0.79 0.79 0.79 188
19 0.5 0.14 0.22 7
20 1 0.45 0.62 11
macro avg 0.64 0.61 0.61 2095
weighted avg 0.93 0.93 0.93 2095

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.

Downloads last month
0
Inference Examples
This model does not have enough activity to be deployed to Inference API (serverless) yet. Increase its social visibility and check back later, or deploy to Inference Endpoints (dedicated) instead.

Collection including poltextlab/xlm-roberta-large-portuguese-legislative-cap-v3