logml.report.notebooks.master_summary

Functions

modeling_to_grid(results[, problems, strata])

Transforms stratified problems result into grid for rendering.

Classes

MasterSummaryNotebook(cfg, global_params, ...)	Notebook for composing different artifacts and displaying a summary for a run.
ReportSummaryNotebook(cfg, global_params, ...)	Report landing page: Notebook for composing different stara and models and displaying logml analysis summary
StandaloneSummaryPage(cfg, global_params, ...)	Generates standalone html file to represent all important findings.

class logml.report.notebooks.master_summary.MasterSummaryNotebook(cfg: GlobalConfig, global_params: Dict, output_structure: logml.report.ReportOutputStructure, logger: logging.Logger = None, file_ext: str = '.ipynb')

Bases: logml.report.notebooks.base.BaseBKNotebook

Notebook for composing different artifacts and displaying a summary for a run.

ALIAS: str = 'master_summary'

VIEWS: List[str] = ['master_summary']

SCOPE: List[logml.report.notebooks.base.BKNotebookScopes] = [<BKNotebookScopes.STRATA: 'strata'>]

logml.report.notebooks.master_summary.modeling_to_grid(results: list, problems: Optional[dict] = None, strata: Optional[dict] = None)

Transforms stratified problems result into grid for rendering.

class logml.report.notebooks.master_summary.ReportSummaryNotebook(cfg, global_params, output_structure, logger=None, file_ext: str = '.md', template_name: Optional[str] = None)

Bases: logml.report.notebooks.base.TemplatedArtifact

Report landing page: Notebook for composing different stara and models and displaying logml analysis summary

ALIAS: str = 'report_summary'

FILE_NAME = 'index.md'

VIEWS: List[str] = None

SCOPE: List[logml.report.notebooks.base.BKNotebookScopes] = []

TEMPLATE_NAME: Optional[str] = 'summary_report.md.tmpl'

get_notebook_toc_entry() → dict

Returns empty top entry.

get_notebook_filename(*suffix_args)

Notebook filename.

class logml.report.notebooks.master_summary.StandaloneSummaryPage(cfg: GlobalConfig, global_params: Dict, output_structure: logml.report.ReportOutputStructure, logger: logging.Logger = None, file_ext: str = '.ipynb')

Bases: logml.report.notebooks.base.BaseBKNotebook

Generates standalone html file to represent all important findings.

ALIAS: str = 'standalone_summary'

VIEWS: List[str] = ['standalone_summary_view']

SCOPE: List[logml.report.notebooks.base.BKNotebookScopes] = []

HTML_FILENAME = 'summary'

get_result_notebook_path()

Returns a path where executed notebook will be dumped.

get_result_html_path()

Returns a path where executed notebook will be dumped.

generate_html()

get_notebook_filename(*suffix_args)

Based on the notebook’s scope defines its filename.