目标是共同编写一套用于对话式人工智能的开源库。编写一套统一且符合我们 文档 中所述指导方针的库至关重要。
SpeechBrain 可用于研究、学术、商业和非商业目的。如果您想贡献,请记住以下特点:
简洁性: 即使是非专业程序员或语音研究人员的学生或用户,也必须容易理解代码。设计你的代码使其易于阅读。在性能水平相同的情况下,编写最简单的代码。
模块化: 编写你的代码使其模块化并与工具包的其他功能良好契合。其理念是开发一组可以自然地相互连接的模型。
效率: 代码应该尽可能高效。贡献者应最大化使用 pytorch 原生操作。
文档: 考虑到 SpeechBrain 的目标,编写丰富且良好的文档是关键一步。编写带有可运行示例的 docstring(如同 PyTorch 代码中那样)。
SpeechBrain 通过 GitHub 托管。贡献需要三个步骤:
1. 分叉、克隆 仓库 并按照 文档 中的详细说明安装我们的测试套件。
2. 编写并正确测试你的代码。使用我们的 pre-commit 测试将你的更改提交到你的分叉,以确保测试通过。然后向官方仓库提交拉取请求(pull request)。
3. 参与评审过程。每个拉取请求由一到两名评审人评审。请将他们的反馈整合到你的代码中。一旦评审人对你的拉取请求感到满意,他们会将其合并到官方代码中。
关于此过程的详细信息(即包括安装测试的步骤)在 文档 中给出。
贡献示例包括新 recipe、新模型、新外部功能、解决问题/bug。
我们要感谢以下贡献者: