AlgorithmReportGenerator

Markdown report generation for algorithm profiles.

Generates human-readable reports from algorithm characterization data, including comparison tables, recommendations, and visualizations.

See ADR-011 for architecture decisions.

Classes

class AlgorithmReportGenerator

Generate markdown reports from algorithm profiles.

Creates detailed reports with: - Algorithm comparison tables - Individual algorithm profiles - Parameter recommendations - Use case guidance

Example:

comparison = characterizer.create_comparison() generator = AlgorithmReportGenerator(comparison) generator.save_report(“algorithm_report.md”)

Methods:

__init__()

Initialize report generator.

generate_report()

Generate complete markdown report.

save_report()

Save report to file.

Functions

generate_report()

Generate complete markdown report.

Returns:

Markdown string.

save_report()

Save report to file.

Args:

output_path: Path to save markdown file.

generate_algorithm_report()

Convenience function to generate and save report.

Args:

comparison: AlgorithmComparison to report. output_path: Path to save report.

Returns:

Generated markdown string.