---
base_model: BAAI/bge-small-en-v1.5
library_name: setfit
metrics:
- accuracy
pipeline_tag: text-classification
tags:
- setfit
- absa
- sentence-transformers
- text-classification
- generated_from_setfit_trainer
widget:
- text: This book is very informative:This book is very informative, describing in
    detail how to do various types of beadwork, primarily loomwork
- text: story packed with adventure:This is a suspenseful story packed with adventure
- text: -drawn out English romances that may or:I don't usually like long-drawn out
    English romances that may or may not go somewhere, but this relationship is more
    realistic than most
- text: another boring history book:One thing is for sure, this is not another boring
    history book
- text: limited to a pre-teen audience, as:I would not say this book is strictly limited
    to a pre-teen audience, as I have found it to be very enjoyable
inference: false
---

# SetFit Polarity Model with BAAI/bge-small-en-v1.5

This is a [SetFit](https://github.com/huggingface/setfit) model that can be used for Aspect Based Sentiment Analysis (ABSA). This SetFit model uses [BAAI/bge-small-en-v1.5](https://huggingface.co/BAAI/bge-small-en-v1.5) 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. In particular, this model is in charge of classifying aspect polarities.

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.

This model was trained within the context of a larger system for ABSA, which looks like so:

1. Use a spaCy model to select possible aspect span candidates.
2. Use a SetFit model to filter these possible aspect span candidates.
3. **Use this SetFit model to classify the filtered aspect span candidates.**

## Model Details

### Model Description
- **Model Type:** SetFit
- **Sentence Transformer body:** [BAAI/bge-small-en-v1.5](https://huggingface.co/BAAI/bge-small-en-v1.5)
- **Classification head:** a [LogisticRegression](https://scikit-learn.org/stable/modules/generated/sklearn.linear_model.LogisticRegression.html) instance
- **spaCy Model:** en_core_web_lg
- **SetFitABSA Aspect Model:** [omymble/books-bge-small-aspect](https://huggingface.co/omymble/books-bge-small-aspect)
- **SetFitABSA Polarity Model:** [omymble/books-bge-small-polarity](https://huggingface.co/omymble/books-bge-small-polarity)
- **Maximum Sequence Length:** 512 tokens
- **Number of Classes:** 3 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                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|:---------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| negative | <ul><li>"too dark for younger ones, unless you:It might be an entertaining point of discussion with a child 12 or older, but it's too dark for younger ones, unless you're ready to talk about true evil, adult motivations, supernatural forces, and fratricide!"</li><li>'The mystery is secondary to:The mystery is secondary to the rest of the story and is only really approached in the remaining 30 pages of the book'</li><li>'was only my book with this problem:I have no idea if it was only my book with this problem'</li></ul>                                                            |
| neutral  | <ul><li>'world, as Nix weaves a wonderful:-enjoy the genre of fantasies, of a unknown world, as Nix weaves a wonderful tale of the things that will open your eyes to a different world'</li><li>'Arthur must get through:Arthur must get through some horrifying trials to save his Earth from the plague, and to prove that he is the Rightful Heir'</li><li>'to say that Mister Monday is definitely worth:I was interested enough in the strange and original concept to read on to the next book, so I would venture to say that Mister Monday is definitely worth reading at least once'</li></ul> |
| positive | <ul><li>'I recommend THE INTRUDERS if you enjoy:I recommend THE INTRUDERS if you enjoy good writing, but if you want a great story, you should try THE STRAW MEN instead'</li><li>'of the major bios on "Big:I\'ve read all of the major bios on "Big Al" and this is by far the best'</li><li>'really great fantasy book:this is a really great fantasy book'</li></ul>                                                                                                                                                                                                                                 |

## 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 AbsaModel

# Download from the 🤗 Hub
model = AbsaModel.from_pretrained(
    "omymble/books-bge-small-aspect",
    "omymble/books-bge-small-polarity",
)
# Run inference
preds = model("The food was great, but the venue is just way too busy.")
```

<!--
### 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   | 24.93  | 60  |

| Label    | Training Sample Count |
|:---------|:----------------------|
| negative | 8                     |
| neutral  | 50                    |
| positive | 42                    |

### Training Hyperparameters
- batch_size: (128, 128)
- num_epochs: (1, 16)
- 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: True
- warmup_proportion: 0.1
- seed: 42
- eval_max_steps: -1
- load_best_model_at_end: True

### Training Results
| Epoch  | Step | Training Loss | Validation Loss |
|:------:|:----:|:-------------:|:---------------:|
| 0.0222 | 1    | 0.2383        | -               |

### Framework Versions
- Python: 3.10.12
- SetFit: 1.0.3
- Sentence Transformers: 3.0.1
- spaCy: 3.7.4
- Transformers: 4.39.0
- PyTorch: 2.3.1+cu121
- Datasets: 2.20.0
- Tokenizers: 0.15.2

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