diff --git a/python/paddle/README.rst b/python/paddle/README.md similarity index 72% rename from python/paddle/README.rst rename to python/paddle/README.md index b84b54f1c3c42879c894b7a6a71362c908f60d93..dc8445d2dbf0ce52cb590cf16c3220c539874cd0 100644 --- a/python/paddle/README.rst +++ b/python/paddle/README.md @@ -20,81 +20,69 @@ We provide users with four installation methods ,which are pip, conda, docker an ### PIP Installation -#### PREQUISTIES +#### PREQUISTIES ##### On Windows: - **Windows 7/8/10 Pro/Enterprise (64bit)** - - **GPU version support CUDA 9.0/9.1/9.2/10.0/10.1,only supports single card** -- **Python version 2.7.15+/3.5.1+/3.6/3.7/3.8 (64 bit)** + - **GPU version support CUDA 10.2/11.2/11.6/11.7** + - **Only supports single card** +- **Python version 3.7/3.8/3.9/3.10 (64 bit)** - **pip version 9.0.1+ (64 bit)** ##### On Linux: - **Linux Version (64 bit)** - - **CentOS 6 (GPU Version Supports CUDA 9.0/9.1/9.2/10.0/10.1, only supports single card**)** - - **CentOS 7 (GPUVersion Supports CUDA 9.0/9.1/9.2/10.0/10.1, CUDA 9.1 only supports single card**)** - - **Ubuntu 14.04 (GPUVersion Supports CUDA 10.0/10.1)** - - **Ubuntu 16.04 (GPUVersion Supports CUDA 9.0/9.1/9.2/10.0/10.1)** - - **Ubuntu 18.04 (GPUVersion Supports CUDA 10.0/10.1)** -- **Python Version: 2.7.15+/3.5.1+/3.6/3.7/3.8 (64 bit)** + - **CentOS 7 (GPUVersion Supports CUDA 10.2/11.2/11.6/11.7)** + - **Ubuntu 16.04/18.04/20.04/22.04 (GPUVersion Supports CUDA 10.2/11.2/11.6/11.7)** +- **Python Version: 3.7/3.8/3.9/3.10 (64 bit)** - **pip or pip3 Version 20.2.2+ (64 bit)** -##### On MacOS: +##### On macOS: - **MacOS version 10.11/10.12/10.13/10.14 (64 bit) (not support GPU version yet)** -- **Python version 2.7.15+/3.5.1+/3.6/3.7/3.8 (64 bit)** +- **Python version 3.7/3.8/3.9/3.10 (64 bit)** - **pip or pip3 version 9.0.1+ (64 bit)** -#### Commands to install +#### Commands to install ###### cpu: -python2: +```bash +pip install paddlepaddle +``` -```python -m pip install paddlepaddle``` +###### gpu: -python3: +```bash +pip install paddlepaddle-gpu +``` -```python3 -m pip install paddlepaddle``` - -###### gpu-cuda10.2: - -python2: - -```python -m pip install paddlepaddle-gpu``` - -python3: - -```python3 -m pip install paddlepaddle-gpu``` - - - -###### gpu-cuda9、10.0、10.1、11: +###### specific version cuda: We only release paddlepaddle-gpu cuda10.2 on pypi. -If you want to install paddlepaddle-gpu with cuda version of 9.0 ,10.0 ,10.1 ,or 11.0, commands to install are on our website: [Installation Document](https://www.paddlepaddle.org.cn/) +If you want to install paddlepaddle-gpu with cuda version of 10.2/11.2/11.6/11.7, commands to install are on our website: [Installation Document](https://www.paddlepaddle.org.cn/documentation/docs/en/install/pip/frompip_en.html) -#### Verify installation +#### Verify installation -After the installation is complete, you can use `python` or `python3` to enter the Python interpreter and then use `import paddle.fluid` and `fluid.install_check.run_check()` +After the installation is complete, you can use `python3` to enter the Python interpreter and then use `import paddle` and `paddle.utils.run_check()` -If `Your Paddle Fluid is installed successfully!` appears, to verify that the installation was successful. +If `PaddlePaddle is installed successfully!` appears, to verify that the installation was successful. ### Other installation methods -If you want to install witch conda or docker or pip,please see commands to install on our website: [Installation Document](https://www.paddlepaddle.org.cn/) +If you want to install witch conda or docker or pip, please see commands to install on our website: [Installation Document](https://www.paddlepaddle.org.cn/documentation/docs/en/install/index_en.html) @@ -124,8 +112,8 @@ If you want to install witch conda or docker or pip,please see commands to insta ## Documentation -We provide [English](http://www.paddlepaddle.org.cn/documentation/docs/en/1.8/beginners_guide/index_en.html) and -[Chinese](http://www.paddlepaddle.org.cn/documentation/docs/zh/1.8/beginners_guide/index_cn.html) documentation. +We provide [English](https://www.paddlepaddle.org.cn/documentation/docs/en/guides/index_en.html) and +[Chinese](https://www.paddlepaddle.org.cn/documentation/docs/zh/guides/index_cn.html) documentation. - [Basic Deep Learning Models](https://www.paddlepaddle.org.cn/documentation/docs/en/beginners_guide/index_en.html) @@ -146,7 +134,7 @@ We provide [English](http://www.paddlepaddle.org.cn/documentation/docs/en/1.8/be Our new API enables much shorter programs. -- [How to Contribute](https://www.paddlepaddle.org.cn/documentation/docs/en/advanced_guide/addon_development/contribute_code/index_en.html) +- [How to Contribute](https://www.paddlepaddle.org.cn/documentation/docs/zh/dev_guides/index_cn.html) We appreciate your contributions! @@ -154,7 +142,7 @@ We provide [English](http://www.paddlepaddle.org.cn/documentation/docs/en/1.8/be - [Github Issues](https://github.com/PaddlePaddle/Paddle/issues): bug reports, feature requests, install issues, usage issues, etc. - QQ discussion group: 796771754 (PaddlePaddle). -- [Forums](http://ai.baidu.com/forum/topic/list/168?pageNo=1): discuss implementations, research, etc. +- [Forums](https://aistudio.baidu.com/paddle/forum/): discuss implementations, research, etc. ## Copyright and License -PaddlePaddle is provided under the [Apache-2.0 license](LICENSE). +PaddlePaddle is provided under the [Apache-2.0 license](https://github.com/PaddlePaddle/Paddle/blob/develop/LICENSE). diff --git a/python/setup.py.in b/python/setup.py.in index f22841e2f86826cc6b29b95052efceaa6526faf7..00c9f738040145c44c657b978ebd7a02d091ebc5 100755 --- a/python/setup.py.in +++ b/python/setup.py.in @@ -763,7 +763,7 @@ else: yield # Log for PYPI -with open("@PADDLE_BINARY_DIR@/python/paddle/README.rst", "r", encoding='UTF-8') as f: +with open("@PADDLE_BINARY_DIR@/python/paddle/README.md", "r", encoding='UTF-8') as f: long_description = f.read() # strip *.so to reduce package size diff --git a/setup.py b/setup.py index d801365dd1338cbd5076ff3be729f00d1c7361e6..5408843083ce2eaafce5176315365cc2ccc62643 100644 --- a/setup.py +++ b/setup.py @@ -1356,7 +1356,7 @@ def main(): # Log for PYPI, get long_description of setup() with open( - paddle_source_dir + '/python/paddle/README.rst', "r", encoding='UTF-8' + paddle_source_dir + '/python/paddle/README.md', "r", encoding='UTF-8' ) as f: long_description = f.read()