diff --git a/docs/source/install.md b/docs/source/install.md index 434e95e3a..850847772 100644 --- a/docs/source/install.md +++ b/docs/source/install.md @@ -4,7 +4,7 @@ There are 3 ways to use `PaddleSpeech`. According to the degree of difficulty, t | Way | Function | Support| |:---- |:----------------------------------------------------------- |:----| -| Easy | (1) Use command-line functions of PaddleSpeech.
(2) Experience PaddleSpeech on Ai Studio. | Linux, Mac,Windows | +| Easy | (1) Use command-line functions of PaddleSpeech.
(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 | | 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 ``` ## 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 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 # 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 -bash Miniconda3-latest-Linux-x86_64.sh -b +bash tools/Miniconda3-latest-Linux-x86_64.sh -b # conda init $HOME/miniconda3/bin/conda init # 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 ``` ### 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 -https://github.com/PaddlePaddle/PaddleSpeech.git -cd PaddleSpeech +# Make sure you are in the root directory of PaddleSpeech pip install . ``` + ## Hard: Get the Full Function (Support Ubuntu) ### Prerequisites - Ubuntu >= 16.04. @@ -124,7 +130,7 @@ Take several steps to launch the Docker image: For example, pull paddle 2.2.0 image: ```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 ```bash @@ -153,10 +159,12 @@ cd PaddleSpeech ``` ### Install the Conda ```bash -# download and install the miniconda -pushd tools -bash extras/install_miniconda.sh -popd +# download the miniconda +wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -P tools/ +# install the miniconda +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 bash # create a conda virtual environment diff --git a/docs/source/install_cn.md b/docs/source/install_cn.md index 6a7a01467..3ffe371d9 100644 --- a/docs/source/install_cn.md +++ b/docs/source/install_cn.md @@ -3,7 +3,7 @@ `PaddleSpeech` 有三种安装方法。根据安装的难易程度,这三种方法可以分为 **简单**, **中等** 和 **困难**. | 方式 | 功能 | 支持系统 | | :--- | :----------------------------------------------------------- | :------------------ | -| 简单 | (1) 使用 PaddleSpeech 的命令行功能.
(2) 在 Aistudio上体验 PaddleSpeech. | Linux, Mac,Windows | +| 简单 | (1) 使用 PaddleSpeech 的命令行功能.
(2) 在 Aistudio上体验 PaddleSpeech. | Linux, Mac(不支持M1芯片),Windows | | 中等 | 支持 PaddleSpeech 主要功能,比如使用已有 examples 中的模型和使用 PaddleSpeech 来训练自己的模型. | Linux | | 困难 | 支持 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 ``` ## 中等: 获取主要功能(支持 Linux) -如果你想要使用` paddlespeech` 的主要功能。你需要完成 4 个步骤 +如果你想要使用` paddlespeech` 的主要功能。你需要完成以下几个步骤 +### Git clone PaddleSpeech +你需要先git clone本仓库 +```bash +git clone https://github.com/PaddlePaddle/PaddleSpeech.git +cd PaddleSpeech +``` + ### 安装 Conda Conda 是一个包管理的环境。你可以前往 [minicoda](https://docs.conda.io/en/latest/miniconda.html) 去下载并安装 conda(请下载 py>=3.7 的版本)。你可以尝试自己安装,或者使用以下的命令: ```bash -# download the miniconda -wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -# install the miniconda -bash Miniconda3-latest-Linux-x86_64.sh -b -# conda init +# 下载 miniconda +wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -P tools/ +# 安装 miniconda +bash tools/Miniconda3-latest-Linux-x86_64.sh -b +# conda 初始化 $HOME/miniconda3/bin/conda init -# activate the conda +# 激活 conda bash ``` 然后你可以创建一个 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 ``` ### 安装 PaddleSpeech -你需要使用 `git clone` 的方式下载并安装 `paddlespeech`,这样你才可以使用 `paddlespeech`中已有的 examples: +最后安装 `paddlespeech`,这样你就可以使用 `paddlespeech`中已有的 examples: ```bash -https://github.com/PaddlePaddle/PaddleSpeech.git -cd PaddleSpeech pip install . ``` ## 困难: 获取所有功能(支持 Ubuntu) @@ -113,7 +118,7 @@ Docker 是一种开源工具,用于在和系统本身环境相隔离的环境 - 下载 docker 镜像: 例如,拉取 paddle2.2.0 镜像: ```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` 仓库 ```bash @@ -141,11 +146,13 @@ cd PaddleSpeech ``` ### 安装 Conda ```bash -# 下载并安装 miniconda -pushd tools -bash extras/install_miniconda.sh -popd -# 使用 "bash" 命令激活Conda环境 +# 下载 miniconda +wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -P tools/ +# 安装 miniconda +bash tools/Miniconda3-latest-Linux-x86_64.sh -b +# conda 初始化 +$HOME/miniconda3/bin/conda init +# 激活 conda bash # 创建 Conda 虚拟环境 conda create -y -p tools/venv python=3.7