Skip to content

DOC use tilde in mod func class #800

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.

Sign up for GitHub

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
Feb 14, 2021
Merged

DOC use tilde in mod func class #800

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions doc/datasets/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ Dataset loading utilities

.. currentmodule:: imblearn.datasets

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

.. _zenodo:

Expand Down
7 changes: 4 additions & 3 deletions doc/miscellaneous.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ will generate balanced mini-batches.
TensorFlow generator
~~~~~~~~~~~~~~~~~~~~

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

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

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

>>> from imblearn.keras import balanced_batch_generator
>>> training_generator, steps_per_epoch = balanced_batch_generator(
Expand Down
4 changes: 2 additions & 2 deletions examples/datasets/plot_make_imbalance.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
Create an imbalanced dataset
============================

An illustration of the :func:`imblearn.datasets.make_imbalance` function to
An illustration of the :func:`~imblearn.datasets.make_imbalance` function to
create an imbalanced dataset from a balanced dataset. We show the ability of
:func:`imblearn.datasets.make_imbalance` of dealing with Pandas DataFrame.
:func:`~imblearn.datasets.make_imbalance` of dealing with Pandas DataFrame.

"""

Expand Down