OCR Evaluation Framework

目录:

  • 安装指南
    • 系统要求
    • 从 PyPI 安装
    • 从源码安装
    • 安装可选依赖
    • 验证安装
    • 故障排除
  • 快速开始
    • 基本使用
    • 命令行界面
    • 配置说明
    • 示例配置
    • 数据格式
    • 输出结果
    • 下一步
  • API 文档
    • 核心模块
      • Config
        • Config.DEFAULT_CONFIG
        • Config.__init__()
        • Config.load_config()
        • Config.get()
        • Config.set()
        • Config.save_config()
        • Config.config
        • Config.get_model_config()
        • Config.get_paddleocr_config()
        • Config.get_qwen_config()
        • Config.get_logging_config()
        • Config.get_output_config()
      • get_config()
      • set_config()
      • load_config_from_file()
      • ModelTypes
        • ModelTypes.PADDLEOCR
        • ModelTypes.QWEN_VL
        • ModelTypes.all_types()
      • BaseEvaluator
        • BaseEvaluator.__init__()
        • BaseEvaluator.get_model_name()
        • BaseEvaluator.get_model_type()
        • BaseEvaluator.initialize()
        • BaseEvaluator.recognize_image()
        • BaseEvaluator.cleanup()
        • BaseEvaluator.validate_image()
        • BaseEvaluator.parse_label_file()
        • BaseEvaluator.calculate_accuracy()
        • BaseEvaluator.evaluate_directory()
        • BaseEvaluator.evaluate_dataset()
      • EvaluationResult
        • EvaluationResult.image_path
        • EvaluationResult.ground_truth
        • EvaluationResult.predicted
        • EvaluationResult.accuracy
        • EvaluationResult.exact_match
        • EvaluationResult.metadata
        • EvaluationResult.__init__()
      • DirectoryResult
        • DirectoryResult.directory
        • DirectoryResult.total_images
        • DirectoryResult.average_accuracy
        • DirectoryResult.exact_match_count
        • DirectoryResult.exact_match_rate
        • DirectoryResult.results
        • DirectoryResult.metadata
        • DirectoryResult.__init__()
      • TestSummary
        • TestSummary.model_name
        • TestSummary.test_timestamp
        • TestSummary.total_images
        • TestSummary.overall_accuracy
        • TestSummary.overall_exact_match_rate
        • TestSummary.directory_results
        • TestSummary.technical_details
        • TestSummary.metadata
        • TestSummary.__init__()
      • PaddleOCREvaluator
        • PaddleOCREvaluator.__init__()
        • PaddleOCREvaluator.get_model_name()
        • PaddleOCREvaluator.get_model_type()
        • PaddleOCREvaluator.initialize()
        • PaddleOCREvaluator.recognize_image()
        • PaddleOCREvaluator.cleanup()
        • PaddleOCREvaluator.get_model_info()
        • PaddleOCREvaluator.create_with_optimal_config()
        • PaddleOCREvaluator.create_from_config_dict()
      • QwenVLEvaluator
        • QwenVLEvaluator.__init__()
        • QwenVLEvaluator.get_model_name()
        • QwenVLEvaluator.get_model_type()
        • QwenVLEvaluator.initialize()
        • QwenVLEvaluator.recognize_image()
        • QwenVLEvaluator.cleanup()
        • QwenVLEvaluator.get_model_info()
        • QwenVLEvaluator.test_connection()
        • QwenVLEvaluator.create_with_default_config()
        • QwenVLEvaluator.create_from_config_dict()
      • create_evaluator()
      • get_supported_models()
      • ReportGenerator
        • ReportGenerator.__init__()
        • ReportGenerator.generate_markdown_report()
        • ReportGenerator.save_markdown_report()
        • ReportGenerator.save_json_results()
      • get_logger()
      • setup_logging()
      • evaluate_model()
      • generate_report()
    • 配置模块
      • Config
        • Config.DEFAULT_CONFIG
        • Config.__init__()
        • Config.load_config()
        • Config.get()
        • Config.set()
        • Config.save_config()
        • Config.config
        • Config.get_model_config()
        • Config.get_paddleocr_config()
        • Config.get_qwen_config()
        • Config.get_logging_config()
        • Config.get_output_config()
      • get_config()
      • set_config()
      • load_config_from_file()
      • ModelTypes
        • ModelTypes.PADDLEOCR
        • ModelTypes.QWEN_VL
        • ModelTypes.all_types()
      • PaddleOCRConstants
        • PaddleOCRConstants.DEFAULT_LANG
        • PaddleOCRConstants.SUPPORTED_LANGS
        • PaddleOCRConstants.OPTIMIZED_CONFIG
      • QwenConstants
        • QwenConstants.DEFAULT_MODEL_NAME
        • QwenConstants.DEFAULT_LMSTUDIO_URL
        • QwenConstants.DEFAULT_TEMPERATURE
        • QwenConstants.DEFAULT_MAX_TOKENS
        • QwenConstants.DEFAULT_PROMPT
      • EvaluationConstants
        • EvaluationConstants.DEFAULT_ACCURACY_THRESHOLD
        • EvaluationConstants.ACCURACY_RANGES
      • TextProcessingConstants
        • TextProcessingConstants.ALPHANUMERIC_PATTERN
        • TextProcessingConstants.EXPLANATION_PREFIXES
        • TextProcessingConstants.QUOTE_CHARS
      • LoggingConstants
        • LoggingConstants.DEFAULT_FORMAT
        • LoggingConstants.DEFAULT_LEVEL
        • LoggingConstants.SUPPORTED_LEVELS
      • ReportConstants
        • ReportConstants.MARKDOWN_EXTENSION
        • ReportConstants.JSON_EXTENSION
        • ReportConstants.HTML_EXTENSION
        • ReportConstants.DEFAULT_REPORT_NAME_TEMPLATE
        • ReportConstants.DEFAULT_RESULTS_NAME_TEMPLATE
        • ReportConstants.REPORT_TIMESTAMP_FORMAT
        • ReportConstants.DISPLAY_TIMESTAMP_FORMAT
      • ErrorCodes
        • ErrorCodes.SUCCESS
        • ErrorCodes.CONFIG_ERROR
        • ErrorCodes.MODEL_INIT_ERROR
        • ErrorCodes.DATA_ERROR
        • ErrorCodes.EVALUATION_ERROR
        • ErrorCodes.REPORT_ERROR
        • ErrorCodes.UNKNOWN_ERROR
      • PerformanceConstants
        • PerformanceConstants.DEFAULT_BATCH_SIZE
        • PerformanceConstants.MAX_IMAGE_SIZE
        • PerformanceConstants.TIMEOUT_SECONDS
      • EnvVars
        • EnvVars.CONFIG_FILE
        • EnvVars.LOG_LEVEL
        • EnvVars.OUTPUT_DIR
        • EnvVars.LMSTUDIO_URL
        • EnvVars.USE_GPU
    • 设置模块
      • Config
        • Config.DEFAULT_CONFIG
        • Config.__init__()
        • Config.load_config()
        • Config.get()
        • Config.set()
        • Config.save_config()
        • Config.config
        • Config.get_model_config()
        • Config.get_paddleocr_config()
        • Config.get_qwen_config()
        • Config.get_logging_config()
        • Config.get_output_config()
      • get_config()
      • set_config()
      • load_config_from_file()
    • 常量模块
      • ModelTypes
        • ModelTypes.PADDLEOCR
        • ModelTypes.QWEN_VL
        • ModelTypes.all_types()
      • PaddleOCRConstants
        • PaddleOCRConstants.DEFAULT_LANG
        • PaddleOCRConstants.SUPPORTED_LANGS
        • PaddleOCRConstants.OPTIMIZED_CONFIG
      • QwenConstants
        • QwenConstants.DEFAULT_MODEL_NAME
        • QwenConstants.DEFAULT_LMSTUDIO_URL
        • QwenConstants.DEFAULT_TEMPERATURE
        • QwenConstants.DEFAULT_MAX_TOKENS
        • QwenConstants.DEFAULT_PROMPT
      • EvaluationConstants
        • EvaluationConstants.DEFAULT_ACCURACY_THRESHOLD
        • EvaluationConstants.ACCURACY_RANGES
      • TextProcessingConstants
        • TextProcessingConstants.ALPHANUMERIC_PATTERN
        • TextProcessingConstants.EXPLANATION_PREFIXES
        • TextProcessingConstants.QUOTE_CHARS
      • LoggingConstants
        • LoggingConstants.DEFAULT_FORMAT
        • LoggingConstants.DEFAULT_LEVEL
        • LoggingConstants.SUPPORTED_LEVELS
      • ReportConstants
        • ReportConstants.MARKDOWN_EXTENSION
        • ReportConstants.JSON_EXTENSION
        • ReportConstants.HTML_EXTENSION
        • ReportConstants.DEFAULT_REPORT_NAME_TEMPLATE
        • ReportConstants.DEFAULT_RESULTS_NAME_TEMPLATE
        • ReportConstants.REPORT_TIMESTAMP_FORMAT
        • ReportConstants.DISPLAY_TIMESTAMP_FORMAT
      • ErrorCodes
        • ErrorCodes.SUCCESS
        • ErrorCodes.CONFIG_ERROR
        • ErrorCodes.MODEL_INIT_ERROR
        • ErrorCodes.DATA_ERROR
        • ErrorCodes.EVALUATION_ERROR
        • ErrorCodes.REPORT_ERROR
        • ErrorCodes.UNKNOWN_ERROR
      • PerformanceConstants
        • PerformanceConstants.DEFAULT_BATCH_SIZE
        • PerformanceConstants.MAX_IMAGE_SIZE
        • PerformanceConstants.TIMEOUT_SECONDS
      • EnvVars
        • EnvVars.CONFIG_FILE
        • EnvVars.LOG_LEVEL
        • EnvVars.OUTPUT_DIR
        • EnvVars.LMSTUDIO_URL
        • EnvVars.USE_GPU
    • 模型模块
    • 基础评估器
      • EvaluationResult
        • EvaluationResult.image_path
        • EvaluationResult.ground_truth
        • EvaluationResult.predicted
        • EvaluationResult.accuracy
        • EvaluationResult.exact_match
        • EvaluationResult.metadata
        • EvaluationResult.__init__()
      • DirectoryResult
        • DirectoryResult.directory
        • DirectoryResult.total_images
        • DirectoryResult.average_accuracy
        • DirectoryResult.exact_match_count
        • DirectoryResult.exact_match_rate
        • DirectoryResult.results
        • DirectoryResult.metadata
        • DirectoryResult.__init__()
      • TestSummary
        • TestSummary.model_name
        • TestSummary.test_timestamp
        • TestSummary.total_images
        • TestSummary.overall_accuracy
        • TestSummary.overall_exact_match_rate
        • TestSummary.directory_results
        • TestSummary.technical_details
        • TestSummary.metadata
        • TestSummary.__init__()
      • BaseEvaluator
        • BaseEvaluator.__init__()
        • BaseEvaluator.get_model_name()
        • BaseEvaluator.get_model_type()
        • BaseEvaluator.initialize()
        • BaseEvaluator.recognize_image()
        • BaseEvaluator.cleanup()
        • BaseEvaluator.validate_image()
        • BaseEvaluator.parse_label_file()
        • BaseEvaluator.calculate_accuracy()
        • BaseEvaluator.evaluate_directory()
        • BaseEvaluator.evaluate_dataset()
    • PaddleOCR 评估器
      • PaddleOCREvaluator
        • PaddleOCREvaluator.__init__()
        • PaddleOCREvaluator.get_model_name()
        • PaddleOCREvaluator.get_model_type()
        • PaddleOCREvaluator.initialize()
        • PaddleOCREvaluator.recognize_image()
        • PaddleOCREvaluator.cleanup()
        • PaddleOCREvaluator.get_model_info()
        • PaddleOCREvaluator.create_with_optimal_config()
        • PaddleOCREvaluator.create_from_config_dict()
    • Qwen 评估器
      • QwenVLEvaluator
        • QwenVLEvaluator.__init__()
        • QwenVLEvaluator.get_model_name()
        • QwenVLEvaluator.get_model_type()
        • QwenVLEvaluator.initialize()
        • QwenVLEvaluator.recognize_image()
        • QwenVLEvaluator.cleanup()
        • QwenVLEvaluator.get_model_info()
        • QwenVLEvaluator.test_connection()
        • QwenVLEvaluator.create_with_default_config()
        • QwenVLEvaluator.create_from_config_dict()
    • 工具模块
    • 日志工具
      • ColoredFormatter
        • ColoredFormatter.COLORS
        • ColoredFormatter.RESET
        • ColoredFormatter.format()
      • OCRLogger
        • OCRLogger.__init__()
        • OCRLogger.configure()
        • OCRLogger.get_logger()
        • OCRLogger.setup_from_config()
      • LogContextManager
        • LogContextManager.__init__()
      • ProgressLogger
        • ProgressLogger.__init__()
        • ProgressLogger.update()
        • ProgressLogger.finish()
      • get_logger()
      • setup_logging()
      • with_log_level()
      • create_progress_logger()
    • 报告生成器
      • ReportGenerator
        • ReportGenerator.__init__()
        • ReportGenerator.generate_markdown_report()
        • ReportGenerator.save_markdown_report()
        • ReportGenerator.save_json_results()
    • 命令行接口
    • 主程序
      • create_cli_parser()
      • show_welcome()
      • show_help_hint()
      • validate_project_structure()
      • setup_project_environment()
      • main()
      • cli_entry()
    • 命令模块
      • BaseCommand
        • BaseCommand.__init__()
        • BaseCommand.setup_logging()
        • BaseCommand.add_common_arguments()
        • BaseCommand.load_config()
      • EvaluateCommand
        • EvaluateCommand.add_arguments()
        • EvaluateCommand.run()
      • CompareCommand
        • CompareCommand.add_arguments()
        • CompareCommand.run()
      • ConfigCommand
        • ConfigCommand.add_arguments()
        • ConfigCommand.run()
    • 使用示例
    • 基本使用
    • 自定义评估器
    • 配置管理
    • 日志配置
    • 报告生成
  • 迁移指南
    • 版本 1.0.0
  • 变更日志
    • 版本 1.0.0 (2024-01-XX)
    • 版本规划
    • 贡献指南
    • 支持
OCR Evaluation Framework
  • 搜索

© 版权所有 2024, Ray。

利用 Sphinx 构建，使用的 主题 由 Read the Docs 开发.