---
library_name: setfit
tags:
- setfit
- sentence-transformers
- text-classification
- generated_from_setfit_trainer
metrics:
- accuracy
widget:
- text: Blockbuster Cuts Online Price, Challenges Netflix (Reuters) Reuters - Video
    chain Blockbuster Inc on\Friday said it would lower the price of its online DVD
    rentals\to undercut a similar move by Netflix Inc. that sparked a stock\a sell-off
    of both companies' shares.
- text: Goss Gets Senate Panel's OK for CIA Post (AP) AP - A Senate panel on Tuesday
    approved the nomination of Rep. Porter Goss, R-Fla., to head the CIA, overcoming
    Democrats' objections that Goss was too political for the job.
- text: 'Crazy Like a Firefox Today, the Mozilla Foundation #39;s Firefox browser
    officially launched -- welcome, version 1.0. In a way, it #39;s much ado about
    nothing, seeing how it wasn #39;t that long ago that we reported on how Mozilla
    had set '
- text: North Korea eases tough stance against US in nuclear talks North Korea on
    Friday eased its tough stance against the United States, saying it is willing
    to resume stalled six-way talks on its nuclear weapons if Washington is ready
    to consider its demands.
- text: Mauresmo confident of LA victory Amelie Mauresmo insists she can win the Tour
    Championships this week and finish the year as world number one. The Frenchwoman
    could overtake Lindsay Davenport with a win in Los Angeles.
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.83
      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:** 4 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>"Bills' patience paying off The savior? The Buffalo Bills have always thought so. Bills general manager and president Tom Donahoe believed if the organization was patient in waiting for Willis McGahee's rebuilt knee to respond, he would be a huge success."</li><li>'NHL Rejects Union Plan, Talks End Without Contract (Update2) Contract talks broke off today between the National Hockey League and its locked-out players union, leaving the sport a step closer to wiping out its whole season.'</li><li>'Veteran guard Black bugs opponents The Connecticut Sun have the  quot;Tasmanian Devil quot; on their side as they enter the WNBA Finals tonight.  quot;Well, you know, I play a lot like that; I #39;m kind of '</li></ul>                                                                                                                                                                                                                                                                                                              |
| 2     | <ul><li>'IBM Reassures Workers After Milestone China Deal During an IBM employee meeting here Wednesday, a worker got up and asked a question that perhaps only 10 years ago would have been unthinkable: If he wanted '</li><li>'Fiat, GM struggle to settle row over Fiat Auto sale option MILAN (AFP) - Top officials from Fiat of Italy and General Motors were conferring in a bid to settle differences on Fiat #39;s option to sell its loss-making car operation to the US auto giant, a dispute that threatens their four-year-old collaboration.'</li><li>'Transco sells four gas networks National Grid Transco has sold half of its gas distribution networks for 5.8bn (\\$10.4bn), it was announced today. The move has been welcomed by the gas and electricity regulator Ofgem, which said new competition in the sector could lower prices.'</li></ul>                                                                                                                                                                                              |
| 0     | <ul><li>'Unit Refused Iraq Mission, Military Says WASHINGTON - Relatives of soldiers who refused to deliver supplies in Iraq say the troops considered the mission too dangerous, in part because their vehicles were in poor shape.    The Army is investigating up to 19 reservist members of a platoon that is part of the 343rd Quartermaster Company, based in Rock Hill, S.C...'</li><li>"Phelps, Thorpe Advance in 200 Freestyle ATHENS, Greece - Michael Phelps took care of qualifying for the Olympic 200-meter freestyle semifinals Sunday, and then found out he had been added to the American team for the evening's 400 freestyle relay final. Phelps' rivals Ian Thorpe and Pieter van den Hoogenband and teammate Klete Keller were faster than the teenager in the 200 free preliminaries..."</li><li>'Iranian Hard-Liners Criticize Nuclear Deal (AP) AP - Iranian hard-liners on Tuesday criticized a nuclear deal reached with European nations, saying Iran gained nothing in return for suspending the nuclear enrichment process.'</li></ul> |
| 3     | <ul><li>'Intel test chip boasts technology to add to speed Intel, the world #39;s biggest semiconductor maker, said Monday it built a test chip with a new process that creates faster circuits by packing 10 million transistors into an area the size of the tip of a ballpoint pen.'</li><li>"Sybase releases free Express database for Linux The company is releasing its new ASE Express Edition for free in hopes of attracting customers who will later upgrade to Sybase's ASE Small Business Edition."</li><li>'Google, 5 big libraries team to offer books Google Inc. has partnered with five of the world #39;s leading libraries, including those at Stanford and Harvard, to digitally scan their collections so that the books can be searched, and in many cases read, online free of charge.'</li></ul>                                                                                                                                                                                                                                             |

## Evaluation

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

## 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("vidhi0206/setfit-paraphrase-mpnet-ag_news_v2")
# Run inference
preds = model("Mauresmo confident of LA victory Amelie Mauresmo insists she can win the Tour Championships this week and finish the year as world number one. The Frenchwoman could overtake Lindsay Davenport with a win in Los Angeles.")
```

<!--
### 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   | 15  | 37.375 | 64  |

| Label | Training Sample Count |
|:------|:----------------------|
| 0     | 16                    |
| 1     | 16                    |
| 2     | 16                    |
| 3     | 16                    |

### Training Hyperparameters
- batch_size: (8, 8)
- 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.0031 | 1    | 0.4374        | -               |
| 0.1562 | 50   | 0.1774        | -               |
| 0.3125 | 100  | 0.0287        | -               |
| 0.4688 | 150  | 0.0008        | -               |
| 0.625  | 200  | 0.0006        | -               |
| 0.7812 | 250  | 0.0002        | -               |
| 0.9375 | 300  | 0.0004        | -               |

### Framework Versions
- Python: 3.8.10
- SetFit: 1.0.3
- Sentence Transformers: 2.3.1
- Transformers: 4.37.2
- PyTorch: 2.2.0+cu121
- Datasets: 2.17.0
- Tokenizers: 0.15.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.*
-->