cursus.steps.scripts.model_wiki_generator

class DataIngestionManager

Bases: object

Manages loading and parsing of metrics data, configuration, and visualizations.

load_metrics_data(metrics_dir)

Load comprehensive metrics data from metrics computation output. Supports both model_metrics_computation and xgboost_model_eval output formats.

discover_visualization_files(plots_dir)

Discover and catalog visualization files for embedding. Includes support for model comparison visualizations.

class WikiTemplateEngine(template_config=None)

Bases: object

Template engine for generating wiki documentation from model data.

generate_wiki_content(context)

Generate complete wiki content from context data.

class ContentGenerator

Bases: object

Generates intelligent content based on model performance data.

generate_performance_assessment(auc_score)

Generate performance assessment based on AUC score.

generate_auc_interpretation(auc_score)

Generate AUC interpretation text.

generate_ap_interpretation(ap_score)

Generate Average Precision interpretation text.

generate_business_impact_summary(dollar_recall=None, count_recall=None, total_abuse_amount=None)

Generate business impact summary based on available metrics.

generate_recommendations_section(recommendations)

Generate formatted recommendations section.

generate_performance_overview(metrics)

Generate performance overview text.

detect_comparison_mode(metrics)

Detect if comparison metrics are present in the data.

generate_comparison_summary(metrics)

Generate model comparison summary text.

generate_statistical_significance_summary(metrics)

Generate statistical significance test summary.

generate_deployment_recommendation(metrics)

Generate deployment recommendation based on comparison results.

class VisualizationIntegrator(output_dir)

Bases: object

Handles integration of visualizations into wiki documentation.

process_visualizations(visualizations)

Process and prepare visualizations for wiki embedding. Returns mapping of plot types to wiki image references.

class WikiReportAssembler(template_engine, content_generator)

Bases: object

Assembles complete wiki reports from generated content and templates.

assemble_complete_report(metrics_data, processed_images, environ_vars)

Assemble complete wiki report from all components.

class WikiOutputManager(output_dir)

Bases: object

Manages output generation in multiple formats.

save_wiki_documentation(wiki_content, model_name, formats=['wiki', 'html', 'markdown'])

Save wiki documentation in multiple formats. Returns dictionary of format -> file path mappings.

create_health_check_file(output_path)

Create a health check file to signal script completion.

main(input_paths, output_paths, environ_vars, job_args)

Main entry point for Model Wiki Generator script. Loads metrics data and visualizations, generates wiki documentation, and saves results.

Parameters:

• input_paths (Dict[str, str]) – Dictionary of input paths

• output_paths (Dict[str, str]) – Dictionary of output paths

• environ_vars (Dict[str, str]) – Dictionary of environment variables

• job_args (argparse.Namespace) – Command line arguments