Skip to content

Commit 231fd3f

Browse files
pplantingapplantinga
committed
Merge branch 'develop' into marksmayo-develop
2 parents ead6ab3 + c23d1e9 commit 231fd3f

666 files changed

Lines changed: 61312 additions & 20481 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/ISSUE_TEMPLATE/bug_report.yaml‎

Lines changed: 25 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,29 @@
11
name: 🪲 Bug Report
22
description: Something went wrong? Let us know! 🐣
3-
title: "[Bug]: "
43
labels: ["bug"]
54
body:
65
- type: markdown
76
attributes:
87
value: |
9-
Before submitting a bug, please make sure the issue hasn't been already addressed by searching through the existing and past issues.
8+
**Before submitting a bug report, please read the following instructions:**
9+
10+
- Make sure the issue hasn't already been addressed by searching through existing and past issues.
11+
- Use a clear and concise title for your bug report.
12+
- Fill out all relevant sections below to help us understand and reproduce the issue.
1013
1114
- type: textarea
1215
id: describe-the-bug
1316
attributes:
1417
label: Describe the bug
15-
description: Short and clear description of what the bug is.
18+
description: Provide a clear and concise description of the bug.
1619
validations:
1720
required: True
1821

1922
- type: textarea
2023
id: expected-behaviour
2124
attributes:
2225
label: Expected behaviour
23-
description: A description of what you expected to happen.
26+
description: Describe what you expected to happen.
2427
validations:
2528
required: True
2629

@@ -29,35 +32,45 @@ body:
2932
attributes:
3033
label: To Reproduce
3134
description: |
32-
If relevant, add a minimal example so that we can reproduce the error by running the code. It is very important for the snippet to be as minimal as possible. We will copy-paste your code, and we expect to get the same result as you did: avoid any external data, and include the relevant imports.
35+
If relevant, add a minimal example or detailed steps to reproduce the error. You can share code directly using Google Colab:
36+
1. Visit [Google Colab](https://colab.research.google.com/).
37+
2. Create a new notebook.
38+
3. Paste your code into the notebook.
39+
4. Share the notebook by clicking on "Share" in the top-right corner.
40+
5. Share the notebook's link here.
41+
42+
In the worst case, provide detailed steps to reproduce the behavior.
43+
3344
placeholder: "```python #your code ``` \n ```yaml #your yaml code ```"
3445
validations:
3546
required: False
3647

3748
- type: textarea
3849
id: versions
3950
attributes:
40-
label: Versions
41-
description: "Please tell us more about your current SpeechBrain version and/or git hash (if installed via cloning+editable install). You can also add other setup information that might be relevant."
51+
label: Environment Details
52+
description: Provide information about your SpeechBrain version, setup, and any other relevant environment details.
4253
validations:
4354
required: False
4455

4556
- type: textarea
4657
id: logs
4758
attributes:
48-
label: Relevant log output
49-
description: Please copy and paste any relevant log output.
59+
label: Relevant Log Output
60+
description: Copy and paste any relevant log output here.
5061
render: shell
62+
validations:
63+
required: False
5164

5265
- type: textarea
5366
id: add-context
5467
attributes:
55-
label: Additional context
56-
description: "Add any other context about the problem here."
68+
label: Additional Context
69+
description: Share any other context about the problem or your environment that may help in troubleshooting.
5770
validations:
5871
required: False
5972

6073
- type: markdown
6174
attributes:
6275
value: |
63-
Thanks for contributing to SpeechBrain!
76+
**Thank you for contributing to SpeechBrain!** Your bug report helps us improve the project's reliability.

‎.github/pull_request_template.md‎

Lines changed: 38 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,45 @@
1-
# Contribution in a nutshell
2-
Hey, this could help our community 🌱
1+
## What does this PR do?
32

4-
# Scope
5-
* [ ] I want to get done ...
6-
* [ ] ... and hope to also achieve ...
3+
<!--
4+
Please include a summary of the change and which issue is fixed.
5+
Please also include relevant motivation and context.
6+
List any dependencies that are required for this change.
77
8-
# Notes for reviewing (optional)
9-
This change has these implication which might need attention over here; —how should we tackle this?
8+
-->
109

11-
# Pre-review
12-
* [ ] (if applicable) add an `extra_requirements.txt` file
13-
* [ ] (if applicable) add database preparation scripts & use symlinks for nested folders (to the level of task READMEs)
14-
* [ ] (if applicable) add a recipe test entry in the depending CSV file under: tests/recipes
15-
* [ ] create a fresh testing environment (install SpeechBrain from cloned repo branch of this PR)
16-
* [ ] (if applicable) run a recipe test for each yaml/your recipe dataset
17-
* [ ] check function comments: are there docstrings w/ arguments & returns? If you're not the verbose type, put a comment every three lines of code (better: every line)
18-
* [ ] use CI locally: `pre-commit run -a` to check linters; run `pytest tests/consistency`
19-
* [ ] (optional) run `tests/.run-doctests.sh` & `tests/.run-unittests.sh`
20-
* [ ] exhausted patience before clicking « Ready for review » in the merge box 🍄
10+
Fixes #<issue_number>
2111

22-
---
12+
<!-- Does your PR introduce any breaking changes? If yes, please list them. -->
2313

24-
Note: when merged, we desire to include your PR title in our contributions list, check out one of our past version releases
25-
—https://github.com/speechbrain/speechbrain/releases/tag/v0.5.14
14+
<details>
15+
<summary><b>Before submitting</b></summary>
2616

27-
Tip: below, on the « Create Pull Request » use the drop-down to select: « Create Draft Pull Request » – your PR will be in draft mode until you declare it « Ready for review »
17+
- [ ] Did you read the [contributor guideline](https://speechbrain.readthedocs.io/en/latest/contributing.html)?
18+
- [ ] Did you make sure your **PR does only one thing**, instead of bundling different changes together?
19+
- [ ] Did you make sure to **update the documentation** with your changes? (if necessary)
20+
- [ ] Did you write any **new necessary tests**? (not for typos and docs)
21+
- [ ] Did you verify new and **existing [tests](https://github.com/speechbrain/speechbrain/tree/develop/tests) pass** locally with your changes?
22+
- [ ] Did you list all the **breaking changes** introduced by this pull request?
23+
- [ ] Does your code adhere to project-specific code style and conventions?
2824

25+
</details>
26+
27+
## PR review
28+
29+
<details>
30+
<summary>Reviewer checklist</summary>
31+
32+
- [ ] Is this pull request ready for review? (if not, please submit in draft mode)
33+
- [ ] Check that all items from **Before submitting** are resolved
34+
- [ ] Make sure the title is self-explanatory and the description concisely explains the PR
35+
- [ ] Add labels and milestones (and optionally projects) to the PR so it can be classified
36+
- [ ] Confirm that the changes adhere to compatibility requirements (e.g., Python version, platform)
37+
- [ ] Review the self-review checklist to ensure the code is ready for review
38+
39+
</details>
40+
41+
<!--
42+
43+
🎩 Magic happens when you code. Keep the spells flowing!
44+
45+
-->

‎.github/workflows/pre-commit.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,5 @@ jobs:
1212
- uses: actions/checkout@v2
1313
- uses: actions/setup-python@v2
1414
with:
15-
python-version: '3.8'
15+
python-version: '3.9'
1616
- uses: pre-commit/action@v2.0.3

‎.github/workflows/pythonapp.yml‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,22 +21,29 @@ jobs:
2121
uses: actions/setup-python@v1
2222
with:
2323
python-version: ${{ matrix.python-version }}
24-
- name: Install libsndfile
24+
- name: Install sox
2525
run: |
2626
sudo apt-get update
27-
sudo apt-get install -y libsndfile1
28-
- name: Install ffmpeg
29-
run: |
30-
sudo apt-get update
31-
sudo apt-get install -y ffmpeg
27+
sudo apt install sox libsox-dev
28+
# Installing only SoX for now due to FFmpeg issues on the CI server with Torchaudio 2.1.
29+
# FFmpeg works fine on all other machines. We'll switch back when the CI server is fixed.
30+
#- name: Install ffmpeg
31+
# run: |
32+
# sudo apt-get update
33+
# sudo apt-get install -y ffmpeg
3234
- name: Display Python version
3335
run: python -c "import sys; print(sys.version)"
3436
- name: Full dependencies
3537
run: |
3638
sudo apt-get update
39+
# up to k2 compatible torch version
40+
pip install torch==2.1.2 torchaudio==2.1.2
3741
pip install -r requirements.txt
3842
pip install --editable .
3943
pip install ctc-segmentation
44+
pip install k2==1.24.4.dev20231220+cpu.torch2.1.2 -f https://k2-fsa.github.io/k2/cpu.html
45+
pip install protobuf
46+
pip install kaldilm==1.15
4047
- name: Consistency tests with pytest
4148
run: |
4249
pytest tests/consistency

‎.github/workflows/release.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ jobs:
1717
ref: main
1818
- uses: actions/setup-python@v2
1919
with:
20-
python-version: 3.8
20+
python-version: 3.9
2121
- name: Install pypa/build
2222
run: python -m pip install build --user
2323
- name: Build binary wheel and source tarball

‎.github/workflows/verify-docs-gen.yml‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,18 @@ jobs:
1111
runs-on: ubuntu-latest
1212
steps:
1313
- uses: actions/checkout@v2
14-
- name: Setup Python 3.8
14+
- name: Setup Python 3.9
1515
uses: actions/setup-python@v2
1616
with:
17-
python-version: '3.8'
17+
python-version: '3.9'
1818
- name: Full dependencies
1919
run: |
20+
# up to k2 compatible torch version
21+
pip install torch==2.1.2 torchaudio==2.1.2
2022
pip install -r requirements.txt
2123
pip install --editable .
2224
pip install -r docs/docs-requirements.txt
25+
pip install k2==1.24.4.dev20231220+cpu.torch2.1.2 -f https://k2-fsa.github.io/k2/cpu.html
2326
- name: Generate docs
2427
run: |
2528
cd docs

‎.gitignore‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -72,11 +72,8 @@ instance/
7272
.scrapy
7373

7474
# Sphinx documentation
75-
docs/_build/
76-
docs/source/*.rst
77-
!docs/source/index.rst
78-
!docs/source/_templates
79-
!docs/source/_static
75+
docs/build/
76+
docs/API/*.rst
8077

8178
# PyBuilder
8279
target/
@@ -158,4 +155,4 @@ dmypy.json
158155
**/log/
159156

160157
# Mac OS
161-
.DS_Store
158+
.DS_Store

‎.readthedocs.yaml‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
# .readthedocs.yaml
22

3+
version: 2
4+
35
build:
4-
image: latest
6+
os: ubuntu-20.04
7+
tools:
8+
python: "3.9"
59

610
python:
7-
version: 3.8
8-
pip_install: True
11+
install:
12+
- requirements: docs/readthedocs-requirements.txt
913

1014
# Don't build any extra formats
1115
formats: []
12-
13-
requirements_file: docs/docs-requirements.txt

‎CITATION.cff‎

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
# This CITATION.cff file was generated with cffinit.
2+
# Visit https://bit.ly/cffinit to generate yours today!
3+
4+
cff-version: 1.2.0
5+
title: SpeechBrain
6+
message: A PyTorch-based Speech Toolkit
7+
type: software
8+
authors:
9+
- given-names: Mirco
10+
family-names: Ravanelli
11+
affiliation: 'Mila - Quebec AI Institute, Université de Montréal'
12+
- given-names: Titouan
13+
family-names: Parcollet
14+
affiliation: >-
15+
LIA - Avignon Université, CaMLSys - University of
16+
Cambridge
17+
- given-names: Peter
18+
family-names: Plantinga
19+
affiliation: Ohio State University
20+
- given-names: Aku
21+
family-names: Rouhe
22+
affiliation: Aalto University
23+
- given-names: Samuele
24+
family-names: Cornell
25+
affiliation: Università Politecnica delle Marche
26+
- given-names: Loren
27+
family-names: Lugosch
28+
affiliation: 'Mila - Quebec AI Institute, McGill University'
29+
- given-names: Cem
30+
family-names: Subakan
31+
affiliation: Mila - Quebec AI Institute
32+
- given-names: Nauman
33+
family-names: Dawalatabad
34+
affiliation: Indian Institute of Technology Madras
35+
- given-names: Abdelwahab
36+
family-names: Heba
37+
affiliation: IRIT - Université Paul Sabatier
38+
- given-names: Jianyuan
39+
family-names: Zhong
40+
affiliation: Mila - Quebec AI Institute
41+
- given-names: Ju-Chieh
42+
family-names: Chou
43+
affiliation: Toyota Technological Institute at Chicago
44+
- given-names: Sung-Lin
45+
family-names: Yeh
46+
affiliation: University of Edinburgh
47+
- given-names: Szu-Wei
48+
family-names: Fu
49+
affiliation: 'Academia Sinica, Taiwan'
50+
- given-names: Chien-Feng
51+
family-names: Liao
52+
affiliation: 'Academia Sinica, Taiwan'
53+
- given-names: Elena
54+
family-names: Rastorgueva
55+
affiliation: NVIDIA
56+
- given-names: François
57+
family-names: Grondin
58+
affiliation: Université de Sherbrooke
59+
- given-names: William
60+
family-names: Aris
61+
affiliation: Université de Sherbrooke
62+
- given-names: Hwidong
63+
family-names: Na
64+
affiliation: Samsung-SAIT
65+
- given-names: Yan
66+
family-names: Gao
67+
affiliation: CaMLSys - University of Cambridge
68+
- given-names: Renato
69+
name-particle: De
70+
family-names: Mori
71+
affiliation: 'LIA - Avignon Université, McGill University'
72+
- given-names: Yoshua
73+
family-names: Bengio
74+
affiliation: 'Mila - Quebec AI Institute, Université de Montréal'
75+
identifiers:
76+
- type: doi
77+
value: 10.48550/arXiv.2106.04624
78+
description: 'SpeechBrain: A General-Purpose Speech Toolkit'
79+
repository-code: 'https://github.com/speechbrain/speechbrain/'
80+
url: 'https://speechbrain.github.io/'
81+
abstract: >-
82+
SpeechBrain is an open-source and all-in-one speech
83+
toolkit. It is designed to facilitate the research and
84+
development of neural speech processing technologies by
85+
being simple, flexible, user-friendly, and
86+
well-documented. This paper describes the core
87+
architecture designed to support several tasks of common
88+
interest, allowing users to naturally conceive, compare
89+
and share novel speech processing pipelines. SpeechBrain
90+
achieves competitive or state-of-the-art performance in a
91+
wide range of speech benchmarks. It also provides training
92+
recipes, pretrained models, and inference scripts for
93+
popular speech datasets, as well as tutorials which allow
94+
anyone with basic Python proficiency to familiarize
95+
themselves with speech technologies.
96+
keywords:
97+
- speech toolkit
98+
- audio
99+
- deep learning
100+
- PyTorch
101+
- transformers
102+
- voice recognition
103+
- speech recognition
104+
- speech-to-text
105+
- language model
106+
- speaker recognition
107+
- speaker verification
108+
- speech processing
109+
- audio processing
110+
- ASR
111+
- speaker diarization
112+
- speech separation
113+
- speech enhancement
114+
- spoken language understanding
115+
- HuggingFace
116+
license: Apache-2.0

0 commit comments

Comments
 (0)