iter

Author: glemaitre

doc/conf.py

@@ -14,6 +14,7 @@
 
 import os
 import sys
+from datetime import datetime
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -52,7 +53,7 @@
 
 # General information about the project.
 project = "imbalanced-learn"
-copyright = "2014-2020, The imbalanced-learn developers"
+copyright = f"2014-{datetime.now().year}, The imbalanced-learn developers"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -202,7 +203,7 @@
         "index",
         "imbalanced-learn.tex",
         "imbalanced-learn Documentation",
-        "G. Lemaitre, F. Nogueira, D. Oliveira, C. Aridas",
+        "The imbalanced-learn developers",
         "manual",
     ),
 ]
@@ -220,7 +221,7 @@
         "index",
         "imbalanced-learn",
         "imbalanced-learn Documentation",
-        ["G. Lemaitre, F. Nogueira, D. Oliveira, C. Aridas"],
+        ["The imbalanced-learn developers"],
         1,
     )
 ]
@@ -238,7 +239,7 @@
         "index",
         "imbalanced-learn",
         "imbalanced-learn Documentation",
-        "G. Lemaitre, F. Nogueira, D. Oliveira, C. Aridas",
+        "The imbalanced-learn developerss",
         "imbalanced-learn",
         "Toolbox for imbalanced dataset in machine learning.",
         "Miscellaneous",
@@ -253,6 +254,8 @@
 # through a change in sphinx basic.css except rtd_theme does not use basic.css.
 # In an ideal world, this would get fixed in this PR:
 # https://github.com/readthedocs/sphinx_rtd_theme/pull/747/files
+
+
 def setup(app):
     app.add_js_file("js/copybutton.js")
     app.add_css_file("basic.css")

doc/references/combine.rst

@@ -7,11 +7,11 @@ Combination of over- and under-sampling methods
    :no-members:
    :no-inherited-members:
 
-.. currentmodule:: imblearn
+.. currentmodule:: imblearn.combine
 
 .. autosummary::
    :toctree: generated/
    :template: class.rst
 
-   combine.SMOTEENN
-   combine.SMOTETomek
+   SMOTEENN
+   SMOTETomek

doc/references/datasets.rst

@@ -7,11 +7,11 @@ Datasets
     :no-members:
     :no-inherited-members:
 
-.. currentmodule:: imblearn
+.. currentmodule:: imblearn.datasets
 
 .. autosummary::
    :toctree: generated/
    :template: function.rst
 
-   datasets.make_imbalance
-   datasets.fetch_datasets
+   make_imbalance
+   fetch_datasets

doc/references/ensemble.rst

@@ -7,7 +7,7 @@ Ensemble methods
     :no-members:
     :no-inherited-members:
 
-.. currentmodule:: imblearn
+.. currentmodule:: imblearn.ensemble
 
 Boosting algorithms
 -------------------
@@ -16,8 +16,8 @@ Boosting algorithms
    :toctree: generated/
    :template: class.rst
 
-   ensemble.EasyEnsembleClassifier
-   ensemble.RUSBoostClassifier
+   EasyEnsembleClassifier
+   RUSBoostClassifier
 
 Bagging algorithms
 ------------------
@@ -26,5 +26,5 @@ Bagging algorithms
    :toctree: generated/
    :template: class.rst
 
-   ensemble.BalancedBaggingClassifier
-   ensemble.BalancedRandomForestClassifier
+   BalancedBaggingClassifier
+   BalancedRandomForestClassifier

doc/references/metrics.rst

@@ -7,23 +7,23 @@
    :no-members:
    :no-inherited-members:
 
-.. currentmodule:: imblearn
-
 Classification metrics
 ----------------------
 See the :ref:`metrics` section of the user guide for further details.
 
+.. currentmodule:: imblearn.metrics
+
 .. autosummary::
    :toctree: generated/
    :template: function.rst
 
-   metrics.classification_report_imbalanced
-   metrics.sensitivity_specificity_support
-   metrics.sensitivity_score
-   metrics.specificity_score
-   metrics.geometric_mean_score
-   metrics.macro_averaged_mean_absolute_error
-   metrics.make_index_balanced_accuracy
+   classification_report_imbalanced
+   sensitivity_specificity_support
+   sensitivity_score
+   specificity_score
+   geometric_mean_score
+   macro_averaged_mean_absolute_error
+   make_index_balanced_accuracy
 
 Pairwise metrics
 ----------------
@@ -33,10 +33,10 @@ See the :ref:`pairwise_metrics` section of the user guide for further details.
    :no-members:
    :no-inherited-members:
 
-.. currentmodule:: imblearn
+.. currentmodule:: imblearn.metrics.pairwise
 
 .. autosummary::
    :toctree: generated/
    :template: class.rst
 
-   metrics.pairwise.ValueDifferenceMetric
+   ValueDifferenceMetric

doc/references/miscellaneous.rst

@@ -12,5 +12,3 @@ Imbalance-learn provides some fast-prototyping tools.
    :template: class.rst
 
    FunctionSampler
-
-.. _pipeline_ref:

doc/references/over_sampling.rst

@@ -7,7 +7,7 @@ Over-sampling methods
     :no-members:
     :no-inherited-members:
 
-.. currentmodule:: imblearn
+.. currentmodule:: imblearn.over_sampling
 
 Basic over-sampling
 -------------------
@@ -16,7 +16,7 @@ Basic over-sampling
    :toctree: generated/
    :template: class.rst
 
-   over_sampling.RandomOverSampler
+   RandomOverSampler
 
 SMOTE algorithms
 ----------------
@@ -25,9 +25,9 @@ SMOTE algorithms
    :toctree: generated/
    :template: class.rst
 
-   over_sampling.SMOTE
-   over_sampling.SMOTENC
-   over_sampling.ADASYN
-   over_sampling.BorderlineSMOTE
-   over_sampling.KMeansSMOTE
-   over_sampling.SVMSMOTE
+   SMOTE
+   SMOTENC
+   ADASYN
+   BorderlineSMOTE
+   KMeansSMOTE
+   SVMSMOTE

doc/references/pipeline.rst

@@ -1,20 +1,22 @@
+.. _pipeline_ref:
+
 Pipeline
 ========
 
 .. automodule:: imblearn.pipeline
     :no-members:
     :no-inherited-members:
 
-.. currentmodule:: imblearn
+.. currentmodule:: imblearn.pipeline
 
 .. autosummary::
    :toctree: generated/
    :template: class.rst
 
-   pipeline.Pipeline
+   Pipeline
 
 .. autosummary::
    :toctree: generated/
    :template: function.rst
 
-   pipeline.make_pipeline
+   make_pipeline

doc/references/under_sampling.rst

@@ -7,22 +7,20 @@ Under-sampling methods
     :no-members:
     :no-inherited-members:
 
-.. currentmodule:: imblearn
-
 Prototype generation
 --------------------
 
 .. automodule:: imblearn.under_sampling._prototype_generation
    :no-members:
    :no-inherited-members:
 
-.. currentmodule:: imblearn
+.. currentmodule:: imblearn.under_sampling
 
 .. autosummary::
    :toctree: generated/
    :template: class.rst
 
-   under_sampling.ClusterCentroids
+   ClusterCentroids
 
 Prototype selection
 -------------------
@@ -31,19 +29,19 @@ Prototype selection
    :no-members:
    :no-inherited-members:
 
-.. currentmodule:: imblearn
+.. currentmodule:: imblearn.under_sampling
 
 .. autosummary::
    :toctree: generated/
    :template: class.rst
 
-   under_sampling.CondensedNearestNeighbour
-   under_sampling.EditedNearestNeighbours
-   under_sampling.RepeatedEditedNearestNeighbours
-   under_sampling.AllKNN
-   under_sampling.InstanceHardnessThreshold
-   under_sampling.NearMiss
-   under_sampling.NeighbourhoodCleaningRule
-   under_sampling.OneSidedSelection
-   under_sampling.RandomUnderSampler
-   under_sampling.TomekLinks
+   CondensedNearestNeighbour
+   EditedNearestNeighbours
+   RepeatedEditedNearestNeighbours
+   AllKNN
+   InstanceHardnessThreshold
+   NearMiss
+   NeighbourhoodCleaningRule
+   OneSidedSelection
+   RandomUnderSampler
+   TomekLinks

doc/references/utils.rst

@@ -5,12 +5,12 @@ Utilities
     :no-members:
     :no-inherited-members:
 
-.. currentmodule:: imblearn
+.. currentmodule:: imblearn.utils
 
 .. autosummary::
    :toctree: generated/
    :template: function.rst
 
-   utils.estimator_checks.parametrize_with_checks
-   utils.check_neighbors_object
-   utils.check_sampling_strategy
+   estimator_checks.parametrize_with_checks
+   check_neighbors_object
+   check_sampling_strategy