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`


   Reports.


   .. py:attribute:: dependencies
      :type:  ClassVar[list[str]]
      :value: ['yaml']



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



   .. py:attribute:: explanations


   .. py:method:: generate(report_filename: str = 'explanations_report.zip', top_n: int = 20, top_k: int = 20, zip_output: bool = False, full_embed: bool = False, *, output_dir: str | pathlib.Path = DEFAULT_OUTPUT_DIR, sort_by: pdstools.explanations._constants.ContributionType = 'contribution_abs', display_by: pdstools.explanations._constants.ContributionType = 'contribution')

      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 full_embed: When True, fully embed JavaScript libraries into the generated
                         Quarto website. Defaults to False, which keeps the smaller
                         CDN-backed output.
      :type full_embed: bool, default False
      :param output_dir: Directory the Quarto project is rendered into, default
                         ``".tmp/reports"``. The rendered site lands in ``<output_dir>/_site``.
      :type output_dir: str | Path, keyword-only
      :param sort_by: Column to rank/select top predictors. Default: ``"contribution_abs"``.
      :type sort_by: str, keyword-only
      :param display_by: Column to use for the report axis values. Default: ``"contribution"``.
      :type display_by: str, keyword-only

      .. rubric:: Notes

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