# 在 Hugging Face 上使用 Asteroid

`asteroid` 是一个用于音频源分离的 PyTorch 工具包。它支持大量数据集和配方，以便快速在常见数据集上进行实验并复现论文。

## 在 Hub 中探索 Asteroid

您可以在[模型页面](https://huggingface.co/models?filter=asteroid)左侧通过筛选找到`asteroid`模型。

Hub 上的所有模型都具备以下功能：
1. 自动生成的模型卡片，包含描述、训练配置、指标等内容。
2. 有助于提高可发现性并包含许可证和数据集等信息的元数据标签。
3. 一个交互式小部件，可直接在浏览器中用于体验该模型。
4. 一个用于发起推理请求的 Inference Providers 小部件。

## 使用现有模型

如需了解加载预训练模型的完整指南，我们建议查阅[官方指南](https://github.com/asteroid-team/asteroid/blob/master/docs/source/readmes/pretrained_models.md)。

所有模型类（`BaseModel`、`ConvTasNet` 等）都有一个 `from_pretrained` 方法，允许你从 Hub 加载模型。

```py
from asteroid.models import ConvTasNet
model = ConvTasNet.from_pretrained('mpariente/ConvTasNet_WHAM_sepclean')
```

如果你想了解如何加载特定模型，可以单击 `Use in Adapter Transformers`，你将获得一个可运行的代码片段来加载该模型！

## 共享您的模型

目前，还没有自动将模型上传到 Hub 的方法，但上传流程已在[官方指南](https://github.com/asteroid-team/asteroid/blob/master/docs/source/readmes/pretrained_models.md#share-your-models)中进行了说明。

所有配方都会创建将模型上传到 Hub 所需的全部文件。该流程通常包含以下步骤：
1. 创建并克隆模型仓库。
2. 将文件从配方输出移动到仓库（模型卡片、模型文件、TensorBoard 跟踪记录）。
3. 推送文件（`git add` + `git commit` + `git push`）。

完成此操作后，您可以直接在浏览器中试用您的模型，并与社区其他成员分享。

## 其他资源

* Asteroid [网站](https://asteroid-team.github.io/)。
* Asteroid [库](https://github.com/asteroid-team/asteroid)。
* 集成 [文档](https://github.com/asteroid-team/asteroid/blob/master/docs/source/readmes/pretrained_models.md)。