.. _l-modules:

Modules
=======

.. contents::
    :local:
    :depth: 1


Summary
+++++++

+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| module                                                              | truncated documentation                                                                                                                                                       |
+=====================================================================+===============================================================================================================================================================================+
| :ref:`__init__ <f-init>`                                            | module ``papierstat``    Module *papierstat*.  Look for insights for machine learned models.      :githublink:`%|py|7`                                                        |
+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initz>`                                           | module ``papierstat.datasets``    Fonctions retournant des jeux de données.      :githublink:`%|py|6`                                                                         |
+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzz>`                                          |                                                                                                                                                                               |
+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzzz>`                                         | module ``papierstat.mltricks``    Raccourcis pour *mltricks*.      :githublink:`%|py|6`                                                                                       |
+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`biased <f-biased>`                                            | module ``papierstat.datasets.biased``    Jeux de données biaisés.      :githublink:`%|py|6`                                                                                   |
+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`carreau <f-carreau>`                                          | module ``papierstat.datasets.carreau``    Jeux de données reliés aux données carroyées.      :githublink:`%|py|6`                                                             |
+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`cat <f-cat>`                                                  | module ``papierstat.datasets.cat``    Jeux de données reliés aux catégories.      :githublink:`%|py|6`                                                                        |
+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`data_helper <f-datahelper>`                                   | module ``papierstat.datasets.data_helper``    Fonctions retournant des jeux de données.      :githublink:`%|py|6`                                                             |
+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`documentation <f-documentation>`                              | module ``papierstat.datasets.documentation``    Automatatisation de certaines parties de la documentation.      :githublink:`%|py|6`                                          |
+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`dummies <f-dummies>`                                          | module ``papierstat.datasets.dummies``    Jeux de données artificiels.      :githublink:`%|py|6`                                                                              |
+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`duration <f-duration>`                                        | module ``papierstat.datasets.duration``    Jeux de données artificiel lié à la prédiction de durées.      :githublink:`%|py|6`                                                |
+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`enedis <f-enedis>`                                            | module ``papierstat.datasets.enedis``    Jeux de données reliés à :epkg:`Enedis`.      :githublink:`%|py|6`                                                                   |
+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`geojson <f-geojson>`                                          | module ``papierstat.datasets.geojson``    Jeux de données reliés aux vins.      :githublink:`%|py|6`                                                                          |
+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`graph <f-graph>`                                              | module ``papierstat.datasets.graph``    Fonctions retournant des jeux de données liés aux graphes.      :githublink:`%|py|6`                                                  |
+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`movies <f-movies>`                                            | module ``papierstat.datasets.movies``    Jeux de données reliés aux films.      :githublink:`%|py|6`                                                                          |
+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`search <f-search>`                                            | module ``papierstat.datasets.search``    Jeux de données reliés aux vins.      :githublink:`%|py|6`                                                                           |
+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`sentiment <f-sentiment>`                                      | module ``papierstat.datasets.sentiment``    Jeux de données reliés aux vins.      :githublink:`%|py|6`                                                                        |
+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`sklearn_base_learner_category <f-sklearnbaselearnercategory>` | module ``papierstat.mltricks.sklearn_base_learner_category``    Implémente un *learner* qui suit la même API que tout :epkg:`scikit-learn` learner.      :githublink:`%|py|6` |
+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`sklearn_example_classifier <f-sklearnexampleclassifier>`      | module ``papierstat.mltricks.sklearn_example_classifier``    Defines :class:`SkCustomKnn`      :githublink:`%|py|5`                                                           |
+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`text_vectorizer_transformer <f-textvectorizertransformer>`    | module ``papierstat.mltricks.text_vectorizer_transformer``    Implements TextVectorizerTransformer.      :githublink:`%|py|5`                                                 |
+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`titanic <f-titanic>`                                          | module ``papierstat.datasets.titanic``    Jeux de données reliés aux vins.      :githublink:`%|py|6`                                                                          |
+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`tweets <f-tweets>`                                            | module ``papierstat.datasets.tweets``    Jeux de données reliés aux vins.      :githublink:`%|py|6`                                                                           |
+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`wines <f-wines>`                                              | module ``papierstat.datasets.wines``    Jeux de données reliés aux vins.      :githublink:`%|py|6`                                                                            |
+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+


.. toctree::
    :maxdepth: 1

    papierstat/__init__
    papierstat/datasets/__init__
    papierstat/datasets/biased
    papierstat/datasets/carreau
    papierstat/datasets/cat
    papierstat/datasets/data/__init__
    papierstat/datasets/data_helper
    papierstat/datasets/documentation
    papierstat/datasets/dummies
    papierstat/datasets/duration
    papierstat/datasets/enedis
    papierstat/datasets/geojson
    papierstat/datasets/graph
    papierstat/datasets/movies
    papierstat/datasets/search
    papierstat/datasets/sentiment
    papierstat/datasets/titanic
    papierstat/datasets/tweets
    papierstat/datasets/wines
    papierstat/mltricks/__init__
    papierstat/mltricks/sklearn_base_learner_category
    papierstat/mltricks/sklearn_example_classifier
    papierstat/mltricks/text_vectorizer_transformer