tune documentation

_doc/examples/README.txt

@@ -0,0 +1,3 @@
+====================
+Galleries d'exemples
+====================

_doc/examples/lectures/README.txt

@@ -0,0 +1,6 @@
+
+.. _l-gallery-examples:
+
+Exemples longs
+--------------
+

_doc/examples/lectures/plot_nuage.py

@@ -0,0 +1,42 @@
+# -*- coding: utf-8 -*-
+"""
+Corrélations
+============
+
+Dessine les corrélations pour un jeu de données.
+"""
+
+###############
+# A remplacer.
+
+import os
+import sys
+this = os.path.abspath(os.path.dirname(__file__))
+if "papierstat" in this:
+    this = this.split("papierstat")[0].rstrip("\\/")
+for module in ["papierstat"]:
+    try:
+        exec("import %s" % module)
+    except ImportError:
+        p = os.path.join(this, module, "src")
+        sys.path.append(p)
+        exec("import %s" % module)
+
+
+#########################
+# Récupération des données
+
+from papierstat.datasets import load_wines_dataset
+df = load_wines_dataset()
+print(df.head(n=2).T)
+
+####################
+# Les corrélations avec :epkg:`seaborn`.
+
+from seaborn import clustermap
+
+clustermap(df.corr(), center=0, cmap="vlag",
+           linewidths=.75, figsize=(13, 13))
+
+import matplotlib.pyplot as plt
+plt.show()

_doc/notebooks/lectures/wines_knn.ipynb

@@ -175,8 +175,8 @@
         }
       ],
       "source": [
-        "from papierstat.datasets import load_wines_datasets\n",
-        "df = load_wines_datasets()\n",
+        "from papierstat.datasets import load_wines_dataset\n",
+        "df = load_wines_dataset()\n",
         "df.head()"
       ]
     },

_doc/notebooks/lectures/wines_knn_eval.ipynb

@@ -25,8 +25,8 @@
       "metadata": {},
       "outputs": [],
       "source": [
-        "from papierstat.datasets import load_wines_datasets\n",
-        "df = load_wines_datasets()\n",
+        "from papierstat.datasets import load_wines_dataset\n",
+        "df = load_wines_dataset()\n",
         "X = df.drop(['quality', 'color'], axis=1)\n",
         "y = df['quality']"
       ]

_doc/notebooks/lectures/wines_knn_split.ipynb

@@ -24,8 +24,8 @@
       "metadata": {},
       "outputs": [],
       "source": [
-        "from papierstat.datasets import load_wines_datasets\n",
-        "df = load_wines_datasets()\n",
+        "from papierstat.datasets import load_wines_dataset\n",
+        "df = load_wines_dataset()\n",
         "X = df.drop(['quality', 'color'], axis=1)\n",
         "y = df['quality']"
       ]

_doc/sphinxdoc/source/biblio.rst

@@ -0,0 +1,15 @@
+
+Bibliographie
+=============
+
+*Anti-sèches*
+
+* `Anti-sèches de machine learning <http://www.xavierdupre.fr/app/ensae_teaching_cs/helpsphinx3/ii_antiseches.html>`_
+
+*Blog*
+
+* `Freakeconometrics <http://freakonometrics.hypotheses.org/>`_
+
+*Livres*
+
+* `The Elements of Statistical Learning <https://web.stanford.edu/~hastie/ElemStatLearn/>`_

_doc/sphinxdoc/source/index.rst

@@ -18,6 +18,7 @@ Petit voyage au pays du machine learning
     introduction
     rappel
     lectures/index
+    biblio
     api/index
     all_notebooks
     i_ex

_doc/sphinxdoc/source/lectures/step1.rst

@@ -36,8 +36,8 @@ ci-dessous, pour deux vins.
     :rst:
 
     from pyquickhelper.pandashelper import df2rst
-    from papierstat.datasets import load_wines_datasets
-    df = load_wines_datasets()
+    from papierstat.datasets import load_wines_dataset
+    df = load_wines_dataset()
     print(df2rst(df.head(n=2).T.reset_index(drop=False)))
 
 On part du principe que si deux vins différents ont la même
@@ -75,14 +75,14 @@ Il peut être également obtenu avec le code suivant :
     :rst:
 
     from pyquickhelper.pandashelper import df2rst
-    from papierstat.datasets import load_wines_datasets
-    df = load_wines_datasets()
+    from papierstat.datasets import load_wines_dataset
+    df = load_wines_dataset()
     print(df2rst(df.head()))
 
 .. plot::
 
-    from papierstat.datasets import load_wines_datasets
-    df = load_wines_datasets()
+    from papierstat.datasets import load_wines_dataset
+    df = load_wines_dataset()
 
     import matplotlib.pyplot as plt
     plt.close('all')

_unittests/ut_datasets/test_wines.py

@@ -39,7 +39,7 @@
 
 from pyquickhelper.loghelper import fLOG
 from pyquickhelper.pycode import ExtTestCase
-from src.papierstat.datasets import load_wines_datasets
+from src.papierstat.datasets import load_wines_dataset
 
 
 class TestWines(ExtTestCase):
@@ -50,7 +50,7 @@ def test_wines_download(self):
             self._testMethodName,
             OutputPrint=__name__ == "__main__")
 
-        df = load_wines_datasets(download=True)
+        df = load_wines_dataset(download=True)
         self.assertEqual(df.shape, (6497, 13))
 
     def test_wines_local(self):
@@ -59,7 +59,7 @@ def test_wines_local(self):
             self._testMethodName,
             OutputPrint=__name__ == "__main__")
 
-        df = load_wines_datasets(download=False)
+        df = load_wines_dataset(download=False)
         self.assertEqual(df.shape, (6497, 13))
 
 

requirements.txt

@@ -6,7 +6,7 @@ openpyxl
 pandas_streaming
 pycodestyle>=2.0.0
 pydocstyle
-pyquickhelper>=1.6.2283
+pyquickhelper>=1.6.2284
 sphinx-bootstrap-theme
 sphinx-gallery
 sphinx-redactor-theme

src/papierstat/datasets/__init__.py

@@ -16,7 +16,7 @@ def get_data_folder():
     return os.path.abspath(this)
 
 
-def load_wines_datasets(download=False):
+def load_wines_dataset(download=False):
     """
     Retourne le jeu de données
     `wines quality <https://archive.ics.uci.edu/ml/datasets/wine+quality>`_.