Skip to content

Commit 1d77037

Browse files
authored
DOC use tilde in mod func class (#800)
1 parent ffe8da9 commit 1d77037

File tree

3 files changed

+10
-9
lines changed

3 files changed

+10
-9
lines changed

doc/datasets/index.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ Dataset loading utilities
66

77
.. currentmodule:: imblearn.datasets
88

9-
The ``imblearn.datasets`` package is complementing the ``sklearn.datasets``
10-
package. The package provides both: (i) a set of imbalanced datasets to perform
11-
systematic benchmark and (ii) a utility to create an imbalanced dataset from an
12-
original balanced dataset.
9+
The :mod:`imblearn.datasets` package is complementing the
10+
:mod:`sklearn.datasets` package. The package provides both: (i) a set of
11+
imbalanced datasets to perform systematic benchmark and (ii) a utility to
12+
create an imbalanced dataset from an original balanced dataset.
1313

1414
.. _zenodo:
1515

doc/miscellaneous.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ will generate balanced mini-batches.
6969
TensorFlow generator
7070
~~~~~~~~~~~~~~~~~~~~
7171

72-
The :func:`imblearn.tensorflow.balanced_batch_generator` allow to generate
72+
The :func:`~imblearn.tensorflow.balanced_batch_generator` allow to generate
7373
balanced mini-batches using an imbalanced-learn sampler which returns indices::
7474

7575
>>> X = X.astype(np.float32)
@@ -143,8 +143,9 @@ define a logistic regression model::
143143
>>> model.compile(optimizer='sgd', loss='categorical_crossentropy',
144144
... metrics=['accuracy'])
145145

146-
:func:`imblearn.keras.balanced_batch_generator` creates a balanced mini-batches
147-
generator with the associated number of mini-batches which will be generated::
146+
:func:`~imblearn.keras.balanced_batch_generator` creates a balanced
147+
mini-batches generator with the associated number of mini-batches which will be
148+
generated::
148149

149150
>>> from imblearn.keras import balanced_batch_generator
150151
>>> training_generator, steps_per_epoch = balanced_batch_generator(

examples/datasets/plot_make_imbalance.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
Create an imbalanced dataset
44
============================
55
6-
An illustration of the :func:`imblearn.datasets.make_imbalance` function to
6+
An illustration of the :func:`~imblearn.datasets.make_imbalance` function to
77
create an imbalanced dataset from a balanced dataset. We show the ability of
8-
:func:`imblearn.datasets.make_imbalance` of dealing with Pandas DataFrame.
8+
:func:`~imblearn.datasets.make_imbalance` of dealing with Pandas DataFrame.
99
1010
"""
1111

0 commit comments

Comments
 (0)