Merge pull request #46 from simai-ml/refactorize_doc

refactorize doc

Author: vtaquet

README.rst

@@ -36,8 +36,18 @@
 MAPIE - Model Agnostic Prediction Interval Estimator
 ====================================================
 
-**MAPIE** allows you to easily estimate prediction intervals using your favourite sklearn-compatible regressor.
+**MAPIE** allows you to easily estimate prediction intervals on single-output data using your favourite scikit-learn-compatible regressor.
 
+Prediction intervals output by **MAPIE** encompass both aleatoric and epistemic uncertainty and are backed by strong theoretical guarantees [1].
+
+🔗 Requirements
+===============
+
+Python 3.7+
+
+**MAPIE** stands on the shoulders of giant.
+
+Its only internal dependency is `scikit-learn <https://scikit-learn.org/stable/>`_.
 
 
 🛠 Installation
@@ -161,15 +171,14 @@ with the financial support from Région Ile de France.
 .. _IledeFrance: https://www.iledefrance.fr/
 
 
-💬  Citations
-=============
+🔍  References
+==============
 
 MAPIE methods are based on the work by `Foygel-Barber et al. (2020) <https://www.stat.uchicago.edu/~rina/jackknife.html>`_.
 
-Rina Foygel Barber, Emmanuel J. Candès, Aaditya Ramdas, and Ryan J. Tibshirani.
+[1] Rina Foygel Barber, Emmanuel J. Candès, Aaditya Ramdas, and Ryan J. Tibshirani.
 Predictive inference with the jackknife+. Ann. Statist., 49(1):486–507, 022021
 
-
 📝 License
 ==========
 

RELEASE_CHECKLIST.md

@@ -13,7 +13,7 @@
     * `make html`
     * `cd ..`
 - [ ] Build source distribution:
-    * `rm -rf build dist`
+    * `rm -rf build dist MAPIE.egg-info`
     * `python setup.py sdist bdist_wheel`
 - [ ] Check that your package is ready for publication: `twine check dist/*`
 - [ ] Update the version number with `bump2version major|minor|patch`

doc/environment.yml

@@ -9,4 +9,5 @@ dependencies:
     - scipy=1.6.1
     - sphinx=3.5.3
     - sphinx-gallery=0.8.2
-    - sphinx_rtd_theme=0.5.2
+    - sphinx_rtd_theme=0.5.2
+    - typing_extensions=3.7.4

doc/images/quickstart_1.png

@@ -1,10 +1,4 @@
-MAPIE: Model Agnostic Prediction Interval Estimator
-===================================================
-
-Welcome to MAPIE's documentation !
-
-MAPIE allows you to easily estimate prediction intervals on single-output data
-using your favourite sklearn-compatible regressor.
+.. include:: ../README.rst 
 
 .. toctree::
    :maxdepth: 2
@@ -28,39 +22,3 @@ using your favourite sklearn-compatible regressor.
    :caption: Examples
 
    auto_examples/index
-
-
-`Getting started`_
-------------------
-
-`Quick start with MAPIE <quick_start.html>`_
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-How to install the module and estimate your first prediction intervals.
-
-`Documentation`_
-----------------
-
-`Theoretical description <theoretical_description.html>`_
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-A brief introduction to the methods used in MAPIE to estimate prediction intervals.
-
-`Tutorial <tutorial.html>`_
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-A tutorial that presents some key features of MAPIE.
-
-`API Documentation <api.html>`_
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The API documentation.
-
-
-`Examples`_
------------
-
-`General examples <auto_examples/index.html>`_
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-A set of examples.