# paddleocr - Doramagic AI Context Pack > 定位：安装前体验与判断资产。它帮助宿主 AI 有一个好的开始，但不代表已经安装、执行或验证目标项目。 ## 充分原则 - **充分原则，不是压缩原则**：AI Context Pack 应该充分到让宿主 AI 在开工前理解项目价值、能力边界、使用入口、风险和证据来源；它可以分层组织，但不以最短摘要为目标。 - **压缩策略**：只压缩噪声和重复内容，不压缩会影响判断和开工质量的上下文。 ## 给宿主 AI 的使用方式 你正在读取 Doramagic 为 paddleocr 编译的 AI Context Pack。请把它当作开工前上下文：帮助用户理解适合谁、能做什么、如何开始、哪些必须安装后验证、风险在哪里。不要声称你已经安装、运行或执行了目标项目。 ## Claim 消费规则 - **事实来源**：Repo Evidence + Claim/Evidence Graph；Human Wiki 只提供显著性、术语和叙事结构。 - **事实最低状态**：`supported` - `supported`：可以作为项目事实使用，但回答中必须引用 claim_id 和证据路径。 - `weak`：只能作为低置信度线索，必须要求用户继续核实。 - `inferred`：只能用于风险提示或待确认问题，不能包装成项目事实。 - `unverified`：不得作为事实使用，应明确说证据不足。 - `contradicted`：必须展示冲突来源，不得替用户强行选择一个版本。 ## 它最适合谁 - **希望把专业流程带进宿主 AI 的用户**：仓库包含 Skill 文档。 证据：`skills/paddleocr-doc-parsing/SKILL.md`, `skills/paddleocr-text-recognition/SKILL.md` Claim：`clm_0003` supported 0.86 ## 它能做什么 - **AI Skill / Agent 指令资产库**（可做安装前预览）：项目包含可被宿主 AI 读取的 Skill 或 Agent 指令文件，可用于把专业流程带入 Claude、Codex、Cursor 等宿主。 证据：`skills/paddleocr-doc-parsing/SKILL.md`, `skills/paddleocr-text-recognition/SKILL.md` Claim：`clm_0001` supported 0.86 - **命令行启动或安装流程**（需要安装后验证）：项目文档中存在可执行命令，真实使用需要在本地或宿主环境中运行这些命令。 证据：`test_tipc/docs/install.md` Claim：`clm_0002` supported 0.86 ## 怎么开始 - `git clone https://github.com/LDOUBLEV/AutoLog` 证据：`test_tipc/docs/install.md` Claim：`clm_0004` supported 0.86 - `git clone https://github.com/PaddlePaddle/PaddleOCR` 证据：`test_tipc/docs/install.md` Claim：`clm_0005` supported 0.86 ## 继续前判断卡 - **当前建议**：仅建议沙盒试装 - **为什么**：项目存在安装命令、宿主配置或本地写入线索，不建议直接进入主力环境，应先在隔离环境试装。 ### 30 秒判断 - **现在怎么做**：仅建议沙盒试装 - **最小安全下一步**：先跑 Prompt Preview；若仍要安装，只在隔离环境试装 - **先别相信**：真实输出质量不能在安装前相信。 - **继续会触碰**：命令执行、宿主 AI 配置、本地环境或项目文件 ### 现在可以相信 - **适合人群线索：希望把专业流程带进宿主 AI 的用户**（supported）：有 supported claim 或项目证据支撑，但仍不等于真实安装效果。 证据：`skills/paddleocr-doc-parsing/SKILL.md`, `skills/paddleocr-text-recognition/SKILL.md` Claim：`clm_0003` supported 0.86 - **能力存在：AI Skill / Agent 指令资产库**（supported）：可以相信项目包含这类能力线索；是否适合你的具体任务仍要试用或安装后验证。 证据：`skills/paddleocr-doc-parsing/SKILL.md`, `skills/paddleocr-text-recognition/SKILL.md` Claim：`clm_0001` supported 0.86 - **能力存在：命令行启动或安装流程**（supported）：可以相信项目包含这类能力线索；是否适合你的具体任务仍要试用或安装后验证。 证据：`test_tipc/docs/install.md` Claim：`clm_0002` supported 0.86 - **存在 Quick Start / 安装命令线索**（supported）：可以相信项目文档出现过启动或安装入口；不要因此直接在主力环境运行。 证据：`test_tipc/docs/install.md` Claim：`clm_0004` supported 0.86 ### 现在还不能相信 - **真实输出质量不能在安装前相信。**（unverified）：Prompt Preview 只能展示引导方式，不能证明真实项目中的结果质量。 - **宿主 AI 版本兼容性不能在安装前相信。**（unverified）：Claude、Cursor、Codex、Gemini 等宿主加载规则和版本差异必须在真实环境验证。 - **不会污染现有宿主 AI 行为，不能直接相信。**（inferred）：Skill、plugin、AGENTS/CLAUDE/GEMINI 指令可能改变宿主 AI 的默认行为。 证据：`skills/paddleocr-doc-parsing/SKILL.md`, `skills/paddleocr-text-recognition/SKILL.md` - **可安全回滚不能默认相信。**（unverified）：除非项目明确提供卸载和恢复说明，否则必须先在隔离环境验证。 - **真实安装后是否与用户当前宿主 AI 版本兼容？**（unverified）：兼容性只能通过实际宿主环境验证。 - **项目输出质量是否满足用户具体任务？**（unverified）：安装前预览只能展示流程和边界，不能替代真实评测。 - **安装命令是否需要网络、权限或全局写入？**（unverified）：这影响企业环境和个人环境的安装风险。 证据：`test_tipc/docs/install.md` ### 继续会触碰什么 - **命令执行**：包管理器、网络下载、本地插件目录、项目配置或用户主目录。 原因：运行第一条命令就可能产生环境改动；必须先判断是否值得跑。 证据：`test_tipc/docs/install.md` - **宿主 AI 配置**：Claude/Codex/Cursor/Gemini/OpenCode 等宿主的 plugin、Skill 或规则加载配置。 原因：宿主配置会改变 AI 后续工作方式，可能和用户已有规则冲突。 证据：`skills/paddleocr-doc-parsing/SKILL.md`, `skills/paddleocr-text-recognition/SKILL.md` - **本地环境或项目文件**：安装结果、插件缓存、项目配置或本地依赖目录。 原因：安装前无法证明写入范围和回滚方式，需要隔离验证。 证据：`test_tipc/docs/install.md` - **宿主 AI 上下文**：AI Context Pack、Prompt Preview、Skill 路由、风险规则和项目事实。 原因：导入上下文会影响宿主 AI 后续判断，必须避免把未验证项包装成事实。 ### 最小安全下一步 - **先跑 Prompt Preview**：用安装前交互式试用判断工作方式是否匹配，不需要授权或改环境。（适用：任何项目都适用，尤其是输出质量未知时。） - **只在隔离目录或测试账号试装**：避免安装命令污染主力宿主 AI、真实项目或用户主目录。（适用：存在命令执行、插件配置或本地写入线索时。） - **先备份宿主 AI 配置**：Skill、plugin、规则文件可能改变 Claude/Cursor/Codex 的默认行为。（适用：存在插件 manifest、Skill 或宿主规则入口时。） - **安装后只验证一个最小任务**：先验证加载、兼容、输出质量和回滚，再决定是否深用。（适用：准备从试用进入真实工作流时。） ### 退出方式 - **保留安装前状态**：记录原始宿主配置和项目状态，后续才能判断是否可恢复。 - **准备移除宿主 plugin / Skill / 规则入口**：如果试装后行为异常，可以把宿主 AI 恢复到试装前状态。 - **记录安装命令和写入路径**：没有明确卸载说明时，至少要知道哪些目录或配置需要手动清理。 - **如果没有回滚路径，不进入主力环境**：不可回滚是继续前阻断项，不应靠信任或运气继续。 ## 哪些只能预览 - 解释项目适合谁和能做什么 - 基于项目文档演示典型对话流程 - 帮助用户判断是否值得安装或继续研究 ## 哪些必须安装后验证 - 真实安装 Skill、插件或 CLI - 执行脚本、修改本地文件或访问外部服务 - 验证真实输出质量、性能和兼容性 ## 边界与风险判断卡 - **把安装前预览误认为真实运行**：用户可能高估项目已经完成的配置、权限和兼容性验证。 处理方式：明确区分 prompt_preview_can_do 与 runtime_required。 Claim：`clm_0006` inferred 0.45 - **命令执行会修改本地环境**：安装命令可能写入用户主目录、宿主插件目录或项目配置。 处理方式：先在隔离环境或测试账号中运行。 证据：`test_tipc/docs/install.md` Claim：`clm_0007` supported 0.86 - **待确认**：真实安装后是否与用户当前宿主 AI 版本兼容？。原因：兼容性只能通过实际宿主环境验证。 - **待确认**：项目输出质量是否满足用户具体任务？。原因：安装前预览只能展示流程和边界，不能替代真实评测。 - **待确认**：安装命令是否需要网络、权限或全局写入？。原因：这影响企业环境和个人环境的安装风险。 ## 开工前工作上下文 ### 加载顺序 - 先读取 how_to_use.host_ai_instruction，建立安装前判断资产的边界。 - 读取 claim_graph_summary，确认事实来自 Claim/Evidence Graph，而不是 Human Wiki 叙事。 - 再读取 intended_users、capabilities 和 quick_start_candidates，判断用户是否匹配。 - 需要执行具体任务时，优先查 role_skill_index，再查 evidence_index。 - 遇到真实安装、文件修改、网络访问、性能或兼容性问题时，转入 risk_card 和 boundaries.runtime_required。 ### 任务路由 - **AI Skill / Agent 指令资产库**：先基于 role_skill_index / evidence_index 帮用户挑选可用角色、Skill 或工作流。 边界：可做安装前 Prompt 体验。 证据：`skills/paddleocr-doc-parsing/SKILL.md`, `skills/paddleocr-text-recognition/SKILL.md` Claim：`clm_0001` supported 0.86 - **命令行启动或安装流程**：先说明这是安装后验证能力，再给出安装前检查清单。 边界：必须真实安装或运行后验证。 证据：`test_tipc/docs/install.md` Claim：`clm_0002` supported 0.86 ### 上下文规模 - 文件总数：2059 - 重要文件覆盖：40/2059 - 证据索引条目：80 - 角色 / Skill 条目：2 ### 证据不足时的处理 - **missing_evidence**：说明证据不足，要求用户提供目标文件、README 段落或安装后验证记录；不要补全事实。 - **out_of_scope_request**：说明该任务超出当前 AI Context Pack 证据范围，并建议用户先查看 Human Manual 或真实安装后验证。 - **runtime_request**：给出安装前检查清单和命令来源，但不要替用户执行命令或声称已执行。 - **source_conflict**：同时展示冲突来源，标记为待核实，不要强行选择一个版本。 ## Prompt Recipes ### 适配判断 - 目标：判断这个项目是否适合用户当前任务。 - 预期输出：适配结论、关键理由、证据引用、安装前可预览内容、必须安装后验证内容、下一步建议。 ```text 请基于 paddleocr 的 AI Context Pack，先问我 3 个必要问题，然后判断它是否适合我的任务。回答必须包含：适合谁、能做什么、不能做什么、是否值得安装、证据来自哪里。所有项目事实必须引用 evidence_refs、source_paths 或 claim_id。 ``` ### 安装前体验 - 目标：让用户在安装前感受核心工作流，同时避免把预览包装成真实能力或营销承诺。 - 预期输出：一段带边界标签的体验剧本、安装后验证清单和谨慎建议；不含真实运行承诺或强营销表述。 ```text 请把 paddleocr 当作安装前体验资产，而不是已安装工具或真实运行环境。 请严格输出四段： 1. 先问我 3 个必要问题。 2. 给出一段“体验剧本”：用 [安装前可预览]、[必须安装后验证]、[证据不足] 三种标签展示它可能如何引导工作流。 3. 给出安装后验证清单：列出哪些能力只有真实安装、真实宿主加载、真实项目运行后才能确认。 4. 给出谨慎建议：只能说“值得继续研究/试装”“先补充信息后再判断”或“不建议继续”，不得替项目背书。 硬性边界： - 不要声称已经安装、运行、执行测试、修改文件或产生真实结果。 - 不要写“自动适配”“确保通过”“完美适配”“强烈建议安装”等承诺性表达。 - 如果描述安装后的工作方式，必须使用“如果安装成功且宿主正确加载 Skill，它可能会……”这种条件句。 - 体验剧本只能写成“示例台词/假设流程”：使用“可能会询问/可能会建议/可能会展示”，不要写“已写入、已生成、已通过、正在运行、正在生成”。 - Prompt Preview 不负责给安装命令；如用户准备试装，只能提示先阅读 Quick Start 和 Risk Card，并在隔离环境验证。 - 所有项目事实必须来自 supported claim、evidence_refs 或 source_paths；inferred/unverified 只能作风险或待确认项。 ``` ### 角色 / Skill 选择 - 目标：从项目里的角色或 Skill 中挑选最匹配的资产。 - 预期输出：候选角色或 Skill 列表，每项包含适用场景、证据路径、风险边界和是否需要安装后验证。 ```text 请读取 role_skill_index，根据我的目标任务推荐 3-5 个最相关的角色或 Skill。每个推荐都要说明适用场景、可能输出、风险边界和 evidence_refs。 ``` ### 风险预检 - 目标：安装或引入前识别环境、权限、规则冲突和质量风险。 - 预期输出：环境、权限、依赖、许可、宿主冲突、质量风险和未知项的检查清单。 ```text 请基于 risk_card、boundaries 和 quick_start_candidates，给我一份安装前风险预检清单。不要替我执行命令，只说明我应该检查什么、为什么检查、失败会有什么影响。 ``` ### 宿主 AI 开工指令 - 目标：把项目上下文转成一次对话开始前的宿主 AI 指令。 - 预期输出：一段边界明确、证据引用明确、适合复制给宿主 AI 的开工前指令。 ```text 请基于 paddleocr 的 AI Context Pack，生成一段我可以粘贴给宿主 AI 的开工前指令。这段指令必须遵守 not_runtime=true，不能声称项目已经安装、运行或产生真实结果。 ``` ## 角色 / Skill 索引 - 共索引 2 个角色 / Skill / 项目文档条目。 - **paddleocr-doc-parsing**（skill）：- 激活提示：当用户任务与“paddleocr-doc-parsing”描述的流程高度相关时，先用它做安装前体验，再决定是否安装。 证据：`skills/paddleocr-doc-parsing/SKILL.md` - **paddleocr-text-recognition**（skill）：- 激活提示：当用户任务与“paddleocr-text-recognition”描述的流程高度相关时，先用它做安装前体验，再决定是否安装。 证据：`skills/paddleocr-text-recognition/SKILL.md` ## 证据索引 - 共索引 80 条证据。 - **关于 2.x 分支的功能**（documentation）：由于 3.x 分支的升级，wheel 包经历了重构，导致部分模型和功能与旧版分支不再兼容。为了使得依赖于 2.x 分支功能的用户能够继续使用这些功能，我们在此目录中保留了与 2.x 分支相关的代码。 证据：`docs/version2.x/README.md` - **🚀 Key Features**（documentation）：Global Leading OCR Toolkit & Document AI Engine 证据：`README.md` - **PaddleOCR official API SDKs**（documentation）：This directory contains source-adjacent maintainer files for the PaddleOCR official API SDKs. The SDKs call hosted PaddleOCR official API services; they do not run local PaddleOCR inference or load local models. 证据：`api_sdk/README.md` - **Readme**（documentation）：移步 docs https://www.paddleocr.ai/v2.10.0/applications/overview.html 证据：`applications/README.md` - **PaddleOCR DB/EAST/PSE 算法训练benchmark测试**（documentation）：PaddleOCR DB/EAST/PSE 算法训练benchmark测试 证据：`benchmark/readme.md` - **PP-OCR Deployment**（documentation）：- PP-OCR Deployment pp-ocr-deployment - Paddle Deployment Introduction paddle-deployment-introduction - PP-OCR Deployment pp-ocr-deployment-1 证据：`deploy/README.md` - **langchain-paddleocr**（documentation）：! PyPI - Version https://img.shields.io/pypi/v/langchain-paddleocr?label=%20 https://pypi.org/project/langchain-paddleocr/ history ! PyPI - License https://img.shields.io/pypi/l/langchain-paddleocr https://opensource.org/license/apache-2-0 ! PyPI - Downloads https://img.shields.io/pepy/dt/langchain-paddleocr https://pypistats.org/packages/langchain-paddleocr 证据：`langchain-paddleocr/README.md` - **PaddleOCR MCP 服务器**（documentation）：请查看 文档 ../docs/version3.x/integrations/mcp server.md 。 证据：`mcp_server/README.md` - **PaddleOCR.js**（documentation）：Official browser OCR SDK and demo for PaddleOCR. 证据：`paddleocr-js/README.md` - **PP-Structure Upgrade Considerations**（documentation）：PP-Structure Upgrade Considerations 证据：`ppstructure/README.md` - **PaddleOCR Agent Skills**（documentation）：This directory contains the official PaddleOCR Agent Skills. 证据：`skills/README.md` - **飞桨训推一体全流程（TIPC）**（documentation）：飞桨除了基本的模型训练和预测，还提供了支持多端多平台的高性能推理部署工具。本文档提供了PaddleOCR中所有模型的飞桨训推一体全流程（Training and Inference Pipeline Criterion TIPC ）信息和测试工具，方便用户查阅每种模型的训练推理部署打通情况，并可以进行一键测试。 证据：`test_tipc/readme.md` - **PaddleOCR Go SDK**（documentation）：Go client for the PaddleOCR official API. It submits OCR and document parsing jobs to hosted PaddleOCR services; it does not run local PaddleOCR inference or load local models. 证据：`api_sdk/go/README.md` - **PaddleOCR TypeScript SDK**（documentation）：TypeScript client for the PaddleOCR official API. It submits OCR and document parsing jobs to hosted PaddleOCR services; it does not perform local OCR inference. 证据：`api_sdk/typescript/README.md` - **Real-time Scene Text Detection with Differentiable Binarization**（documentation）：Real-time Scene Text Detection with Differentiable Binarization 证据：`benchmark/PaddleOCR_DBNet/README.MD` - **Android Demo**（documentation）：- Android Demo android-demo - 1. 简介 1-简介 - 2. 近期更新 2-近期更新 - 3. 快速使用 3-快速使用 - 3.1 环境准备 31-环境准备 - 3.2 导入项目 32-导入项目 - 3.3 运行demo 33-运行demo - 3.4 运行模式 34-运行模式 - 3.5 设置 35-设置 - 4 更多支持 4-更多支持 证据：`deploy/android_demo/README.md` - **Readme**（documentation）：Running PaddleOCR text recognition model on bare metal Arm R Cortex R -M55 CPU using Arm Virtual Hardware ====================================================================== 证据：`deploy/avh/README.md` - **Introduction**（documentation）：Introduction Many users hope package the PaddleOCR service into a docker image, so that it can be quickly released and used in the docker or K8s environment. 证据：`deploy/docker/hubserving/README.md` - **基于PaddleHub Serving的服务部署**（documentation）：- 基于PaddleHub Serving的服务部署 基于paddlehub-serving的服务部署 - 1. 近期更新 1-近期更新 - 2. 快速启动服务 2-快速启动服务 - 2.1 安装PaddleHub 21-安装PaddleHub - 2.2 下载推理模型 22-下载推理模型 - 2.3 安装服务模块 23-安装服务模块 - 2.4 启动服务 24-启动服务 - 2.4.1. 命令行命令启动（仅支持CPU） 241-命令行命令启动仅支持cpu - 2.4.2 配置文件启动（支持CPU、GPU） 242-配置文件启动支持cpugpu - 3. 发送预测请求 3-发送预测请求 - 4. 返回结果格式说明 4-返回结果格式说明 - 5. 自定义修改服务模块 5-自定义修改服务模块 证据：`deploy/hubserving/readme.md` - **PaddleOCR iOS Demo**（documentation）：请查看 文档 ../../docs/version3.x/inference deployment/cross platform/ios deployment.md 。 证据：`deploy/ios_demo/README.md` - **Mobile deployment based on Paddle-Lite**（documentation）：Mobile deployment based on Paddle-Lite 证据：`deploy/lite/readme.md` - **Paddle2ONNX model transformation and prediction**（documentation）：Paddle2ONNX model transformation and prediction 证据：`deploy/paddle2onnx/readme.md` - **云上飞桨部署工具**（documentation）：云上飞桨（PaddleCloud） https://github.com/PaddlePaddle/PaddleCloud 是面向飞桨框架及其模型套件的部署工具， 为用户提供了模型套件Docker化部署和Kubernetes集群部署两种方式，可以满足不同场景与环境的部署需求。 本章节我们将使用PaddleCloud提供的OCR标准镜像以及云原生组件来训练和部署PP-OCRv3识别模型。 证据：`deploy/paddlecloud/README.md` - **PaddleOCR-VL 高性能服务化部署**（documentation）：本目录提供一套支持并发请求处理的 PaddleOCR-VL 系列 高性能服务化部署方案，适用于 PaddleOCR-VL 、 PaddleOCR-VL-1.5 、 PaddleOCR-VL-1.6 等产线版本。 证据：`deploy/paddleocr_vl_docker/hps/README.md` - **PaddleOCR Android Demo**（documentation）：请查看 文档 ../../docs/version3.x/inference deployment/cross platform/android deployment.md 。 证据：`deploy/ppocr-android/README.md` - **OCR模型自动压缩示例**（documentation）：目录： - OCR模型自动压缩示例 ocr模型自动压缩示例 - 1. 简介 1-简介 - 2. Benchmark 2-benchmark - PPOCRV4\ det ppocrv4 det - PPOCRV4\ rec ppocrv4 rec - 3. 自动压缩流程 3-自动压缩流程 - 3.1 准备环境 31-准备环境 - 3.2 准备数据集 32-准备数据集 - 3.2.1 PPOCRV4\ det\ server数据集预处理 321-ppocrv4 det server数据集预处理 - 3.3 准备预测模型 33-准备预测模型 - 4.预测部署 4预测部署 - 4.1 Paddle Inference 验证性能 41-paddle-inference-验证性能 - 4.1.1 使用测试脚本进行批量测试： 411-使用测试脚本进行批量测试 - 4.1.2 基于压缩模型进行基于GPU的批量测试： 412-基于压缩模型进行基于gpu的批量测试 - 4.1.3 基于压缩前模型进行基于GPU的批量测试： 413-基于压缩前模型进行基于gpu的批量测试 - 4.1.4 基于压缩模型进行基于CPU的批量测试： 414-基于压缩模型进行基于cpu的批量测试 - 4.2 PaddleLite端侧部署 42-paddlelite端侧部署 - 5.FAQ 5faq - 5.1 报错找不到模型文件或者数据集文件 51-报错找不到模型文件或者数据集文件 - 5.2 软件环境一致，硬件不同导致精度差异很大？ 52-软件环境一致硬件不同导致精度差异很大 证据：`deploy/slim/auto_compression/README.md` - **PP-OCR模型裁剪**（documentation）：复杂的模型有利于提高模型的性能，但也导致模型中存在一定冗余，模型裁剪通过移出网络模型中的子模型来减少这种冗余，达到减少模型计算复杂度，提高模型推理性能的目的。 本教程将介绍如何使用飞桨模型压缩库PaddleSlim做PaddleOCR模型的压缩。 PaddleSlim https://github.com/PaddlePaddle/PaddleSlim 集成了模型剪枝、量化（包括量化训练和离线量化）、蒸馏和神经网络搜索等多种业界常用且领先的模型压缩功能，如果您感兴趣，可以关注并了解。 证据：`deploy/slim/prune/README.md` - **PP-OCR模型量化**（documentation）：PP-OCR模型量化 复杂的模型有利于提高模型的性能，但也导致模型中存在一定冗余，模型量化将全精度缩减到定点数减少这种冗余，达到减少模型计算复杂度，提高模型推理性能的目的。 模型量化可以在基本不损失模型的精度的情况下，将FP32精度的模型参数转换为Int8精度，减小模型参数大小并加速计算，使用量化后的模型在移动端等部署时更具备速度优势。 证据：`deploy/slim/quantization/README.md` - **PaddleOCR.js SDK**（documentation）：@paddleocr/paddleocr-js is the browser SDK package for running PaddleOCR pipelines in the frontend. 证据：`paddleocr-js/packages/core/README.md` - **编译**（documentation）：编译 This code is refer from: https://github.com/whai362/PSENet/blob/python3/models/post processing/pse 证据：`ppocr/postprocess/pse_postprocess/pse/README.md` - **Dictionary and Corpus**（documentation）：Dictionary files usually character level vocabulary are included here for easier configuration. Corpus contributed by OSS contributors are listed here, please respect copyrights when using them at your own risk. 证据：`ppocr/utils/dict/README.md` - **Key Information Extraction KIE**（documentation）：- 1. Introduction 1-introduction - 2. Performance 2-performance - 3. Visualization 3-visualization - 3.1 SER 31-ser - 3.2 RE 32-re - 4. Usage 4-usage - 4.1 Prepare for the environment 41-prepare-for-the-environment - 4.2 Quick start 42-quick-start - 4.3 More 43-more - 5. Reference 5-reference - 6. License 6-license 证据：`ppstructure/kie/README.md` - **Layout analysis**（documentation）：- 1. Introduction 1-Introduction - 2. Quick start 2-Quick-start - 3. Install 3-Install - 3.1 Install PaddlePaddle 31-Install-paddlepaddle - 3.2 Install PaddleDetection 32-Install-paddledetection - 4. Data preparation 4-Data-preparation - 4.1 English data set 41-English-data-set - 4.2 More datasets 42-More-datasets - 5. Start training 5-Start-training - 5.1 Train 51-Train - 5.2 FGD Distillation training 52-Fgd-distillation-training - 6. Model evaluation and prediction 6-Model-evaluation-and-prediction - 6.1 Indicator evaluation 61-Indicator-evaluation - 6.2 Test layout analysis results 62-Test-layout-analysis-results - 7. Model export and inference 7-Model-export-and-inference - 7.1 Model ex… 证据：`ppstructure/layout/README.md` - **PDF2WORD**（documentation）：PDF2Word是PaddleOCR社区开发者 whjdark https://github.com/whjdark 基于PP-StructureV2版面分析与恢复模型实现的PDF转换Word应用程序，提供可直接安装的exe应用程序， 方便Windows用户免环境配置运行 证据：`ppstructure/pdf2word/README.md` - **Layout Recovery**（documentation）：- 1. Introduction 1 - 2. Install 2 - 2.1 Install PaddlePaddle 2.1 - 2.2 Install PaddleOCR 2.2 - 3. Quick Start using standard PDF parse 3 - 4. Quick Start using image format PDF parse 4 - 4.1 Download models 4.1 - 4.2 Layout recovery 4.2 - 5. More 5 证据：`ppstructure/recovery/README.md` - **Table Recognition**（documentation）：- 1. pipeline 1-pipeline - 2. Performance 2-performance - 3. Result 3-result - 4. How to use 4-how-to-use - 4.1 Quick start 41-quick-start - 4.2 Training, Evaluation and Inference 42-training-evaluation-and-inference - 4.3 Calculate TEDS 43-calculate-teds - 5. Reference 5-reference 证据：`ppstructure/table/README.md` - **TIPC Linux端补充训练功能测试**（documentation）：Linux端基础训练预测功能测试的主程序为test train python.sh，可以测试基于Python的模型训练、评估等基本功能，包括裁剪、量化、蒸馏训练。 证据：`test_tipc/supplementary/readme.md` - **简介**（documentation）：tools/end2end 目录下存放了文本检测+文本识别pipeline串联预测的指标评测代码以及可视化工具。本节介绍文本检测+文本识别的端对端指标评估方式。 证据：`tools/end2end/readme.md` - **Package**（package_manifest）：{ "name": "paddleocr-js-workspace", "version": "0.1.0", "private": true, "type": "module", "repository": { "type": "git", "url": "https://github.com/PaddlePaddle/PaddleOCR.git", "directory": "paddleocr-js" }, "homepage": "https://github.com/PaddlePaddle/PaddleOCR/tree/main/paddleocr-js", "bugs": { "url": "https://github.com/PaddlePaddle/PaddleOCR/issues" }, "keywords": "paddleocr", "ocr", "monorepo", "browser-ocr", "typescript" , "engines": { "node": " =20.11" }, "workspaces": "packages/ ", "apps/ " , "scripts": { "dev:demo": "npm run dev --workspace apps/demo --", "build": "npm run build:sdk && npm run build:demo", "build:demo": "npm run build --workspace apps/demo", "build:sdk": "npm run… 证据：`paddleocr-js/package.json` - **Package**（package_manifest）：{ "name": "@paddleocr/api-sdk", "version": "0.2.3", "description": "TypeScript SDK for the PaddleOCR official API", "type": "module", "main": "./dist/index.cjs", "module": "./dist/index.js", "types": "./dist/index.d.ts", "exports": { ".": { "import": { "types": "./dist/index.d.ts", "default": "./dist/index.js" }, "require": { "types": "./dist/index.d.cts", "default": "./dist/index.cjs" } } }, "files": "dist", "README.md", "README cn.md" , "publishConfig": { "access": "public" }, "repository": { "type": "git", "url": "https://github.com/PaddlePaddle/PaddleOCR.git", "directory": "api sdk/typescript" }, "homepage": "https://github.com/PaddlePaddle/PaddleOCR/tree/main/api sdk/typescript", "bugs… 证据：`api_sdk/typescript/package.json` - **Package**（package_manifest）：{ "name": "demo", "private": true, "version": "0.1.0", "type": "module", "keywords": "paddleocr", "ocr-demo", "browser-ocr", "vite" , "engines": { "node": " =20.11" }, "scripts": { "dev": "vite", "build": "vite build", "preview": "vite preview", "typecheck": "tsc --noEmit" }, "dependencies": { "@paddleocr/paddleocr-js": " " }, "devDependencies": { "typescript": "^5.9.3", "vite": "^6.4.1" } } 证据：`paddleocr-js/apps/demo/package.json` - **Package**（package_manifest）：{ "name": "@paddleocr/paddleocr-js", "version": "0.4.2", "description": "Browser-based OCR SDK powered by PaddleOCR, ONNX Runtime Web and OpenCV.js", "license": "Apache-2.0", "author": "PaddlePaddle Authors", "type": "module", "repository": { "type": "git", "url": "https://github.com/PaddlePaddle/PaddleOCR.git", "directory": "paddleocr-js/packages/core" }, "homepage": "https://github.com/PaddlePaddle/PaddleOCR/tree/main/paddleocr-js", "bugs": { "url": "https://github.com/PaddlePaddle/PaddleOCR/issues" }, "publishConfig": { "access": "public" }, "exports": { ".": { "import": { "types": "./dist/index.d.ts", "default": "./dist/index.mjs" } }, "./viz": { "import": { "types": "./dist/viz/index.d… 证据：`paddleocr-js/packages/core/package.json` - **1. 环境准备**（documentation）：推荐环境： - CUDA 10.1/10.2 - CUDNN 7.6/cudnn8.1 - TensorRT 6.1.0.5 / 7.1 / 7.2 证据：`test_tipc/docs/install.md` - **Readme**（documentation）：Place the images that you want to detect here. You better named them as such: img 10.jpg img 11.jpg img {img id}.jpg 证据：`benchmark/PaddleOCR_DBNet/test/README.MD` - **PaddleOCR Document Parsing**（skill_instruction）：- Documents with tables invoices, financial reports, spreadsheets - Documents with mathematical formulas academic papers, scientific documents - Documents with charts and diagrams - Multi-column layouts newspapers, magazines, brochures - Complex document structures requiring layout analysis 证据：`skills/paddleocr-doc-parsing/SKILL.md` - **PaddleOCR Text Recognition**（skill_instruction）：- Extract text from images screenshots, photos, scans - Extract text from PDFs or document images when the goal is line/box-level text - Extract text from URLs or local files that point to images/PDFs 证据：`skills/paddleocr-text-recognition/SKILL.md` - **License**（source_file）：Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ 证据：`LICENSE` - **License**（source_file）：Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files the "Software" , to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: 证据：`deploy/cpp_infer/THIRD_PARTY_LICENSES/tensorRT_Pro/LICENSE` - **License**（source_file）：Boost Software License - Version 1.0 - August 17th, 2003 证据：`deploy/ios_demo/PaddleOCRDemo/ThirdParty/Clipper1/LICENSE` - **1. Installation and Environment Setup**（documentation）：🎉 Welcome to PaddleOCR FAQ! This document compiles common issues and solutions from GitHub Issues and Discussions, providing reference for OCR developers. 证据：`docs/FAQ.en.md` - **1. 通用问题**（documentation）：PaddleOCR收集整理了自从开源以来在issues和用户群中的常见问题并且给出了简要解答，旨在为OCR的开发者提供一些参考，也希望帮助大家少走一些弯路。 证据：`docs/FAQ.md` - **🔄 Quick Overview of Execution Results**（documentation）：Since its initial release, PaddleOCR has gained widespread acclaim across academia, industry, and research communities, thanks to its cutting-edge algorithms and proven performance in real-world applications. It’s already powering popular open-source projects like Umi-OCR, OmniParser, MinerU, and RAGFlow, making it the go-to OCR toolkit for developers worldwide. 证据：`docs/index.en.md` - **🔄 快速一览运行效果**（documentation）：PaddleOCR自发布以来凭借学术前沿算法和产业落地实践，受到了产学研各方的喜爱，并被广泛应用于众多知名开源项目，例如：Umi-OCR、OmniParser、MinerU、RAGFlow等，已成为广大开发者心中的开源OCR领域的首选工具。2025年5月20日，飞桨团队发布 PaddleOCR 3.0 ，全面适配 飞桨框架3.0 https://github.com/PaddlePaddle/Paddle 正式版，进一步 提升文字识别精度 ，支持 多文字类型识别 和 手写体识别 ，满足大模型应用对 复杂文档高精度解析 的旺盛需求，结合 文心大模型4.5 显著提升关键信息抽取精度，并新增 对昆仑芯、昇腾等国产硬件 的支持。 证据：`docs/index.md` - **Installation**（documentation）：PaddleOCR supports unified inference-engine configuration, allowing you to choose the underlying runtime. PaddleOCR currently supports PaddlePaddle and Transformers. 证据：`docs/quick_start.en.md` - **安装**（documentation）：PaddleOCR 支持通过统一的推理引擎配置选择底层运行时，目前可使用 PaddlePaddle 或 Transformers。 证据：`docs/quick_start.md` - **Community Contribution**（documentation）：Thank you for your long-term support and attention to PaddleOCR. Building a professional, harmonious, and mutually helpful open-source community with developers is the goal of PaddleOCR. This document showcases existing community contributions, explains various types of contributions, and describes new opportunities and processes, hoping to make the contribution process more efficient and the path clearer. 证据：`docs/community/community_contribution.en.md` - **社区贡献**（documentation）：感谢大家长久以来对PaddleOCR的支持和关注，与广大开发者共同构建一个专业、和谐、相互帮助的开源社区是PaddleOCR的目标。本文档展示了已有的社区贡献、对于各类贡献说明、新的机会与流程，希望贡献流程更加高效、路径更加清晰。 证据：`docs/community/community_contribution.md` - **Other Data Annotation Tools**（documentation）：There are the commonly used data annotation tools, which will be continuously updated. Welcome to contribute tools~ 证据：`docs/data_anno_synth/data_annotation.en.md` - **其它数据标注工具**（documentation）：- 工具描述：矩形标注 - 工具地址： - 示意图： ! ./images/labelimg.jpg 证据：`docs/data_anno_synth/data_annotation.md` - **Data Synthesis Tools**（documentation）：In addition to open source data, users can also use synthesis tools to synthesize data. There are the commonly used data synthesis tools, which will be continuously updated. Welcome to contribute tools~ 证据：`docs/data_anno_synth/data_synthesis.en.md` - 其余 20 条证据见 `AI_CONTEXT_PACK.json` 或 `EVIDENCE_INDEX.json`。 ## 宿主 AI 必须遵守的规则 - **把本资产当作开工前上下文，而不是运行环境。**：AI Context Pack 只包含证据化项目理解，不包含目标项目的可执行状态。 证据：`docs/version2.x/README.md`, `README.md`, `api_sdk/README.md` - **回答用户时区分可预览内容与必须安装后才能验证的内容。**：安装前体验的消费者价值来自降低误装和误判，而不是伪装成真实运行。 证据：`docs/version2.x/README.md`, `README.md`, `api_sdk/README.md` ## 用户开工前应该回答的问题 - 你准备在哪个宿主 AI 或本地环境中使用它？ - 你只是想先体验工作流，还是准备真实安装？ - 你最在意的是安装成本、输出质量、还是和现有规则的冲突？ ## 验收标准 - 所有能力声明都能回指到 evidence_refs 中的文件路径。 - AI_CONTEXT_PACK.md 没有把预览包装成真实运行。 - 用户能在 3 分钟内看懂适合谁、能做什么、如何开始和风险边界。 --- ## Doramagic Context Augmentation 下面内容用于强化 Repomix/AI Context Pack 主体。Human Manual 只提供阅读骨架；踩坑日志会被转成宿主 AI 必须遵守的工作约束。 ## Human Manual 骨架 使用规则：这里只是项目阅读路线和显著性信号，不是事实权威。具体事实仍必须回到 repo evidence / Claim Graph。 宿主 AI 硬性规则： - 不得把页标题、章节顺序、摘要或 importance 当作项目事实证据。 - 解释 Human Manual 骨架时，必须明确说它只是阅读路线/显著性信号。 - 能力、安装、兼容性、运行状态和风险判断必须引用 repo evidence、source path 或 Claim Graph。 - **项目概览与系统架构**：importance `high` - source_paths: README.md, paddleocr/__init__.py, paddleocr/_cli.py, paddleocr/_abstract.py, paddleocr/_api_client/_core.py - **核心模型与算法体系**：importance `high` - source_paths: ppocr/modeling/architectures/base_model.py, ppocr/modeling/backbones/rec_svtrv2.py, ppocr/modeling/heads/det_db_head.py, ppocr/modeling/heads/rec_ctc_head.py, ppocr/postprocess/db_postprocess.py - **部署与多平台集成**：importance `high` - source_paths: deploy/cpp_infer/src/pipelines/ocr/pipeline.cc, deploy/cpp_infer/src/api/pipelines/ocr.cc, deploy/hubserving/ocr_system/module.py, deploy/ios_demo/PaddleOCRDemo/Engine/OCREngine.swift, deploy/ppocr-android/ppocr-sdk/src/main/java/com/paddle/ocr/PaddleOCR.kt - **配置、自定义与社区生态**：importance `medium` - source_paths: configs/rec/PP-OCRv5/PP-OCRv5_server_rec.yml, tools/train.py, tools/infer/predict_system.py, deploy/slim/prune/export_prune_model.py, deploy/slim/quantization/quant.py ## Repo Inspection Evidence / 源码检查证据 - repo_clone_verified: true - repo_inspection_verified: true - repo_commit: `1af0448a200eae430b9addb40e7118d67f9840ab` - inspected_files: `README.md`, `pyproject.toml`, `requirements.txt`, `docs/FAQ.en.md`, `docs/FAQ.md`, `docs/community/code_and_doc.en.md`, `docs/community/code_and_doc.md`, `docs/community/community_contribution.en.md`, `docs/community/community_contribution.md`, `docs/data_anno_synth/data_annotation.en.md`, `docs/data_anno_synth/data_annotation.md`, `docs/data_anno_synth/data_synthesis.en.md`, `docs/data_anno_synth/data_synthesis.md`, `docs/data_anno_synth/x_anylabeling.en.md`, `docs/data_anno_synth/x_anylabeling.md`, `docs/datasets/datasets.en.md`, `docs/datasets/datasets.md`, `docs/datasets/handwritten_datasets.en.md`, `docs/datasets/handwritten_datasets.md`, `docs/datasets/kie_datasets.en.md` 宿主 AI 硬性规则： - 没有 repo_clone_verified=true 时，不得声称已经读过源码。 - 没有 repo_inspection_verified=true 时，不得把 README/docs/package 文件判断写成事实。 - 没有 quick_start_verified=true 时，不得声称 Quick Start 已跑通。 ## Doramagic Pitfall Constraints / 踩坑约束 这些规则来自 Doramagic 发现、验证或编译过程中的项目专属坑点。宿主 AI 必须把它们当作工作约束，而不是普通说明文字。 ### Constraint 1: 失败模式：installation: Link Checker Report - Trigger: Developers should check this installation risk before relying on the project: Link Checker Report - Host AI rule: Before packaging this project, run the relevant install/config/quickstart check for: Link Checker Report. Context: Observed when using python - Why it matters: Developers may fail before the first successful local run: Link Checker Report - Evidence: failure_mode_cluster:github_issue | https://github.com/PaddlePaddle/PaddleOCR/issues/18134 | Link Checker Report, failure_mode_cluster:github_issue | https://github.com/PaddlePaddle/PaddleOCR/issues/18131 | Link Checker Report, failure_mode_cluster:github_issue | https://github.com/PaddlePaddle/PaddleOCR/issues/18126 | Link Checker Report, failure_mode_cluster:github_issue | https://github.com/PaddlePaddle/PaddleOCR/issues/18122 | Link Checker Report, failure_mode_cluster:github_issue | https://github.com/PaddlePaddle/PaddleOCR/issues/18103 | Link Checker Report - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 ### Constraint 2: 失败模式：installation: 图片识别没有文字输出。 - Trigger: Developers should check this installation risk before relying on the project: 图片识别没有文字输出。 - Host AI rule: Before packaging this project, run the relevant install/config/quickstart check for: 图片识别没有文字输出。. Context: Observed when using python, linux, cuda - Why it matters: Developers may fail before the first successful local run: 图片识别没有文字输出。 - Evidence: failure_mode_cluster:github_issue | https://github.com/PaddlePaddle/PaddleOCR/issues/17974 | 图片识别没有文字输出。 - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 ### Constraint 3: 来源证据：Link Checker Report - Trigger: GitHub 社区证据显示该项目存在一个安装相关的待验证问题：Link Checker Report - Host AI rule: 来源显示可能已有修复、规避或版本变化，说明书中必须标注适用版本。 - Why it matters: 可能增加新用户试用和生产接入成本。 - Evidence: community_evidence:github | https://github.com/PaddlePaddle/PaddleOCR/issues/18157 | 来源类型 github_issue 暴露的待验证使用条件。 - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 ### Constraint 4: 来源证据：PaddleOCR-VL HPS: returnMarkdownImages=false is ineffective with default PaddleX 3.6 SDK - Trigger: GitHub 社区证据显示该项目存在一个安装相关的待验证问题：PaddleOCR-VL HPS: returnMarkdownImages=false is ineffective with default PaddleX 3.6 SDK - Why it matters: 可能增加新用户试用和生产接入成本。 - Evidence: community_evidence:github | https://github.com/PaddlePaddle/PaddleOCR/issues/18194 | 来源讨论提到 docker 相关条件，需在安装/试用前复核。 - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 ### Constraint 5: 来源证据：图片识别没有文字输出。 - Trigger: GitHub 社区证据显示该项目存在一个安装相关的待验证问题：图片识别没有文字输出。 - Host AI rule: 来源显示可能已有修复、规避或版本变化，说明书中必须标注适用版本。 - Why it matters: 可能增加新用户试用和生产接入成本。 - Evidence: community_evidence:github | https://github.com/PaddlePaddle/PaddleOCR/issues/17974 | 来源讨论提到 python 相关条件，需在安装/试用前复核。 - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 ### Constraint 6: 失败模式：configuration: Link Checker Report - Trigger: Developers should check this configuration risk before relying on the project: Link Checker Report - Host AI rule: Before packaging this project, run the relevant install/config/quickstart check for: Link Checker Report. Context: Source discussion did not expose a precise runtime context. - Why it matters: Developers may misconfigure credentials, environment, or host setup: Link Checker Report - Evidence: failure_mode_cluster:github_issue | https://github.com/PaddlePaddle/PaddleOCR/issues/18157 | Link Checker Report - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 ### Constraint 7: 失败模式：configuration: PaddleOCR-VL HPS: returnMarkdownImages=false is ineffective with default PaddleX 3.6 SDK - Trigger: Developers should check this configuration risk before relying on the project: PaddleOCR-VL HPS: returnMarkdownImages=false is ineffective with default PaddleX 3.6 SDK - Host AI rule: Before packaging this project, run the relevant install/config/quickstart check for: PaddleOCR-VL HPS: returnMarkdownImages=false is ineffective with default PaddleX 3.6 SDK. Context: Observed when using python, docker - Why it matters: Developers may misconfigure credentials, environment, or host setup: PaddleOCR-VL HPS: returnMarkdownImages=false is ineffective with default PaddleX 3.6 SDK - Evidence: failure_mode_cluster:github_issue | https://github.com/PaddlePaddle/PaddleOCR/issues/18194 | PaddleOCR-VL HPS: returnMarkdownImages=false is ineffective with default PaddleX 3.6 SDK - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 ### Constraint 8: 能力判断依赖假设 - Trigger: README/documentation is current enough for a first validation pass. - Host AI rule: 将假设转成下游验证清单。 - Why it matters: 假设不成立时，用户拿不到承诺的能力。 - Evidence: capability.assumptions | https://github.com/PaddlePaddle/PaddleOCR | README/documentation is current enough for a first validation pass. - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 ### Constraint 9: 维护活跃度未知 - Trigger: 未记录 last_activity_observed。 - Host AI rule: 补 GitHub 最近 commit、release、issue/PR 响应信号。 - Why it matters: 新项目、停更项目和活跃项目会被混在一起，推荐信任度下降。 - Evidence: evidence.maintainer_signals | https://github.com/PaddlePaddle/PaddleOCR | last_activity_observed missing - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 - Trigger: no_demo - Evidence: downstream_validation.risk_items | https://github.com/PaddlePaddle/PaddleOCR | no_demo; severity=medium - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。