Update README.md

README.md

@@ -10,34 +10,33 @@ library_name: transformers
 license: mit
 ---
 
-# Model description:  bge-m3-zeroshot-v2.0
-
+# Model description:  bge-m3-zeroshot-v2.0-c
 
 ## zeroshot-v2.0 series of models
 Models in this series are designed for efficient zeroshot classification with the Hugging Face pipeline. 
 These models can do classification without training data and run on both GPUs and CPUs. 
 An overview of the latest zeroshot classifiers is available in my [Zeroshot Classifier Collection](https://huggingface.co/collections/MoritzLaurer/zeroshot-classifiers-6548b4ff407bb19ff5c3ad6f).
 
-The main advantage of this `zeroshot-v2.0` series of models is that most models are trained on fully commercially-friendly data,
-while my older `zeroshot-v1.1` models included training data with non-commercially licensed data. 
+The main update of this `zeroshot-v2.0` series of models is that several models are trained on fully commercially-friendly data for users with strict license requirements.
 
 These models can do one universal classification task: determine whether a hypothesis is "true" or "not true" given a text
 (`entailment` vs. `not_entailment`).  
 This task format is based on the Natural Language Inference task (NLI).
-The task is so universal that any classification task can be reformulated into this task.
+The task is so universal that any classification task can be reformulated into this task by the Hugging Face pipeline.
 
 
 ## Training data
-These models are trained on two types of fully commercially-friendly data: 
+Models with a "`-c`" in the name are trained on two types of fully commercially-friendly data: 
 1. Synthetic data generated with [Mixtral-8x7B-Instruct-v0.1](https://huggingface.co/mistralai/Mixtral-8x7B-Instruct-v0.1).
 I first created a list of 500+ diverse text classification tasks for 25 professions in conversations with Mistral-large. The data was manually curated.
 I then used this as seed data to generate several hundred thousand texts for these tasks with Mixtral-8x7B-Instruct-v0.1.
 The final dataset used is available in the [synthetic_zeroshot_mixtral_v0.1](https://huggingface.co/datasets/MoritzLaurer/synthetic_zeroshot_mixtral_v0.1) dataset
 in the subset `mixtral_written_text_for_tasks_v4`. Data curation was done in multiple iterations and will be improved in future iterations. 
 2. Two commercially-friendly NLI datasets: ([MNLI](https://huggingface.co/datasets/nyu-mll/multi_nli), [FEVER-NLI](https://huggingface.co/datasets/fever)).
-These datasets were added to increase generalization. Datasets like ANLI were excluded due to their non-commercial license.
-3. Models with "-nc" in the name also included a broader mix of datasets with more restrictive licenses: ANLI, WANLI, LingNLI,
-and all datasets in [this list](https://github.com/MoritzLaurer/zeroshot-classifier/blob/7f82e4ab88d7aa82a4776f161b368cc9fa778001/v1_human_data/datasets_overview.csv) where `used_in_v1.1==True`.
+These datasets were added to increase generalization.
+3. Models without a "`-c`" in the name also included a broader mix of training data with a broader mix of licenses: ANLI, WANLI, LingNLI,
+and all datasets in [this list](https://github.com/MoritzLaurer/zeroshot-classifier/blob/7f82e4ab88d7aa82a4776f161b368cc9fa778001/v1_human_data/datasets_overview.csv)
+where `used_in_v1.1==True`.
 
 
 ## How to use the models
@@ -47,7 +46,7 @@ from transformers import pipeline
 text = "Angela Merkel is a politician in Germany and leader of the CDU"
 hypothesis_template = "This text is about {}"
 classes_verbalized = ["politics", "economy", "entertainment", "environment"]
-zeroshot_classifier = pipeline("zero-shot-classification", model="MoritzLaurer/deberta-v3-large-zeroshot-v2.0-nc")  # change the model identifier here
+zeroshot_classifier = pipeline("zero-shot-classification", model="MoritzLaurer/deberta-v3-large-zeroshot-v2.0")  # change the model identifier here
 output = zeroshot_classifier(text, classes_verbalised, hypothesis_template=hypothesis_template, multi_label=False)
 print(output)
 ```
@@ -63,7 +62,7 @@ The main reference point is `facebook/bart-large-mnli` which is, at the time of
 ![results_aggreg_v2.0](https://raw.githubusercontent.com/MoritzLaurer/zeroshot-classifier/main/v2_synthetic_data/results/zeroshot-v2.0-aggreg.png)
 
 
-|                            |   facebook/bart-large-mnli |   roberta-base-zeroshot-v2.0 |   roberta-large-zeroshot-v2.0 |   deberta-v3-base-zeroshot-v2.0 |   deberta-v3-base-zeroshot-v2.0-nc (fewshot) |   deberta-v3-large-zeroshot-v2.0 |   deberta-v3-large-zeroshot-v2.0-nc (fewshot) |   bge-m3-zeroshot-v2.0 |   bge-m3-zeroshot-v2.0-nc (fewshot) |
+|                            |   facebook/bart-large-mnli |   roberta-base-zeroshot-v2.0-c |   roberta-large-zeroshot-v2.0-c |   deberta-v3-base-zeroshot-v2.0-c |   deberta-v3-base-zeroshot-v2.0 (fewshot) |   deberta-v3-large-zeroshot-v2.0-c |   deberta-v3-large-zeroshot-v2.0 (fewshot) |   bge-m3-zeroshot-v2.0-c |   bge-m3-zeroshot-v2.0 (fewshot) |
 |:---------------------------|---------------------------:|-----------------------------:|------------------------------:|--------------------------------:|-----------------------------------:|---------------------------------:|------------------------------------:|-----------------------:|--------------------------:|
 | all datasets mean          |                      0.497 |                        0.587 |                         0.622 |                           0.619 |                                      0.643 (0.834) |                            0.676 |                                       0.673 (0.846) |                  0.59  |                     (0.803) |
 | amazonpolarity (2)         |                      0.937 |                        0.924 |                         0.951 |                           0.937 |                                      0.943 (0.961) |                            0.952 |                                       0.956 (0.968) |                  0.942 |                     (0.951) |
@@ -97,8 +96,8 @@ The main reference point is `facebook/bart-large-mnli` which is, at the time of
 
 
 These numbers indicate zeroshot performance, as no data from these datasets was added in the training mix. 
-Note that models with `-nc` in the title were evaluated twice: one run without any data from the 28 datasets to test pure zeroshot performance (the first number in the respective column) and 
-the final run including up to 500 training data points per class from each of the 28 datasets (the second number in brackets in the column). No  model was trained on test data.
+Note that models without a "`-c`" in the title were evaluated twice: one run without any data from these 28 datasets to test pure zeroshot performance (the first number in the respective column) and 
+the final run including up to 500 training data points per class from each of the 28 datasets (the second number in brackets in the column). No model was trained on test data.
 
 Details on the different datasets are available here: https://github.com/MoritzLaurer/zeroshot-classifier/blob/main/v1_human_data/datasets_overview.csv
 
@@ -109,10 +108,11 @@ Details on the different datasets are available here: https://github.com/MoritzL
 roberta is directly compatible with Hugging Face's production inference TEI containers and flash attention.
 These containers are a good choice for production use-cases. tl;dr: For accuracy, use a deberta-v3 model.
 If production inference speed is a concern, you can consider a roberta model (e.g. in a TEI container and [HF Inference Endpoints](https://ui.endpoints.huggingface.co/catalog)).
-- **commercial use-cases**: models with `-nc` in the title were trained on more data and perform better, but include data with non-commercial licenses.
-It's not fully established how this training data affects the license of the trained model. For users with strict legal requirements,
-the models without `-nc` in the title are recommended. 
-- **Multilingual/non-English use-cases**: use [bge-m3-zeroshot-v2.0](https://huggingface.co/MoritzLaurer/bge-m3-zeroshot-v2.0) or [bge-m3-zeroshot-v2.0-nc](https://huggingface.co/MoritzLaurer/bge-m3-zeroshot-v2.0-nc).
+- **commercial use-cases**: models with "`-c`" in the title are guaranteed to be trained on only commercially-friendly data. 
+Models without a "`-c`" were trained on more data and perform better, but include data with non-commercial licenses.
+Legal opinions diverge if this training data affects the license of the trained model. For users with strict legal requirements,
+the models with "`-c`" in the title are recommended. 
+- **Multilingual/non-English use-cases**: use [bge-m3-zeroshot-v2.0](https://huggingface.co/MoritzLaurer/bge-m3-zeroshot-v2.0) or [bge-m3-zeroshot-v2.0-c](https://huggingface.co/MoritzLaurer/bge-m3-zeroshot-v2.0-c).
 Note that multilingual models perform worse than English-only models. You can therefore also first machine translate your texts to English with libraries like [EasyNMT](https://github.com/UKPLab/EasyNMT)
 and then apply any English-only model to the translated data. Machine translation also facilitates validation in case your team does not speak all languages in the data. 
 - **context window**: The `bge-m3` models can process up to 8192 tokens. The other models can process up to 512. Note that longer text inputs both make the
@@ -120,6 +120,8 @@ mode slower and decrease performance, so if you're only working with texts of up
 - The latest updates on new models are always available in the [Zeroshot Classifier Collection](https://huggingface.co/collections/MoritzLaurer/zeroshot-classifiers-6548b4ff407bb19ff5c3ad6f).
 
 
+
+
 ## Reproduction
 
 Reproduction code is available in the `v2_synthetic_data` directory here: https://github.com/MoritzLaurer/zeroshot-classifier/tree/main
@@ -133,8 +135,9 @@ Biases can come from the underlying foundation model, the human NLI training dat
 
 
 ## License
-The foundation model is published under the MIT license.
-The the licenses of the training data vary depending on the model, see above.
+The foundation model was published under the MIT license.
+The licenses of the training data vary depending on the model, see above.
+
 
 ## Citation
 
@@ -171,11 +174,11 @@ text = "Angela Merkel is a politician in Germany and leader of the CDU"
 # formulation 1
 hypothesis_template = "This text is about {}"
 classes_verbalized = ["politics", "economy", "entertainment", "environment"]
-# formulation 2
+# formulation 2 depending on your use-case
 hypothesis_template = "The topic of this text is {}"
-classes_verbalized = ["politics", "economic policy", "entertainment or music", "environmental protection"]
+classes_verbalized = ["political activities", "economic policy", "entertainment or music", "environmental protection"]
 # test different formulations
-zeroshot_classifier = pipeline("zero-shot-classification", model="MoritzLaurer/deberta-v3-large-zeroshot-v2.0-nc")  # change the model identifier here
+zeroshot_classifier = pipeline("zero-shot-classification", model="MoritzLaurer/deberta-v3-large-zeroshot-v2.0")  # change the model identifier here
 output = zeroshot_classifier(text, classes_verbalized, hypothesis_template=hypothesis_template, multi_label=False)
 print(output)
 ```