MTN: classification examples and notebooks reorganisation (#689)

FaustinPulveric · web-flow · commit c62d29a09959 · 2025-05-12T10:53:31.000+02:00
diff --git a/doc/index_binary_classification.rst b/doc/index_binary_classification.rst
@@ -4,5 +4,5 @@ The binary classification case
 .. toctree::
    :maxdepth: 2
 
-   examples_classification/4-tutorials/plot_main-tutorial-binary-classification
+   examples_classification/2-advanced-analysis/plot_main-tutorial-binary-classification
    theoretical_description_binary_classification
diff --git a/doc/index_classification.rst b/doc/index_classification.rst
@@ -5,9 +5,6 @@ Prediction sets (classification)
    :maxdepth: 2
 
    choosing_the_right_algorithm_classification
-   examples_classification/4-tutorials/plot_main-tutorial-classification
-   examples_classification/4-tutorials/plot_crossconformal
    examples_classification/index
-   notebooks_classification
    theoretical_description_classification
    index_binary_classification
diff --git a/examples/classification/2-advanced-analysis/plot_comp_methods_on_2d_dataset.py b/examples/classification/2-advanced-analysis/plot_comp_methods_on_2d_dataset.py
@@ -1,6 +1,6 @@
 """
 ======================================================
-Comparing prediction sets on a two-dimensional dataset
+LAC and APS methods explained
 ======================================================
 
 In this tutorial, we compare the prediction sets estimated by
diff --git a/examples/classification/2-advanced-analysis/plot_crossconformal.py b/examples/classification/2-advanced-analysis/plot_crossconformal.py
@@ -1,7 +1,7 @@
 """
-==================================
-Cross-conformal for classification
-==================================
+=========================================
+Cross conformal classification explained
+=========================================
 
 In this tutorial, we estimate the impact of the
 training/conformalization split on the prediction sets and
diff --git a/examples/classification/2-advanced-analysis/plot_main-tutorial-binary-classification.py b/examples/classification/2-advanced-analysis/plot_main-tutorial-binary-classification.py
@@ -1,7 +1,7 @@
 """
-===========================
-Tutorial for set prediction
-===========================
+============================================================
+Set prediction example in the binary classification setting
+============================================================
 
 In this example, we propose set prediction for binary classification
 estimated by :class:`~mapie_v1.classification.SplitConformalClassifier` with the "lac"
diff --git a/examples/classification/3-scientific-articles/plot_sadinle2019_example.py b/examples/classification/3-scientific-articles/plot_sadinle2019_example.py
@@ -1,7 +1,7 @@
 """
-================================================
-Reproducing Example 7 from Sadinle et al. (2019)
-================================================
+=======================================================================================
+Least Ambiguous Set-Valued Classifiers with Bounded Error Levels, Sadinle et al. (2019)
+=======================================================================================
 
 We use :class:`~mapie_v1.classification.SplitConformalClassifier` to reproduce
 Example 7 from Sadinle et al. (2019).
diff --git a/examples/classification/4-other-notebooks/README.rst b/examples/classification/4-other-notebooks/README.rst
@@ -0,0 +1,8 @@
+.. _classification_examples_4:
+
+4. Other notebooks
+--------------------
+
+This section lists a series of Jupyter notebooks hosted on the MAPIE Github repository that can be run on Google Colab:
+
+  - `Deep learning with MAPIE on the Cifar10 dataset <https://github.com/scikit-learn-contrib/MAPIE/tree/master/notebooks/classification/Cifar10.ipynb>`_
diff --git a/examples/classification/4-tutorials/README.rst b/examples/classification/4-tutorials/README.rst
diff --git a/examples/classification/4-tutorials/plot_main-tutorial-classification.py b/examples/classification/4-tutorials/plot_main-tutorial-classification.py
diff --git a/examples/classification/README.rst b/examples/classification/README.rst
@@ -1,4 +1,6 @@
 .. _classification_examples:
 
-Classification examples
-=======================
+All classification examples
+============================
+
+Following is a collection of notebooks demonstrating how to use MAPIE in classification.
diff --git a/notebooks/classification/Cifar10.ipynb b/notebooks/classification/Cifar10.ipynb
