wikd commited on
Commit
11f9284
1 Parent(s): ec3867a

Upload 13 files

Browse files
1_Pooling/config.json ADDED
@@ -0,0 +1,10 @@
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "word_embedding_dimension": 384,
3
+ "pooling_mode_cls_token": true,
4
+ "pooling_mode_mean_tokens": false,
5
+ "pooling_mode_max_tokens": false,
6
+ "pooling_mode_mean_sqrt_len_tokens": false,
7
+ "pooling_mode_weightedmean_tokens": false,
8
+ "pooling_mode_lasttoken": false,
9
+ "include_prompt": true
10
+ }
README.md ADDED
@@ -0,0 +1,179 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ library_name: setfit
3
+ tags:
4
+ - setfit
5
+ - sentence-transformers
6
+ - text-classification
7
+ - generated_from_setfit_trainer
8
+ base_model: BAAI/bge-small-en-v1.5
9
+ metrics:
10
+ - accuracy
11
+ widget:
12
+ - text: Can you tell I about eny ongoing promoistion onr discounts onteh organic produce?
13
+ - text: A bought somenting that didn ' th meet my expectations. It there ein way go
14
+ get and partial refund?
15
+ - text: I ' d like to palac a ladge ordet for my business. Do you offer ang specialy
16
+ bulk shopping rates?
17
+ - text: Ken you telle mo more about the origin atch farming practices of your cofffee
18
+ beans?
19
+ - text: I ' d llike to exchange a product I bought in - store. Du hi needs yo bring
20
+ tie oringal receipt?
21
+ pipeline_tag: text-classification
22
+ inference: true
23
+ ---
24
+
25
+ # SetFit with BAAI/bge-small-en-v1.5
26
+
27
+ This is a [SetFit](https://github.com/huggingface/setfit) model that can be used for Text Classification. 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.
28
+
29
+ The model has been trained using an efficient few-shot learning technique that involves:
30
+
31
+ 1. Fine-tuning a [Sentence Transformer](https://www.sbert.net) with contrastive learning.
32
+ 2. Training a classification head with features from the fine-tuned Sentence Transformer.
33
+
34
+ ## Model Details
35
+
36
+ ### Model Description
37
+ - **Model Type:** SetFit
38
+ - **Sentence Transformer body:** [BAAI/bge-small-en-v1.5](https://huggingface.co/BAAI/bge-small-en-v1.5)
39
+ - **Classification head:** a [LogisticRegression](https://scikit-learn.org/stable/modules/generated/sklearn.linear_model.LogisticRegression.html) instance
40
+ - **Maximum Sequence Length:** 512 tokens
41
+ - **Number of Classes:** 5 classes
42
+ <!-- - **Training Dataset:** [Unknown](https://huggingface.co/datasets/unknown) -->
43
+ <!-- - **Language:** Unknown -->
44
+ <!-- - **License:** Unknown -->
45
+
46
+ ### Model Sources
47
+
48
+ - **Repository:** [SetFit on GitHub](https://github.com/huggingface/setfit)
49
+ - **Paper:** [Efficient Few-Shot Learning Without Prompts](https://arxiv.org/abs/2209.11055)
50
+ - **Blogpost:** [SetFit: Efficient Few-Shot Learning Without Prompts](https://huggingface.co/blog/setfit)
51
+
52
+ ### Model Labels
53
+ | Label | Examples |
54
+ |:-------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
55
+ | Tech Support | <ul><li>"I ' am trying to place an orden online bt Then website keeps crashing. Can you assit my?"</li><li>"Mi online order won ' t go throw - is there an isuue with years pament prossesing?"</li><li>"I ' m goning an error when tryied tou redeem my loyality points. Who cen assist we?"</li></ul> |
56
+ | HR | <ul><li>"I ' m considere submitting my ow - weeck notice. Waht It's tehe typical resignation process?"</li><li>"I ' m looking e swich to a part - time sehdule. Whate re rhe requirements?"</li><li>"In ' d loke to fill a formal complain about worksplace discrimination. Who did I contact?"</li></ul> |
57
+ | Product | <ul><li>'Whots are your best practices ofr mantain foord quality and freshness?'</li><li>'Whots newbrand ow nut butters dou you carry tahat are peanut - free?'</li><li>'Do you hafe any seasonal nor limited - tíme produts in stock rignt now?'</li></ul> |
58
+ | Returns | <ul><li>'My grocery delivary contained items tath where spoiled or pas their expiration date. How dos me get replacements?'</li><li>"I ' d llike to exchange a product I bought in - store. Du hi needs yo bring tie oringal receipt?"</li><li>'I eceibed de demaged item in my online oder. Hou do I’m go about getting a refund?'</li></ul> |
59
+ | Logistics | <ul><li>'I have a question about youtr Holiday shiping deathlines and prioritized delivery options'</li><li>'I nedd to change the delivery addrss foy mh upcoming older. How can I go that?'</li><li>'Can jou explain York polices around iterms that approxmatlly out of stock or on backorder?'</li></ul> |
60
+
61
+ ## Uses
62
+
63
+ ### Direct Use for Inference
64
+
65
+ First install the SetFit library:
66
+
67
+ ```bash
68
+ pip install setfit
69
+ ```
70
+
71
+ Then you can load this model and run inference.
72
+
73
+ ```python
74
+ from setfit import SetFitModel
75
+
76
+ # Download from the 🤗 Hub
77
+ model = SetFitModel.from_pretrained("setfit_model_id")
78
+ # Run inference
79
+ preds = model("Can you tell I about eny ongoing promoistion onr discounts onteh organic produce?")
80
+ ```
81
+
82
+ <!--
83
+ ### Downstream Use
84
+
85
+ *List how someone could finetune this model on their own dataset.*
86
+ -->
87
+
88
+ <!--
89
+ ### Out-of-Scope Use
90
+
91
+ *List how the model may foreseeably be misused and address what users ought not to do with the model.*
92
+ -->
93
+
94
+ <!--
95
+ ## Bias, Risks and Limitations
96
+
97
+ *What are the known or foreseeable issues stemming from this model? You could also flag here known failure cases or weaknesses of the model.*
98
+ -->
99
+
100
+ <!--
101
+ ### Recommendations
102
+
103
+ *What are recommendations with respect to the foreseeable issues? For example, filtering explicit content.*
104
+ -->
105
+
106
+ ## Training Details
107
+
108
+ ### Training Set Metrics
109
+ | Training set | Min | Median | Max |
110
+ |:-------------|:----|:-------|:----|
111
+ | Word count | 10 | 16.125 | 28 |
112
+
113
+ | Label | Training Sample Count |
114
+ |:-------------|:----------------------|
115
+ | Returns | 8 |
116
+ | Tech Support | 8 |
117
+ | Logistics | 8 |
118
+ | HR | 8 |
119
+ | Product | 8 |
120
+
121
+ ### Training Hyperparameters
122
+ - batch_size: (32, 32)
123
+ - num_epochs: (10, 10)
124
+ - max_steps: -1
125
+ - sampling_strategy: oversampling
126
+ - body_learning_rate: (2e-05, 1e-05)
127
+ - head_learning_rate: 0.01
128
+ - loss: CosineSimilarityLoss
129
+ - distance_metric: cosine_distance
130
+ - margin: 0.25
131
+ - end_to_end: False
132
+ - use_amp: False
133
+ - warmup_proportion: 0.1
134
+ - seed: 42
135
+ - eval_max_steps: -1
136
+ - load_best_model_at_end: False
137
+
138
+ ### Framework Versions
139
+ - Python: 3.11.8
140
+ - SetFit: 1.0.3
141
+ - Sentence Transformers: 2.6.1
142
+ - Transformers: 4.39.3
143
+ - PyTorch: 2.4.0.dev20240413
144
+ - Datasets: 2.18.0
145
+ - Tokenizers: 0.15.2
146
+
147
+ ## Citation
148
+
149
+ ### BibTeX
150
+ ```bibtex
151
+ @article{https://doi.org/10.48550/arxiv.2209.11055,
152
+ doi = {10.48550/ARXIV.2209.11055},
153
+ url = {https://arxiv.org/abs/2209.11055},
154
+ author = {Tunstall, Lewis and Reimers, Nils and Jo, Unso Eun Seo and Bates, Luke and Korat, Daniel and Wasserblat, Moshe and Pereg, Oren},
155
+ keywords = {Computation and Language (cs.CL), FOS: Computer and information sciences, FOS: Computer and information sciences},
156
+ title = {Efficient Few-Shot Learning Without Prompts},
157
+ publisher = {arXiv},
158
+ year = {2022},
159
+ copyright = {Creative Commons Attribution 4.0 International}
160
+ }
161
+ ```
162
+
163
+ <!--
164
+ ## Glossary
165
+
166
+ *Clearly define terms in order to be accessible across audiences.*
167
+ -->
168
+
169
+ <!--
170
+ ## Model Card Authors
171
+
172
+ *Lists the people who create the model card, providing recognition and accountability for the detailed work that goes into its construction.*
173
+ -->
174
+
175
+ <!--
176
+ ## Model Card Contact
177
+
178
+ *Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors.*
179
+ -->
config.json ADDED
@@ -0,0 +1,31 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "_name_or_path": "BAAI/bge-small-en-v1.5",
3
+ "architectures": [
4
+ "BertModel"
5
+ ],
6
+ "attention_probs_dropout_prob": 0.1,
7
+ "classifier_dropout": null,
8
+ "hidden_act": "gelu",
9
+ "hidden_dropout_prob": 0.1,
10
+ "hidden_size": 384,
11
+ "id2label": {
12
+ "0": "LABEL_0"
13
+ },
14
+ "initializer_range": 0.02,
15
+ "intermediate_size": 1536,
16
+ "label2id": {
17
+ "LABEL_0": 0
18
+ },
19
+ "layer_norm_eps": 1e-12,
20
+ "max_position_embeddings": 512,
21
+ "model_type": "bert",
22
+ "num_attention_heads": 12,
23
+ "num_hidden_layers": 12,
24
+ "pad_token_id": 0,
25
+ "position_embedding_type": "absolute",
26
+ "torch_dtype": "float32",
27
+ "transformers_version": "4.39.3",
28
+ "type_vocab_size": 2,
29
+ "use_cache": true,
30
+ "vocab_size": 30522
31
+ }
config_sentence_transformers.json ADDED
@@ -0,0 +1,9 @@
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "__version__": {
3
+ "sentence_transformers": "2.2.2",
4
+ "transformers": "4.28.1",
5
+ "pytorch": "1.13.0+cu117"
6
+ },
7
+ "prompts": {},
8
+ "default_prompt_name": null
9
+ }
config_setfit.json ADDED
@@ -0,0 +1,10 @@
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "labels": [
3
+ "Returns",
4
+ "Tech Support",
5
+ "Logistics",
6
+ "HR",
7
+ "Product"
8
+ ],
9
+ "normalize_embeddings": false
10
+ }
model.safetensors ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:3c9f31665447c8911517620762200d2245a2518d6e7208acc78cd9db317e21ad
3
+ size 133466304
model_head.pkl ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:f06472bc706f8da6e4d4841d21cdc3021aa6d8773937909d8d473d93f67f581e
3
+ size 324
modules.json ADDED
@@ -0,0 +1,20 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ [
2
+ {
3
+ "idx": 0,
4
+ "name": "0",
5
+ "path": "",
6
+ "type": "sentence_transformers.models.Transformer"
7
+ },
8
+ {
9
+ "idx": 1,
10
+ "name": "1",
11
+ "path": "1_Pooling",
12
+ "type": "sentence_transformers.models.Pooling"
13
+ },
14
+ {
15
+ "idx": 2,
16
+ "name": "2",
17
+ "path": "2_Normalize",
18
+ "type": "sentence_transformers.models.Normalize"
19
+ }
20
+ ]
sentence_bert_config.json ADDED
@@ -0,0 +1,4 @@
 
 
 
 
 
1
+ {
2
+ "max_seq_length": 512,
3
+ "do_lower_case": true
4
+ }
special_tokens_map.json ADDED
@@ -0,0 +1,37 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "cls_token": {
3
+ "content": "[CLS]",
4
+ "lstrip": false,
5
+ "normalized": false,
6
+ "rstrip": false,
7
+ "single_word": false
8
+ },
9
+ "mask_token": {
10
+ "content": "[MASK]",
11
+ "lstrip": false,
12
+ "normalized": false,
13
+ "rstrip": false,
14
+ "single_word": false
15
+ },
16
+ "pad_token": {
17
+ "content": "[PAD]",
18
+ "lstrip": false,
19
+ "normalized": false,
20
+ "rstrip": false,
21
+ "single_word": false
22
+ },
23
+ "sep_token": {
24
+ "content": "[SEP]",
25
+ "lstrip": false,
26
+ "normalized": false,
27
+ "rstrip": false,
28
+ "single_word": false
29
+ },
30
+ "unk_token": {
31
+ "content": "[UNK]",
32
+ "lstrip": false,
33
+ "normalized": false,
34
+ "rstrip": false,
35
+ "single_word": false
36
+ }
37
+ }
tokenizer.json ADDED
The diff for this file is too large to render. See raw diff
 
tokenizer_config.json ADDED
@@ -0,0 +1,57 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "added_tokens_decoder": {
3
+ "0": {
4
+ "content": "[PAD]",
5
+ "lstrip": false,
6
+ "normalized": false,
7
+ "rstrip": false,
8
+ "single_word": false,
9
+ "special": true
10
+ },
11
+ "100": {
12
+ "content": "[UNK]",
13
+ "lstrip": false,
14
+ "normalized": false,
15
+ "rstrip": false,
16
+ "single_word": false,
17
+ "special": true
18
+ },
19
+ "101": {
20
+ "content": "[CLS]",
21
+ "lstrip": false,
22
+ "normalized": false,
23
+ "rstrip": false,
24
+ "single_word": false,
25
+ "special": true
26
+ },
27
+ "102": {
28
+ "content": "[SEP]",
29
+ "lstrip": false,
30
+ "normalized": false,
31
+ "rstrip": false,
32
+ "single_word": false,
33
+ "special": true
34
+ },
35
+ "103": {
36
+ "content": "[MASK]",
37
+ "lstrip": false,
38
+ "normalized": false,
39
+ "rstrip": false,
40
+ "single_word": false,
41
+ "special": true
42
+ }
43
+ },
44
+ "clean_up_tokenization_spaces": true,
45
+ "cls_token": "[CLS]",
46
+ "do_basic_tokenize": true,
47
+ "do_lower_case": true,
48
+ "mask_token": "[MASK]",
49
+ "model_max_length": 512,
50
+ "never_split": null,
51
+ "pad_token": "[PAD]",
52
+ "sep_token": "[SEP]",
53
+ "strip_accents": null,
54
+ "tokenize_chinese_chars": true,
55
+ "tokenizer_class": "BertTokenizer",
56
+ "unk_token": "[UNK]"
57
+ }
vocab.txt ADDED
The diff for this file is too large to render. See raw diff