twitter roberta base sentiment

Providercardiffnlp
Categorysentiment-analysis
LicenseApache-2.0
Downloads1.9K
Stars0

Overview

The twitter-roberta-base-sentiment model is a specialized encoder based on the RoBERTa architecture, fine-tuned specifically on a massive corpus of English tweets. Unlike general-purpose sentiment models, this version is optimized for the nuances of social media language, including slang, emojis, and irregular syntax. It classifies text into three distinct categories: negative, neutral, and positive. For developers, this makes it an ideal choice for building real-time brand monitoring tools, customer feedback pipelines, or social listening dashboards. It integrates seamlessly with the Hugging Face Transformers library, offering a lightweight footprint that balances inference speed with high accuracy on short-form, informal text.

Highlights

  • Fine-tuned on Twitter data for high social media accuracy
  • Three-way classification: positive, negative, and neutral
  • Seamless integration via Hugging Face Transformers library
  • Apache-2.0 license for flexible commercial deployment
  • Optimized for short-form text and informal linguistic patterns

Usage

Install
# Install Hugging Face transformers
pip install transformers torch
SDK Usage
# Load model with transformers
from transformers import AutoModel, AutoTokenizer

model = AutoModel.from_pretrained("cardiffnlp/twitter-roberta-base-sentiment")
tokenizer = AutoTokenizer.from_pretrained("cardiffnlp/twitter-roberta-base-sentiment")

Hugging Face Download

We recommend downloading the model via the Hugging Face CLI or Hub SDK.

Guidance:Before downloading, install huggingface_hub with:

Guidance
pip install -U huggingface_hub

CLI Download

Download the full repository

Download the full repository
huggingface-cli download cardiffnlp/twitter-roberta-base-sentiment

Download a single file to a local folder (e.g. config.json into ./dir)

Download a single file to a local folder (e.g. config.json into ./dir)
huggingface-cli download cardiffnlp/twitter-roberta-base-sentiment config.json --local-dir ./dir

See the official docs for more CLI options

SDK Download

SDK Download
# 模型下载
from huggingface_hub import snapshot_download
model_dir = snapshot_download('cardiffnlp/twitter-roberta-base-sentiment')

Git Download

Make sure git-lfs is installed first

Git Download
git lfs install
git clone https://huggingface.co/cardiffnlp/twitter-roberta-base-sentiment

To skip LFS large-file downloads, use:

Skip LFS
GIT_LFS_SKIP_SMUDGE=1 git clone https://huggingface.co/cardiffnlp/twitter-roberta-base-sentiment

Model files are hosted on the Hugging Face Hub — download directly via HF CLI / SDK / Git, not through this site.

PyTorch / Transformers Usage

Install Transformers

Install Transformers
pip install -U transformers torch

Load the model and run inference

Load the model and run inference
from transformers import AutoModelForCausalLM, AutoTokenizer

model = AutoModelForCausalLM.from_pretrained('cardiffnlp/twitter-roberta-base-sentiment')
tokenizer = AutoTokenizer.from_pretrained('cardiffnlp/twitter-roberta-base-sentiment')

Model Download

We recommend downloading the model via the ModelScope CLI or SDK.

Guidance:Before downloading, install ModelScope with:

Guidance
pip install modelscope

CLI Download

Download the full repository

Download the full repository
modelscope download --model cardiffnlp/twitter-roberta-base-sentiment

Download a single file to a local folder (e.g. README.md into ./dir)

Download a single file to a local folder (e.g. README.md into ./dir)
modelscope download --model cardiffnlp/twitter-roberta-base-sentiment README.md --local_dir ./dir

See the docs for more CLI options

SDK Download

SDK Download
# 模型下载
from modelscope import snapshot_download
model_dir = snapshot_download('cardiffnlp/twitter-roberta-base-sentiment')

Git Download

Make sure git-lfs is installed first

Git Download
git lfs install
git clone https://www.modelscope.cn/cardiffnlp/twitter-roberta-base-sentiment.git

To skip LFS large-file downloads, use:

Skip LFS
GIT_LFS_SKIP_SMUDGE=1 git clone https://www.modelscope.cn/cardiffnlp/twitter-roberta-base-sentiment.git

ModelScope 模型页直接下载模型文件;无需将模型文件放在本站服务器。

Notebook Quickstart

Install the ModelScope library

Install the ModelScope library
pip install "modelscope[audio,cv,nlp,multi-modal,science]" -f https://modelscope.oss-cn-beijing.aliyuncs.com/releases/repo.html

Load the model and run inference

Load the model and run inference
from modelscope.pipelines import pipeline
from modelscope.utils.constant import Tasks

p = pipeline('text-generation', 'cardiffnlp/twitter-roberta-base-sentiment')

Full Documentation

来源: HuggingFace

---
datasets:

  • tweet_eval

language:
  • en

---

Twitter-roBERTa-base for Sentiment Analysis

This is a roBERTa-base model trained on ~58M tweets and finetuned for sentiment analysis with the TweetEval benchmark. This model is suitable for English (for a similar multilingual model, see XLM-T).

<b>Labels</b>:
0 -> Negative;
1 -> Neutral;
2 -> Positive

<b>New!</b> We just released a new sentiment analysis model trained on more recent and a larger quantity of tweets.
See twitter-roberta-base-sentiment-latest and TweetNLP for more details.

Example of classification

python
from transformers import AutoModelForSequenceClassification
from transformers import TFAutoModelForSequenceClassification
from transformers import AutoTokenizer
import numpy as np
from scipy.special import softmax
import csv
import urllib.request

Preprocess text (username and link placeholders)

def preprocess(text): new_text = [] for t in text.split(" "): t = '@user' if t.startswith('@') and len(t) > 1 else t t = 'http' if t.startswith('http') else t new_text.append(t) return " ".join(new_text)

Tasks:

emoji, emotion, hate, irony, offensive, sentiment

stance/abortion, stance/atheism, stance/climate, stance/feminist, stance/hillary

task='sentiment'
MODEL = f"cardiffnlp/twitter-roberta-base-{task}"

tokenizer = AutoTokenizer.from_pretrained(MODEL)

download label mapping

labels=[] mapping_link = f"https://raw.githubusercontent.com/cardiffnlp/tweeteval/main/datasets/{task}/mapping.txt" with urllib.request.urlopen(mapping_link) as f: html = f.read().decode('utf-8').split("\n") csvreader = csv.reader(html, delimiter='\t') labels = [row[1] for row in csvreader if len(row) > 1]

PT

model = AutoModelForSequenceClassification.from_pretrained(MODEL) model.save_pretrained(MODEL)

text = "Good night 😊"
text = preprocess(text)
encoded_input = tokenizer(text, return_tensors='pt')
output = model(**encoded_input)
scores = output[0][0].detach().numpy()
scores = softmax(scores)

# TF

model = TFAutoModelForSequenceClassification.from_pretrained(MODEL)

model.save_pretrained(MODEL)

text = "Good night 😊"

encoded_input = tokenizer(text, return_tensors='tf')

output = model(encoded_input)

scores = output[0][0].numpy()

scores = softmax(scores)

ranking = np.argsort(scores)
ranking = ranking[::-1]
for i in range(scores.shape[0]):
l = labels[ranking[i]]
s = scores[ranking[i]]
print(f"{i+1}) {l} {np.round(float(s), 4)}")

Output:

code
1) positive 0.8466
2) neutral 0.1458
3) negative 0.0076

BibTeX entry and citation info

Please cite the reference paper if you use this model.

bibtex
@inproceedings{barbieri-etal-2020-tweeteval,
    title = "{T}weet{E}val: Unified Benchmark and Comparative Evaluation for Tweet Classification",
    author = "Barbieri, Francesco  and
      Camacho-Collados, Jose  and
      Espinosa Anke, Luis  and
      Neves, Leonardo",
    booktitle = "Findings of the Association for Computational Linguistics: EMNLP 2020",
    month = nov,
    year = "2020",
    address = "Online",
    publisher = "Association for Computational Linguistics",
    url = "https://aclanthology.org/2020.findings-emnlp.148",
    doi = "10.18653/v1/2020.findings-emnlp.148",
    pages = "1644--1650"
}
Join our Telegram