Add SetFit model

1_Pooling/config.json

@@ -0,0 +1,10 @@
+{
+  "word_embedding_dimension": 768,
+  "pooling_mode_cls_token": false,
+  "pooling_mode_mean_tokens": true,
+  "pooling_mode_max_tokens": false,
+  "pooling_mode_mean_sqrt_len_tokens": false,
+  "pooling_mode_weightedmean_tokens": false,
+  "pooling_mode_lasttoken": false,
+  "include_prompt": true
+}

README.md

@@ -0,0 +1,263 @@
+---
+library_name: setfit
+tags:
+- setfit
+- sentence-transformers
+- text-classification
+- generated_from_setfit_trainer
+base_model: sentence-transformers/paraphrase-mpnet-base-v2
+metrics:
+- accuracy
+widget:
+- text: How long will it take to deliver the 50 pack of Brown Bakery Boxes to Patna?
+- text: What materials should I look for in a high-quality tea infuser to ensure the
+    best brewing experience?
+- text: I need to return an item, what is the return policy for online orders?
+- text: What is the policy for returning sneakers with a damaged box?
+- text: What is the procedure for returning a large quantity of boxes?
+pipeline_tag: text-classification
+inference: true
+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.8266666666666667
+      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:** 5 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                                                                                                                                                                                                                                                                                                                      |
+|:------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| product policy          | <ul><li>'What is the procedure for returning sneakers purchased with a credit note?'</li><li>'How do I provide proof of purchase or order information when returning a damaged product?'</li><li>'What is the process for exchanging sneakers?'</li></ul>                                                                     |
+| order tracking          | <ul><li>"My order was supposed to arrive yesterday but it hasn't. Can you check the delivery status for me?"</li><li>'What is the delivery status for my order placed using phone number 7654321098?'</li><li>'What is the process for requesting a signature upon delivery for my order?'</li></ul>                          |
+| general faq             | <ul><li>'What are the key factors to consider when developing a personalized diet plan for weight loss?'</li><li>'What are some tips for maximizing the antioxidant content when brewing green tea?'</li><li>'Can you explain why Mashru silk is considered more comfortable to wear compared to pure silk sarees?'</li></ul> |
+| product faq             | <ul><li>'What is the fabric used in the Pure Katan silk double Bird Satin Tanchoi Banarasi Saree?'</li><li>'What are the available colors for this Saree?'</li><li>'What is the price of this Saree?'</li></ul>                                                                                                               |
+| product discoverability | <ul><li>'Do you have adidas Superstar shoes?'</li><li>'Do you have any bestseller teas available?'</li><li>'What types of spices do you carry?'</li></ul>                                                                                                                                                                     |
+
+## Evaluation
+
+### Metrics
+| Label   | Accuracy |
+|:--------|:---------|
+| **all** | 0.8267   |
+
+## 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("setfit_model_id")
+# Run inference
+preds = model("What is the policy for returning sneakers with a damaged box?")
+```
+
+<!--
+### 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   | 4   | 12.2784 | 28  |
+
+| Label                   | Training Sample Count |
+|:------------------------|:----------------------|
+| general faq             | 24                    |
+| order tracking          | 32                    |
+| product discoverability | 40                    |
+| product faq             | 40                    |
+| product policy          | 40                    |
+
+### Training Hyperparameters
+- batch_size: (16, 16)
+- num_epochs: (2, 2)
+- 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
+- seed: 42
+- eval_max_steps: -1
+- load_best_model_at_end: True
+
+### Training Results
+| Epoch  | Step | Training Loss | Validation Loss |
+|:------:|:----:|:-------------:|:---------------:|
+| 0.0007 | 1    | 0.2756        | -               |
+| 0.0326 | 50   | 0.1828        | -               |
+| 0.0651 | 100  | 0.1005        | -               |
+| 0.0977 | 150  | 0.0536        | -               |
+| 0.1302 | 200  | 0.0163        | -               |
+| 0.1628 | 250  | 0.0032        | -               |
+| 0.1953 | 300  | 0.0016        | -               |
+| 0.2279 | 350  | 0.0006        | -               |
+| 0.2604 | 400  | 0.0006        | -               |
+| 0.2930 | 450  | 0.0006        | -               |
+| 0.3255 | 500  | 0.0003        | -               |
+| 0.3581 | 550  | 0.0004        | -               |
+| 0.3906 | 600  | 0.0012        | -               |
+| 0.4232 | 650  | 0.0003        | -               |
+| 0.4557 | 700  | 0.0002        | -               |
+| 0.4883 | 750  | 0.0002        | -               |
+| 0.5208 | 800  | 0.0002        | -               |
+| 0.5534 | 850  | 0.0001        | -               |
+| 0.5859 | 900  | 0.0002        | -               |
+| 0.6185 | 950  | 0.0002        | -               |
+| 0.6510 | 1000 | 0.0002        | -               |
+| 0.6836 | 1050 | 0.0001        | -               |
+| 0.7161 | 1100 | 0.0001        | -               |
+| 0.7487 | 1150 | 0.0001        | -               |
+| 0.7812 | 1200 | 0.0002        | -               |
+| 0.8138 | 1250 | 0.0001        | -               |
+| 0.8464 | 1300 | 0.0003        | -               |
+| 0.8789 | 1350 | 0.0002        | -               |
+| 0.9115 | 1400 | 0.0001        | -               |
+| 0.9440 | 1450 | 0.0001        | -               |
+| 0.9766 | 1500 | 0.0001        | -               |
+| 1.0091 | 1550 | 0.0001        | -               |
+| 1.0417 | 1600 | 0.0001        | -               |
+| 1.0742 | 1650 | 0.0001        | -               |
+| 1.1068 | 1700 | 0.0001        | -               |
+| 1.1393 | 1750 | 0.0001        | -               |
+| 1.1719 | 1800 | 0.0001        | -               |
+| 1.2044 | 1850 | 0.0001        | -               |
+| 1.2370 | 1900 | 0.0001        | -               |
+| 1.2695 | 1950 | 0.0001        | -               |
+| 1.3021 | 2000 | 0.0001        | -               |
+| 1.3346 | 2050 | 0.0001        | -               |
+| 1.3672 | 2100 | 0.0001        | -               |
+| 1.3997 | 2150 | 0.0001        | -               |
+| 1.4323 | 2200 | 0.0001        | -               |
+| 1.4648 | 2250 | 0.0001        | -               |
+| 1.4974 | 2300 | 0.0001        | -               |
+| 1.5299 | 2350 | 0.0001        | -               |
+| 1.5625 | 2400 | 0.0001        | -               |
+| 1.5951 | 2450 | 0.0001        | -               |
+| 1.6276 | 2500 | 0.0001        | -               |
+| 1.6602 | 2550 | 0.0001        | -               |
+| 1.6927 | 2600 | 0.0001        | -               |
+| 1.7253 | 2650 | 0.0001        | -               |
+| 1.7578 | 2700 | 0.0001        | -               |
+| 1.7904 | 2750 | 0.0001        | -               |
+| 1.8229 | 2800 | 0.0001        | -               |
+| 1.8555 | 2850 | 0.0001        | -               |
+| 1.8880 | 2900 | 0.0001        | -               |
+| 1.9206 | 2950 | 0.0001        | -               |
+| 1.9531 | 3000 | 0.0001        | -               |
+| 1.9857 | 3050 | 0.0001        | -               |
+
+### Framework Versions
+- Python: 3.9.19
+- SetFit: 1.0.3
+- Sentence Transformers: 2.7.0
+- Transformers: 4.40.2
+- PyTorch: 2.2.2
+- Datasets: 2.19.1
+- Tokenizers: 0.19.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.*
+-->

config.json

@@ -0,0 +1,24 @@
+{
+  "_name_or_path": "sentence-transformers/paraphrase-mpnet-base-v2",
+  "architectures": [
+    "MPNetModel"
+  ],
+  "attention_probs_dropout_prob": 0.1,
+  "bos_token_id": 0,
+  "eos_token_id": 2,
+  "hidden_act": "gelu",
+  "hidden_dropout_prob": 0.1,
+  "hidden_size": 768,
+  "initializer_range": 0.02,
+  "intermediate_size": 3072,
+  "layer_norm_eps": 1e-05,
+  "max_position_embeddings": 514,
+  "model_type": "mpnet",
+  "num_attention_heads": 12,
+  "num_hidden_layers": 12,
+  "pad_token_id": 1,
+  "relative_attention_num_buckets": 32,
+  "torch_dtype": "float32",
+  "transformers_version": "4.40.2",
+  "vocab_size": 30527
+}

config_sentence_transformers.json

@@ -0,0 +1,9 @@
+{
+  "__version__": {
+    "sentence_transformers": "2.0.0",
+    "transformers": "4.7.0",
+    "pytorch": "1.9.0+cu102"
+  },
+  "prompts": {},
+  "default_prompt_name": null
+}

config_setfit.json

@@ -0,0 +1,10 @@
+{
+  "normalize_embeddings": false,
+  "labels": [
+    "general faq",
+    "order tracking",
+    "product discoverability",
+    "product faq",
+    "product policy"
+  ]
+}

model.safetensors

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a7a1db18307e364cf3c01695eb54f32bf59affcd89b06e613d186860a99b7c60
+size 437967672

model_head.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:796f50030b29efdbd383f3c2422de14f5e93a945934926fd762e1315f588b897
+size 32063

modules.json

@@ -0,0 +1,14 @@
+[
+  {
+    "idx": 0,
+    "name": "0",
+    "path": "",
+    "type": "sentence_transformers.models.Transformer"
+  },
+  {
+    "idx": 1,
+    "name": "1",
+    "path": "1_Pooling",
+    "type": "sentence_transformers.models.Pooling"
+  }
+]

sentence_bert_config.json

@@ -0,0 +1,4 @@
+{
+  "max_seq_length": 512,
+  "do_lower_case": false
+}

special_tokens_map.json

@@ -0,0 +1,51 @@
+{
+  "bos_token": {
+    "content": "<s>",
+    "lstrip": false,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  },
+  "cls_token": {
+    "content": "<s>",
+    "lstrip": false,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  },
+  "eos_token": {
+    "content": "</s>",
+    "lstrip": false,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  },
+  "mask_token": {
+    "content": "<mask>",
+    "lstrip": true,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  },
+  "pad_token": {
+    "content": "<pad>",
+    "lstrip": false,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  },
+  "sep_token": {
+    "content": "</s>",
+    "lstrip": false,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  },
+  "unk_token": {
+    "content": "[UNK]",
+    "lstrip": false,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  }
+}

tokenizer_config.json

@@ -0,0 +1,59 @@
+{
+  "added_tokens_decoder": {
+    "0": {
+      "content": "<s>",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "1": {
+      "content": "<pad>",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "2": {
+      "content": "</s>",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "104": {
+      "content": "[UNK]",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "30526": {
+      "content": "<mask>",
+      "lstrip": true,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    }
+  },
+  "bos_token": "<s>",
+  "clean_up_tokenization_spaces": true,
+  "cls_token": "<s>",
+  "do_basic_tokenize": true,
+  "do_lower_case": true,
+  "eos_token": "</s>",
+  "mask_token": "<mask>",
+  "model_max_length": 512,
+  "never_split": null,
+  "pad_token": "<pad>",
+  "sep_token": "</s>",
+  "strip_accents": null,
+  "tokenize_chinese_chars": true,
+  "tokenizer_class": "MPNetTokenizer",
+  "unk_token": "[UNK]"
+}