---
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.7647368421052632
      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                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|:------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 3     | <ul><li>'RosettaNet Extends to Singapore E-business standards consortium RosettaNet spread its wings over Singapore with the opening of its Architecture Center of Excellence, the group said Friday.'</li><li>'Microsoft delays automatic XP SP2 delivery SAN FRANCISCO - Microsoft Corp. has pushed back automatic distribution of Windows XP Service Pack 2 (SP2) to allow business users more time to instruct their machines to skip the update.'</li><li>'Microsoft blows into Florida with Visual Studio 2005 Microsoft ignored the apocalyptic weather threatening Florida yesterday to unveil the beta version of its Visual Studio 2005 Standard Edition at the VSLive!'</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                 |
| 2     | <ul><li>'ChevronTexaco Profit Up, Misses Forecasts  NEW YORK (Reuters) - ChevronTexaco Corp.&lt;A HREF="http://www.investor.reuters.com/FullQuote.aspx?ticker=CVX.N target=/stocks/quickinfo/fullquote"&gt;CVX.N&lt;/A&gt;, the No. 2  U.S. oil company, on Friday reported a 62 percent rise in  quarterly profit from record oil prices and gains from asset  sales, but the results fell short of Wall Street forecasts.'</li><li>'Spotlight: Aer Lingus chief #39;s survival guide DUBLIN Willie Walsh, the chief executive of Aer Lingus, holds interviews and meetings in a former chairman #39;s unused office since his own is too messy for visitors, he says.'</li><li>'Google Desktop Search Has Arrived Google has finally announced Google Desktop Search, a search application that enables users to search their email, files, web history, and chats.'</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>'Pardon request draws Chechens #39; ire MOSCOW - Amid rising ethnic tensions in the North Caucasus, thousands on Tuesday took to the streets of Grozny, the Chechen capital, to protest the proposed pardon of a Russian army colonel who murdered a young Chechen woman.'</li></ul> |
| 1     | <ul><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>'Astros Continue Charge Jeff Bagwell drives in two runs and Jeff Kent hit his 300th career homer to send the Astros to a 6-4 win over the Cardinals.'</li><li>'NL Wrap: Maddux Hits 15-Win Mark as Cubs Top Bucs Greg Maddux reached the 15-win plateau for a record 17th straight season and also drove in two runs in the second inning to power the Chicago Cubs to a 6-3 victory over the host Pittsburgh Pirates in the National League Thursday.'</li></ul>                                                                                                                                                                                                                                                                                                                                                                                         |

## Evaluation

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

## 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   | 15  | 36.7188 | 64  |

| 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.1998        | -               |
| 0.3125 | 50   | 0.0922        | -               |
| 0.625  | 100  | 0.0015        | -               |
| 0.9375 | 150  | 0.0011        | -               |

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