Skip to main content
To get the best results, analyze the results of each run and adjust the configuration settings to fit your specific collection. The script produces four key outputs:
  • Terminal output - Real-time progress per page, ending with a summary
  • Log file - Includes every step of the process, including AI model requests and responses
  • Page images and extracted text - Original + enhanced images, and extracted text as plain text files
  • stats.txt - Easy-to-read summary of processed files with proposed filenames

Terminal output

When given the --verbose-output argument, the script displays detailed, real-time progress and a summary.
Terminal output

Log file, page images and extracted text

You’ll find a timestamped log file in [project-root]/logs/[your-run-timestamp]/[pdf-filename], where logs is the directory you set for DIAGNOSTIC_FOLDER. Review the per-page images and corresponding text files to get a sense of what the models are picking up and extracting.
Log file directory
Read the sample output log Gist.

stats.txt Output

When given the --with-stats-export flag, the script will write a stats.txt file to the same directory as the log file.
stats.txt

Use .runtime-ignore folders to selectively run sets of files

@todo: Work in progress
Take the following [project-root]/data/ directory structure:
.runtime-ignore folders provide a flexible way to organize and isolate problematic PDFs during testing. This example follows our Test Cases directory pattern, making it easy to move files between folders while troubleshooting without breaking the subtrees.