---
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.8393421052631579
      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>'Titans QB to sit out final three games, undergo surgery for &lt;b&gt;...&lt;/b&gt; Tennessee quarterback Steve McNair will not play the final three games of the season and will have surgery to strengthen the bruised sternum that has plagued him most of the year.'</li><li>'Mental miscues hurt the Gators Flinching in the trenches, holding around quarterback Chris Leak and even a late hit by punter Eric Wilbur plagued Florida throughout the game.'</li><li>'Arsenal boss admits admiration for Man City #39;s SWP Arsenal boss Arsene Wenger admits he is keeping tabs on Manchester City winger Shaun Wright-Phillips. Wenger said:  quot;He is getting higher every year.'</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                        |
| 0     | <ul><li>'Sharon Allows 1,000 More Settler Homes in West Bank  JERUSALEM (Reuters) - Prime Minister Ariel Sharon, facing a  party mutiny over his plan to quit the Gaza Strip, has approved  1,000 more Israeli settler homes in the West Bank in a move  that drew a cautious response Tuesday from Washington.'</li><li>' #39;US arms to Islamabad could impact India-Pakistan ties #39; (LEADS &lt;b&gt;...&lt;/b&gt; India News: New Delhi, Dec 9 : India Thursday expressed concern at a US decision to sell sophisticated weapons to Pakistan, saying it would adversely affect the  quot;sensitive quot; India-Pakistan peace process as well as growing India-US ties.'</li><li>"Stars Arrive by Yacht at MTV Video Awards MIAMI - An already broiling Miami had even more sizzle on Sunday as MTV brought the annual party known as the Video Music Awards to the city for the first time in the awards' 21-year history.    The change of scenery for the awards, typically held in New York or Los Angeles, helped raise the decadence level at the already raucous, celebrity-soaked affair..."</li></ul> |
| 2     | <ul><li>'Merck begins search for new CEO NEW YORK, October 12 (newratings.com) - The global pharmaceutical giant, Merck  amp; Company (MRK.NYS) plans to appoint a new CEO by the end of next year.'</li><li>'Dollar Jumps as the G7 Fades  LONDON (Reuters) - The dollar surged against the euro, yen  and Swiss franc on Monday as, with a Group of Seven rich  nations meeting out of the way, the greenback was free to join  a wave of optimism about the U.S. economy.'</li><li>'Fed Seen Boosting Rates Despite Worries (Reuters) Reuters - Federal Reserve policy-makers were\\expected to raise U.S. interest rates on Tuesday for a third\\time this year, continuing to lift borrowing costs from\\rock-bottom levels despite some signs of economic softness.'</li></ul>                                                                                                                                                                                                                                                                                                                                 |
| 3     | <ul><li>'Grand Theft Auto ... Stolen! First it was Halo 2. Now the newest version of Grand Theft Auto has been leaked to the Internet. Rockstar Games #39; latest entry in its highly successful crime/action series, San Andreas, is scheduled for an '</li><li>'Satellite boosts Olympic security An enhanced satellite location system aims to help Olympic security guards react more quickly to emergencies.'</li><li>'Regulator vows to ease way for Net phone use BOSTON The United States #39; top telecommunications regulator plans to protect fledgling Internet telephone services from being taxed and heavily regulated by the 50 state governments.'</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                        |

## Evaluation

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

## 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")
# 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   | 20  | 38.7812 | 73  |

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

### 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.0063 | 1    | 0.1416        | -               |
| 0.3125 | 50   | 0.0677        | -               |
| 0.625  | 100  | 0.0006        | -               |
| 0.9375 | 150  | 0.0006        | -               |

### 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.*
-->