(简体中文|English)

安装

有三种使用 PaddleSpeech 的方法。根据难度的程度,这三种方法可以分为 简单中等困难。你可以选择三种方式之一来安装 PaddleSpeech

方式

函数

支持

简单

(1) 使用 PaddleSpeech 的命令行功能。
(2) 在 Ai Studio 上体验 PaddleSpeech。

Linux, Mac(不支持 M1 芯片),Windows(有关安装的更多信息,请参见 #1195

中级

支持主要功能,例如使用现成的示例和使用PaddleSpeech来训练您的模型。

Linux,Mac(不支持M1芯片,不支持训练模型),Windows(不支持训练模型)

困难

支持Paddlespeech的全部功能,包括使用连接CTC解码器与kaldi(asr2), 训练n-gram语言模型,Montreal-Forced-Aligner等。您更加能够成为一名开发者!

Ubuntu

先决条件

  • Python >= 3.7

  • PaddlePaddle 最新版本(请参考 安装指南

  • C++ 编译环境

  • 提示:对于Linux和Mac,请在安装文档中不要使用命令sh,而是使用命令bash

  • 提示:我们建议您从 paddlepaddle 安装,网址:https://mirror.baidu.com/pypi/simple,并从 paddlespeech 安装,网址:https://pypi.tuna.tsinghua.edu.cn/simple。

简单:获取基本功能(支持Linux、Mac和Windows)

  • 如果你是PaddleSpeech的新手,想要轻松体验而不需要使用自己的机器。我们推荐你使用AI Studio进行体验。这里有一个关于PaddleSpeech的逐步教程,你可以在免费机器上使用PaddleSpeech的基本功能。

  • 如果您想使用Paddlespeech的命令行功能,您需要完成以下步骤来安装 PaddleSpeech。有关如何使用命令行功能的更多信息,您可以查看 cli

安装 Conda

Conda是一个环境管理系统。您可以访问 minicoda (选择版本 py>=3.7)以下载和安装conda。 然后为 paddlespeech 安装conda依赖项:

conda install -y -c conda-forge sox libsndfile bzip2

安装 C++ 编译环境

(如果您已经有了C++编译环境,您可以跳过此步骤。)

Windows

您需要安装 Visual Studio 来创建C++编译环境。

https://visualstudio.microsoft.com/visual-cpp-build-tools/

你也可以查看 #1195 获取更多帮助。

Mac

brew install gcc

Linux

#  centos
sudo yum install gcc gcc-c++
# ubuntu
sudo apt install build-essential
# Others
conda install -y -c gcc_linux-64=8.4.0 gxx_linux-64=8.4.0

安装 PaddleSpeech

某些用户可能由于默认下载源无法安装 kaldiio,您可以先安装 pytest-runner

pip install pytest-runner -i https://pypi.tuna.tsinghua.edu.cn/simple

然后你可以使用以下命令:

pip install paddlepaddle -i https://mirror.baidu.com/pypi/simple
pip install paddlespeech -i https://pypi.tuna.tsinghua.edu.cn/simple

您还可以指定paddlepaddle的版本或安装开发版本。

# install 2.4.1 version. Note, 2.4.1 is just an example, please follow the minimum dependency of paddlepaddle for your selection
pip install paddlepaddle==2.4.1 -i https://mirror.baidu.com/pypi/simple
# install develop version
pip install paddlepaddle==0.0.0 -f https://www.paddlepaddle.org.cn/whl/linux/cpu-mkl/develop.html

如果在使用 paddlespeech 时遇到下载 nltk_data 的问题,可能是由于您的网络不佳,我们建议您下载由我们提供的 nltk_data,并将其解压到您的 ${HOME}

如果您未能安装paddlespeech-ctcdecoders,您只能无法使用deepspeech2模型推理。对于其他模型,没关系。

中级:获取主要功能(支持Linux,mac,Windows不支持训练)

如果您想获取 paddlespeech 的主要功能,您需要执行以下步骤:

克隆PaddleSpeech

您需要首先 git clone 这个仓库。

git clone https://github.com/PaddlePaddle/PaddleSpeech.git
cd PaddleSpeech

安装 Conda

Conda是一个环境管理系统。您可以去 minicoda 选择一个版本 (py>=3.7)。对于Windows,您可以按照安装指南逐步进行,对于Linux和Mac,您可以使用以下命令:

# 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
# activate the conda
bash

然后您可以使用以下命令创建一个conda虚拟环境:

conda create -y -p tools/venv python=3.8

激活conda虚拟环境:

conda activate tools/venv

安装 paddlespeech 的 conda 依赖:

conda install -y -c conda-forge sox libsndfile swig bzip2

安装 C++ 编译环境

(如果您已经拥有C++编译环境,可以跳过此步骤。) 不要忘记在您的系统上安装 gccgxx。 您可以选择使用以下脚本进行安装。

#  centos
sudo yum install gcc gcc-c++
# ubuntu
sudo apt install build-essential
# Others
conda install -y -c gcc_linux-64=8.4.0 gxx_linux-64=8.4.0

(臀部:如果您想通过方式安装,请不要使用最后一个脚本):

安装 PaddlePaddle

您可以根据您的系统选择 PaddlePaddle 版本。例如,对于 CUDA 10.2,CuDNN7.6 安装 paddlepaddle-gpu 2.4.1:

# Note, 2.4.1 is just an example, please follow the minimum dependency of paddlepaddle for your selection
python3 -m pip install paddlepaddle-gpu==2.4.1 -i https://mirror.baidu.com/pypi/simple

您还可以安装paddlepaddle的开发版本。例如,对于CUDA 10.2,CuDNN7.6,请安装paddlepaddle-gpu开发版:

python3 -m pip install paddlepaddle-gpu==0.0.0.post102 -f https://www.paddlepaddle.org.cn/whl/linux/gpu/develop.html

安装 PaddleSpeech

您可以通过以下命令安装 paddlespeech,然后您可以在 paddlespeech 中使用现成的示例:

# Some users may fail to install `kaldiio` due to the default download source, you can install `pytest-runner` at first;
pip install pytest-runner -i https://pypi.tuna.tsinghua.edu.cn/simple
# Make sure you are in the root directory of PaddleSpeech
pip install . -i https://pypi.tuna.tsinghua.edu.cn/simple

困难: 获取完整功能 (支持Ubuntu)

前提条件

  • Ubuntu >= 16.04.

  • 选择 1:使用 Ubuntu Docker 容器。

  • 选择 2:在 Ubuntu 上以 root 权限工作。

为了避免环境设置的麻烦,强烈建议在Docker容器中运行。否则,如果你在拥有root权限的Ubuntu上工作,你仍然可以完成安装。

选择 1:在 Docker 容器中运行(推荐)

Docker是一个开源工具,用于在隔离环境中构建、运输和运行分布式应用程序。如果您没有Docker环境,请参考Docker。如果您将使用GPU版本,您还需要安装nvidia-docker

我们提供包含最新PaddleSpeech代码的docker镜像,所有环境和包依赖都预先安装好。您需要做的就是拉取并运行docker镜像。然后,您可以在没有任何额外步骤的情况下享受PaddleSpeech。

docker hub获取这些镜像和指南,包括CPU、GPU、ROCm环境版本。

如果您对自动构建docker镜像有一些定制化的要求,可以在github仓库 PaddlePaddle/PaddleCloud 中获取。

选择 2: 在具有 root 权限的 Ubuntu 中运行

  • 通过 apt 安装 build-essential

sudo apt install build-essential
  • 克隆这个仓库

git clone https://github.com/PaddlePaddle/PaddleSpeech.git
# Enter the PaddleSpeech dir
cd PaddleSpeech

安装Conda

# 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
conda create -y -p tools/venv python=3.8
# Activate the conda virtual environment:
conda activate tools/venv
# Install the conda packages
conda install -y -c conda-forge sox libsndfile swig bzip2 libflac bc

安装 PaddlePaddle

确保您拥有GPU,并且paddlepaddle版本正确。例如,对于CUDA 10.2,CuDNN7.6安装paddle 2.4.1:

# Note, 2.4 is just an example, please follow the minimum dependency of paddlepaddle for your selection
python3 -m pip install paddlepaddle-gpu==2.4.1 -i https://mirror.baidu.com/pypi/simple

您还可以安装paddlepaddle的开发版本。例如,对于CUDA 10.2,CuDNN7.6,请安装paddlepaddle-gpu开发版:

python3 -m pip install paddlepaddle-gpu==0.0.0.post102 -f https://www.paddlepaddle.org.cn/whl/linux/gpu/develop.html

以开发模式安装PaddleSpeech

一些用户可能由于默认下载源无法安装 kaldiio,您可以先安装 pytest-runner

pip install pytest-runner -i https://pypi.tuna.tsinghua.edu.cn/simple

然后安装 PaddleSpeech:

pip install -e .[develop] -i https://pypi.tuna.tsinghua.edu.cn/simple

安装Kaldi(可选)

pushd tools
bash extras/install_openblas.sh
bash extras/install_kaldi.sh
popd