From 65f27b802bf5927d832976c7a04b8cedc36b62ee Mon Sep 17 00:00:00 2001 From: gaotingquan Date: Wed, 24 Aug 2022 07:07:24 +0000 Subject: [PATCH] docs: polish --- docs/en/inference_deployment/whl_deploy_en.md | 9 ++++----- docs/en/installation/install_paddleclas_en.md | 8 ++++---- docs/zh_CN/inference_deployment/whl_deploy.md | 9 ++++----- docs/zh_CN/installation/install_paddleclas.md | 6 +++--- 4 files changed, 15 insertions(+), 17 deletions(-) diff --git a/docs/en/inference_deployment/whl_deploy_en.md b/docs/en/inference_deployment/whl_deploy_en.md index e2666458..7c94f6de 100644 --- a/docs/en/inference_deployment/whl_deploy_en.md +++ b/docs/en/inference_deployment/whl_deploy_en.md @@ -25,17 +25,16 @@ PaddleClas supports Python wheel package for prediction. At present, PaddleClas ## 1. Installation -* installing from pypi +* **[Recommended]** Installing from PyPI: ```bash -pip3 install paddleclas==2.2.1 +pip3 install paddleclas ``` -* build own whl package and install +* Please build and install locally if you need to use the develop branch of PaddleClas to experience the latest functions, or need to redevelop based on PaddleClas. The command is as follows: ```bash -python3 setup.py bdist_wheel -pip3 install dist/* +python3 setup.py install ``` diff --git a/docs/en/installation/install_paddleclas_en.md b/docs/en/installation/install_paddleclas_en.md index 2bd7d817..c71d3516 100644 --- a/docs/en/installation/install_paddleclas_en.md +++ b/docs/en/installation/install_paddleclas_en.md @@ -25,14 +25,14 @@ git clone https://gitee.com/paddlepaddle/PaddleClas.git -b develop ## 2. Install PaddleClas and requirements -It is recommanded that installing from PyPI: +* **[Recommended]** Installing from PyPI: ```shell pip install paddleclas ``` -PaddleClas dependencies are listed in file `requirements.txt`, you can use the following command to install the dependencies. +* Please build and install locally if you need to use the develop branch of PaddleClas to experience the latest functions, or need to redevelop based on PaddleClas. The command is as follows: -``` -pip install --upgrade -r requirements.txt -i https://mirror.baidu.com/pypi/simple +```shell +python setup.py install ``` diff --git a/docs/zh_CN/inference_deployment/whl_deploy.md b/docs/zh_CN/inference_deployment/whl_deploy.md index 0b84c83e..1f8b8995 100644 --- a/docs/zh_CN/inference_deployment/whl_deploy.md +++ b/docs/zh_CN/inference_deployment/whl_deploy.md @@ -23,17 +23,16 @@ PaddleClas 支持 Python Whl 包方式进行预测，目前 Whl 包方式仅支 ## 1. 安装 paddleclas -* pip 安装 +* **[推荐]** 直接 pip 安装： ```bash -pip3 install paddleclas==2.2.1 +pip3 install paddleclas ``` -* 本地构建并安装 +* 如需使用 PaddleClas develop 分支体验最新功能，或是需要基于 PaddleClas 进行二次开发，请本地构建安装： ```bash -python3 setup.py bdist_wheel -pip3 install dist/* +python3 setup.py install ``` diff --git a/docs/zh_CN/installation/install_paddleclas.md b/docs/zh_CN/installation/install_paddleclas.md index 108033ed..752b81ad 100644 --- a/docs/zh_CN/installation/install_paddleclas.md +++ b/docs/zh_CN/installation/install_paddleclas.md @@ -98,16 +98,16 @@ git clone https://gitee.com/paddlepaddle/PaddleClas.git -b release/2.4 ### 1.3 安装 PaddleClas 及其 Python 依赖库 -建议直接从 PyPI 安装 PaddleClas： +* **[建议]** 直接安装 PaddleClas： ```shell pip install paddleclas ``` -PaddleClas 的 Python 依赖库在 `requirements.txt` 中给出，可通过如下命令安装： +* 如需使用 PaddleClas develop 分支体验最新功能，或是需要基于 PaddleClas 进行二次开发，请本地构建安装，命令如下： ```shell -pip install --upgrade -r requirements.txt -i https://mirror.baidu.com/pypi/simple +python setup.py install ``` -- GitLab