:orphan:



.. _sphx_glr_auto_examples:

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

These examples illustrate the main features of HiClass.

.. toctree::
    :hidden:



.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In order to use `bert-sklearn &lt;https://github.com/charles9n/bert-sklearn&gt;`_ with HiClass, some ...">

.. only:: html

 .. figure:: /auto_examples/images/thumb/sphx_glr_plot_bert_thumb.png
     :alt: BERT sklearn

     :ref:`sphx_glr_auto_examples_plot_bert.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/plot_bert

.. raw:: html

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

.. only:: html

 .. figure:: /auto_examples/images/thumb/sphx_glr_plot_hello_hiclass_thumb.png
     :alt: Hello HiClass

     :ref:`sphx_glr_auto_examples_plot_hello_hiclass.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/plot_hello_hiclass

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="HiClass supports different number of levels in the hierarchy. For this example, we will train a...">

.. only:: html

 .. figure:: /auto_examples/images/thumb/sphx_glr_plot_empty_levels_thumb.png
     :alt: Different Number of Levels

     :ref:`sphx_glr_auto_examples_plot_empty_levels.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/plot_empty_levels

.. 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...">

.. only:: html

 .. figure:: /auto_examples/images/thumb/sphx_glr_plot_binary_policies_thumb.png
     :alt: Binary Training Policies

     :ref:`sphx_glr_auto_examples_plot_binary_policies.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/plot_binary_policies

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="A simple example to show how to use multi-label classification in HiClass. Please have a look a...">

.. only:: html

 .. figure:: /auto_examples/images/thumb/sphx_glr_plot_multilabel_thumb.png
     :alt: Using Hierarchical Multi-Label Classification

     :ref:`sphx_glr_auto_examples_plot_multilabel.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/plot_multilabel

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="HiClass is fully compatible with Pickle. Pickle can be used to easily store machine learning mo...">

.. only:: html

 .. figure:: /auto_examples/images/thumb/sphx_glr_plot_model_persistence_thumb.png
     :alt: Model Persistence

     :ref:`sphx_glr_auto_examples_plot_model_persistence.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/plot_model_persistence

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="HiClass can be adopted in scikit-learn pipelines, and fully supports sparse matrices as input. ...">

.. only:: html

 .. figure:: /auto_examples/images/thumb/sphx_glr_plot_pipeline_thumb.png
     :alt: Building Pipelines

     :ref:`sphx_glr_auto_examples_plot_pipeline.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/plot_pipeline

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Larger datasets require more time for training. While by default the models in HiClass are trai...">

.. only:: html

 .. figure:: /auto_examples/images/thumb/sphx_glr_plot_parallel_training_thumb.png
     :alt: Parallel Training

     :ref:`sphx_glr_auto_examples_plot_parallel_training.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/plot_parallel_training

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="A minimalist example showing how to calibrate a HiClass LCN model. The calibration method can b...">

.. only:: html

 .. figure:: /auto_examples/images/thumb/sphx_glr_plot_calibration_thumb.png
     :alt: Calibrating a Classifier

     :ref:`sphx_glr_auto_examples_plot_calibration.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/plot_calibration

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="A minimalist example showing how to use HiClass Explainer to obtain SHAP values of LCPN model. ...">

.. only:: html

 .. figure:: /auto_examples/images/thumb/sphx_glr_plot_lcpn_explainer_thumb.png
     :alt: Explaining Local Classifier Per Node

     :ref:`sphx_glr_auto_examples_plot_lcpn_explainer.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/plot_lcpn_explainer

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="A minimalist example showing how to use HiClass Explainer to obtain SHAP values of LCPPN model....">

.. only:: html

 .. figure:: /auto_examples/images/thumb/sphx_glr_plot_lcppn_explainer_thumb.png
     :alt: Explaining Local Classifier Per Parent Node

     :ref:`sphx_glr_auto_examples_plot_lcppn_explainer.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/plot_lcppn_explainer

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="A minimalist example showing how to use HiClass Explainer to obtain SHAP values of LCPL model. ...">

.. only:: html

 .. figure:: /auto_examples/images/thumb/sphx_glr_plot_lcpl_explainer_thumb.png
     :alt: Explaining Local Classifier Per Level

     :ref:`sphx_glr_auto_examples_plot_lcpl_explainer.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/plot_lcpl_explainer
.. raw:: html

    <div class="sphx-glr-clear"></div>



.. only :: html

 .. container:: sphx-glr-footer
    :class: 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>`_