README.md

---
license: apache-2.0
language: en
datasets:
- imdb
tags:
- sentiment-analysis
---

# Funnel Transformer small (B4-4-4 with decoder) fine-tuned on IMDB for Sentiment Analysis

This are the model weights for the Funnel Transformer small model fine-tuned on the IMDB dataset for performing Sentiment Analysis.

The original model weights for English language are from [funnel-transformer/small](https://huggingface.co/funnel-transformer/small) and it uses a similar objective objective as [ELECTRA](https://huggingface.co/transformers/model_doc/electra.html). It was introduced in [this paper](https://arxiv.org/pdf/2006.03236.pdf) and first released in [this repository](https://github.com/laiguokun/Funnel-Transformer). This model is uncased: it does not make a difference between english and English.

## Fine-tuning Results

|                               | Accuracy | Precision | Recall   | F1       |
|-------------------------------|----------|-----------|----------|----------|
| funnel-transformer-small-imdb | 0.956530 | 0.952286  | 0.961075 | 0.956661 |


## Model description (from [funnel-transformer/small](https://huggingface.co/funnel-transformer/small))

Funnel Transformer is a transformers model pretrained on a large corpus of English data in a self-supervised fashion. This means it was pretrained on the raw texts only, with no humans labelling them in any way (which is why it can use lots of publicly available data) with an automatic process to generate inputs and labels from those texts.

More precisely, a small language model corrupts the input texts and serves as a generator of inputs for this model, and the pretraining objective is to predict which token is an original and which one has been replaced, a bit like a GAN training.

This way, the model learns an inner representation of the English language that can then be used to extract features useful for downstream tasks: if you have a dataset of labeled sentences for instance, you can train a standard classifier using the features produced by the BERT model as inputs.

# How to use

Here is how to use this model to get the features of a given text in PyTorch:

```python
from transformers import FunnelTokenizer, FunnelModel
tokenizer = FunnelTokenizer.from_pretrained("Sreevishnu/funnel-transformer-small-imdb")
model = FunneModel.from_pretrained("Sreevishnu/funnel-transformer-small-imdb")
text = "Replace me by any text you'd like."
encoded_input = tokenizer(text, return_tensors='pt')
output = model(**encoded_input)
```