From d221902d5b76d242916cbfac66e08be1a9f50589 Mon Sep 17 00:00:00 2001 From: Guillaume Lemaitre Date: Wed, 22 Aug 2018 23:08:39 +0200 Subject: [PATCH] DOC: improve documentation of pipeline --- imblearn/pipeline.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/imblearn/pipeline.py b/imblearn/pipeline.py index d07d5ef6e..90af7ab6c 100644 --- a/imblearn/pipeline.py +++ b/imblearn/pipeline.py @@ -28,9 +28,10 @@ class Pipeline(pipeline.Pipeline): """Pipeline of transforms and resamples with a final estimator. - Sequentially apply a list of transforms, samples and a final estimator. + Sequentially apply a list of transforms, sampling, and a final estimator. Intermediate steps of the pipeline must be transformers or resamplers, that is, they must implement fit, transform and sample methods. + The samplers are only applied during fit. The final estimator only needs to implement fit. The transformers and samplers in the pipeline can be cached using ``memory`` argument.