pdstools.explanations.Reports
=============================

.. py:module:: pdstools.explanations.Reports


Classes
-------

.. autoapisummary::

   pdstools.explanations.Reports.Reports


Module Contents
---------------

.. py:class:: Reports(explanations: pdstools.explanations.Explanations.Explanations)

   Bases: :py:obj:`pdstools.utils.namespaces.LazyNamespace`


   .. py:attribute:: dependencies
      :value: ['yaml']



   .. py:attribute:: dependency_group
      :value: 'explanations'



   .. py:attribute:: explanations


   .. py:attribute:: report_foldername
      :value: 'reports'



   .. py:attribute:: report_folderpath


   .. py:attribute:: report_output_dir


   .. py:attribute:: aggregate_folder


   .. py:attribute:: params_file


   .. py:method:: generate(report_filename: str = 'explanations_report.zip', top_n: int = defaults.top_n, top_k: int = defaults.top_k, zip_output: bool = False, **filter_kwargs)

      Generate the explanations report.

      :param report_filename: Name of the output report file.
      :type report_filename: str
      :param top_n: Number of top explanations to include.
      :type top_n: int
      :param top_k: Number of top features to include in explanations.
      :type top_k: int
      :param zip_output: Whether to zip the output report.
                         The filename will be used as the zip file name.
      :type zip_output: bool
      :param \*\*filter_kwargs: Optional filtering and display controls. Valid keys:

                                - ``sort_by`` (str): Column to rank/select top predictors.
                                  Default: ``"contribution_abs"``.
                                - ``display_by`` (str): Column to use for the report axis values.
                                  Default: ``"contribution"``.

      .. rubric:: Notes

      Progress and diagnostic information is logged at DEBUG level.
      Enable debug logging to see detailed report generation steps.