Merge pull request #1769 from cuicheng01/develop

polish

Author: cuicheng01

README.md

@@ -1,7 +1,8 @@
 <p align="center">
   <img src="https://github.com/PaddlePaddle/PaddleX/assets/45199522/63c6d059-234f-4a27-955e-ac89d81409ee" width="360" height ="55" alt="PaddleX" align="middle" />
 </p>
- <p align= "center"> PaddleX -- 飞桨低代码开发工具，以低代码的形式支持开发者快速实现产业实际项目落地 </p>
+
+<p align= "center"> PaddleX -- 飞桨低代码开发工具，以低代码的形式支持开发者快速实现产业实际项目落地 </p>
 
 <p align="left">
     <a href="./LICENSE"><img src="https://img.shields.io/badge/license-Apache%202-red.svg"></a>
@@ -10,51 +11,75 @@
     <a href=""><img src="https://img.shields.io/badge/hardware-intel cpu%2C%20gpu%2C%20xpu%2C%20npu%2C%20mlu-yellow.svg"></a>
 </p>
 
+## 简介
+PaddleX3.0 是飞桨精选模型的低代码开发工具，支持国内外多款主流硬件的模型训练和推理，覆盖工业、能源、金融、交通、教育等全行业，助力开发者产业实践落地。
+
+任务示例展示
 
+## 📣 近期更新
+🔥 PaddleX3.0 升级中，6 月正式发布，敬请期待，云端使用请前往飞桨 AI Studio 星河社区：https://aistudio.baidu.com/pipeline/mine ，点击「创建产线」开启使用。
 
-## 近期动态
-🔥 PaddleX3.0 升级中，6月正式发布，敬请期待，云端使用请前往飞桨 AI Studio 星河社区：https://aistudio.baidu.com/pipeline/mine ，点击「创建产线」开启使用。
+## 🌟 特性
 
-## 产品介绍
-PaddleX3.0 是飞桨精选模型的低代码开发工具，支持国内外多款主流硬件的训练和推理，覆盖工业、能源、金融、交通、教育等全行业，沉淀产业实际经验，并提供丰富的案例实践教程，全程助力开发者产业实践落地。
+PaddleX 3.0 集成飞桨生态优势能力，覆盖7大场景任务，构建 16 条模型产线，提供低代码开发模式，助力开发者在不同主流硬件上进行模型全流程开发。
 
-PaddleX3.0 分为本地端和云端，本地端提供统一任务API接口，支持图像分类、目标检测、图像分割、实例分割、OCR、时序相关等任务；云端提供[图形化开发界面](https://aistudio.baidu.com/pipeline/mine)，支持开发者使用零代码产线产出高质量模型和部署包。本项目面向本地端，开发者可以基于本项目快速完成模型训练、评估、推理。本项目提供了两种模型开发工具，即**单模型开发工具**和**模型产线开发工具**。
+  - **基础模型产线（模型数量多，场景全）：** 精选 72 个飞桨优质模型，覆盖图像分类、目标检测、图像分割、OCR、文本图像版面分析、时序预测等场景任务
+  - **特色模型产线（提效显著）：** 提供大小模型结合，大模型半监督学习和多模型融合显著提效方案
+  - **低代码开发模式（便捷开发部署）：** 提供零代码和低代码两种开发方式。
+     - 零代码开发通过用户图形界面（GUI）交互式提交后台训练任务，打通在线&离线部署，支持以 API 的形式调用在线服务。
+     - 低代码开发，一套 API 接口实现 16 条模型产线全流程开发，同时支持用户自定义模型串联流程。
+  - **本地端多硬件支持（兼容性强）：** 支持英伟达 GPU、昆仑芯、昇腾和寒武纪多硬件上，纯离线使用 
 
+<div align="center">
+    <img src="https://github.com/PaddlePaddle/PaddleX/assets/45199522/61c4738f-735e-4ceb-aa5f-1038d4506d1c">
+</div>
 
-## 安装与快速开始
+## ⚡ 安装与快速开始
 - [安装](./docs/tutorials/INSTALL.md)
 - 快速开始
-  - [单模型开发工具](./docs/tutorials/tools/model_tools.md)
-  - [模型产线开发工具](./docs/tutorials/tools/pipelines_tools.md)
+  - [单模型开发工具](./docs/tutorials/inference/model_inference_tools.md)
+  - [模型产线开发工具](./docs/tutorials/inference/pipeline_inference_tools.md)
+
+## 🛠️ PaddleX3.0 覆盖的模型和模型产线
+  - [单模型列表](./docs/tutorials/models/support_model_list.md)
+  - [模型产线列表](./docs/tutorials/pipelines/support_pipeline_list.md)
+
+## 📖 零代码开发教程
+- [云端图形化开发界面](https://aistudio.baidu.com/pipeline/mine)：支持开发者使用零代码产线产出高质量模型和部署包
+- [教程《零门槛开发产业级 AI 模型》](https://aistudio.baidu.com/practical/introduce/546656605663301)：提供产业级模型开发经验，并且用12个实用的产业实践案例，手把手带你零门槛开发产业级AI模型
 
-## 单模型开发工具
-本节介绍 PaddleX3.0 单模型的全流程开发流程，包括数据准备、模型训练/评估、模型推理的使用方法。PaddleX3.0 支持的模型可以参考 [PaddleX模型库](./docs/tutorials/models/support_model_list.md)。
+## 📖 低代码开发教程
 
-### 1. 数据准备
-- [数据准备流程](./docs/data/README.md)
+### 一、单模型开发工具 🚀
+本节介绍 PaddleX3.0 单模型的全流程开发流程，包括数据准备、模型训练/评估、模型推理的使用方法。PaddleX3.0 支持的模型可以参考 [PaddleX 模型库](./docs/tutorials/models/support_model_list.md)。
+
+#### 1. 快速体验
+- [快速体验](./docs/tutorials/models/model_inference_tools.md)
+
+#### 2. 数据准备
+- [数据准备流程](./docs/tutorials/data/README.md)
 - [数据标注](./docs/tutorials/data/annotation/README.md)
 - [数据校验](./docs/tutorials/data/dataset_check.md)
-### 2. 模型训练
+
+#### 3. 模型训练
 - [模型训练/评估](./docs/tutorials/base/README.md)
 - [模型优化](./docs/tutorials/base/model_optimize.md)
 
-### 3. 模型推理
- - [模型推理](docs/tutorials/inference/model_inference_tools.md)
- - [模型推理 API 介绍](docs/tutorials/inference/model_infernce_api.md)
+#### 4. 模型推理
+- [模型推理](./docs/tutorials/base/README.md)
 
-## 模型产线开发工具
- - [模型产线推理](docs/tutorials/inference/pipeline_inference_tools.md)
- - [模型产线推理 API 介绍](docs/tutorials/inference/pipeline_infernce_api.md)
+### 二、模型产线开发工具 🔥
+本节将介绍 PaddleX3.0 模型产线的全流程开发流程，包括数据准备、模型训练/评估、模型推理的使用方法。PaddleX3.0 支持的模型产线可以参考 [PaddleX 模型产线列表](./docs/tutorials/pipelines/support_pipeline_list.md)
 
-## 多硬件支持
-🔥 本项目支持在多种硬件上进行模型的开发，除了 GPU 外，当前支持的硬件还有**昆仑芯**、**昇腾芯**、**寒武纪芯**。只需添加一个配置设备的参数，即可在对应硬件上使用上述工具。详情可以参考上述文档。
+## 🌟 多硬件支持
+本项目支持在多种硬件上进行模型的开发，除了 GPU 外，当前支持的硬件还有**昆仑芯**、**昇腾芯**、**寒武纪芯**。只需添加一个配置设备的参数，即可在对应硬件上使用上述工具。
 
 - 昇腾芯支持的模型列表请参考 [PaddleX 昇腾芯模型列表](./docs/tutorials/models/support_npu_model_list.md)。
 - 昆仑芯支持的模型列表请参考 [PaddleX 昆仑芯模型列表](./docs/tutorials/models/support_xpu_model_list.md)。
 - 寒武纪芯支持的模型列表请参考 [PaddleX 寒武纪芯模型列表](./docs/tutorials/models/support_mlu_model_list.md)。
 
 
-## 贡献代码
+## 👀 贡献代码
 
 我们非常欢迎您为 PaddleX 贡献代码或者提供使用建议。如果您可以修复某个 issue 或者增加一个新功能，欢迎给我们提交 Pull Requests。
 

docs/tutorials/INSTALL_OTHER_DEVICES.md

@@ -6,8 +6,8 @@
 - 1.拉取镜像，此镜像仅为开发环境，镜像中不包含预编译的飞桨安装包，镜像中已经默认安装了昇腾算子库 CANN-8.0.RC1。
 
 ```
-docker pull registry.baidubce.com/device/paddle-npu:cann80RC1-ubuntu20-aarch64-gcc84-py39 # 适用于 ARM 架构
-docker pull registry.baidubce.com/device/paddle-npu:cann80RC1-ubuntu20-x86_64-gcc84-py39 # 适用于 X86 架构
+# 适用于 X86 架构，暂时不提供 Arrch64 架构镜像
+docker pull registry.baidubce.com/device/paddle-npu:cann80RC1-ubuntu20-x86_64-gcc84-py39
 ```
 
 - 2.参考如下命令启动容器，ASCEND_RT_VISIBLE_DEVICES 指定可见的 NPU 卡号
@@ -18,7 +18,7 @@ docker run -it --name paddle-npu-dev -v $(pwd):/work \
     -v /usr/local/bin/npu-smi:/usr/local/bin/npu-smi \
     -v /usr/local/dcmi:/usr/local/dcmi \
     -e ASCEND_RT_VISIBLE_DEVICES="0,1,2,3,4,5,6,7" \
-    registry.baidubce.com/device/paddle-npu:cann80RC1-ubuntu20-$(uname -m)-gcc84-py39 /bin/bash
+    registry.baidubce.com/device/paddle-npu:cann80RC1-ubuntu20-x86_64-gcc84-py39 /bin/bash
 ```
 ### 1.2 安装paddle包
 当前提供 Python3.9 的 wheel 安装包。如有其他 Python 版本需求，可以参考[飞桨官方文档](https://www.paddlepaddle.org.cn/install/quick)自行编译安装。
@@ -27,8 +27,8 @@ docker run -it --name paddle-npu-dev -v $(pwd):/work \
 
 ```
 # 注意需要先安装飞桨CPU版本
-pip install 
-pip install
+pip install https://paddle-model-ecology.bj.bcebos.com/paddlex/whl/paddle-device/npu/paddlepaddle-0.0.0-cp39-cp39-linux_x86_64.whl
+pip install https://paddle-model-ecology.bj.bcebos.com/paddlex/whl/paddle-device/npu/paddle_custom_npu-0.0.0-cp39-cp39-linux_x86_64.whl
 ```
 - 2.验证安装包
 安装完成之后，运行如下命令。
@@ -65,8 +65,8 @@ docker run -it --name paddle-mlu-dev -v $(pwd):/work \
 - 1.下载安装 Python3.10 的wheel 安装包。
 ```
 # 注意需要先安装飞桨 CPU 版本
-python -m pip install paddlepaddle -i https://www.paddlepaddle.org.cn/packages/nightly/cpu/
-python -m pip install --pre paddle-custom-mlu -i https://www.paddlepaddle.org.cn/packages/nightly/mlu/
+pip install https://paddle-model-ecology.bj.bcebos.com/paddlex/whl/paddle-device/mlu/paddlepaddle-3.0.0.dev20240621-cp310-cp310-linux_x86_64.whl
+pip install https://paddle-model-ecology.bj.bcebos.com/paddlex/whl/paddle-device/mlu/paddle_custom_mlu-3.0.0.dev20240621-cp310-cp310-linux_x86_64.whl
 ```
 - 2.验证安装包
 安装完成之后，运行如下命令。
@@ -102,8 +102,8 @@ docker run -it --name=xxx -m 81920M --memory-swap=81920M \
 
 - 1.安装 Python3.10 的 wheel 安装包
 ```
-pip install https://paddle-wheel.bj.bcebos.com/2.6.1/xpu/paddlepaddle_xpu-2.6.1-cp310-cp310-linux_x86_64.whl # X86 架构
-pip install https://paddle-device.bj.bcebos.com/2.6.1/xpu/paddlepaddle_xpu-2.6.1-cp310-cp310-linux_aarch64.whl # ARM 架构
+pip install https://paddle-model-ecology.bj.bcebos.com/paddlex/whl/paddle-device/xpu/paddlepaddle_xpu-2.6.1-cp310-cp310-linux_x86_64.whl # X86 架构
+pip install https://paddle-model-ecology.bj.bcebos.com/paddlex/whl/paddle-device/xpu/paddlepaddle_xpu-2.6.1-cp310-cp310-linux_aarch64.whl # ARM 架构
 ```
 - 2.验证安装包
 安装完成之后，运行如下命令
@@ -113,4 +113,4 @@ python -c "import paddle; paddle.utils.run_check()"
 预期得到如下输出结果
 ```
 PaddlePaddle is installed successfully! Let's start deep learning with PaddlePaddle now.
-```
+```

docs/tutorials/data/annotation/ClsAnnoTools.md

@@ -20,14 +20,14 @@ pip install labelme
 
 <center>
 
-<img src='https://paddle-model-ecology.bj.bcebos.com/paddlex/PaddleX3.0/doc_images/applications/image_classification_dataset_prepare/image_dir.png' width='600px'>
+<img src='https://github.com/PaddlePaddle/PaddleX/assets/142379845/3e333d6b-cbab-4161-b7df-9fb65a0576c7' width='600px'>
 </center>
 
 3. 在 pets 文件夹中创建待标注数据集的类别标签文件 flags.txt，并在 flags.txt 中按行写入待标注数据集的类别。以猫狗分类数据集的 flags.txt 为例，如下图所示：
 
 <center>
 
-<img src='https://paddle-model-ecology.bj.bcebos.com/paddlex/PaddleX3.0/doc_images/applications/image_classification_dataset_prepare/label_txt.png' width='600px'>
+<img src='https://github.com/PaddlePaddle/PaddleX/assets/142379845/6d29c675-facf-4932-a5c6-52e7a7428181' width='600px'>
 </center>
 
 ### 2.2 启动 Labelme
@@ -46,35 +46,35 @@ labelme images --nodata --autosave --output annotations --flags flags.txt
 
 <center>
 
-<img src='https://paddle-model-ecology.bj.bcebos.com/paddlex/PaddleX3.0/doc_images/applications/image_classification_dataset_prepare/labelme.png' width='600px'>
+<img src='https://github.com/PaddlePaddle/PaddleX/assets/142379845/5965e351-8f53-4ca2-85eb-bf1f53d1c50b' width='600px'>
 </center>
 
 2. 在 Flags 界面选择类别。
 
 <center>
 
-<img src='https://paddle-model-ecology.bj.bcebos.com/paddlex/PaddleX3.0/doc_images/applications/image_classification_dataset_prepare/flags.png' width='300px'>
+<img src='https://github.com/PaddlePaddle/PaddleX/assets/142379845/45889bd0-abb6-46ca-aa35-f4e124ad8481' width='300px'>
 </center>
 
 3. 标注好后点击存储。（若在启动 labelme 时未指定 --output 字段，会在第一次存储时提示选择存储路径，若指定 --autosave 字段使用自动保存，则无需点击存储按钮）。
 
 <center>
 
-<img src='https://paddle-model-ecology.bj.bcebos.com/paddlex/PaddleX3.0/doc_images/applications/image_classification_dataset_prepare/save.png' width='100px'>
+<img src='https://github.com/PaddlePaddle/PaddleX/assets/142379845/8a3f3e54-68a9-4f9a-8c68-63272fb2e0b6' width='100px'>
 </center>
 
 4. 然后点击 "Next Image" 进行下一张图片的标注。
 
 <center>
 
-<img src='https://paddle-model-ecology.bj.bcebos.com/paddlex/PaddleX3.0/doc_images/applications/image_classification_dataset_prepare/next_image.png' width='100px'>
+<img src='https://github.com/PaddlePaddle/PaddleX/assets/142379845/d9be34e1-d44c-4738-8101-3895c70a8b6e' width='100px'>
 </center>
 
 5. 最终标注好的标签文件如图所示。
 
 <center>
 
-<img src='https://paddle-model-ecology.bj.bcebos.com/paddlex/PaddleX3.0/doc_images/applications/image_classification_dataset_prepare/annotation_result.png' width='600px'>
+<img src='https://github.com/PaddlePaddle/PaddleX/assets/142379845/30432aae-7b5a-4539-ae09-fa476144ef6b' width='600px'>
 </center>
 
 6. 使用 [convert_to_imagenet.py](https://paddle-model-ecology.bj.bcebos.com/paddlex/PaddleX3.0/doc_images/applications/image_classification_dataset_prepare/convert_to_imagenet.py) 脚本将标注好的数据集转换为 ImageNet-1k 数据集格式，生成 train.txt，val.txt 和label.txt。
@@ -88,7 +88,7 @@ python convert_to_imagenet.py --dataset_path /path/to/dataset
 
 <center>
 
-<img src='https://paddle-model-ecology.bj.bcebos.com/paddlex/PaddleX3.0/doc_images/applications/image_classification_dataset_prepare/directory_structure.png' width='600px'>
+<img src='https://github.com/PaddlePaddle/PaddleX/assets/142379845/23074d47-d2af-44fc-9377-b38cd7823f32' width='600px'>
 </center>
 
-8. 将 pets 目录打包压缩为 .tar 或 .zip 格式压缩包即可得到猫狗图像分类标准 labelme 格式数据集，然后上传至 [通用图像分类产线](https://aistudio.baidu.com/pipeline/mine) 经过数据化分后即可进行训练。
+8. 将 pets 目录打包压缩为 .tar 或 .zip 格式压缩包即可得到猫狗图像分类标准 labelme 格式数据集，然后上传至 [通用图像分类产线](https://aistudio.baidu.com/pipeline/mine) 经过数据化分后即可进行训练。