快速安装

SpeechBrain 正在不断发展。新的功能、教程和文档将陆续出现。SpeechBrain 可以通过 PyPI 安装以快速使用标准库。此外，本地安装可用于运行实验以及修改/自定义工具包及其 recipes。

SpeechBrain 同时支持 CPU 和 GPU 计算。然而，对于大多数 recipes 来说，训练期间需要 GPU。请注意，使用 GPU 必须正确安装 CUDA。

我们支持 PyTorch 1.9+ 和 Python 3.8-3.12（如果 PyTorch 支持，比此处列出的更新的 Python 版本也可能工作）。我们建议你升级到至少 3.9+，因为对 3.8 的支持最终将被移除。

通过 PyPI 安装

创建 Python 环境后（参见下文说明），你只需输入

pip install speechbrain

根据你的操作系统，音频加载可能需要安装可选的 torchaudio 依赖才能工作。如果开箱即用无法工作，请访问音频故障排除。

然后你就可以通过以下方式访问 SpeechBrain

import speechbrain as sb

创建 Python 环境后（参见下文说明），你只需输入

git clone https://github.com/speechbrain/speechbrain.git
cd speechbrain
pip install -r requirements.txt
pip install --editable .

然后你就可以通过以下方式访问 SpeechBrain

import speechbrain as sb

对 speechbrain 包进行的任何修改都将自动生效，因为我们使用 --editable 标志进行了安装。

请在主文件夹中运行以下脚本，以确保你的安装正常工作

pytest tests

如果你有 GPU，可以使用 pytest tests --device='cuda' 运行测试

你可以使用以下命令运行 doctests

tests/.run-doctests.sh

SpeechBrain 支持基于 Linux 的发行版和 macOS。Windows 用户可以在此 GitHub issue 中找到解决方案。

一个好的实践是为你的不同工具和工具包设置不同的 Python 环境，这样它们就不会相互干扰。这可以使用 Anaconda 或 venv 来完成。

只需按照本教程即可安装 Anaconda。实际上，只需下载安装脚本并执行即可。

安装 Conda 后，你可以使用以下命令创建一个新环境

conda create --name speechbrain python=3.11

然后，使用以下命令激活它

conda activate speechbrain

现在，你可以安装所有需要的包了！

有关使用 Anaconda 管理环境的更多信息，请参见文档。

venv 更简单。创建你的环境使用

python3 -m venv /path/to/new/virtual/speechbrain

并使用以下命令激活它

source /path/to/new/virtual/speechbrain/bin/activate

现在，你可以安装所有需要的包了！

由于 SpeechBrain 仅依赖 PyTorch，其 GPU 使用方式也与 PyTorch 关联。因此，如果 PyTorch 能检测到你的 GPU，SpeechBrain 也能。可以调用 torch 包中的许多函数来验证是否检测到你的 GPU

import torch

torch.cuda.is_available()
torch.cuda.current_device()
torch.cuda.device(0)
torch.cuda.device_count()
torch.cuda.get_device_name(0)