Update the doc for pipeline

Guillaume Lemaitre · Guillaume Lemaitre · commit 3497ccf84955 · 2016-06-26T17:51:03.000+02:00
diff --git a/doc/api.rst b/doc/api.rst
@@ -89,3 +89,21 @@ Classes
    
    ensemble.BalanceCascade
    ensemble.EasyEnsemble
+
+
+.. _pipeline_ref:
+
+Pipeline
+========
+
+.. automodule:: unbalanced_dataset.pipeline
+    :no-members:
+    :no-inherited-members:
+
+.. currentmodule:: unbalanced_dataset
+
+.. autosummary::
+   :toctree: generated/
+   
+   pipeline.Pipeline
+   pipeline.make_pipeline
diff --git a/examples/pipeline/README.txt b/examples/pipeline/README.txt
@@ -0,0 +1,6 @@
+.. _pipeline_examples:
+
+Pipeline examples
+=================
+
+Example of how to use the a pipeline to include under-sampling with `scikit-learn` estimators.
diff --git a/examples/pipeline/plot_enn_and_renn_in_pipeline.py b/examples/pipeline/plot_enn_and_renn_in_pipeline.py
diff --git a/examples/pipeline/plot_pipeline_classification.py b/examples/pipeline/plot_pipeline_classification.py
@@ -1,8 +1,11 @@
 """
+
 =========================
 Pipeline Object
 =========================
+
 An example of the Pipeline object working with transformers and resamplers.
+
 """
 
 print(__doc__)
