poltextlab's picture
Update README.md
ea306a2 verified
metadata
license: mit
language:
  - pl
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.
  Please allow us a few business days to manually review subscriptions.

  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-polish-media-cap-v3

Model description

An xlm-roberta-large model finetuned on multilingual training data containing texts of the media domain labelled with major topic codes from the Comparative Agendas Project.

How to use the model

from transformers import AutoTokenizer, pipeline

tokenizer = AutoTokenizer.from_pretrained("xlm-roberta-large")
pipe = pipeline(
    model="poltextlab/xlm-roberta-large-polish-media-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 34419 examples (20% of the available data).
Model accuracy is 0.70.

label precision recall f1-score support
0 0.65 0.64 0.65 1977
1 0.66 0.53 0.59 989
2 0.77 0.78 0.77 1886
3 0.65 0.71 0.68 561
4 0.6 0.55 0.58 753
5 0.79 0.83 0.81 1769
6 0.75 0.76 0.76 993
7 0.79 0.74 0.76 990
8 0.55 0.45 0.49 157
9 0.75 0.77 0.76 1682
10 0.65 0.68 0.66 3316
11 0.63 0.6 0.61 479
12 0.66 0.63 0.65 872
13 0.69 0.69 0.69 2278
14 0.67 0.72 0.69 2841
15 0.63 0.68 0.65 686
16 0.68 0.64 0.66 383
17 0.65 0.71 0.68 4545
18 0.8 0.71 0.75 5847
19 0.53 0.62 0.57 481
20 0.61 0.6 0.6 872
macro avg 0.69 0.64 0.64 34419
weighted avg 0.7 0.7 0.7 34419

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.

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.