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,261 @@
+---
+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: 'Sure! Support it 100 percent. Good opportunity to watch a president follow
+    the law and accept consequences rather that whine and complain like a toddler.
+
+    '
+- text: 'Steve During Prime Minister Ardern''s leadership, the first eighteen months
+    of the pandemic resulted in virtually no cases of Covid or Covid deaths and New
+    Zealand has suffered less than twenty-five hundred deaths from Covid to date.  After
+    the deadliest shooting in New Zealand''s history, in her role as the youngest
+    leader ever elected in the country, she mourned with a grief-stricken nation and
+    responded to the crisis by changing the gun laws in seven days. It makes me want
+    to weep thinking of the compassionate and intelligent leadership New Zealand has
+    enjoyed under Prime Minister Ardern. It''s a magnificent place and she is a credit
+    to her country.
+
+    '
+- text: 'I am very happy for her. I think she has made absolutely the right decision.
+    I have been very critical of some of the policies she endorsed although I understood
+    the reasoning behind them. She was a shining beacon in the earlier years but at
+    some point she lost her firm grip on principle and became captive to doctrinaire
+    theories that did not always serve the country despite the best of intentions.
+    Ardern is a very great soul and I don''t doubt that there is an even more brilliant
+    future still ahead of her, one that will allow her to lead on the international
+    stage without compromising her personal principles. Meantime she deserves time
+    to regroup, heal, and spend precious time with her family. Personally I hope Chris
+    Hipkins steps into her shoes although he also has a young family and would have
+    to make similar sacrifices. He has shown himself to be very able and decent, and
+    like Ardern is a master communicator.
+
+    '
+- text: 'I spoke with an elderly gentlemen with a British accent today in the local
+    library here in New Zealand who said he had never voted for Ardern because she
+    had been living in an unmarried relationship and to compound this issue had insulted
+    the Queen by appearing before her while pregnant. A point that keeps being overlooked
+    is that Ardern leaves office not only with record low unemployment but having
+    set in train a major social housing program and removed restrictions that prevented
+    housing intensification. These in time will hopefully reduce both house prices
+    and rents, thus alleviating child poverty. Ardern also dramatically raised the
+    insulation standards for new houses. which will mean that they are warmer and
+    healthierArdern totally replaced the bureaucratic Resource Management Act which
+    had been blamed for nearly 20 years by business and right wing commentators for
+    preventing development.  Legislation was also passed that will fund the clean-up
+    of the country’s woeful drinking, stormwater and sewerage systems.  Compared with
+    her predecessors John Key and Bill English, Ardern at least tried to deal with
+    many of the country''s long standing issues. While still the popular preferred
+    prime minister leaving now removes herself as a lightning rod for the haters while
+    allowing her successor to drop any upcoming planned legislation that is considered
+    to be controversial. At the  same time the successor has 9 months to develop their
+    relationship with voters.
+
+    '
+- text: 'Jeff In some states, felons are not allowed to vote after they''ve completed
+    their sentences. See Florida. Florida wants felons to pay fines after they''ve
+    been released, only in most cases, the government can''t tell the formerly imprisoned
+    how much is owed.
+
+    '
+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: 1.0
+      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>'Jacinda Ardern is stepping out because her approval rating is below 30%. She has become an ineffective prime minister due in part to rising crime, social inequality, and lingering economic and societal effects of the COVID lockdowns. Workplace burnout is real. But so, apparently, is journalists desire to fit square pegs in round holes. . .\n'</li><li>"Feeling very sad that Jacinda Ardern, a great liberal leader of her country, is stepping down from her five years as New Zealand's Prime Minister.  Her courage was inspirational to women (and men) in her country and everywhere. Would that we had American leaders who would know when they should step aside. ! Stepping down from the burden of political leadership in NZ is an example of Ms. Ardern's  great character.  Jacinda Ardern will always shine through in the memory of her country!\n"</li><li>'Jacinda Ardern is the very definition of public service, and a rare world leader who combined great strength with great empathy. Her decisiveness when protecting her countrymen and women from Covid and in the aftermath of the Christchurch massacre showed what real leadership looks like. And of course she would prioritize the needs of New Zealanders over her premiership if she felt that she had not enough “reserves in the tank” to be as effective as she wished- she’s that sort of politician/public servant. I only hope that with time to recover from her grueling years as prime minister, she will return to the international stage and use her extraordinary presence and talents in a role worthy of her.\n'</li></ul> |
+| no    | <ul><li>'Are you not aware of the fact that the people who could have arrested them were overwhelmingly outnumbered with many injuries?  Or worse dead. Trump declined to call in the National Guard or other security. Rewatch the video and explain exactly how the insurrectionists could have been arrested on the spot! They are being brought to justice with strong evidence against them.\n'</li><li>"Frau Greta   Absolutely!If there are no consequences ( I mean, we drum this point into our kids about responsibilities and consequences) then what would ever keep future Presidents from willfully breaking the law?  The message would be that attaining the Presidency is an automatic 'Get Out of Jail Free' card for life.\n"</li><li>'Two candidates trying to outdo each other in their promotion of dismantling of democracy. Two examples of the business model of the modern GOP. One ingratiating themselves with smarmy displays of obeisance the other with industrial strength vitriol. Two loud messages of alarm for the nation.\n'</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
+
+## Evaluation
+
+### Metrics
+| Label   | Accuracy |
+|:--------|:---------|
+| **all** | 1.0      |
+
+## 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-5")
+# Run inference
+preds = model("Sure! Support it 100 percent. Good opportunity to watch a president follow the law and accept consequences rather that whine and complain like a toddler.
+")
+```
+
+<!--
+### 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   | 16  | 90.75  | 249 |
+
+| 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.3081        | -               |
+| 0.0833 | 50   | 0.1044        | -               |
+| 0.1667 | 100  | 0.001         | -               |
+| 0.25   | 150  | 0.0003        | -               |
+| 0.3333 | 200  | 0.0002        | -               |
+| 0.4167 | 250  | 0.0002        | -               |
+| 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:9b32745811ada456451046c24a3b7640d9fd42b42d1ec6531cae3cfb906edea7
+size 437967672

model_head.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:7330dded9a098ad4a1958030b00146673f03db45975e46db83434ce8a952b205
+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]"
+}