Merge pull request #211 from scikit-learn-contrib/doc-tutorials-in-sections

Add tutorials in documentation sections

Author: LacombeLouis

HISTORY.rst

@@ -2,6 +2,12 @@
 History
 =======
 
+0.4.2 (XXXX-XX-XX)
+------------------
+
+* Add tutorial for time series
+* Convert existing tutorials in .py
+
 0.4.1 (2002-06-27)
 ------------------
 

Makefile

@@ -4,7 +4,7 @@ lint:
 	flake8 . --exclude=doc
 
 type-check:
-	mypy mapie examples
+	mypy mapie
 
 tests:
 	pytest -vs --doctest-modules mapie

README.rst

@@ -1,6 +1,6 @@
 .. -*- mode: rst -*-
 
-|GitHubActions|_ |Codecov|_ |ReadTheDocs|_ |License|_ |PythonVersion|_ |PyPi|_ |Conda|_ |Release|_ |Commits|_
+|GitHubActions|_ |Codecov|_ |ReadTheDocs|_ |License|_ |PythonVersion|_ |PyPi|_ |Conda|_ |Release|_ |Commits|_ |DOI|_
 
 .. |GitHubActions| image:: https://github.com/scikit-learn-contrib/MAPIE/actions/workflows/test.yml/badge.svg
 .. _GitHubActions: https://github.com/scikit-learn-contrib/MAPIE/actions
@@ -29,6 +29,9 @@
 .. |Commits| image:: https://img.shields.io/github/commits-since/scikit-learn-contrib/mapie/latest/master
 .. _Commits: https://github.com/scikit-learn-contrib/MAPIE/commits/master
 
+.. |DOI| image:: https://img.shields.io/badge/10.48550/arXiv.2207.12274-B31B1B.svg
+.. _DOI: https://arxiv.org/abs/2207.12274
+
 .. image:: https://github.com/simai-ml/MAPIE/raw/master/doc/images/mapie_logo_nobg_cut.png
     :width: 400
     :align: center

doc/images/quickstart_1.png

@@ -13,7 +13,8 @@
    :caption: REGRESSION
 
    theoretical_description_regression
-   tutorial_regression
+   examples_regression/4-tutorials/plot_main-tutorial-regression
+   examples_regression/4-tutorials/plot_ts-tutorial
    examples_regression/index
    notebooks_regression
 
@@ -23,7 +24,8 @@
    :caption: CLASSIFICATION
 
    theoretical_description_classification
-   tutorial_classification
+   examples_classification/4-tutorials/plot_main-tutorial-classification
+   examples_classification/4-tutorials/plot_crossconformal
    examples_classification/index
    notebooks_classification
 

doc/index.rst

@@ -6,5 +6,5 @@ problems for computer vision settings that are too heavy to be included in the e
 galleries.
 
 
-   1. Estimating prediction sets on the Cifar10 dataset : `notebook <https://github.com/scikit-learn-contrib/MAPIE/tree/master/notebooks/classification/Cifar10.ipynb>`_
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+1. Estimating prediction sets on the Cifar10 dataset : `notebook <https://github.com/scikit-learn-contrib/MAPIE/tree/master/notebooks/classification/Cifar10.ipynb>`_
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------

doc/notebooks_classification.rst

@@ -23,7 +23,7 @@ Given some target quantile :math:`\alpha` or associated target coverage level :m
 we aim at constructing a prediction interval :math:`\hat{C}_{n, \alpha}` for a new
 feature vector :math:`X_{n+1}` such that 
 
-.. math:: 
+.. math::
     P \{Y_{n+1} \in \hat{C}_{n, \alpha}(X_{n+1}) \} \geq 1 - \alpha
 
 1. The "Naive" method

doc/theoretical_description_regression.rst

@@ -1,4 +1,4 @@
-.. _classification_examples:
+.. _classification_examples_1:
 
 1. Quickstart examples
 ----------------------

examples/classification/1-quickstart/README.rst

@@ -1,4 +1,4 @@
-.. _classification_examples:
+.. _classification_examples_2:
 
 2. Advanced analysis
 --------------------