scitex_ml.classification.reporters.reporter_utils.reporting

Functions

create_summary_statistics(results)

Create comprehensive summary statistics from results.

export_for_paper(results, output_dir[, verbose])

Export results in formats suitable for academic papers.

generate_latex_report(results, output_path)

Generate LaTeX report for academic papers.

generate_markdown_report(results, output_path)

Generate comprehensive markdown report.

generate_org_report(results, output_path[, ...])

Generate org-mode report with inline images and optional pandoc conversions.
scitex_ml.classification.reporters.reporter_utils.reporting.generate_org_report(results, output_path, include_plots=True, verbose=True, convert_formats=True)[source]

Generate org-mode report with inline images and optional pandoc conversions.

Parameters:

  • results (Dict[str, Any]) – Classification results dictionary

  • output_path (Union[str, Path]) – Output file path

  • include_plots (bool, default True) – Whether to include plot images

  • verbose (bool, default True) – Whether to print progress messages

  • convert_formats (bool, default True) – Whether to use pandoc to generate other formats

Returns:

Path to generated report

Return type:

Path

scitex_ml.classification.reporters.reporter_utils.reporting.generate_markdown_report(results, output_path, include_plots=True, verbose=True)[source]

Generate comprehensive markdown report.

Parameters:

  • results (Dict[str, Any]) – Classification results dictionary

  • output_path (Union[str, Path]) – Output file path

  • include_plots (bool, default True) – Whether to include plot images

  • verbose (bool, default True) – Whether to print progress messages

Returns:

Path to generated report

Return type:

Path

scitex_ml.classification.reporters.reporter_utils.reporting.generate_latex_report(results, output_path, verbose=True)[source]

Generate LaTeX report for academic papers.

Parameters:

  • results (Dict[str, Any]) – Classification results dictionary

  • output_path (Union[str, Path]) – Output file path

  • verbose (bool, default True) – Whether to print progress messages

Returns:

Path to generated report

Return type:

Path

scitex_ml.classification.reporters.reporter_utils.reporting.create_summary_statistics(results)[source]

Create comprehensive summary statistics from results.

Parameters:

results (Dict[str, Any]) – Classification results

Returns:

Summary statistics

Return type:

Dict[str, Any]

scitex_ml.classification.reporters.reporter_utils.reporting.export_for_paper(results, output_dir, verbose=True)[source]

Export results in formats suitable for academic papers.

Parameters:

  • results (Dict[str, Any]) – Classification results

  • output_dir (Union[str, Path]) – Output directory for exports

  • verbose (bool, default True) – Whether to print progress messages

Returns:

Paths to exported files

Return type:

Dict[str, Path]