omymble/books-bge-small-polarity

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

This is a SetFit model that can be used for Aspect Based Sentiment Analysis (ABSA). This SetFit model uses BAAI/bge-small-en-v1.5 as the Sentence Transformer embedding model. A LogisticRegression 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. 1.Fine-tuning a Sentence Transformer with contrastive learning.
2. 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. 1.Use a spaCy model to select possible aspect span candidates.
2. 2.Use a SetFit model to filter these possible aspect span candidates.
3. 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
• —Classification head: a LogisticRegression instance
• —spaCy Model: encoreweb_lg
• —SetFitABSA Aspect Model: omymble/books-bge-small-aspect
• —SetFitABSA Polarity Model: omymble/books-bge-small-polarity
• —Maximum Sequence Length: 512 tokens
• —Number of Classes: 3 classes <!-- - Training Dataset: Unknown --> <!-- - Language: Unknown --> <!-- - License: Unknown -->

Model Sources

• —Repository: SetFit on GitHub
• —Paper: Efficient Few-Shot Learning Without Prompts
• —Blogpost: SetFit: Efficient Few-Shot Learning Without Prompts

Model Labels

Uses

Direct Use for Inference

First install the SetFit library:

pip install setfit

Then you can load this model and run inference.

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 Hyperparameters

• —batch_size: (128, 128)
• —num_epochs: (1, 16)
• —max_steps: -1
• —sampling_strategy: oversampling
• —bodylearningrate: (2e-05, 1e-05)
• —headlearningrate: 0.01
• —loss: CosineSimilarityLoss
• —distancemetric: cosinedistance
• —margin: 0.25
• —endtoend: False
• —use_amp: True
• —warmup_proportion: 0.1
• —seed: 42
• —evalmaxsteps: -1
• —loadbestmodelatend: True

Training Results

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

@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. -->