Skip to content

[MRG]fix minor errors in developer's utils #326

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 23, 2017
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions doc/developers_utils.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand Down Expand Up @@ -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.