diff --git a/DocAI Incubator Tools/best-practices/Pre Post Bounding Box Mismatch/readme.md b/DocAI Incubator Tools/best-practices/Pre Post Bounding Box Mismatch/readme.md index 8c54dc417..1d060dfef 100644 --- a/DocAI Incubator Tools/best-practices/Pre Post Bounding Box Mismatch/readme.md +++ b/DocAI Incubator Tools/best-practices/Pre Post Bounding Box Mismatch/readme.md @@ -4,13 +4,13 @@ This tool is a comparison utility script designed to detect two primary issues: ## Issues Defined -- **Parser issue:** +- **Parser issue:** Identified when the bounding box fails to encompass the entire text region, resulting in incomplete text capture. When users access the HITL worker UI, they adjust the bounding box to cover the entire text region and save their changes. This script highlights such discrepancies. -- **OCR issue:** +- **OCR issue:** Recognized when the bounding box does cover the entire text region, but the resultant text is not captured fully. These cases are flagged by the script. -## Inputs +## Inputs - **project_id:** Provide the specific project ID. diff --git a/DocAI Incubator Tools/best-practices/Utilities/utilities.py b/DocAI Incubator Tools/best-practices/Utilities/utilities.py index 4b8898caa..0686f2360 100644 --- a/DocAI Incubator Tools/best-practices/Utilities/utilities.py +++ b/DocAI Incubator Tools/best-practices/Utilities/utilities.py @@ -82,8 +82,8 @@ def bucket_delete(bucket_name): bucket_name (str): The name of the bucket to be deleted. Returns: - None. If the bucket exists, it will be deleted. - If it doesn't exist or an error occurs, + None. If the bucket exists, it will be deleted. + If it doesn't exist or an error occurs, the function will silently pass. """ @@ -129,11 +129,11 @@ def matching_files_two_buckets(bucket_1, bucket_2): Returns: tuple: A tuple containing two dictionaries: - 1. matched_files_dict: Dictionary with filenames from - bucket_1 as keys and corresponding similar filenames + 1. matched_files_dict: Dictionary with filenames from + bucket_1 as keys and corresponding similar filenames from bucket_2 as values. - 2. non_matched_files_dict: Dictionary with filenames from - bucket_1 as keys and a message indicating no similar file + 2. non_matched_files_dict: Dictionary with filenames from + bucket_1 as keys and a message indicating no similar file was found in bucket_2 as values. """