Documentation update: tutorial for text classification models compari…

…son (#2426) # Description Context: #2068 In this PR a new tutorial is added: model-comparison for text classification. It is the follow up of the work done during PyConFr in Bordeaux. Closes #2068 **Type of change** (Please delete options that are not relevant. Remember to title the PR according to the type of change) - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] Refactor (change restructuring the codebase without changing functionality) - [ ] Improvement (change adding some improvement to an existing functionality) - [x] Documentation update **How Has This Been Tested** (Please describe the tests that you ran to verify your changes. And ideally, reference `tests`) - [ ] Test A - [ ] Test B **Checklist** - [ ] I have merged the original branch into my forked branch - [ ] I added relevant documentation - [ ] follows the style guidelines of this project - [ ] I did a self-review of my code - [ ] I made corresponding changes to the documentation - [ ] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works --------- Co-authored-by: David Berenstein <[email protected]>
argilla-io · Mar 21, 2023 · ae2d65b · ae2d65b
1 parent e1fce7c
commit ae2d65b
Show file tree

Hide file tree

Showing 9 changed files with 2,376 additions and 1 deletion.
diff --git a/...oring-textclassification-setfit-explainability/f1-score-for-zero-shot-model.png b/...oring-textclassification-setfit-explainability/f1-score-for-zero-shot-model.png
diff --git a/.../_static/tutorials/monitoring-textclassification-setfit-explainability/modal.md b/.../_static/tutorials/monitoring-textclassification-setfit-explainability/modal.md
@@ -0,0 +1,9 @@
+```{grid-item-card} 🕵️‍♀️ Compare two Text Classification zero-shot models using Argilla
+:img-top: /_static/tutorials/monitoring-textclassification-setfit-explainability/f1-score-for-zero-shot-model.png
+:link: ../../tutorials/notebooks/monitoring-textclassification-setfit-explainability.html
+
+MLOps Steps: Monitoring \
+NLP Tasks: TextClassification \
+Libraries: Argilla, SetFit \
+Techniques: Zero-shot classification
+```
diff --git a/...rials/monitoring-textclassification-setfit-explainability/zero-shot-dataset.png b/...rials/monitoring-textclassification-setfit-explainability/zero-shot-dataset.png
diff --git a/...orials/monitoring-textclassification-setfit-explainability/zero-shot-setfit.png b/...orials/monitoring-textclassification-setfit-explainability/zero-shot-setfit.png
diff --git a/docs/_source/tutorials/libraries/setfit.md b/docs/_source/tutorials/libraries/setfit.md
@@ -13,4 +13,6 @@ SetFit is an efficient and prompt-free framework for few-shot fine-tuning of Sen
 ```
 ```{include} /_static/tutorials/training-textclassification-setfit-sentiment/modal.md
 ```
+```{include} /_static/tutorials/monitoring-textclassification-setfit-explainability/modal.md
+```
 ````
diff --git a/docs/_source/tutorials/notebooks/monitoring-textclassification-setfit-explainability.ipynb b/docs/_source/tutorials/notebooks/monitoring-textclassification-setfit-explainability.ipynb
diff --git a/docs/_source/tutorials/steps/4_monitoring.md b/docs/_source/tutorials/steps/4_monitoring.md
@@ -15,4 +15,6 @@ These tutorials show you how Argilla can help you to monitor your model predicti
 ```
 ```{include} /_static/tutorials/monitoring-textclassification-transformers-explainability/modal.md
 ```
+```{include} /_static/tutorials/monitoring-textclassification-setfit-explainability/modal.md
+```
 ````
diff --git a/docs/_source/tutorials/tasks/text_classification.md b/docs/_source/tutorials/tasks/text_classification.md
@@ -39,4 +39,6 @@
 ```
 ```{include} /_static/tutorials/training-textclassification-modal-activelearning/modal.md
 ```
+```{include} /_static/tutorials/monitoring-textclassification-setfit-explainability/modal.md
+```
 ````
diff --git a/docs/_source/tutorials/techniques/few_shot.md b/docs/_source/tutorials/techniques/few_shot.md
@@ -16,4 +16,6 @@ These tutorials show how to use few and zero-shot classifications with Argilla.
 ```
 ```{include} /_static/tutorials/labelling-textclassification-gpt3-fewshot/modal.md
 ```
-````
+```{include} /_static/tutorials/monitoring-textclassification-setfit-explainability/modal.md
+```
+````