hana_ml.visualizers package
==============================

The Visualizers Package consists of the following sections:

* :ref:`eda-label`
* :ref:`m4_sampling-label`
* :ref:`metrics-label`
* :ref:`model_debriefing-label`
* :ref:`dataset_report-label`
* :ref:`shap-label`
* :ref:`unified_report-label`
* :ref:`visualizer_base-label`
* :ref:`digraph-label`
* :ref:`word_cloud-label`
* :ref:`automl_progress-label`
* :ref:`automl_report-label`
* :ref:`time_series_report-label`
* :ref:`automl_config-label`
* :ref:`tracking-label`


.. _eda-label:

hana_ml.visualizers.eda
-----------------------

.. automodule:: hana_ml.visualizers.eda
    :members:
    :inherited-members:
    :show-inheritance:

.. _metrics-label:

hana_ml.visualizers.metrics
---------------------------

.. automodule:: hana_ml.visualizers.metrics
    :members:
    :inherited-members:
    :show-inheritance:

.. _m4_sampling-label:

hana_ml.visualizers.m4_sampling
-------------------------------

.. automodule:: hana_ml.visualizers.m4_sampling
    :members:
    :inherited-members:
    :show-inheritance:

.. _model_debriefing-label:

hana_ml.visualizers.model_debriefing
------------------------------------

.. automodule:: hana_ml.visualizers.model_debriefing
    :members:
    :inherited-members:
    :show-inheritance:

.. _dataset_report-label:

hana_ml.visualizers.dataset_report
----------------------------------

.. autoclass:: hana_ml.visualizers.dataset_report.DatasetReportBuilder
    :members:
    :inherited-members:
    :show-inheritance:

.. _shap-label:

hana_ml.visualizers.shap
------------------------

.. automodule:: hana_ml.visualizers.shap
    :members:
    :inherited-members:
    :show-inheritance:

.. _unified_report-label:

hana_ml.visualizers.unified_report
----------------------------------

.. automodule:: hana_ml.visualizers.unified_report
    :members:
    :inherited-members:
    :show-inheritance:


.. _visualizer_base-label:

hana_ml.visualizers.visualizer_base
-----------------------------------

.. automodule:: hana_ml.visualizers.visualizer_base
    :members:
    :inherited-members:
    :show-inheritance:
    :exclude-members: Visualizer


.. _digraph-label:

hana_ml.visualizers.digraph
---------------------------

.. automodule:: hana_ml.visualizers.digraph
    :members:
    :inherited-members:
    :show-inheritance:


.. _word_cloud-label:

hana_ml.visualizers.word_cloud
------------------------------

.. automodule:: hana_ml.visualizers.word_cloud
    :members:
    :inherited-members:
    :show-inheritance:
    :exclude-members: to_image

.. _automl_progress-label:

hana_ml.visualizers.automl_progress
-----------------------------------

.. autoclass:: hana_ml.visualizers.automl_progress.PipelineProgressStatusMonitor
    :members:

.. autoclass:: hana_ml.visualizers.automl_progress.SimplePipelineProgressStatusMonitor
    :members:


.. _automl_report-label:

hana_ml.visualizers.automl_report
---------------------------------

.. automodule:: hana_ml.visualizers.automl_report
    :members:
    :inherited-members:
    :show-inheritance:


.. _time_series_report-label:

hana_ml.visualizers.time_series_report
--------------------------------------

.. automodule:: hana_ml.visualizers.time_series_report
    :members:
    :inherited-members:
    :show-inheritance:


.. _automl_config-label:

hana_ml.visualizers.automl_config
---------------------------------

.. autoclass:: hana_ml.visualizers.automl_config.AutoMLConfig
    :members: generate_html, get_config_dict


.. _tracking-label:

hana_ml.visualizers.tracking
----------------------------

.. autoclass:: hana_ml.visualizers.tracking.ExperimentMonitor
    :members:

.. autoclass:: hana_ml.visualizers.tracking.ScheduledTaskMonitor
    :members: