mirror of
https://github.com/PaddlePaddle/PaddleOCR.git
synced 2026-09-01 15:32:24 +08:00
Lin Manhui
eeb12cd4de
* Update for paddleocr 3.5 * Fix doc * Add doc to nav * Refine docs * Fix PaddleOCR-VL doc * Polish PaddleOCR-VL docs * Polish docs * Add notice * Polish doc * update docs * update * update * update speed data * add warning * update warning * update warning * update warning * update warning * update * update * Fix bugs * Update API docs * Update API docs * Update git ignore * Update docs * update pp_structure_v3 case * update * Allow specifying URLs for pdx and ppocr version * docs: release-review fixes for 3.5 docs Addresses issues surfaced during release-time review of #17820, covering broken rendering, broken cross-language and anchor links, expression and consistency nits, and the strict-mode docs-anchor CI. Rendering fixes: - Restore truncated/duplicated parameter-table rows in OCR.en.md, PP-DocTranslation.en.md, PP-StructureV3.en.md, and doc_understanding.en.md - Fix mis-indented kwarg in the PP-DocTranslation.en.md transformers example (would SyntaxError on copy-paste) - Fix 4-backtick closing fence and over-wide rowspan in chart_parsing.{en,zh}.md - Fill in empty enable_hpi default (None) in PaddleOCR-VL.en.md Link fixes: - Point module_usage .en.md files at ../inference_engine.en.md instead of the Chinese ../inference_engine.md (11 files) - Replace Chinese anchor #五推理引擎 with #5-inference-engine in eight module_usage .en.md files, and normalize the corresponding heading from "## V. Inference Engine" to "## 5. Inference Engine" in textline_orientation_classification.en.md - Correct mislabeled PaddleX weight-conversion link text in text_detection.en.md and table_structure_recognition.en.md - Align broken cross-file link in inference_engine.md with the actual slug (#3-paddlex) so it stops conflicting with high_performance_inference.md and serving.md Chinese anchor resolution (CI fix): - Attach explicit {#anchor} (attr_list) attributes to the zh headings for "推理引擎", "权重转换", and "流程导览" so the existing in-page Chinese anchors resolve under the default mkdocs slugify. Build now clean under `mkdocs-ci.yml` strict mode. Expression and consistency: - Drop duplicated "and vLLM" phrase in NVIDIA Blackwell WARNING - Restore Chinese key "驾驶室准乘人数" in PP-ChatOCRv4.en.md transformers example (rest of the doc keeps it) - Normalize "Paddle framework" to "PaddlePaddle framework" and align link text with target file title across affected docs - Fix plural/singular mismatch ("examples"/"them" -> "example"/"it") in module_usage .en.md quick-start intros that show one command - Add missing comma after hardware names in five hardware EN tutorials - Add spacing in "PaddleX 产线 Python 脚本使用说明" link text in inference_engine.md - Use uppercase CPU/GPU in paddlepaddle_installation.md comments Navigation: - Add missing English nav_translations entries so the English sidebar no longer shows raw Chinese labels: PP-DocTranslation产线 -> PP-DocTranslation Pipeline 推理引擎与配置说明 -> Inference Engine and Configuration Signed-off-by: Bvicii <yizhanhuang2002@gmail.com> * docs: clarify that engine=None preserves legacy PaddleOCR behavior Addresses PR #17820 review feedback: the engine-parameter row lists `paddle`, `paddle_static`, `paddle_dynamic`, and `transformers` as supported values but doesn't mention that `None` is also valid (and is the default). Add a short user-facing clarification to every engine row's Description so readers who see `default=None` understand what that means: - EN: "If left as `None` (the default), PaddleOCR preserves the behavior of earlier versions, which in most configurations is equivalent to `paddle`." - ZH: "保持为默认值 None 时，PaddleOCR 保留旧版本的行为，在大多数配置下 等价于 paddle。" 48 files, 66 engine rows updated (33 EN + 33 ZH). No changes to engine_config rows, which use a different description. Signed-off-by: Bvicii <yizhanhuang2002@gmail.com> * Optimize docs * Update docs * docs: align CUDA 12.6 Docker driver version with pip section Per review feedback from changdazhou on PR #17820 (L26), update the CUDA 12.6 Docker GPU line to require driver >= 550.54.14, matching the pip section already at L61 (both ZH and EN). Signed-off-by: Bvicii <yizhanhuang2002@gmail.com> * docs: include None in engine supported-values list Per follow-up review on PR #17820: from a completeness standpoint, None belongs in the "Supports ..." enumeration rather than only in the trailing clarification sentence. Move None into the list as the default value and tighten the follow-on sentence accordingly. - EN: "Supports None (the default), paddle, paddle_static, paddle_dynamic, and transformers. When left as None, PaddleOCR preserves the behavior of earlier versions..." - ZH: "支持 None（默认值）、paddle、paddle_static、paddle_dynamic、 transformers。保持为默认值 None 时..." Applied to all three supported-value variants across the module_usage and pipeline_usage pages — same 48 files / 66 rows as the previous clarification commit. Signed-off-by: Bvicii <yizhanhuang2002@gmail.com> * fix docs * update * update * docs: revert PaddleOCR-VL.md to HTML and re-apply maintainer prose Revert PaddleOCR-VL.md to the pre-a874bcb3e8 "Optimize docs" state, then re-apply the PR's three edits and a small set of the maintainer's prose-only changes from that commit. Full revert rationale:a874bcb3e8converted every HTML table in the file to pipe-tables (17 tables) but the conversion had multiple rendering problems — unescaped `|` inside `str|None` type cells breaking column alignment, trailing rows collapsed into prose, a corrupted `prompt_label` row. The commit also stripped every `<details>/<summary>` wrapper (27 in total), so both the parameter tables and the Docker Compose customization / multi-language invocation examples stopped being collapsed, and it broke the YAML frontmatter (`comments: true` → `## comments: true`), the tabbed `=== "..."` blocks, and some HTML-entity escaping inside C++/PHP code samples. Edits preserved on top of the HTML baseline: - This PR's three edits: {#流程导览} anchor, and the engine-row completeness / default-None clarification on both engine rows. - Maintainer's prose edits froma874bcb3e8that were clearly intentional and did not introduce rendering regressions: * Remove the paddleocr-vl-1.5_metrics.png image. * Expand the "镜像中仅预装飞桨框架" note with a recommendation to install other engines via 方法二. * Generalize the "latest-xxx" TIP wording. * Switch the paddlepaddle.org.cn quick-install URL from autolink to explicit Markdown link syntax. Other prose/structure changes froma874bcb3e8(list-indent reflow inside tabs, `<details>` stripping, table conversions, frontmatter, code-sample re-encoding) are rendering regressions rather than intended edits and are rolled back here; maintainer can re-apply any genuinely desired prose changes cleanly on top of this baseline. Signed-off-by: Bvicii <yizhanhuang2002@gmail.com> * Update docs * Update doc * Update docs * Fix docs * Add .worktrees to gitignore * Fix doc bug --------- Signed-off-by: Bvicii <yizhanhuang2002@gmail.com> Co-authored-by: zhangyue66 <zhangyue66@baidu.com> Co-authored-by: Bvicii <yizhanhuang2002@gmail.com>