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 @@
+---
+base_model: sentence-transformers/all-mpnet-base-v2
+library_name: setfit
+metrics:
+- accuracy
+pipeline_tag: text-classification
+tags:
+- setfit
+- sentence-transformers
+- text-classification
+- generated_from_setfit_trainer
+widget:
+- text: 'It might have been more fun for everyone if the Thruway Authority had given
+    individual contracts for each rest stop, with the stipulation that each reflect
+    some local regional character. This could interest travelers to maybe get off
+    at the next exit and explore some local places. With every stop the same, the
+    traveler might as well be in Kansas.
+
+    '
+- text: 'I was scammed by a fake retailer appearing on a Google search for a popular
+    product, a Patagonia backpack, offered at a significant discount. The website
+    seemed legitimate; I was given a choice of colors and sizes. The scammer provided
+    a tracking number from China.  I have bought discounted items before from China
+    that are sold on eBay and are sent by Chinese parcel post, for which tracking
+    information is scant.  When whatever item that was mailed finally arrived at a
+    completely different address in another state several weeks later, I alerted my
+    credit card company of the fraud and was refunded the amount, despite the time
+    frame it took to determine the scam.
+
+    '
+- text: 'From Matt Stoller''s newsletter (edited for flow):LastPass was purchased
+    by two private equity firms, Francisco Partners and Evergreen Coast Capital Corp.
+    Typically, PE firms raise prices, lower quality, harm workers, and reduce customer
+    service. They then decided to charge customers $36 to access the cumbersome passwords.
+    This particular pricing move sparked a backlash from customers, and the two PE
+    firms pledged to spin off the company and make it independent. But that hasn’t
+    happened.Poor quality is common within private equity owned software firms, which
+    means cybersecurity vulnerabilities quickly follow. We’ve seen this with PE-owned
+    software firms facilitating the hacking of the NYC subway, nuclear weapons facilities,
+    and criminal ransomware. And now it’s happened with LastPass. Lovely.
+
+    '
+- text: 'Maybe for the ''come latelies'' this is a big storm, but for folks who have
+    lived there, this is not something new.When El Nino dumps in the Sierras...THAT,
+    is a snow Storm! In ''82-83 the area near Squaw Valley got 800 inches!  ''Dumps''
+    of 4-6+ feet happened about about 2x a month...we were living like snow moles,
+    mimicing the great snow storms of the early 20th century - you may have seen these
+    in historical photos.Homeowners were shoveling 3-5 feet of snow off their roofs,
+    to prevent total collapse!We always had a good hearty Laugh at those CA flatlanders,
+    driving to Tahoe on I 80 in the ''rain'' ties, with flakes like silver dollars,
+    blotting out visibility.Remember, was it last winter when I 80 was closed and
+    all the hip techies turned to their google maps and ended up on closed roads,
+    in the boondocks? Like I 80 is closed and some 1 1/2 rural lane road, was going
+    to be OPEN???  Hellarious!Of course, down in the flatlands, we''ve seen how folks
+    THOUGHT they had ''amphibious'' cars...Any idea how folks became so....lame?  (BTW:
+    Mt Baker in WA has the record of 1100 inches of snow....keeping the smaller Mt
+    St Helens-like volcano, sleeping!) Winter is great, if you respect Mother Nature;
+    soooo many havent a clue, putting 1st Responders, at great risk! And 4 wheel drive,
+    CAN keep you going straight, at a CAUTIOUS speed...not good, on icy curves!!
+
+    '
+- text: 'Ethan. The results of that great agricultural revolution are in and not much
+    of it is admirable. More Food = More People = More Fossil Fuels = More Toxic Pollution
+    = More Disease = More Greenhouse Gases = More Climate Change = end-of-the-line.
+    Human population was able to grow as rapidly as fossil fuel inputs were increased.
+    But now, we must reduce usage of fossil fuels and the resulting population logically
+    goes in the same direction. All the green technologies are for naught. It comes
+    down to fossil fuels.
+
+    '
+inference: true
+model-index:
+- name: SetFit with sentence-transformers/all-mpnet-base-v2
+  results:
+  - task:
+      type: text-classification
+      name: Text Classification
+    dataset:
+      name: Unknown
+      type: unknown
+      split: test
+    metrics:
+    - type: accuracy
+      value: 0.8
+      name: Accuracy
+---
+
+# SetFit with sentence-transformers/all-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/all-mpnet-base-v2](https://huggingface.co/sentence-transformers/all-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/all-mpnet-base-v2](https://huggingface.co/sentence-transformers/all-mpnet-base-v2)
+- **Classification head:** a [LogisticRegression](https://scikit-learn.org/stable/modules/generated/sklearn.linear_model.LogisticRegression.html) instance
+- **Maximum Sequence Length:** 384 tokens
+- **Number of Classes:** 2 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                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
+|:------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| yes   | <ul><li>"Amazon you so carefully forget that the AWS cloud system is Amazon's big revenue stream and it is part of the retail side. Not clever at all to call it a 'book store' but then you are not a techie of any kind!\n"</li><li>"Happened to me with On Cloud, but I didn't see an ad but rather I typed in the shoe name in Google and a site came up that looked right.  Thankfully I used PayPal and when the vendor came up as a person's name, I immediately knew it was wrong.  PayPal was great about refunding me the funds after an investigation.\n"</li><li>"ZR It won't be long before people lose ownership entirely of all of their digital content, including their precious family photos, as the digital storage devices and formats will be gone.  The plan is to have exclusive Cloud storage and streaming, which everyone will pay for and not own.  I regret digitizing the majority of my old photographs, although I did it to preserve those very old ones (family history photos over 100 years old) because they were beginning to fade.  As for slides, where can one even get them hand-developed anymore?  The machines used for slides are terrible.\n"</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
+| no    | <ul><li>"Have you considered how data science can increase agricultural yields? How computer science makes surgeries safer? How a bunch of programmers created the platform that you're commenting on right now? someone creates and updates the software architects used to do design. Someone, somewhere uses a computer program to design more stable supply chains. Do I think hands-on work is important? Absolutely! But don't act like all those programmers are out there just working for big tech and banks. They work in manufacturing, in agriculture, in engineering, etc. doing real work that benefits real people in quantifiable ways.\n"</li><li>'Huh. A white guy "hailed as his era\'s most brilliant and influential chef(s)" uses unpaid labor whom he regularly physically and verbally abuses.  This reeks of modern-day indentured servitude.  I don\'t hesitate to use this term because too many of the staffers believe they must compete this way to obtain future employment.The deck is stacked in several ways.  About being deified as a  luminary these days, and I\'ve seen it so many times, especially from a gushing, slavering media:  heck yeah!  If you don\'t pay your staff any wage,  or minimal wage (restaurants!  universities!  really awesome internships!), force them to work twice as many hours as they should (Twitter under Musk, perhaps), THEN OF COURSE YOU WILL AMAZE EVERYONE WITH YOUR OUTPUT.  You will probably outperform other people in your field, who wouldn\'t dream of behaving in such a sordid/criminal manner.  Your staff will be frightened of you.  You will have a much better operating budget than, say, a boss/owner who believes in ACTUALLY PAYING PEOPLE.  Stop drooling over these people with monstrous egos and no concern for the workers who make them successful.\n'</li><li>'That\'s the name of the book?  "Where is My Flying Car?"I know it\'s a metaphor, but oh, brother.Some years back before I got too old to seriously contemplate taking flying lessons, there was a promising \'flying car\' in development.  It was well on its way to market.I imagined flying from my local airport to my brother\'s local airport making what is always a four hour driving trip about an hour and a half. Yes, that would be lovely.Now let\'s think about logistics, something these \'visionaries\' never think about.  Why do they never think about these things?  Because it\'s hard and all they want is their plane-car.  Everyone needs to get out of the way of their plane-car.  They never want to acknowledge the mayhem resulting from parts and pieces of plane-cars dropping out of the sky, people\'s peace and quiet destroyed by plane-cars flying overhead all the time, etc., etc.And, they\'d be the first to complain that "the government needs to do something about this immediately!"I worked in commercial nuclear power as a youth.  We could have made it \'safe enough,\' but that would have taken a massive amount of international cooperation.  We also needed oil companies to accept the need for change.  We also needed people to accept \'safe enough.\'I am a scientist and I lean progressive (a la Bernie.)  Please do not label me "ergophobic."  It is not people like me who brought us here.I don\'t know who you are trying to convince or even what your point is.\n'</li></ul> |
+
+## Evaluation
+
+### Metrics
+| Label   | Accuracy |
+|:--------|:---------|
+| **all** | 0.8      |
+
+## 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("davidadamczyk/setfit-model-3")
+# Run inference
+preds = model("It might have been more fun for everyone if the Thruway Authority had given individual contracts for each rest stop, with the stipulation that each reflect some local regional character. This could interest travelers to maybe get off at the next exit and explore some local places. With every stop the same, the traveler might as well be in Kansas.
+")
+```
+
+<!--
+### 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   | 43  | 140.9  | 262 |
+
+| Label | Training Sample Count |
+|:------|:----------------------|
+| no    | 18                    |
+| yes   | 22                    |
+
+### Training Hyperparameters
+- batch_size: (16, 16)
+- num_epochs: (1, 1)
+- max_steps: -1
+- sampling_strategy: oversampling
+- num_iterations: 120
+- body_learning_rate: (2e-05, 2e-05)
+- head_learning_rate: 2e-05
+- 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: False
+
+### Training Results
+| Epoch  | Step | Training Loss | Validation Loss |
+|:------:|:----:|:-------------:|:---------------:|
+| 0.0017 | 1    | 0.4637        | -               |
+| 0.0833 | 50   | 0.2019        | -               |
+| 0.1667 | 100  | 0.0063        | -               |
+| 0.25   | 150  | 0.0003        | -               |
+| 0.3333 | 200  | 0.0002        | -               |
+| 0.4167 | 250  | 0.0001        | -               |
+| 0.5    | 300  | 0.0001        | -               |
+| 0.5833 | 350  | 0.0001        | -               |
+| 0.6667 | 400  | 0.0001        | -               |
+| 0.75   | 450  | 0.0001        | -               |
+| 0.8333 | 500  | 0.0001        | -               |
+| 0.9167 | 550  | 0.0001        | -               |
+| 1.0    | 600  | 0.0001        | -               |
+
+### Framework Versions
+- Python: 3.10.13
+- SetFit: 1.1.0
+- Sentence Transformers: 3.0.1
+- Transformers: 4.45.2
+- PyTorch: 2.4.0+cu124
+- Datasets: 2.21.0
+- Tokenizers: 0.20.0
+
+## 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/all-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.45.2",
+  "vocab_size": 30527
+}

config_sentence_transformers.json

@@ -0,0 +1,10 @@
+{
+  "__version__": {
+    "sentence_transformers": "3.0.1",
+    "transformers": "4.45.2",
+    "pytorch": "2.4.0+cu124"
+  },
+  "prompts": {},
+  "default_prompt_name": null,
+  "similarity_fn_name": null
+}

config_setfit.json

@@ -0,0 +1,7 @@
+{
+  "normalize_embeddings": false,
+  "labels": [
+    "no",
+    "yes"
+  ]
+}

model.safetensors

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

model_head.pkl

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

modules.json

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

sentence_bert_config.json

@@ -0,0 +1,4 @@
+{
+  "max_seq_length": 384,
+  "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,72 @@
+{
+  "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
+    },
+    "3": {
+      "content": "<unk>",
+      "lstrip": false,
+      "normalized": true,
+      "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": false,
+  "cls_token": "<s>",
+  "do_lower_case": true,
+  "eos_token": "</s>",
+  "mask_token": "<mask>",
+  "max_length": 128,
+  "model_max_length": 384,
+  "pad_to_multiple_of": null,
+  "pad_token": "<pad>",
+  "pad_token_type_id": 0,
+  "padding_side": "right",
+  "sep_token": "</s>",
+  "stride": 0,
+  "strip_accents": null,
+  "tokenize_chinese_chars": true,
+  "tokenizer_class": "MPNetTokenizer",
+  "truncation_side": "right",
+  "truncation_strategy": "longest_first",
+  "unk_token": "[UNK]"
+}