---

Asteroid 是一个基于 PyTorch 的音频源分离工具包， 它支持在常见数据集上快速进行实验。 该工具包包含支持多种数据集和架构的源代码， 以及用于复现一些重要论文的配方。

你正在使用 Asteroid 吗？或者想开始使用吗？

如果你发现了 bug，请提交 issue； 如果你已经修复了它，请提交 pull request！ 对于新功能也是如此——告诉我们你的需求，或者帮助我们一起实现！ 别犹豫，加入我们的 Slack 频道， 在那里也可以提问或提出新功能建议！ Asteroid 旨在成为一个__社区驱动的项目__， 快来参与进来，一起帮助我们吧！

目录

• 目录
• 安装
• 教程
• 运行配方
• 可用的配方
• 支持的数据集
• 预训练模型
• 贡献
• TensorBoard 可视化
• 指导原则
• 引用 Asteroid

安装

(↑返回目录) 要安装 Asteroid，首先克隆仓库，然后使用 conda、pip 或 python 进行安装：

# 首先克隆并进入仓库
git clone https://github.com/asteroid-team/asteroid
cd asteroid

• 使用 pip

# 以可编辑模式使用 pip 安装
pip install -e .
# 或者，使用 python 以开发模式安装
# python setup.py develop

• 使用 conda（如果你还没有安装 conda，可以参考 这里。）

conda env create -f environment.yml
conda activate asteroid

• Asteroid 也发布在 PyPI 上，你可以通过以下命令安装最新版本：

pip install asteroid

教程

(↑返回目录) 以下是展示 Asteroid 功能使用示例的笔记本列表。

• Asteroid 入门
• 简介与概览
• 滤波器组 API
• 排列不变损失包装器 PITLossWrapper
• 处理大型 WAV 文件

运行配方

(↑返回目录) 大多数情况下，运行配方需要额外的依赖包， 我们建议执行以下命令来安装这些依赖：

# 从 asteroid/ 目录下
pip install -r requirements.txt

然后选择你想运行的配方并执行即可！

cd egs/wham/ConvTasNet
. ./run.sh

更多详细信息请参阅 egs/README.md。

可用的配方

(↑返回目录)

• ConvTasnet (Luo 等人)
• Tasnet (Luo 等人)
• 深度聚类 (Hershey 等人 和 Isik 等人)
• Chimera ++ (Luo 等人 和 Wang 等人)
• DualPathRNN (Luo 等人)
• 两步学习 (Tzinis 等人)
• SudoRMRFNet (Tzinis 等人)
• DPTNet (Chen 等人)
• DCCRNet (Hu 等人)
• DCUNet (Choi 等人)
• CrossNet-Open-Unmix (Sawata 等人)
• 多解码器 DPRNN (Zhu 等人)
• Open-Unmix（即将推出）(Stöter 等人)
• Wavesplit（即将推出）(Zeghidour 等人)

支持的数据集

(↑返回目录)

• WSJ0-2mix / WSJ03mix (Hershey 等人)
• WHAM (Wichern 等人)
• WHAMR (Maciejewski 等人)
• LibriMix (Cosentino 等人)
• Microsoft DNS 挑战 (Chandan 等人)
• SMS_WSJ (Drude 等人)
• MUSDB18 (Raffi 等人)
• FUSS (Wisdom 等人)
• AVSpeech (Ephrat 等人)
• Kinect-WSJ (Sivasankaran 等人)

预训练模型

(↑返回目录) 详情请参见 此处

贡献

(↑返回目录) 我们始终致力于扩展对声源分离和语音增强研究的覆盖范围，以下是目前我们尚未涵盖的内容列表。 你想贡献吗？这里是一个很好的起点！

• Wavesplit (Zeghidour 和 Grangier)
• FurcaNeXt (Shi 等人)
• DeepCASA (Liu 和 Want)
• VCTK 测试集，来自 Kadioglu 等人
• 中断式和级联式 PIT (Yang 等人)
• 一致性约束 (Wisdom 等人)
• 可微分的 STOI 和 PESQ。
• 来自 Tukuljac 等人 的参数化滤波器组
• 端到端 MISI (Wang 等人)

别忘了阅读我们的贡献指南。

你也可以提交一个问题或拉取请求，以添加本列表中遗漏的内容。

TensorBoard 可视化

所有配方的默认日志记录器都是 TensorBoard。从配方文件夹中，你可以运行以下命令来可视化所有实验的日志。你还可以通过从数据集目录运行类似的命令，在同一数据集上比较不同的系统。

# 启动 TensorBoard（默认端口为 6006）
tensorboard --logdir exp/ --port tf_port

如果你在远程启动 TensorBoard，应该打开一个 SSH 隧道：

# 打开端口转发连接。使用 -Nf 选项以避免打开远程会话。
ssh -L local_port:localhost:tf_port user@ip

然后打开 http://localhost:local_port/。如果两个端口相同，你也可以直接点击远程提供的 TensorBoard URL，这样更方便。

指导原则

(↑返回目录)

• 模块化。 构建模块经过精心设计，可以无缝地组合在一起。滤波器组、编码器、掩码器、解码器和损失函数都是常见的构建模块，可以灵活组合以创建新的系统。
• 可扩展性。 使用 Asteroid 添加新功能非常简单。可以轻松添加新的滤波器组、分离架构、数据集，甚至配方。
• 可重复性。 配方提供了一种简便的方式，通过一个脚本即可完成数据准备、系统设计、训练和评估，从而轻松复现结果。这对社区来说是一项至关重要的工具！

引用 Asteroid

(↑返回目录) 如果你喜欢使用 Asteroid 并希望引用我们，请使用以下格式：

@inproceedings{Pariente2020Asteroid,
    title={Asteroid：基于 PyTorch 的音频声源分离工具包，专为研究人员设计},
    author={Manuel Pariente、Samuele Cornell、Joris Cosentino、Sunit Sivasankaran、Efthymios Tzinis、Jens Heitkaemper、Michel Olvera、Fabian-Robert Stöter、Mathieu Hu、Juan M. Martín-Doñas、David Ditter、Ariel Frank、Antoine Deleforge 和 Emmanuel Vincent},
    year={2020},
    booktitle={Interspeech 会议论文集},
}

Asteroid 快速上手指南

Asteroid 是一个基于 PyTorch 的音频源分离工具包，专为研究人员设计，支持多种数据集和架构，旨在实现快速的实验复现。

环境准备

在开始之前，请确保您的系统满足以下要求：

• 操作系统: Linux, macOS 或 Windows
• Python: 3.7 及以上版本
• 核心依赖: PyTorch (建议安装与您的 CUDA 版本匹配的 PyTorch)
• 包管理工具: 推荐使用 conda 或 pip

国内加速建议： 如果您在中国大陆，建议在安装依赖时配置国内镜像源以加速下载。

• Conda: 使用清华源或中科大源。
• Pip: 使用阿里云、清华或腾讯源 (例如：pip install -i https://pypi.tuna.tsinghua.edu.cn/simple ...)。

安装步骤

您可以选择以下任意一种方式进行安装：

方法一：通过 PyPI 安装（推荐，适合直接使用）

这是获取最新稳定 release 版本的最快方式。

pip install asteroid
# 国内用户建议使用：
# pip install -i https://pypi.tuna.tsinghua.edu.cn/simple asteroid

方法二：源码安装（适合开发或修改代码）

如果您需要修改源码或运行官方提供的完整实验脚本（recipes），建议克隆仓库并安装。

# 1. 克隆仓库
git clone https://github.com/asteroid-team/asteroid
cd asteroid

# 2. 安装依赖 (运行 recipes 通常需要额外依赖)
pip install -r requirements.txt
# 国内用户建议使用：
# pip install -i https://pypi.tuna.tsinghua.edu.cn/simple -r requirements.txt

# 3. 以可编辑模式安装 asteroid
pip install -e .

方法三：使用 Conda 环境

如果您希望隔离环境，可以使用项目提供的 environment.yml 文件。

# 创建并激活环境
conda env create -f environment.yml
conda activate asteroid

基本使用

Asteroid 的核心功能包括加载预训练模型、处理音频文件以及运行完整的训练脚本。

1. 使用预训练模型进行分离

这是最简单的使用场景。您可以直接加载官方提供的预训练模型对音频进行源分离。

import torch
from asteroid.models import ConvTasNet

# 加载预训练模型 (例如：在 WHAM 数据集上训练的 ConvTasNet)
model = ConvTasNet.from_pretrained("ConvTasNet_WHAM!_separate_all")

# 准备输入音频 (假设 mix 是一个形状为 [batch, time] 的 Tensor)
# 这里仅作示例，实际使用时需加载真实的 wav 文件
mix = torch.randn(1, 16000) 

# 执行分离
with torch.no_grad():
    separated_sources = model(mix)

# separated_sources 的形状通常为 [batch, num_sources, time]
print(separated_sources.shape)

2. 运行官方实验脚本 (Recipes)

Asteroid 提供了大量复现经典论文的脚本（位于 egs/ 目录）。以下以运行 WHAM 数据集上的 ConvTasNet 为例：

# 进入对应的实验目录
cd egs/wham/ConvTasNet

# 运行脚本 (请确保已执行过 'pip install -r requirements.txt')
. ./run.sh

运行后，脚本将自动处理数据准备、模型训练和评估，并使用 TensorBoard 记录日志。

3. 查看训练日志

所有实验默认使用 TensorBoard 记录。在实验目录下运行以下命令即可可视化训练过程：

# 启动 TensorBoard (默认端口 6006)
tensorboard --logdir exp/

如果是远程服务器，请通过 SSH 隧道转发端口：

ssh -L 6006:localhost:6006 user@your_server_ip

然后在本地浏览器访问 http://localhost:6006。