absa-polarity / README.md
kaylaisya's picture
Add SetFit ABSA model
a2e9b7d verified
---
library_name: setfit
tags:
- setfit
- absa
- sentence-transformers
- text-classification
- generated_from_setfit_trainer
metrics:
- accuracy
widget:
- text: pelayanan lambat pelayan kurang:pelayanan lambat pelayan kurang ajar dan tidak
sopan terlalu banyak ngerumpi ngobrol sesama pelayan akhirnya kerjaan tidak pokus
dan salah kasih pesanan sudah pelayan tidak bagus pelayanya kurang ajar
- text: batu bandung dengan tempat yang bagus &:Restoran cepat saji 24 jam di buah
batu bandung dengan tempat yang bagus & nyaman, pelayanan yang baik, dan pelayanan
yang cepat. Di sini untuk sarapan dan menghabiskan sekitar 40k hingga 50k per
orang. Saya ingin pergi ke sana lagi lain kali.
- text: kentang gorengnya. rasanya sangat enak berbeda:Pengalaman luar biasa makan
di sini. Tidak hanya makanannya saja yang luar biasa. tempatnya sangat nyaman
untuk berkumpul bersama teman dan keluarga. Jangan lupa pesan kentang gorengnya.
rasanya sangat enak berbeda dengan kentang goreng di tempat lain
- text: Pelayanannya bagus dan makanannya:Pelayanannya bagus dan makanannya tidak
membosankan😊😊
- text: luas. Untuk rasa seperti MCd biasa:Tempat makannya nyaman, lumayan besar,
pegawainya ramah. Tempat parkirnya sungguh luas. Untuk rasa seperti MCd biasa,
enak dan cukup enak. Waktu penyajiannya cukup cepat Menyukainya.
pipeline_tag: text-classification
inference: false
---
# SetFit Polarity Model
This is a [SetFit](https://github.com/huggingface/setfit) model that can be used for Aspect Based Sentiment Analysis (ABSA). 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:** [Unknown](https://huggingface.co/unknown) -->
- **Classification head:** a [LogisticRegression](https://scikit-learn.org/stable/modules/generated/sklearn.linear_model.LogisticRegression.html) instance
- **spaCy Model:** id_core_news_trf
- **SetFitABSA Aspect Model:** [kaylaisya/absa-aspect](https://huggingface.co/kaylaisya/absa-aspect)
- **SetFitABSA Polarity Model:** [kaylaisya/absa-polarity](https://huggingface.co/kaylaisya/absa-polarity)
- **Maximum Sequence Length:** 8192 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 |
|:--------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| positif | <ul><li>'enak enak, pelayanannya juga mantap,:makanannya enak enak, pelayanannya juga mantap, terbaik lah'</li><li>'Rasanya selalu enak gak:Rasanya selalu enak gak pernah berubah, higines. Anak2 pada suka makan ayam goreng mcd'</li><li>'Pelayanannya cukup ramah dan:Pelayanannya cukup ramah dan praktis. Makanannya enak dan segar, khususnya es krim. Sip, lah.'</li></ul> |
| netral | <ul><li>'nya unik.. harganya standar lah sesuai:Sangat strategis,ramai, cukup luas dan nyaman, pelayanan ramah dan cepat.. parkiran juga luas , akhirnya kesampaian juga cobain menu ayam gulai cukup enak&cita rasa nya unik.. harganya standar lah sesuai rasa ,salam sukses selalu ☺️'</li><li>'makan siang, tempat nya menjorok kedalam:Mampir ke sini bareng temen mau makan siang, tempat nya menjorok kedalam, tatanan design nya MCD semua standard sesuai dengan kapasitas lahan nya, tempatnya juga dijaga banget kebersihannya, pelayanannya bagus, kakak-kakak pelayannya juga …'</li><li>'mbanya bantu take tempat, gesit ketika:Ini mba2nya supuer helpfull, karena kesana serombongan ber10 orang, mbanya bantu take tempat, gesit ketika dimintai bantuan. …'</li></ul> |
| negatif | <ul><li>'Pelayanan DriveThru terburuk!:Pelayanan DriveThru terburuk!!! Parkiran jg sempit gak bs keluar kalo batal drive thru. Ngantri drive thru 1 jam! Gak abis pikir. Tolong deh diperbaiki. Jika memang gak bs melayani, kasi tau dan segera ditutup drpd orang menunggu lama. Tolong banget management McD buah batu diperhatikan'</li><li>'Apa-apaan ini pelayanannya, pesen coke:Apa-apaan ini pelayanannya, pesen coke float doang sampe 32 menit. Dah gitu tadi datang workernya bilang ga ready sodanya, lah aturan dari awal pas payment di kasir langsung ngomong kalo ada mulut & otak. Kek gitu lalu nyuruh aku konfir ke kasir, …'</li><li>'menu paket ,rasa ayam crispyny agak:Over all ok...\nCm kmriin pesen menu paket ,rasa ayam crispyny agak asin.. smga kedepan lebih baik lg.'</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(
"kaylaisya/absa-aspect",
"kaylaisya/absa-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 | 6 | 27.2254 | 64 |
| Label | Training Sample Count |
|:--------|:----------------------|
| konflik | 0 |
| negatif | 12 |
| netral | 24 |
| positif | 758 |
### Training Hyperparameters
- batch_size: (64, 64)
- num_epochs: (1, 1)
- 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: False
### Framework Versions
- Python: 3.10.12
- SetFit: 1.0.3
- Sentence Transformers: 3.0.1
- spaCy: 3.7.4
- Transformers: 4.36.2
- PyTorch: 2.3.0+cu121
- Datasets: 2.19.2
- 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.*
-->