poltextlab's picture
usage guide update (gated access)
36d8eeb verified
---
license: mit
language:
- multilingual
tags:
- zero-shot-classification
- text-classification
- pytorch
metrics:
- accuracy
- f1-score
extra_gated_prompt: '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'
extra_gated_fields:
Name: text
Country: country
Institution: text
E-mail: text
Use case: text
---
# xlm-roberta-large-spanish-party-cap-v3
## Model description
An `xlm-roberta-large` model finetuned on multilingual training data containing texts of the `party` domain labelled 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
```python
from transformers import AutoTokenizer, pipeline
tokenizer = AutoTokenizer.from_pretrained("xlm-roberta-large")
pipe = pipeline(
model="poltextlab/xlm-roberta-large-spanish-party-cap-v3",
task="text-classification",
tokenizer=tokenizer,
use_fast=False,
token="<your_hf_read_only_token>"
)
text = "We will place an immediate 6-month halt on the finance driven closure of beds and wards, and set up an independent audit of needs and facilities."
pipe(text)
```
### Gated access
Due to the gated access, you must pass the `token` parameter when loading the model. In earlier versions of the Transformers package, you may need to use the `use_auth_token` parameter instead.
## Model performance
The model was evaluated on a test set of 3041 examples (10% of the available data).<br>
Model accuracy is **0.75**.
| label | precision | recall | f1-score | support |
|:-------------|------------:|---------:|-----------:|----------:|
| 0 | 0.64 | 0.67 | 0.65 | 183 |
| 1 | 0.7 | 0.59 | 0.64 | 126 |
| 2 | 0.86 | 0.79 | 0.83 | 150 |
| 3 | 0.86 | 0.78 | 0.82 | 88 |
| 4 | 0.77 | 0.75 | 0.76 | 235 |
| 5 | 0.81 | 0.83 | 0.82 | 234 |
| 6 | 0.67 | 0.77 | 0.72 | 88 |
| 7 | 0.71 | 0.85 | 0.78 | 53 |
| 8 | 0.4 | 0.64 | 0.49 | 59 |
| 9 | 0.88 | 0.85 | 0.87 | 117 |
| 10 | 0.85 | 0.82 | 0.83 | 219 |
| 11 | 0.68 | 0.76 | 0.71 | 225 |
| 12 | 0.79 | 0.77 | 0.78 | 77 |
| 13 | 0.64 | 0.74 | 0.68 | 211 |
| 14 | 0.81 | 0.76 | 0.79 | 84 |
| 15 | 0.75 | 0.71 | 0.73 | 154 |
| 16 | 0.77 | 0.49 | 0.6 | 49 |
| 17 | 0.83 | 0.77 | 0.8 | 249 |
| 18 | 0.78 | 0.73 | 0.75 | 298 |
| 19 | 0.67 | 0.5 | 0.57 | 32 |
| 20 | 0.83 | 0.82 | 0.82 | 110 |
| macro avg | 0.75 | 0.73 | 0.73 | 3041 |
| weighted avg | 0.76 | 0.75 | 0.75 | 3041 |
## 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).
## Debugging and issues
This architecture uses the `sentencepiece` tokenizer. In order to run 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.