|
---
|
|
tags:
|
|
- setfit
|
|
- sentence-transformers
|
|
- text-classification
|
|
- generated_from_setfit_trainer
|
|
widget:
|
|
- text: 'green might want to hang onto that ski mask , as robbery may be the only
|
|
way to pay for his next project . '
|
|
- text: 'even horror fans will most likely not find what they ''re seeking with trouble
|
|
every day ; the movie lacks both thrills and humor . '
|
|
- text: 'the acting , costumes , music , cinematography and sound are all astounding
|
|
given the production ''s austere locales . '
|
|
- text: 'byler reveals his characters in a way that intrigues and even fascinates
|
|
us , and he never reduces the situation to simple melodrama . '
|
|
- text: 'a sequence of ridiculous shoot - ''em - up scenes . '
|
|
metrics:
|
|
- accuracy
|
|
pipeline_tag: text-classification
|
|
library_name: setfit
|
|
inference: true
|
|
base_model: sentence-transformers/paraphrase-mpnet-base-v2
|
|
model-index:
|
|
- name: SetFit with sentence-transformers/paraphrase-mpnet-base-v2
|
|
results:
|
|
- task:
|
|
type: text-classification
|
|
name: Text Classification
|
|
dataset:
|
|
name: Unknown
|
|
type: unknown
|
|
split: test
|
|
metrics:
|
|
- type: accuracy
|
|
value: 0.844559585492228
|
|
name: Accuracy
|
|
---
|
|
|
|
# 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:** 2 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 |
|
|
|:---------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| positive | <ul><li>'a powerful and reasonably fulfilling gestalt '</li><li>'while the importance of being earnest offers opportunities for occasional smiles and chuckles '</li><li>'the proud warrior that still lingers in the souls of these characters '</li></ul> |
|
|
| negative | <ul><li>'hate yourself '</li><li>'eight crazy nights is a total misfire . '</li><li>'guilty about it '</li></ul> |
|
|
|
|
## Evaluation
|
|
|
|
### Metrics
|
|
| Label | Accuracy |
|
|
|:--------|:---------|
|
|
| **all** | 0.8446 |
|
|
|
|
## 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("Data-Yang/setfit-paraphrase-mpnet-base-v2-sst2")
|
|
# Run inference
|
|
preds = model("a sequence of ridiculous shoot - 'em - up scenes . ")
|
|
```
|
|
|
|
<!--
|
|
### 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 | 3 | 7.875 | 18 |
|
|
|
|
| Label | Training Sample Count |
|
|
|:---------|:----------------------|
|
|
| negative | 8 |
|
|
| positive | 8 |
|
|
|
|
### Training Hyperparameters
|
|
- batch_size: (16, 16)
|
|
- num_epochs: (4, 4)
|
|
- max_steps: -1
|
|
- sampling_strategy: oversampling
|
|
- body_learning_rate: (2e-05, 1e-05)
|
|
- head_learning_rate: 0.01
|
|
- loss: CosineSimilarityLoss
|
|
- distance_metric: cosine_distance
|
|
- margin: 0.25
|
|
- end_to_end: False
|
|
- use_amp: False
|
|
- warmup_proportion: 0.1
|
|
- l2_weight: 0.01
|
|
- seed: 42
|
|
- eval_max_steps: -1
|
|
- load_best_model_at_end: True
|
|
|
|
### Training Results
|
|
| Epoch | Step | Training Loss | Validation Loss |
|
|
|:------:|:----:|:-------------:|:---------------:|
|
|
| 0.1111 | 1 | 0.2851 | - |
|
|
| 1.0 | 9 | - | 0.2266 |
|
|
| 2.0 | 18 | - | 0.1825 |
|
|
| 3.0 | 27 | - | 0.1699 |
|
|
| 4.0 | 36 | - | 0.1700 |
|
|
|
|
### Framework Versions
|
|
- Python: 3.12.3
|
|
- SetFit: 1.1.0
|
|
- Sentence Transformers: 3.2.1
|
|
- Transformers: 4.42.2
|
|
- PyTorch: 2.4.1+cpu
|
|
- Datasets: 3.0.2
|
|
- Tokenizers: 0.19.1
|
|
|
|
## 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.*
|
|
--> |
