Skip to content

Commit

Permalink
docs: add installation documentation of paddle (#14117)
Browse files Browse the repository at this point in the history
  • Loading branch information
SWHL authored Oct 29, 2024
1 parent 7cecf0a commit 5430e43
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 3 deletions.
22 changes: 19 additions & 3 deletions docs/quick_start.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,23 @@ hide:

### Install

```bash linenums="1"
pip install paddleocr
```
#### 1. Install PaddlePaddle

> If you don't have a basic Python runtime environment, please refer to [Running environment preparation](./ppocr/environment.en.md).
=== "CPU installation"

```bash linenums="1"
pip install paddlepaddle
```

=== "GPU installation"

Since the GPU needs to be installed and used according to the specific CUDA version, the following only takes the Linux platform, pip installation of NVIDIA GPU, CUDA11.8 as an example. For other platforms, please refer to the instructions in [PaddlePaddle official website installation document](https://www.paddlepaddle.org.cn/en).

```bash linenums="1"
python -m pip install paddlepaddle-gpu==3.0.0b1 -i https://www.paddlepaddle.org.cn/packages/stable/cu118/
```

### Use by code

Expand Down Expand Up @@ -264,6 +278,8 @@ paddleocr -h
['0', 0.99999964]
```

For more detailed documentation, please go to: [PaddleOCR Quick Start](./ppocr/quick_start.en.md)

### Online Demo

- PP-OCRv4 online experience:<https://aistudio.baidu.com/aistudio/projectdetail/6611435>
Expand Down
23 changes: 23 additions & 0 deletions docs/quick_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,27 @@ hide:

### 安装

#### 1. 安装PaddlePaddle

> 如果您没有基础的Python运行环境,请参考[运行环境准备](./ppocr/environment.md)
=== "CPU端安装"

```bash linenums="1"
pip install paddlepaddle
```

=== "GPU端安装"

由于GPU端需要根据具体CUDA版本来对应安装使用,以下仅以Linux平台,pip安装英伟达GPU, CUDA11.8为例,其他平台,请参考[飞桨官网安装文档](https://www.paddlepaddle.org.cn/install/quick)中的说明进行操作。


```bash linenums="1"
python -m pip install paddlepaddle-gpu==3.0.0b1 -i https://www.paddlepaddle.org.cn/packages/stable/cu118/
```

#### 2. 安装`paddleocr`

```bash linenums="1"
pip install paddleocr
```
Expand Down Expand Up @@ -264,6 +285,8 @@ paddleocr -h
['0', 0.99999964]
```

更加详细的文档,请移步:[PaddleOCR快速开始](./ppocr/quick_start.md)

### 在线demo

- PP-OCRv4 在线体验地址:<https://aistudio.baidu.com/community/app/91660>
Expand Down

0 comments on commit 5430e43

Please sign in to comment.