ronalhung's picture
Add SetFit ABSA model
76e6db6 verified
metadata
tags:
  - setfit
  - absa
  - sentence-transformers
  - text-classification
  - generated_from_setfit_trainer
widget:
  - text: even the wine by the glass was good.:even the wine by the glass was good.
  - text: >-
      I had the Pad Thai and the noodles:I had the Pad Thai and the noodles were
      sticky.
  - text: >-
      happy and the food was delicious,:The have over 100 different beers to
      offer thier guest so that made my husband very happy and the food was
      delicious, if I must recommend a dish it must be the pumkin tortelini.
  - text: >-
      The takeout menu says to keep:The takeout menu says to keep an eye out for
      an expanded menu offering more italian dishes, I can't wait!
  - text: >-
      fresh garlic or eggplant.:Try their plain pizza with fresh garlic or
      eggplant.
metrics:
  - f1_micro
  - f1_macro
  - precision_macro
  - recall_macro
pipeline_tag: text-classification
library_name: setfit
inference: false
base_model: sentence-transformers/all-mpnet-base-v2
model-index:
  - name: SetFit Polarity Model with sentence-transformers/all-mpnet-base-v2
    results:
      - task:
          type: text-classification
          name: Text Classification
        dataset:
          name: Unknown
          type: unknown
          split: test
        metrics:
          - type: f1_micro
            value: 0.7498485766202302
            name: F1_Micro
          - type: f1_macro
            value: 0.49023998155757353
            name: F1_Macro
          - type: precision_macro
            value: 0.5006485437092179
            name: Precision_Macro
          - type: recall_macro
            value: 0.4955397132006286
            name: Recall_Macro

SetFit Polarity Model with sentence-transformers/all-mpnet-base-v2

This is a SetFit model that can be used for Aspect Based Sentiment Analysis (ABSA). This SetFit model uses sentence-transformers/all-mpnet-base-v2 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. Fine-tuning a Sentence Transformer 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 Sources

Model Labels

Label Examples
negative
  • 'But the staff was so horrible:But the staff was so horrible to us.'
  • ', forgot our toast, left out:They did not have mayonnaise, forgot our toast, left out ingredients (ie cheese in an omelet), below hot temperatures and the bacon was so over cooked it crumbled on the plate when you touched it.'
  • 'did not have mayonnaise, forgot our:They did not have mayonnaise, forgot our toast, left out ingredients (ie cheese in an omelet), below hot temperatures and the bacon was so over cooked it crumbled on the plate when you touched it.'
positive
  • "factor was the food, which was:To be completely fair, the only redeeming factor was the food, which was above average, but couldn't make up for all the other deficiencies of Teodora."
  • "The food is uniformly exceptional:The food is uniformly exceptional, with a very capable kitchen which will proudly whip up whatever you feel like eating, whether it's on the menu or not."
  • "a very capable kitchen which will proudly:The food is uniformly exceptional, with a very capable kitchen which will proudly whip up whatever you feel like eating, whether it's on the menu or not."
neutral
  • "'s on the menu or not.:The food is uniformly exceptional, with a very capable kitchen which will proudly whip up whatever you feel like eating, whether it's on the menu or not."
  • 'to sample both meats).:Our agreed favorite is the orrechiete with sausage and chicken (usually the waiters are kind enough to split the dish in half so you get to sample both meats).'
  • 'to split the dish in half so:Our agreed favorite is the orrechiete with sausage and chicken (usually the waiters are kind enough to split the dish in half so you get to sample both meats).'
conflict
  • 'The food was delicious but:The food was delicious but do not come here on a empty stomach.'
  • "The service varys from day:The service varys from day to day- sometimes they're very nice, and sometimes not."
  • 'Though the Spider Roll may look like:Though the Spider Roll may look like a challenge to eat, with soft shell crab hanging out of the roll, it is well worth the price you pay for them.'

Evaluation

Metrics

Label F1_Micro F1_Macro Precision_Macro Recall_Macro
all 0.7498 0.4902 0.5006 0.4955

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(
    "ronalhung/setfit-absa-restaurants-aspect",
    "ronalhung/setfit-absa-restaurants-polarity",
)
# Run inference
preds = model("The food was great, but the venue is just way too busy.")

Training Details

Training Set Metrics

Training set Min Median Max
Word count 6 22.4961 51
Label Training Sample Count
conflict 6
negative 43
neutral 36
positive 169

Training Hyperparameters

  • batch_size: (64, 64)
  • num_epochs: (5, 5)
  • 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: False
  • warmup_proportion: 0.1
  • l2_weight: 0.01
  • seed: 42
  • eval_max_steps: -1
  • load_best_model_at_end: True

Training Results

Epoch Step Training Loss Validation Loss
0.0019 1 0.259 -
0.0975 50 0.258 0.2233
0.1949 100 0.1565 0.1765
0.2924 150 0.0433 0.1571
0.3899 200 0.0204 0.1520
0.4873 250 0.0099 0.1809
0.5848 300 0.0042 0.1879
0.6823 350 0.0014 0.1873
0.7797 400 0.0006 0.1967
0.8772 450 0.0011 0.1959

Framework Versions

  • Python: 3.11.13
  • SetFit: 1.1.2
  • Sentence Transformers: 4.1.0
  • spaCy: 3.8.7
  • Transformers: 4.52.4
  • PyTorch: 2.6.0+cu124
  • Datasets: 3.6.0
  • Tokenizers: 0.21.1

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}
}