Skip to content

【PaddleX No.1】PaddleX 文档优化 #4064

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 4 commits into
base: release/3.0
Choose a base branch
from
Open

【PaddleX No.1】PaddleX 文档优化 #4064

wants to merge 4 commits into from

Conversation

Echo-Nie
Copy link

@Echo-Nie Echo-Nie commented May 21, 2025 •
edited
Loading

PaddleX描述

根据最新文档：PaddleX文档3.0 对 README 和 README_en 文件进行对齐，删除被废弃的文档，新增更多的文档，与3.0文档进行对齐。

操作类型 文档路径 文档名称 变更说明
✅ 新增 文本图像智能分析 文档场景信息抽取v4产线使用教程 新增v4版本产线教程
✅ 新增 🛠️ 模型产线部署 获取ONNX模型 新增模型格式转换文档
✅ 新增 💻 多硬件使用 燧原 GCU 飞桨安装教程 新增国产硬件适配指南
✅ 新增 📂 数据标注教程 图像分类任务模块/目标检测任务模块等10项 新增标准化数据标注规范
✅ 新增 📑 产线列表 PaddleX产线列表(CPU/GPU/DCU/MLU/NPU/XPU/GCU) 新增各硬件平台产线清单
✅ 新增 📄 模型列表 PaddleX模型列表（含各硬件平台） 新增各硬件平台模型适配清单
✅ 新增 📝 产业实践教程 16个应用场景教程（论文文献抽取/车牌识别/垃圾分类等） 新增行业应用实践案例
✅ 新增 ⌨️ 单功能模块 PaddleX 产线命令行使用说明 新增命令行操作文档
✅ 新增 ⚙️ 单功能模块 产线并行推理 新增多线程优化指南
❌ 删除 文本图像智能分析 印章文本识别产线使用教程 合并到公式识别模块
❌ 删除 🔄 计算机视觉 通用图像识别产线使用教程 与图像分类产线合并
❌ 删除 📝 相关说明文件 PaddleX 时序任务模型配置文件参数说明 参数说明整合到通用配置文档

预览链接： README.md ， README_en

FAQ描述

基于原文档的基础上，参考 常见问题——PaddleX，对一些常见问题进行补充。

问题编号 操作类型 问题内容 修改说明
Q1 无变化 PaddleX是什么？ 内容完全一致，未作修改
Q2 无变化 产线与模块的关系 内容完全一致，未作修改
Q3 无变化 wheel包安装模式选择 内容完全一致，未作修改
Q4 无变化 PaddleX与星河零代码产线区别 内容完全一致，未作修改
Q5 ✅ 新增 有没有适用于低配设备的小模型？ 新增内容：
• 模型裁剪功能说明
• VOC检测任务案例
Q6 ✅ 新增 如何从之前训练的模型继续训练？ 新增内容：
• pretrain_weights参数使用说明
Q7 ✅ 新增 PaddleX保存的几种模型有什么区别？ 新增内容：
• 四类模型用途说明（正常/裁剪/部署/量化）
• model.yml区分方法
Q8 ✅ 新增 每次训练都需要重新下载预训练模型？ 新增内容：
• 手动管理模型路径方法
• paddlex.pretrain_dir设置说明
Q9 无变化 使用过程中遇到问题如何反馈？ 内容完全一致，未作修改

预览链接： FAQ.md ， FAQ_en

VisualDL描述

  1. 标题数量太多，影响用户的使用体验，而且很多小标题并非重点，显得目录结构杂而混乱，难以让用户区分Visual的核心重点。所以将一些非核心的标题改为文本加粗形式。
  2. 对于文档中的每个小标题进行编号如“一、二、三、”，“1. 2. 3.”，“a. b. c. ”，使得文档结构更清晰且有条理。
  3. 修改正文中的目录结构，只包含一级标题（除了 介绍）。
  4. 对于“命令行启动VisualDL”添加示例代码。
  5. 对“核心亮点”中的内容进行修改，原文档侧重于项目本身，润色后不仅体验项目特点，还从用户角度考虑。
  6. 原来的VisualDL采用的是相对路径，这里改成超链接形式。

预览链接： VisualDL ， VisualDL_en

issue：#3557

Note

完成了FAQ模块、VisualDL模块，PaddleX文档对齐
update 2025/5/22：9:57

@changdazhou @openvino-book @luotao1

@paddle-bot Paddle-bot
Copy link

paddle-bot bot commented May 21, 2025

Thanks for your contribution!

@paddle-bot paddle-bot bot added the contributor External developers label May 21, 2025
@Echo-Nie
Copy link
Author

Echo-Nie commented May 22, 2025 •
edited
Loading

预览链接： README.md ， README_en

预览链接： FAQ.md ， FAQ_en

预览链接： VisualDL ， VisualDL_en

@changdazhou @openvino-book @luotao1 pls review

@luotao1 luotao1 mentioned this pull request May 22, 2025
Open
@luotao1 luotao1 added the HappyOpenSource 快乐开源活动issue与PR label May 22, 2025
@changdazhou
Copy link
Collaborator

代码提交前有fetch最新代码，并做pre-commit不，建议将commit压缩成一个提交，保持简洁

@Echo-Nie
1. Add the documentation for VisualDL (Zh and En) 2. Modify the READM…
b1434b8 
…E.md document for PaddleX (update the En document simultaneously), mainly modifying the 'Documentation' section of this md file 3. Modify the FAQ document (Zh and En)
@Echo-Nie
Copy link
Author

代码提交前有fetch最新代码

有的，如下图
image

并做pre-commit不，建议将commit压缩成一个提交，保持简洁

是的，如下图
image

已经合并为一个commit

cuicheng01
cuicheng01 reviewed May 26, 2025
View reviewed changes
docs/VisualDL.md Outdated
<img src="https://raw.githubusercontent.com/PaddlePaddle/VisualDL/develop/frontend/packages/core/public/images/logo-visualdl.svg?sanitize=true" width="70%"/>
</p>


Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

文档中logo、二维码等内容可以删除掉。另外，建议说明下PaddleX中产出的log或者权重怎么使用vdl

Copy link
Author

@Echo-Nie Echo-Nie May 26, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

文档中logo、二维码等内容可以删除掉

Done

另外，建议说明下PaddleX中产出的log或者权重怎么使用vdl

ok, I will first study the relevant content, and then I will add related descriptions. Thx for your review.🫡

Echo-Nie added 2 commits May 26, 2025 15:08
@Echo-Nie
1. FAQ.md&FAQ.en.md: del the content about Quant;
07331a5 
2. VisualDL.en.md&VisualDL.md: del the logo and QR Code
3. mkdocs.yml: add the VisualDL
4. VisualDL: ready to add the content: How to use the log or weights produced by PaddleX with vdl. I am still in the process of learning.
@Echo-Nie
del the Prune content in FAQ
28b8f6d
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cuicheng01 cuicheng01 cuicheng01 left review comments

Assignees

@luotao1 luotao1

@openvino-book openvino-book

@changdazhou changdazhou

Labels
contributor External developers HappyOpenSource 快乐开源活动issue与PR
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@Echo-Nie @changdazhou @cuicheng01 @luotao1 @openvino-book