:orphan:

.. _examples-index:

**General-purpose and introductory examples for the imbalanced-ensemble toolbox.**

**The examples gallery is still under construction.** Please refer to APIs for more detailed guidelines of how to use 
``imbens``.


.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. thumbnail-parent-div-close

.. raw:: html

    </div>


Basic usage examples
--------------------

Quick start with :mod:`imbens`.



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example illustrates how to quickly visualize an  imbens.ensemble classifier with the imbens.visualizer module.">

.. only:: html

  .. image:: /auto_examples/basic/images/thumb/sphx_glr_plot_basic_visualize_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_basic_plot_basic_visualize.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Visualize an ensemble classifier</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example illustrates how to enable and customize the training  log when training an imbens.ensemble classifier.">

.. only:: html

  .. image:: /auto_examples/basic/images/thumb/sphx_glr_plot_training_log_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_basic_plot_training_log.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Customize ensemble training log</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows the basic usage of an  imbens.ensemble classifier.">

.. only:: html

  .. image:: /auto_examples/basic/images/thumb/sphx_glr_plot_basic_example_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_basic_plot_basic_example.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Train and predict with an ensemble classifier</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/basic/plot_basic_visualize
   /auto_examples/basic/plot_training_log
   /auto_examples/basic/plot_basic_example


Classification examples
-----------------------

Examples about using classification algorithms in :mod:`imbens.ensemble` module.



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how imbalanced-ensemble can be used to cooperate with  scikit-learn base classifier and recognize images of hand-written digits, from 0-9.">

.. only:: html

  .. image:: /auto_examples/classification/images/thumb/sphx_glr_plot_digits_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_classification_plot_digits.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Classify class-imbalanced hand-written digits</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Plot the classification probability for ensemble models with different base classifiers. ">

.. only:: html

  .. image:: /auto_examples/classification/images/thumb/sphx_glr_plot_probability_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_classification_plot_probability.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Plot probabilities with different base classifiers</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how to customize the cost matrix of cost-sensitive ensemble methods.">

.. only:: html

  .. image:: /auto_examples/classification/images/thumb/sphx_glr_plot_cost_matrix_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_classification_plot_cost_matrix.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Customize cost matrix</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how to customize the sampling schedule to achieve dynamic resampling. This can be easily done by setting the &quot;balancing_schedule&quot; parameter when calling the &quot;fit()&quot; method. ">

.. only:: html

  .. image:: /auto_examples/classification/images/thumb/sphx_glr_plot_sampling_schedule_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_classification_plot_sampling_schedule.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Use dynamic resampling schedule</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how to customize the resampling target to achieve advanced resampling control. This can be easily done by setting the &quot;target_label&quot; and &quot;n_target_samples&quot; parameter when calling the &quot;fit()&quot; method. ">

.. only:: html

  .. image:: /auto_examples/classification/images/thumb/sphx_glr_plot_resampling_target_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_classification_plot_resampling_target.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Customize resampling target</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="A comparison of a several classifiers in imbens.ensemble  on synthetic datasets. The point of this example is to illustrate the nature  of decision boundaries of different imbalanced ensmeble classifiers.  This should be taken with a grain of salt, as the intuition conveyed by these  examples does not necessarily carry over to real datasets.">

.. only:: html

  .. image:: /auto_examples/classification/images/thumb/sphx_glr_plot_classifier_comparison_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_classification_plot_classifier_comparison.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Classifier comparison</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="An example of how to cooperate imbens with deep learning frameworks like PyTorch. In this example, we first define a simple MLP classifier using PyTorch, and pack  it into a scikit-learn-style wrapper class TorchMLPClassifier. We then use it as  the base estimator of imbens.ensemble.SelfPacedEnsembleClassifier and  train the ensemble on a toy imbalanced dataset.">

.. only:: html

  .. image:: /auto_examples/classification/images/thumb/sphx_glr_plot_torch_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_classification_plot_torch.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Classification with PyTorch Neural Network</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/classification/plot_digits
   /auto_examples/classification/plot_probability
   /auto_examples/classification/plot_cost_matrix
   /auto_examples/classification/plot_sampling_schedule
   /auto_examples/classification/plot_resampling_target
   /auto_examples/classification/plot_classifier_comparison
   /auto_examples/classification/plot_torch


Dataset examples
----------------

Examples concerning the :mod:`imbens.datasets` module.



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="An illustration of using the  generate_imbalance_data  function to create an imbalanced dataset. ">

.. only:: html

  .. image:: /auto_examples/datasets/images/thumb/sphx_glr_plot_generate_imbalance_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_datasets_plot_generate_imbalance.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Generate an imbalanced dataset</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="An illustration of the make_imbalance function to create an imbalanced dataset from a balanced dataset. We show the ability of make_imbalance of dealing with Pandas DataFrame.">

.. only:: html

  .. image:: /auto_examples/datasets/images/thumb/sphx_glr_plot_make_imbalance_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_datasets_plot_make_imbalance.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Make a dataset class-imbalanced</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="An illustration of the make_imbalance  function to create an imbalanced version of the digits dataset.">

.. only:: html

  .. image:: /auto_examples/datasets/images/thumb/sphx_glr_plot_make_imbalance_digits_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_datasets_plot_make_imbalance_digits.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Make digits dataset class-imbalanced</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/datasets/plot_generate_imbalance
   /auto_examples/datasets/plot_make_imbalance
   /auto_examples/datasets/plot_make_imbalance_digits


Evaluation examples
-------------------

Examples illustrating how classification using imbalanced dataset can be done.



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Specific metrics have been developed to evaluate classifier which has been trained using imbalanced data. &quot;mod:`imbens` provides a classification report (imbens.metrics.classification_report_imbalanced)  similar to sklearn, with additional metrics specific to imbalanced learning problem.">

.. only:: html

  .. image:: /auto_examples/evaluation/images/thumb/sphx_glr_plot_classification_report_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_evaluation_plot_classification_report.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Evaluate classification by compiling a report</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Specific metrics have been developed to evaluate classifier which has been trained using imbalanced data. imbens provides mainly two additional metrics which are not implemented in sklearn: (i) geometric mean (imbens.metrics.geometric_mean_score)  and (ii) index balanced accuracy (imbens.metrics.make_index_balanced_accuracy).">

.. only:: html

  .. image:: /auto_examples/evaluation/images/thumb/sphx_glr_plot_metrics_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_evaluation_plot_metrics.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Metrics specific to imbalanced learning</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/evaluation/plot_classification_report
   /auto_examples/evaluation/plot_metrics


Pipeline examples
-----------------

Example of how to use the a pipeline to include under-sampling with `scikit-learn` estimators.


.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="An example of the Pipeline object (or make_pipeline helper function) working with transformers (~sklearn.decomposition.PCA,  KNeighborsClassifier from scikit-learn) and resamplers (~imbens.sampler.EditedNearestNeighbours,  SMOTE).">

.. only:: html

  .. image:: /auto_examples/pipeline/images/thumb/sphx_glr_plot_pipeline_classification_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_pipeline_plot_pipeline_classification.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Usage of pipeline embedding samplers</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/pipeline/plot_pipeline_classification


Visualizer examples
-------------------

Examples concerning the  :mod:`imbens.visualizer`. module.



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example illustrates how to use the  imbens.visualizer module to plot confusion  matrix for imbens.ensemble classifier(s).">

.. only:: html

  .. image:: /auto_examples/visualizer/images/thumb/sphx_glr_plot_confusion_matrix_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_visualizer_plot_confusion_matrix.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Plot confusion matrix</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example illustrates how to use the  imbens.visualizer module to visualize or  compare imbens.ensemble classifier(s).">

.. only:: html

  .. image:: /auto_examples/visualizer/images/thumb/sphx_glr_plot_performance_curve_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_visualizer_plot_performance_curve.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Plot performance curves</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/visualizer/plot_confusion_matrix
   /auto_examples/visualizer/plot_performance_curve


.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-gallery

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download all examples in Python source code: auto_examples_python.zip </auto_examples/auto_examples_python.zip>`

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download all examples in Jupyter notebooks: auto_examples_jupyter.zip </auto_examples/auto_examples_jupyter.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_