
# 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 [SetFitHead](huggingface.co/docs/setfit/reference/main#setfit.SetFitHead) 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 [SetFitHead](huggingface.co/docs/setfit/reference/main#setfit.SetFitHead) instance
- **Maximum Sequence Length:** 512 tokens
- **Number of Classes:** 8 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                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|:------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 3     | <ul><li>'As a result , governments will invest more in researching the usage of these new types of energy , travelling using public transport will become much cheaper than personal car .'</li><li>'the two boys heard that he was planing to steal some money and kill people so the boys start their adventure on stoping Injuin Joe ...'</li><li>"Usually there are generation problems , sons do n't understand parents and vicecersa , but dialoging and listening emotions and facts , everyone can have another point of view ."</li></ul> |
| 5     | <ul><li>'You can also bought a lot of gifts like key chains , statue , or what else memories to be made before returning to Malaysia .'</li><li>'I asked myself many times what is the aim of our life ?'</li><li>'My name is Eider and I am 21 years old . I had read your advertisement in the newspaper !'</li></ul>                                                                                                                                                                                                                            |
| 2     | <ul><li>'They were not only really clever people but also excellent co - workers .'</li><li>'On balance , learning foreign languages is very positive on different aspect , so if you have the positivity of learning a new language do it , because it will bring you many benefits .'</li><li>'It is a job with a lot of interesting aspects ,'</li></ul>                                                                                                                                                                                        |
| 0     | <ul><li>'The third section is to print the prepared bank notes .'</li><li>"That 's why I order all of you to go there and feel the pleasure and have a try their own food ."</li><li>'No one can deny that the pollution issue is one of the utmost important thing which should be prevented .'</li></ul>                                                                                                                                                                                                                                         |
| 6     | <ul><li>"The water was very cold and I could n't swim , then I played football in the sand of the beach ."</li><li>'We have solar panels and a place to make compost at the last garden , with worms who eat and degrade all the organic waste of the school .'</li><li>'In modern societies , there are lots of friends around our daily lives .'</li></ul>                                                                                                                                                                                       |
| 7     | <ul><li>'However , people who use Facebook , Twitter or SMS in general , are not likely to have their own personal privacy that there is a possibility of cycle of bullying .'</li><li>'I been twelve years practice volleyball and because of it I knew lot of people who help me to grow up in the sport and life .'</li><li>"What about you?What 's new in Brazil?As you know , my friend John asked me to help him with the organization at the concert , which was performed last month ."</li></ul>                                          |
| 4     | <ul><li>'Something that they don know was that the whole thing was a movie !'</li><li>"If we think about it the car is better because we do n't need to wait for them has we are waiting for the bus or underground but in another way car cust more money than the public transport ."</li><li>'Recently I saw the thriller of mokingjay part 2 .'</li></ul>                                                                                                                                                                                      |
| 1     | <ul><li>'If you want to see that movie , you need to watch the first 3 movies before to understand it .'</li><li>'People collects trash of their house and await the trash truck that carried the trash to a landfill located outside the village .'</li><li>"Travelling by car is n't so much more convenient unless it is so much more comfortable , but actually we do n't think about the contamination in our planet ."</li></ul>                                                                                                             |

## Evaluation

### Metrics
| Label   | Accuracy |
|:--------|:---------|
| **all** | 0.1478   |

## 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("HelgeKn/BEA2019-multi-class-8")
# Run inference
preds = model("Had 12 years old .")
```

<!--
### 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   | 20.7031 | 56  |

| Label | Training Sample Count |
|:------|:----------------------|
| 0     | 8                     |
| 1     | 8                     |
| 2     | 8                     |
| 3     | 8                     |
| 4     | 8                     |
| 5     | 8                     |
| 6     | 8                     |
| 7     | 8                     |

### Training Hyperparameters
- batch_size: (16, 16)
- num_epochs: (2, 2)
- 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.0063 | 1    | 0.2999        | -               |
| 0.3125 | 50   | 0.2097        | -               |
| 0.625  | 100  | 0.0868        | -               |
| 0.9375 | 150  | 0.0369        | -               |
| 1.25   | 200  | 0.0208        | -               |
| 1.5625 | 250  | 0.0049        | -               |
| 1.875  | 300  | 0.0038        | -               |

### Framework Versions
- Python: 3.9.13
- SetFit: 1.0.1
- Sentence Transformers: 2.2.2
- Transformers: 4.36.0
- PyTorch: 2.1.1+cpu
- Datasets: 2.15.0
- 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": "Buses are more simple - you just buy a ticket ."}, {"text": "As citizens of village , we totally care about environment of our village ."}, {"text": "So , finally I suggest that it would be a great idea to combine the different types of activities , both popular and the newest ."}, {"text": "Had 12 years old ."}, {"text": "On the other hand , I have the theoretical knowledge to use new the technologies this great project requires ."}], "pipeline_tag": "text-classification", "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.14782608695652175, "name": "Accuracy"}]}]}]}
setfit safetensors mpnet sentence-transformers text-classification generated_from_setfit_trainer arxiv:2209.11055 base_model:sentence-transformers/paraphrase-mpnet-base-v2 model-index region:us