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 = _DEFAULT.TOP_N.value, top_k: int = _DEFAULT.TOP_K.value, zip_output: bool = False, verbose: bool = False)

      Generate the explanations report.

      Args:
          report_filename (str):
              Name of the output report file.
          top_n (int):
              Number of top explanations to include.
          top_k (int):
              Number of top features to include in explanations.
          zip_output (bool):
              Whether to zip the output report.
              The filename will be used as the zip file name.
          verbose (bool):
              Whether to print verbose output during report generation.



   .. py:method:: _validate_report_dir()


   .. py:method:: _copy_report_resources()


   .. py:method:: _set_params(top_n: int = _DEFAULT.TOP_N.value, top_k: int = _DEFAULT.TOP_K.value, verbose: bool = False)