Skip to content

Commit e2650a1

Browse files
author
Joan Massich
committed
Add development doc
1 parent f02c565 commit e2650a1

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

doc/developers_utils.rst

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
.. _developers-utils:
2+
3+
========================
4+
Utilities for Developers
5+
========================
6+
7+
Imbalanced-learn contains a number of utilities to help with development. These are
8+
located in :mod:`imblearn.utils`, and include tools in a number of categories.
9+
All the following functions and classes are in the module :mod:`imblearn.utils`.
10+
11+
.. warning ::
12+
13+
These utilities are meant to be used internally within the imbalanced-learn
14+
package. They are not guaranteed to be stable between versions of
15+
scikit-learn. Backports, in particular, will be removed as the scikit-learn
16+
dependencies evolve.
17+
18+
19+
.. currentmodule:: imblearn.utils
20+
21+
22+
Validation Tools
23+
================
24+
25+
These are tools used to check and validate input. When you write a function
26+
which accepts arrays, matrices, or sparse matrices as arguments, the following
27+
should be used when applicable.
28+
29+
- :func:`check_neighbors_object`: Check the objects is consistent to be a NN.
30+
- :func:`check_target_type`: Check the target types to be conform to the current samplers.
31+
- :func:`check_ratio`: Checks ratio for consistent type and return a dictionary
32+
containing each targeted class with its corresponding number of pixel.
33+
34+
Helper Functions
35+
================
36+
These are tools to facilitate writing code for imbalance learn.
37+
38+
- :func:`hash_X_y`: Compute hash of the input arrays.
39+
- :func:`deprecate_parameter`: Helper to deprecate a parameter by another one.

doc/user_guide.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,4 @@ User Guide
1515
combine.rst
1616
ensemble.rst
1717
Dataset loading utilities <datasets/index.rst>
18+
developers_utils.rst

0 commit comments

Comments
 (0)