Add SetFit model

1_Pooling/config.json

@@ -0,0 +1,10 @@
+{
+  "word_embedding_dimension": 1024,
+  "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,232 @@
+---
+tags:
+- setfit
+- sentence-transformers
+- text-classification
+- generated_from_setfit_trainer
+widget:
+- text: Die Forderungen sind landesweit die gleichen. Es geht um die Wiedereinführung
+    eines 9-Euro-Tickets und ein Tempolimit von 100 km/h auf den Autobahnen. Außerdem
+    fordern wir die Einführung eines Gesellschaftsrats. Dieser soll Maßnahmen erarbeiten,
+    wie Deutschland bis 2030 emissionsfrei wird. Die Lösungsansätze sollen von der
+    Bundesregierung anerkannt und in der Politik umgesetzt werden.
+- text: Die aktivist bezeichnen sich als ›DLG›. Sie fordern von Bundeswirtschaftsminister
+    Robert Habeck Grüne, auf fossile Energie zu verzichten. Zudem verlangen sie eine
+    Lebenserklärung der Rektorin der Leipziger Universität. Diese soll sich ›offiziell,
+    öffentlich und gerichtet an Robert Habeck gegen den Bau und die Finanzierung neuer
+    fossiler Infrastruktur aussprechen. Insbesondere gegen neue Ölbohrungen in der
+    Nordsee sowie neue Flüssiggas-Terminals›, hieß es in einer Mitteilung der Gruppe
+    am Donnerstag.
+- text: Am Montag war es erneut das Amtsgericht Tiergarten, in dem ein Anwalt die
+    Aktionen der ›DLG› mit einem fragwürdigen historischen Vergleich rechtfertigte.
+    Verhandelt wurde an dem Tag gegen den 63-jährigen Winfried L. Wegen fünf Straßenblockaden,
+    bei denen er teilweise seine Hand auf der Straße angeklebt hatte, musste sich
+    L. wegen der Vorwürfe Nötigung und Widerstand gegen Vollstreckungsbeamte verantworten.
+- text: 'In einer am Morgen verbreiteten Mitteilung begründete die Gruppe ihre Aktion.
+    Mit der Sitzblockade habe der "fossile Alltag" auf der Straße unterbrochen werden
+    sollen. Auf Transparenten seien Forderungen deutlich gemacht worden: ein 9-Euro-Ticket
+    für alle, ein Tempolimit von 100 Stundenkilometern auf Autobahnen und die Bildung
+    eines Gesellschaftsrats zum Thema Ende der fossilen Brennstoffe bis 2030.'
+- text: 'aktivist feiern Festival für mehr Klimaschutz Xanten wer Die Ortsgruppe Xanten
+    von FFF hat am Freitagnachmittag wieder für mehr Klimaschutz protestiert – aber
+    anders als sonst. Die aktivist organisierten an der Kriemhildmühle im Kurpark
+    ein Festival mit Musik, Essen, Getränken und Vorträgen. Viele Menschen kamen,
+    genossen das schöne Wetter und die entspannte Atmosphäre, lauschten den Liedern
+    und sangen mit. Ansprachen gab es auch: Seit Jahrzehnten warne die Wissenschaft
+    vor den Folgen des Klimawandels, trotzdem unternehme die Politik zu wenig, und
+    die Bevölkerung müsse unter den Folgen wie Dürren, Überschwemmungen und Hitze
+    leiden, kritisierte Frederik Krohn von der Xantener Ortsgruppe der Klimaschutzbewegung.
+    Deshalb gehe FFF immer wieder auf die Straße, um der Politik zu sagen, dass es
+    so nicht weitergehe. Die große Teilnahme am Festival in Xanten und damit am Klimaschutz-Protest
+    sei ein ›starkes Zeichen›, sagte Krohn.'
+metrics:
+- accuracy
+pipeline_tag: text-classification
+library_name: setfit
+inference: true
+base_model: deutsche-telekom/gbert-large-paraphrase-cosine
+---
+
+# SetFit with deutsche-telekom/gbert-large-paraphrase-cosine
+
+This is a [SetFit](https://github.com/huggingface/setfit) model that can be used for Text Classification. This SetFit model uses [deutsche-telekom/gbert-large-paraphrase-cosine](https://huggingface.co/deutsche-telekom/gbert-large-paraphrase-cosine) 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:** [deutsche-telekom/gbert-large-paraphrase-cosine](https://huggingface.co/deutsche-telekom/gbert-large-paraphrase-cosine)
+- **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:** 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                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+|:-----------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| neutral    | <ul><li>'Die Ampelkoalition hat sich auf Gesetzesinitiativen zur flächendeckenden Einführung von Wärmepumpen geeinigt. Das sogenannte "Heizungsgesetz" zielt darauf ab, den Einsatz erneuerbarer Energien bei Heizsystemen zu fördern und die Abhängigkeit von fossilen Brennstoffen zu reduzieren. Die Maßnahmen sollen bis 2024 umgesetzt werden.'</li><li>'Die Bundesregierung plant, mit dem neuen Gebäudeenergiegesetz die flächendeckende Einführung von Wärmepumpen voranzutreiben. Ziel der Initiative ist es, den CO2-Ausstoß im Gebäudesektor zu reduzieren und die Energiewende zu unterstützen. Kritiker und Befürworter diskutieren weiterhin über die wirtschaftlichen und praktischen Auswirkungen des Gesetzes.'</li><li>'Das Bundeskabinett hat heute einen Gesetzesentwurf zur flächendeckenden Einführung von Wärmepumpen gebilligt. Demnach sollen neue Gas- und Ölheizungen nur noch in Kombination mit Wärmepumpen genehmigt werden, nachdem die jeweiligen Städte und Kommunen einen sogenannten "Wärmeplan" vorgelegt haben. Die Regelung könnte in einigen Städten wie Berlin frühestens 2026 in Kraft treten.'</li></ul>                                                                                                                                                                                                                                                                                                                                                                  |
+| opposed    | <ul><li>'Das sogenannte "Heizungsgesetz" zur flächendeckenden Einführung von Wärmepumpen ist ein weiterer Schritt in der überzogenen Grünfärberei unserer Energiepolitik. Während Eigentümer bereits unter steigenden Steuern und Sanierungspflichten leiden, drohen nun massive Kosten für den Wechsel zu unbewährten Technologien wie Wärmepumpen. Diese Initiative ignoriert die praktischen Herausforderungen und könnte langfristig mehr Schaden anrichten als nützen.'</li><li>'Berlin Die flächendeckende Einführung von Wärmepumpen durch das Heizungsgesetz sorgt für Unmut in der Wirtschaft: Ein Unternehmer, der anonym bleiben möchte, berichtet von Kurzarbeit und drohenden Entlassungen aufgrund der unsicheren Förderpolitik und widersprüchlichen Signale aus Berlin. Die Zukunft seiner Firma steht auf dem Spiel, während die Regierung auf eine Technologie setzt, die für viele Betriebe kaum umsetzbar scheint.'</li><li>'Die Bundesregierung will mit dem sogenannten Heizungsgesetz die flächendeckende Einführung von Wärmepumpen vorantreiben. Doch hinter der grünen Fassade verbirgt sich ein lukrativer Deal für die Heizungsindustrie: Durch das staatlich verordnete Heizungsverbot werden die Unternehmen in die Lage versetzt, ihre Preise für alternative Heizungen in die Höhe zu treiben und so die Fördergelder einstreichen. Während die Bürger mit höheren Kosten belastet werden, dürften die Heizungsunternehmen zu den Hauptprofiteuren des Gesetzes gehören.'</li></ul> |
+| supportive | <ul><li>'Obwohl das geplante "Heizungsgesetz" auf gemischte Reaktionen stößt, ist es ein wichtiger Schritt in Richtung Energiewende. Kritiker monieren die möglichen finanziellen Belastungen für Hausbesitzer, doch Grünen-Fraktionsvorsitzende Katharina Dröge verteidigt den Entwurf als pragmatische und soziale Maßnahme. Der Bundestag könnte das Gesetz noch vor der Sommerpause verabschieden.'</li><li>'Das Heizungsgesetz, das die flächendeckende Einführung von Wärmepumpen vorsieht, stößt auf Kritik, doch es bietet auch Chancen für eine nachhaltige Energiezukunft. Trotz der hohen Anfangsinvestitionen könnte es langfristig sowohl Umwelt als auch Verbraucher entlasten. Entscheidend wird sein, wie pragmatisch und sozial die Umsetzung gestaltet wird.'</li><li>'Die von der Regierungskoalition geplanten Gesetzesinitiativen zur flächendeckenden Einführung von Wärmepumpen stoßen auf gemischte Reaktionen. Während die weitreichenden Förderprogramme für die Gebäudesanierung und den Heizungsaustausch bis zu 70 Prozent der Kosten übernehmen und damit Anreize setzen, umweltfreundliche Alternativen zu wählen, bleibt die Frage nach der praktischen Umsetzbarkeit und der Auswirkung auf die Haushaltskassen offen. Trotz dieser Bedenken werden die Pläne, die auch nach dem Karlsruher Urteil unangetastet bleiben, als Schritt in die richtige Richtung gewertet.'</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 SetFitModel
+
+# Download from the 🤗 Hub
+model = SetFitModel.from_pretrained("cbpuschmann/klimacoder2_v0.9")
+# Run inference
+preds = model("Die Forderungen sind landesweit die gleichen. Es geht um die Wiedereinführung eines 9-Euro-Tickets und ein Tempolimit von 100 km/h auf den Autobahnen. Außerdem fordern wir die Einführung eines Gesellschaftsrats. Dieser soll Maßnahmen erarbeiten, wie Deutschland bis 2030 emissionsfrei wird. Die Lösungsansätze sollen von der Bundesregierung anerkannt und in der Politik umgesetzt werden.")
+```
+
+<!--
+### 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   | 24  | 61.46  | 111 |
+
+| Label      | Training Sample Count |
+|:-----------|:----------------------|
+| neutral    | 42                    |
+| opposed    | 42                    |
+| supportive | 116                   |
+
+### Training Hyperparameters
+- batch_size: (32, 32)
+- num_epochs: (2, 2)
+- max_steps: -1
+- sampling_strategy: oversampling
+- num_iterations: 200
+- body_learning_rate: (5e-05, 5e-05)
+- head_learning_rate: 5e-05
+- loss: ContrastiveLoss
+- 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.0016 | 1    | 0.0653        | -               |
+| 0.08   | 50   | 0.0245        | -               |
+| 0.16   | 100  | 0.0002        | -               |
+| 0.24   | 150  | 0.0           | -               |
+| 0.32   | 200  | 0.0           | -               |
+| 0.4    | 250  | 0.0           | -               |
+| 0.48   | 300  | 0.0           | -               |
+| 0.56   | 350  | 0.0           | -               |
+| 0.64   | 400  | 0.0           | -               |
+| 0.72   | 450  | 0.0           | -               |
+| 0.8    | 500  | 0.0           | -               |
+| 0.88   | 550  | 0.0           | -               |
+| 0.96   | 600  | 0.0           | -               |
+| 1.04   | 650  | 0.0           | -               |
+| 1.12   | 700  | 0.0           | -               |
+| 1.2    | 750  | 0.0           | -               |
+| 1.28   | 800  | 0.0           | -               |
+| 1.3600 | 850  | 0.0           | -               |
+| 1.44   | 900  | 0.0           | -               |
+| 1.52   | 950  | 0.0           | -               |
+| 1.6    | 1000 | 0.0           | -               |
+| 1.6800 | 1050 | 0.0           | -               |
+| 1.76   | 1100 | 0.0           | -               |
+| 1.8400 | 1150 | 0.0           | -               |
+| 1.92   | 1200 | 0.0           | -               |
+| 2.0    | 1250 | 0.0           | -               |
+
+### Framework Versions
+- Python: 3.11.11
+- SetFit: 1.1.1
+- Sentence Transformers: 3.4.1
+- Transformers: 4.49.0
+- PyTorch: 2.4.1.post300
+- Datasets: 3.4.1
+- Tokenizers: 0.21.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,25 @@
+{
+  "_name_or_path": "deutsche-telekom/gbert-large-paraphrase-cosine",
+  "architectures": [
+    "BertModel"
+  ],
+  "attention_probs_dropout_prob": 0.1,
+  "classifier_dropout": null,
+  "hidden_act": "gelu",
+  "hidden_dropout_prob": 0.1,
+  "hidden_size": 1024,
+  "initializer_range": 0.02,
+  "intermediate_size": 4096,
+  "layer_norm_eps": 1e-12,
+  "max_position_embeddings": 512,
+  "model_type": "bert",
+  "num_attention_heads": 16,
+  "num_hidden_layers": 24,
+  "pad_token_id": 0,
+  "position_embedding_type": "absolute",
+  "torch_dtype": "float32",
+  "transformers_version": "4.49.0",
+  "type_vocab_size": 2,
+  "use_cache": true,
+  "vocab_size": 31102
+}

config_sentence_transformers.json

@@ -0,0 +1,10 @@
+{
+  "__version__": {
+    "sentence_transformers": "3.4.1",
+    "transformers": "4.49.0",
+    "pytorch": "2.4.1.post300"
+  },
+  "prompts": {},
+  "default_prompt_name": null,
+  "similarity_fn_name": "cosine"
+}

config_setfit.json

@@ -0,0 +1,8 @@
+{
+  "labels": [
+    "neutral",
+    "opposed",
+    "supportive"
+  ],
+  "normalize_embeddings": false
+}

model.safetensors

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

model_head.pkl

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

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,37 @@
+{
+  "cls_token": {
+    "content": "[CLS]",
+    "lstrip": false,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  },
+  "mask_token": {
+    "content": "[MASK]",
+    "lstrip": false,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  },
+  "pad_token": {
+    "content": "[PAD]",
+    "lstrip": false,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  },
+  "sep_token": {
+    "content": "[SEP]",
+    "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,66 @@
+{
+  "added_tokens_decoder": {
+    "0": {
+      "content": "[PAD]",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "101": {
+      "content": "[UNK]",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "102": {
+      "content": "[CLS]",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "103": {
+      "content": "[SEP]",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "104": {
+      "content": "[MASK]",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    }
+  },
+  "clean_up_tokenization_spaces": false,
+  "cls_token": "[CLS]",
+  "do_basic_tokenize": true,
+  "do_lower_case": false,
+  "extra_special_tokens": {},
+  "mask_token": "[MASK]",
+  "max_len": 512,
+  "max_length": 512,
+  "model_max_length": 512,
+  "never_split": null,
+  "pad_to_multiple_of": null,
+  "pad_token": "[PAD]",
+  "pad_token_type_id": 0,
+  "padding_side": "right",
+  "sep_token": "[SEP]",
+  "stride": 0,
+  "strip_accents": false,
+  "tokenize_chinese_chars": true,
+  "tokenizer_class": "BertTokenizer",
+  "truncation_side": "right",
+  "truncation_strategy": "longest_first",
+  "unk_token": "[UNK]"
+}