---
library_name: setfit
tags:
- setfit
- sentence-transformers
- text-classification
- generated_from_setfit_trainer
metrics:
- accuracy
widget:
- text: Artificial intelligence is changing the way we live and work.
- text: The university is offering scholarships for students in financial need.
- text: The new Marvel movie is breaking box office records.
- text: The annual Met Gala is a major event in the fashion world.
- text: Visiting the Grand Canyon is a breathtaking experience.
pipeline_tag: text-classification
inference: true
base_model: sentence-transformers/paraphrase-mpnet-base-v2
---

# SetFit with sentence-transformers/paraphrase-mpnet-base-v2

This is a [SetFit](https://github.com/huggingface/setfit) model that can be used for Text Classification. This SetFit model uses [sentence-transformers/paraphrase-mpnet-base-v2](https://huggingface.co/sentence-transformers/paraphrase-mpnet-base-v2) as the Sentence Transformer embedding model. A [LogisticRegression](https://scikit-learn.org/stable/modules/generated/sklearn.linear_model.LogisticRegression.html) instance is used for classification.

The model has been trained using an efficient few-shot learning technique that involves:

1. Fine-tuning a [Sentence Transformer](https://www.sbert.net) with contrastive learning.
2. Training a classification head with features from the fine-tuned Sentence Transformer.

## Model Details

### Model Description
- **Model Type:** SetFit
- **Sentence Transformer body:** [sentence-transformers/paraphrase-mpnet-base-v2](https://huggingface.co/sentence-transformers/paraphrase-mpnet-base-v2)
- **Classification head:** a [LogisticRegression](https://scikit-learn.org/stable/modules/generated/sklearn.linear_model.LogisticRegression.html) instance
- **Maximum Sequence Length:** 512 tokens
- **Number of Classes:** 12 classes
<!-- - **Training Dataset:** [Unknown](https://huggingface.co/datasets/unknown) -->
<!-- - **Language:** Unknown -->
<!-- - **License:** Unknown -->

### Model Sources

- **Repository:** [SetFit on GitHub](https://github.com/huggingface/setfit)
- **Paper:** [Efficient Few-Shot Learning Without Prompts](https://arxiv.org/abs/2209.11055)
- **Blogpost:** [SetFit: Efficient Few-Shot Learning Without Prompts](https://huggingface.co/blog/setfit)

### Model Labels
| Label | Examples                                                                                                                                                                                                                                                                          |
|:------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 0     | <ul><li>'The mayor announced a new initiative to improve public transportation.'</li><li>'The senator is facing criticism for her stance on the recent bill.'</li><li>'The upcoming election has sparked intense debates among the candidates.'</li></ul>                         |
| 3     | <ul><li>'Regular exercise and a balanced diet are key to maintaining good health.'</li><li>'The World Health Organization has issued new guidelines on COVID-19.'</li><li>'A new study reveals the benefits of meditation for mental health.'</li></ul>                           |
| 6     | <ul><li>'The stock market saw a significant drop following the announcement.'</li><li>'Investing in real estate can be a profitable venture if done correctly.'</li><li>"The company's profits have doubled since the launch of their new product."</li></ul>                     |
| 9     | <ul><li>'Visiting the Grand Canyon is a breathtaking experience.'</li><li>'The tourism industry has been severely impacted by the pandemic.'</li><li>'Backpacking through Europe is a popular choice for young travelers.'</li></ul>                                              |
| 12    | <ul><li>'The new restaurant in town offers a fusion of Italian and Japanese cuisine.'</li><li>'Drinking eight glasses of water a day is essential for staying hydrated.'</li><li>'Cooking classes are a fun way to learn new recipes and techniques.'</li></ul>                   |
| 15    | <ul><li>'The school district is implementing a new curriculum for the upcoming year.'</li><li>'Online learning has become increasingly popular during the pandemic.'</li><li>'The university is offering scholarships for students in financial need.'</li></ul>                  |
| 18    | <ul><li>'Climate change is causing a significant rise in sea levels.'</li><li>'Recycling and composting are effective ways to reduce waste.'</li><li>'The Amazon rainforest is home to millions of unique species.'</li></ul>                                                     |
| 21    | <ul><li>'The new fashion trend is all about sustainability and eco-friendly materials.'</li><li>'The annual Met Gala is a major event in the fashion world.'</li><li>'Vintage clothing has made a comeback in recent years.'</li></ul>                                            |
| 24    | <ul><li>"NASA's Mars Rover has made significant discoveries about the red planet."</li><li>'The Nobel Prize in Physics was awarded for breakthroughs in black hole research.'</li><li>'Genetic engineering is opening up new possibilities in medical treatment.'</li></ul>       |
| 27    | <ul><li>'The NBA Finals are set to begin next week with the top two teams in the league.'</li><li>'Serena Williams continues to dominate the tennis world with her powerful serve.'</li><li>'The World Cup is the most prestigious tournament in international soccer.'</li></ul> |
| 30    | <ul><li>'Artificial intelligence is changing the way we live and work.'</li><li>'The latest iPhone has a number of exciting new features.'</li><li>'Cybersecurity is becoming increasingly important as more and more data moves online.'</li></ul>                               |
| 33    | <ul><li>'The new Marvel movie is breaking box office records.'</li><li>'The Grammy Awards are a celebration of the best music of the year.'</li><li>'The latest season of Game of Thrones had fans on the edge of their seats.'</li></ul>                                         |

## Uses

### Direct Use for Inference

First install the SetFit library:

```bash
pip install setfit
```

Then you can load this model and run inference.

```python
from setfit import SetFitModel

# Download from the 🤗 Hub
model = SetFitModel.from_pretrained("EmeraldMP/ANLP_kaggle")
# Run inference
preds = model("The new Marvel movie is breaking box office records.")
```

<!--
### Downstream Use

*List how someone could finetune this model on their own dataset.*
-->

<!--
### Out-of-Scope Use

*List how the model may foreseeably be misused and address what users ought not to do with the model.*
-->

<!--
## Bias, Risks and Limitations

*What are the known or foreseeable issues stemming from this model? You could also flag here known failure cases or weaknesses of the model.*
-->

<!--
### Recommendations

*What are recommendations with respect to the foreseeable issues? For example, filtering explicit content.*
-->

## Training Details

### Training Set Metrics
| Training set | Min | Median  | Max |
|:-------------|:----|:--------|:----|
| Word count   | 8   | 11.0833 | 17  |

| Label | Training Sample Count |
|:------|:----------------------|
| 0     | 3                     |
| 3     | 3                     |
| 6     | 3                     |
| 9     | 3                     |
| 12    | 3                     |
| 15    | 3                     |
| 18    | 3                     |
| 21    | 3                     |
| 24    | 3                     |
| 27    | 3                     |
| 30    | 3                     |
| 33    | 3                     |

### Training Hyperparameters
- batch_size: (16, 16)
- num_epochs: (1, 1)
- max_steps: -1
- sampling_strategy: oversampling
- num_iterations: 20
- body_learning_rate: (2e-05, 2e-05)
- head_learning_rate: 2e-05
- loss: CosineSimilarityLoss
- distance_metric: cosine_distance
- margin: 0.25
- end_to_end: False
- use_amp: False
- warmup_proportion: 0.1
- seed: 42
- eval_max_steps: -1
- load_best_model_at_end: False

### Training Results
| Epoch  | Step | Training Loss | Validation Loss |
|:------:|:----:|:-------------:|:---------------:|
| 0.0111 | 1    | 0.1765        | -               |
| 0.5556 | 50   | 0.0137        | -               |

### Framework Versions
- Python: 3.10.12
- SetFit: 1.0.3
- Sentence Transformers: 2.7.0
- Transformers: 4.38.2
- PyTorch: 2.2.1+cu121
- Datasets: 2.18.0
- Tokenizers: 0.15.2

## Citation

### BibTeX
```bibtex
@article{https://doi.org/10.48550/arxiv.2209.11055,
    doi = {10.48550/ARXIV.2209.11055},
    url = {https://arxiv.org/abs/2209.11055},
    author = {Tunstall, Lewis and Reimers, Nils and Jo, Unso Eun Seo and Bates, Luke and Korat, Daniel and Wasserblat, Moshe and Pereg, Oren},
    keywords = {Computation and Language (cs.CL), FOS: Computer and information sciences, FOS: Computer and information sciences},
    title = {Efficient Few-Shot Learning Without Prompts},
    publisher = {arXiv},
    year = {2022},
    copyright = {Creative Commons Attribution 4.0 International}
}
```

<!--
## Glossary

*Clearly define terms in order to be accessible across audiences.*
-->

<!--
## Model Card Authors

*Lists the people who create the model card, providing recognition and accountability for the detailed work that goes into its construction.*
-->

<!--
## Model Card Contact

*Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors.*
-->