compass.utilities.finalize.compile_run_summary_message#

compile_run_summary_message(total_seconds, total_cost, out_dir, document_count)[source]#

Summarize the run results into a formatted string

Parameters:

  • total_seconds (int or float) – Total number of seconds the run took to complete.

  • total_cost (int or float) – Total cost of the run, in $.

  • out_dir (path-like) – Path to output directory where the run results are saved.

  • document_count (int) – Number of documents found during the run.

Returns:

str – Formatted string summarizing the run results.