From 402a1d3916281dbb624a37a7dde1b526efe05482 Mon Sep 17 00:00:00 2001 From: Joan Massich Date: Wed, 23 Aug 2017 15:50:04 +0200 Subject: [PATCH] fix minor errors in developer's utils --- doc/developers_utils.rst | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/doc/developers_utils.rst b/doc/developers_utils.rst index bd370b4d2..c0e577934 100644 --- a/doc/developers_utils.rst +++ b/doc/developers_utils.rst @@ -15,11 +15,12 @@ All the following functions and classes are in the module :mod:`imblearn.utils`. imbalance-learn. Backports, in particular, will be removed as the imbalance-learn dependencies evolve. -.. currentmodule:: imblearn.utils Validation Tools ================ +.. currentmodule:: imblearn.utils + These are tools used to check and validate input. When you write a function which accepts arrays, matrices, or sparse matrices as arguments, the following should be used when applicable. @@ -29,8 +30,11 @@ should be used when applicable. - :func:`check_ratio`: Checks ratio for consistent type and return a dictionary containing each targeted class with its corresponding number of pixel. + Deprecation ------------ +=========== + +.. currentmodule:: imblearn.utils.deprecation .. warning :: Apart from :func:`deprecate_parameter` the rest of this section is taken from @@ -96,3 +100,4 @@ same information as the deprecation warning as explained above. Use the On the top of all the functionality provided by scikit-learn. Imbalance-learn provides :func:`deprecate_parameter`: which is used to deprecate a sampler's parameter (attribute) by another one. +