Skip to content

Commit b9982f5

Browse files
JackwatervegJackwaterveg
authored
reviset the install.md (#1165)
1 parent 8798573 commit b9982f5

File tree

2 files changed

+44
-29
lines changed

2 files changed

+44
-29
lines changed

‎docs/source/install.md

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ There are 3 ways to use `PaddleSpeech`. According to the degree of difficulty, t
44

55
| Way | Function | Support|
66
|:---- |:----------------------------------------------------------- |:----|
7-
| Easy | (1) Use command-line functions of PaddleSpeech. <br> (2) Experience PaddleSpeech on Ai Studio. | Linux, Mac，Windows |
7+
| Easy | (1) Use command-line functions of PaddleSpeech. <br> (2) Experience PaddleSpeech on Ai Studio. | Linux, Mac(not support M1 chip)，Windows |
88
| Medium | Support major functions ，such as using the` ready-made `examples and using PaddleSpeech to train your model. | Linux |
99
| Hard | Support full function of Paddlespeech，including training n-gram language model, Montreal-Forced-Aligner, and so on. And you are more able to be a developer! | Ubuntu |
1010

@@ -52,15 +52,21 @@ You can use the following command:
5252
pip install paddlepaddle paddlespeech
5353
```
5454
## Medium: Get the Major Functions (Support Linux)
55-
If you want to get the major function of `paddlespeech`. There are 4 steps you need to do.
55+
If you want to get the major function of `paddlespeech`, you need to do following steps:
56+
### Git clone PaddleSpeech
57+
You need to `git clone` this repository at first.
58+
```bash
59+
git clone https://github.com/PaddlePaddle/PaddleSpeech.git
60+
cd PaddleSpeech
61+
```
5662

5763
### Install Conda
5864
Conda is a management system of the environment. You can go to [minicoda](https://docs.conda.io/en/latest/miniconda.html) to select a version (py>=3.7) and install it by yourself or you can use the following command:
5965
```bash
6066
# download the miniconda
61-
wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh
67+
wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -P tools/
6268
# install the miniconda
63-
bash Miniconda3-latest-Linux-x86_64.sh -b
69+
bash tools/Miniconda3-latest-Linux-x86_64.sh -b
6470
# conda init
6571
$HOME/miniconda3/bin/conda init
6672
# activate the conda
@@ -102,12 +108,12 @@ You can choose the `PaddlePaddle` version based on your system. For example, for
102108
python3 -m pip install paddlepaddle-gpu==2.2.0
103109
```
104110
### Install PaddleSpeech
105-
You need to `git clone` this repository and install `paddlespeech` by the following commands，then you can use the `ready-made` examples in `paddlespeech` :
111+
You can install `paddlespeech` by the following command，then you can use the `ready-made` examples in `paddlespeech` :
106112
```bash
107-
https://github.com/PaddlePaddle/PaddleSpeech.git
108-
cd PaddleSpeech
113+
# Make sure you are in the root directory of PaddleSpeech
109114
pip install .
110115
```
116+
111117
## Hard: Get the Full Function (Support Ubuntu)
112118
### Prerequisites
113119
- Ubuntu >= 16.04.
@@ -124,7 +130,7 @@ Take several steps to launch the Docker image:
124130

125131
For example, pull paddle 2.2.0 image:
126132
```bash
127-
nvidia-docker pull registry.baidubce.com/paddlepaddle/paddle:2.2.0-gpu-cuda10.2-cudnn7
133+
sudo nvidia-docker pull registry.baidubce.com/paddlepaddle/paddle:2.2.0-gpu-cuda10.2-cudnn7
128134
```
129135
- Clone this repository
130136
```bash
@@ -153,10 +159,12 @@ cd PaddleSpeech
153159
```
154160
### Install the Conda
155161
```bash
156-
# download and install the miniconda
157-
pushd tools
158-
bash extras/install_miniconda.sh
159-
popd
162+
# download the miniconda
163+
wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -P tools/
164+
# install the miniconda
165+
bash tools/Miniconda3-latest-Linux-x86_64.sh -b
166+
# conda init
167+
$HOME/miniconda3/bin/conda init
160168
# use the "bash" command to make the conda environment works
161169
bash
162170
# create a conda virtual environment

‎docs/source/install_cn.md

Lines changed: 24 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
`PaddleSpeech` 有三种安装方法。根据安装的难易程度，这三种方法可以分为 **简单**, **中等** 和 **困难**.
44
| 方式 | 功能 | 支持系统 |
55
| :--- | :----------------------------------------------------------- | :------------------ |
6-
| 简单 | (1) 使用 PaddleSpeech 的命令行功能. <br> (2) 在 Aistudio上体验 PaddleSpeech. | Linux, Mac，Windows |
6+
| 简单 | (1) 使用 PaddleSpeech 的命令行功能. <br> (2) 在 Aistudio上体验 PaddleSpeech. | Linux, Mac(不支持M1芯片)，Windows |
77
| 中等 | 支持 PaddleSpeech 主要功能，比如使用已有 examples 中的模型和使用 PaddleSpeech 来训练自己的模型. | Linux |
88
| 困难 | 支持 PaddleSpeech 的各项功能，包含训练语言模型,使用强制对齐等。并且你更能成为一名开发者！ | Ubuntu |
99
## 先决条件
@@ -47,17 +47,24 @@ conda install -y -c gcc_linux-64=8.4.0 gxx_linux-64=8.4.0
4747
pip install paddlepaddle paddlespeech
4848
```
4949
## 中等： 获取主要功能（支持 Linux）
50-
如果你想要使用` paddlespeech` 的主要功能。你需要完成 4 个步骤
50+
如果你想要使用` paddlespeech` 的主要功能。你需要完成以下几个步骤
51+
### Git clone PaddleSpeech
52+
你需要先git clone本仓库
53+
```bash
54+
git clone https://github.com/PaddlePaddle/PaddleSpeech.git
55+
cd PaddleSpeech
56+
```
57+
5158
### 安装 Conda
5259
Conda 是一个包管理的环境。你可以前往 [minicoda](https://docs.conda.io/en/latest/miniconda.html) 去下载并安装 conda（请下载 py>=3.7 的版本）。你可以尝试自己安装，或者使用以下的命令：
5360
```bash
54-
# download the miniconda
55-
wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh
56-
# install the miniconda
57-
bash Miniconda3-latest-Linux-x86_64.sh -b
58-
# conda init
61+
# 下载 miniconda
62+
wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -P tools/
63+
# 安装 miniconda
64+
bash tools/Miniconda3-latest-Linux-x86_64.sh -b
65+
# conda 初始化
5966
$HOME/miniconda3/bin/conda init
60-
# activate the conda
67+
# 激活 conda
6168
bash
6269
```
6370
然后你可以创建一个 conda 的虚拟环境：
@@ -94,10 +101,8 @@ conda install -y -c gcc_linux-64=8.4.0 gxx_linux-64=8.4.0
94101
python3 -m pip install paddlepaddle-gpu==2.2.0
95102
```
96103
### 安装 PaddleSpeech
97-
你需要使用 `git clone` 的方式下载并安装 `paddlespeech`，这样你才可以使用 `paddlespeech`中已有的 examples：
104+
最后安装 `paddlespeech`，这样你就可以使用 `paddlespeech`中已有的 examples：
98105
```bash
99-
https://github.com/PaddlePaddle/PaddleSpeech.git
100-
cd PaddleSpeech
101106
pip install .
102107
```
103108
## 困难： 获取所有功能（支持 Ubuntu）
@@ -113,7 +118,7 @@ Docker 是一种开源工具，用于在和系统本身环境相隔离的环境
113118
- 下载 docker 镜像:
114119
例如，拉取 paddle2.2.0 镜像：
115120
```bash
116-
nvidia-docker pull registry.baidubce.com/paddlepaddle/paddle:2.2.0-gpu-cuda10.2-cudnn7
121+
sudo nvidia-docker pull registry.baidubce.com/paddlepaddle/paddle:2.2.0-gpu-cuda10.2-cudnn7
117122
```
118123
- 克隆 `PaddleSpeech` 仓库
119124
```bash
@@ -141,11 +146,13 @@ cd PaddleSpeech
141146
```
142147
### 安装 Conda
143148
```bash
144-
# 下载并安装 miniconda
145-
pushd tools
146-
bash extras/install_miniconda.sh
147-
popd
148-
# 使用 "bash" 命令激活Conda环境
149+
# 下载 miniconda
150+
wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -P tools/
151+
# 安装 miniconda
152+
bash tools/Miniconda3-latest-Linux-x86_64.sh -b
153+
# conda 初始化
154+
$HOME/miniconda3/bin/conda init
155+
# 激活 conda
149156
bash
150157
# 创建 Conda 虚拟环境
151158
conda create -y -p tools/venv python=3.7

0 commit comments

Comments
 (0)