
# 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:** 3 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                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|:------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 1     | <ul><li>'I don’t drink much but I like wine tasting. We usually buy local wine to take to dinners and such as we rarely drink wine. (NGL, I am a beer drinker so I’m probably just pleb.)'</li><li>'Never do the bottom right 2 again, give you major banker/tech bro adult frat boy vibes. I can see you chugging a beer and talking about bitcoin with those looks. Upper left makes you look younger and great.'</li><li>'NGL I like pepsi much more than coke. I dunno why.'</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| 2     | <ul><li>'?? angolbryggeri - Hazy Crazy\n\n✴️ IPA\n\n?? Sweden ????\n\n??Abv 6.5%\n\n⭐️ 3.60 / 5.0 ~ avg 3.67\n\n?? systembolaget\n\n#beer #bier #birra #öl #cerveza #øl #craftbeer #ipa #dipa #tipa #sour #gose #berlinerweisse #paleale #pilsner #lager #stout #beeroftheday #beerphotografy #hantverksöl #untappd #beergeek #beerlover #ilovebeer #cheers #beerstagram #instabeer #beerporn #ängöl #sweden'</li><li>"I'm a feast kind of guy Bring out the roast pig and Flagons of ale"</li><li>'“Just grab me a beer” legend'</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| 0     | <ul><li>"My boys (Aged 20 and 26) have moved out so I can't say what they do in their own homes but when they lived with us they were supper straight laced and had no desire to explore Alcohol or Drugs. They were into Gaming or Sports not Partying. Weed is Legal here and as far as I know they are not into that either. They definitely don't smoke, maybe they do Gummies but that would be about it."</li><li>"Like you said cost is a big one. Plus I just wonder if younger generations might not be into it as much. I can't remember the beer company, but one is talking about making a non alcoholic drink, since the younger generation aren't drinking beer as much. "</li><li>'She just graduated and I know they drink occasionally, but it’s all Mike’s Lemonade and White Claw city. Very tame stuff. Her friend group also experimented with that fake pot stuff, I forget the name. I told her I wasn’t okay with that and I’d buy her actual pot (rec is legal in my state) if she was determined to try it, but they apparently all lost interest.'</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("bhaskars113/guinness-segments-model")
# Run inference
preds = model("Can Earned the Brewery Pioneer (Level 6) badge! Earned the I Believe in IPA! (Level 5) badge!")
```

<!--
### 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   | 6   | 45.7143 | 135 |

| Label | Training Sample Count |
|:------|:----------------------|
| 0     | 14                    |
| 1     | 14                    |
| 2     | 14                    |

### 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.0095 | 1    | 0.2908        | -               |
| 0.4762 | 50   | 0.0394        | -               |
| 0.9524 | 100  | 0.0021        | -               |

### Framework Versions
- Python: 3.10.12
- SetFit: 1.0.1
- Sentence Transformers: 2.2.2
- Transformers: 4.35.2
- PyTorch: 2.1.0+cu121
- Datasets: 2.16.1
- Tokenizers: 0.15.0

## 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.*
-->
{"library_name": "setfit", "tags": ["setfit", "sentence-transformers", "text-classification", "generated_from_setfit_trainer"], "metrics": ["accuracy"], "widget": [{"text": "As someone on the line between Millenial and GenZ, yeah. Bars are expensive and loud, and ubers home are expensive. It's a lot more reasonable to pool a bit of money, throw some food on a grill, and buy our own booze. We don't have the disposable income to hang out at bars regularly."}, {"text": "When we switch main focus from college football to college basketball, I can report back on Collier. But I'll be interested to see what the guys who really crunch tape on draft prospects say as these seasons progress. I know theres more than a few here in the sub. A huge 3 with skills would be fun to stack next to Wemby though."}, {"text": "The gen Z kids I see are more risk averse in general, because exposure to a lifetime on the internet has taught them that one mistake can ruin their lives. It always blows my mind when boomers and Xers like me wonder why kids have such high anxiety these days. It\u2019s because they are regularly exposed to the judgement and horrors of the world around them. We were raised in a protective bubble mentally, in comparison"}, {"text": "Well I guess I would expect this from a beer garden but I totally agree, those vibes don\u2019t belong at Coachella"}, {"text": "Can Earned the Brewery Pioneer (Level 6) badge! Earned the I Believe in IPA! (Level 5) badge!"}], "pipeline_tag": "text-classification", "inference": true, "base_model": "sentence-transformers/paraphrase-mpnet-base-v2"}
setfit safetensors mpnet sentence-transformers text-classification generated_from_setfit_trainer arxiv:2209.11055 base_model:sentence-transformers/paraphrase-mpnet-base-v2 region:us