msb-public
/
PaddleSpeech
mirror of https://github.com/PaddlePaddle/PaddleSpeech
1
0
Code Issues Projects Releases Wiki Activity

reviset the install.md (#1165)

Browse Source
pull/1167/head
Jackwaterveg 3 years ago committed by GitHub
parent 879857332d
commit b9982f5810
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 44 additions and 29 deletions
Show Stats Download Patch File Download Diff File

32
docs/source/install.md
Unescape View File

@ -4,7 +4,7 @@ There are 3 ways to use `PaddleSpeech`. According to the degree of difficulty, t
| Way | Function | Support| | Way | Function | Support|
|:---- |:----------------------------------------------------------- |:----| |:---- |:----------------------------------------------------------- |:----|
| Easy | (1) Use command-line functions of PaddleSpeech. <br> (2) Experience PaddleSpeech on Ai Studio. | Linux, Mac，Windows | | Easy | (1) Use command-line functions of PaddleSpeech. <br> (2) Experience PaddleSpeech on Ai Studio. | Linux, Mac(not support M1 chip)，Windows |
| Medium | Support major functions ，such as using the` ready-made `examples and using PaddleSpeech to train your model. | Linux | | Medium | Support major functions ，such as using the` ready-made `examples and using PaddleSpeech to train your model. | Linux |
| 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 | | 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 |
@ -52,15 +52,21 @@ You can use the following command:
pip install paddlepaddle paddlespeech pip install paddlepaddle paddlespeech
``` ```
## Medium: Get the Major Functions (Support Linux) ## Medium: Get the Major Functions (Support Linux)
If you want to get the major function of `paddlespeech`. There are 4 steps you need to do. If you want to get the major function of `paddlespeech`, you need to do following steps:
### Git clone PaddleSpeech
You need to `git clone` this repository at first.
```bash
git clone https://github.com/PaddlePaddle/PaddleSpeech.git
cd PaddleSpeech
```
### Install Conda ### Install Conda
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: 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:
```bash ```bash
# download the miniconda # download the miniconda
wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -P tools/
# install the miniconda # install the miniconda
bash Miniconda3-latest-Linux-x86_64.sh -b bash tools/Miniconda3-latest-Linux-x86_64.sh -b
# conda init # conda init
$HOME/miniconda3/bin/conda init $HOME/miniconda3/bin/conda init
# activate the conda # activate the conda
@ -102,12 +108,12 @@ You can choose the `PaddlePaddle` version based on your system. For example, for
python3 -m pip install paddlepaddle-gpu==2.2.0 python3 -m pip install paddlepaddle-gpu==2.2.0
``` ```
### Install PaddleSpeech ### Install PaddleSpeech
You need to `git clone` this repository and install `paddlespeech` by the following commands，then you can use the `ready-made` examples in `paddlespeech` : You can install `paddlespeech` by the following command，then you can use the `ready-made` examples in `paddlespeech` :
```bash ```bash
https://github.com/PaddlePaddle/PaddleSpeech.git # Make sure you are in the root directory of PaddleSpeech
cd PaddleSpeech
pip install . pip install .
``` ```
## Hard: Get the Full Function (Support Ubuntu) ## Hard: Get the Full Function (Support Ubuntu)
### Prerequisites ### Prerequisites
- Ubuntu >= 16.04. - Ubuntu >= 16.04.
@ -124,7 +130,7 @@ Take several steps to launch the Docker image:
For example, pull paddle 2.2.0 image: For example, pull paddle 2.2.0 image:
```bash ```bash
nvidia-docker pull registry.baidubce.com/paddlepaddle/paddle:2.2.0-gpu-cuda10.2-cudnn7 sudo nvidia-docker pull registry.baidubce.com/paddlepaddle/paddle:2.2.0-gpu-cuda10.2-cudnn7
``` ```
- Clone this repository - Clone this repository
```bash ```bash
@ -153,10 +159,12 @@ cd PaddleSpeech
``` ```
### Install the Conda ### Install the Conda
```bash ```bash
# download and install the miniconda # download the miniconda
pushd tools wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -P tools/
bash extras/install_miniconda.sh # install the miniconda
popd bash tools/Miniconda3-latest-Linux-x86_64.sh -b
# conda init
$HOME/miniconda3/bin/conda init
# use the "bash" command to make the conda environment works # use the "bash" command to make the conda environment works
bash bash
# create a conda virtual environment # create a conda virtual environment

41
docs/source/install_cn.md
Unescape View File

@ -3,7 +3,7 @@
`PaddleSpeech` 有三种安装方法。根据安装的难易程度，这三种方法可以分为 **简单**, **中等** 和 **困难**. `PaddleSpeech` 有三种安装方法。根据安装的难易程度，这三种方法可以分为 **简单**, **中等** 和 **困难**.
| 方式 | 功能 | 支持系统 | | 方式 | 功能 | 支持系统 |
| :--- | :----------------------------------------------------------- | :------------------ | | :--- | :----------------------------------------------------------- | :------------------ |
| 简单 | (1) 使用 PaddleSpeech 的命令行功能. <br> (2) 在 Aistudio上体验 PaddleSpeech. | Linux, Mac，Windows | | 简单 | (1) 使用 PaddleSpeech 的命令行功能. <br> (2) 在 Aistudio上体验 PaddleSpeech. | Linux, Mac(不支持M1芯片)，Windows |
| 中等 | 支持 PaddleSpeech 主要功能，比如使用已有 examples 中的模型和使用 PaddleSpeech 来训练自己的模型. | Linux | | 中等 | 支持 PaddleSpeech 主要功能，比如使用已有 examples 中的模型和使用 PaddleSpeech 来训练自己的模型. | Linux |
| 困难 | 支持 PaddleSpeech 的各项功能，包含训练语言模型,使用强制对齐等。并且你更能成为一名开发者！ | Ubuntu | | 困难 | 支持 PaddleSpeech 的各项功能，包含训练语言模型,使用强制对齐等。并且你更能成为一名开发者！ | Ubuntu |
## 先决条件 ## 先决条件
@ -47,17 +47,24 @@ conda install -y -c gcc_linux-64=8.4.0 gxx_linux-64=8.4.0
pip install paddlepaddle paddlespeech pip install paddlepaddle paddlespeech
``` ```
## 中等： 获取主要功能（支持 Linux） ## 中等： 获取主要功能（支持 Linux）
如果你想要使用` paddlespeech` 的主要功能。你需要完成 4 个步骤 如果你想要使用` paddlespeech` 的主要功能。你需要完成以下几个步骤
### Git clone PaddleSpeech
你需要先git clone本仓库
```bash
git clone https://github.com/PaddlePaddle/PaddleSpeech.git
cd PaddleSpeech
```
### 安装 Conda ### 安装 Conda
Conda 是一个包管理的环境。你可以前往 [minicoda](https://docs.conda.io/en/latest/miniconda.html) 去下载并安装 conda（请下载 py>=3.7 的版本）。你可以尝试自己安装，或者使用以下的命令： Conda 是一个包管理的环境。你可以前往 [minicoda](https://docs.conda.io/en/latest/miniconda.html) 去下载并安装 conda（请下载 py>=3.7 的版本）。你可以尝试自己安装，或者使用以下的命令：
```bash ```bash
# download the miniconda # 下载 miniconda
wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -P tools/
# install the miniconda # 安装 miniconda
bash Miniconda3-latest-Linux-x86_64.sh -b bash tools/Miniconda3-latest-Linux-x86_64.sh -b
# conda init # conda 初始化
$HOME/miniconda3/bin/conda init $HOME/miniconda3/bin/conda init
# activate the conda # 激活 conda
bash bash
``` ```
然后你可以创建一个 conda 的虚拟环境： 然后你可以创建一个 conda 的虚拟环境：
@ -94,10 +101,8 @@ conda install -y -c gcc_linux-64=8.4.0 gxx_linux-64=8.4.0
python3 -m pip install paddlepaddle-gpu==2.2.0 python3 -m pip install paddlepaddle-gpu==2.2.0
``` ```
### 安装 PaddleSpeech ### 安装 PaddleSpeech
你需要使用 `git clone` 的方式下载并安装 `paddlespeech`，这样你才可以使用 `paddlespeech`中已有的 examples： 最后安装 `paddlespeech`，这样你就可以使用 `paddlespeech`中已有的 examples：
```bash ```bash
https://github.com/PaddlePaddle/PaddleSpeech.git
cd PaddleSpeech
pip install . pip install .
``` ```
## 困难： 获取所有功能（支持 Ubuntu） ## 困难： 获取所有功能（支持 Ubuntu）
@ -113,7 +118,7 @@ Docker 是一种开源工具，用于在和系统本身环境相隔离的环境
- 下载 docker 镜像: - 下载 docker 镜像:
例如，拉取 paddle2.2.0 镜像： 例如，拉取 paddle2.2.0 镜像：
```bash ```bash
nvidia-docker pull registry.baidubce.com/paddlepaddle/paddle:2.2.0-gpu-cuda10.2-cudnn7 sudo nvidia-docker pull registry.baidubce.com/paddlepaddle/paddle:2.2.0-gpu-cuda10.2-cudnn7
``` ```
- 克隆 `PaddleSpeech` 仓库 - 克隆 `PaddleSpeech` 仓库
```bash ```bash
@ -141,11 +146,13 @@ cd PaddleSpeech
``` ```
### 安装 Conda ### 安装 Conda
```bash ```bash
# 下载并安装 miniconda # 下载 miniconda
pushd tools wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -P tools/
bash extras/install_miniconda.sh # 安装 miniconda
popd bash tools/Miniconda3-latest-Linux-x86_64.sh -b
# 使用 "bash" 命令激活Conda环境 # conda 初始化
$HOME/miniconda3/bin/conda init
# 激活 conda
bash bash
# 创建 Conda 虚拟环境 # 创建 Conda 虚拟环境
conda create -y -p tools/venv python=3.7 conda create -y -p tools/venv python=3.7

Write Preview
Loading…
Cancel
Save