:orphan:

Gallery of Examples
===================

These examples illustrate the main features of HiClass.

.. toctree::
    :hidden:



.. raw:: html

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

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="A minimalist example showing how to use HiClass to train and predict.">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_plot_hello_hiclass_thumb.png
    :alt:

  :doc:`/auto_examples/plot_hello_hiclass`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Hello HiClass</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="HiClass supports different number of levels in the hierarchy. For this example, we will train a local classifier per node with a hierarchy similar to the following image:">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_plot_empty_levels_thumb.png
    :alt:

  :doc:`/auto_examples/plot_empty_levels`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Different Number of Levels</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The siblings policy is used by default on the local classifier per node, but the remaining ones can be selected with the parameter binary_policy, for example:">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_plot_binary_policies_thumb.png
    :alt:

  :doc:`/auto_examples/plot_binary_policies`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Binary Training Policies</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="HiClass is fully compatible with Pickle. Pickle can be used to easily store machine learning models on disk. In this example, we demonstrate how to use pickle to store and load trained classifiers.">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_plot_model_persistence_thumb.png
    :alt:

  :doc:`/auto_examples/plot_model_persistence`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Model Persistence</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="HiClass can be adopted in scikit-learn pipelines, and fully supports sparse matrices as input. This example desmonstrates the use of both of these features.">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_plot_pipeline_thumb.png
    :alt:

  :doc:`/auto_examples/plot_pipeline`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Building Pipelines</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Larger datasets require more time for training. While by default the models in HiClass are trained using a single core, it is possible to train each local classifier in parallel by leveraging the library Ray [1]_. If Ray is not installed, the parallelism defaults to Joblib. In this example, we demonstrate how to train a hierarchical classifier in parallel by setting the parameter n_jobs to use all the cores available. Training is performed on a mock dataset from Kaggle [2]_.">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_plot_parallel_training_thumb.png
    :alt:

  :doc:`/auto_examples/plot_parallel_training`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Parallel Training</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="A minimalist example showing how to calibrate a HiClass LCN model. The calibration method can be selected with the calibration_method parameter, for example:">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_plot_calibration_thumb.png
    :alt:

  :doc:`/auto_examples/plot_calibration`

.. raw:: html

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


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/plot_hello_hiclass
   /auto_examples/plot_empty_levels
   /auto_examples/plot_binary_policies
   /auto_examples/plot_model_persistence
   /auto_examples/plot_pipeline
   /auto_examples/plot_parallel_training
   /auto_examples/plot_calibration


.. 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>`_