pdstools.reports.GlobalExplanations.scripts.generate_report¶

Pre-render script for the GlobalExplanations Quarto website project.

This script is executed by Quarto as a pre-render step (configured in _quarto.yml) before the website is built. It reads .qmd templates from assets/templates/, substitutes parameter placeholders (e.g. {TOP_N}, {SORT_BY_TYPE}) with values from params.yml, and writes the final .qmd files that Quarto then renders into the website.

Templates are located in: assets/templates/ Generated .qmd files are written to the project root for Quarto to render.

Classes¶

ReportGenerator

Quarto pre-render generator for the GlobalExplanations website project.

Module Contents¶

logger¶

ENCODING = 'utf-8'¶

CONTEXT_FOLDER = 'by-model-context'¶

TOP_N = 20¶

TOP_K = 20¶

FROM_DATE_DEFAULT = 'N/A'¶

TO_DATE_DEFAULT = 'N/A'¶

SORT_BY_DEFAULT = 'contribution_abs'¶

SORT_BY_TEXT_DEFAULT = 'absolute average contribution'¶

DISPLAY_BY_DEFAULT = 'contribution'¶

DISPLAY_BY_TEXT_DEFAULT = 'average contribution'¶

DATA_FOLDER = 'aggregated_data'¶

UNIQUE_CONTEXTS_FILENAME = 'unique_contexts.json'¶

PLOTS_FOR_BATCH = 'plots_for_batch'¶

PARAMS_FILENAME = 'params.yml'¶

TEMPLATES_FOLDER = './assets/templates'¶

INTRODUCTION_FILENAME = 'getting-started.qmd'¶

OVERVIEW_FILENAME = 'overview.qmd'¶

ALL_CONTEXT_HEADER_TEMPLATE = 'all_context_header.qmd'¶

ALL_CONTEXT_CONTENT_TEMPLATE = 'all_context_content.qmd'¶

SINGLE_CONTEXT_TEMPLATE = 'context.qmd'¶

class ReportGenerator¶

Quarto pre-render generator for the GlobalExplanations website project. Reads .qmd templates from assets/templates/, substitutes parameter placeholders with values from params.yml, and writes the rendered .qmd files for Quarto to build. Shared configuration (front matter, theme, branding) is inherited from _quarto.yml; templates only contain page-specific content and code cells.

report_folder¶

root_dir = ''¶

data_folder = ''¶

top_n = None¶

top_k = None¶

from_date = None¶

to_date = None¶

sort_by = None¶

sort_by_text = None¶

display_by = None¶

display_by_text = None¶

model_context_limit¶

by_context_folder¶

plots_for_batch_filepath¶

contexts = None¶

run()¶: Main method to generate the report files.

generator¶

`logger`
`ENCODING`
`CONTEXT_FOLDER`
`TOP_N`
`TOP_K`
`FROM_DATE_DEFAULT`
`TO_DATE_DEFAULT`
`SORT_BY_DEFAULT`
`SORT_BY_TEXT_DEFAULT`
`DISPLAY_BY_DEFAULT`
`DISPLAY_BY_TEXT_DEFAULT`
`DATA_FOLDER`
`UNIQUE_CONTEXTS_FILENAME`
`PLOTS_FOR_BATCH`
`PARAMS_FILENAME`
`TEMPLATES_FOLDER`
`INTRODUCTION_FILENAME`
`OVERVIEW_FILENAME`
`ALL_CONTEXT_HEADER_TEMPLATE`
`ALL_CONTEXT_CONTENT_TEMPLATE`
`SINGLE_CONTEXT_TEMPLATE`
`generator`

pdstools.reports.GlobalExplanations.scripts.generate_report¶

Attributes¶

Classes¶

Module Contents¶