Merge branch 'develop' into feature/channel_adapt

Author: faliwang

.github/workflows/pre-commit.yml

@@ -0,0 +1,16 @@
+name: SpeechBrain pre-commit
+
+on: # yamllint disable-line rule:truthy
+  push:
+    branches: [main, develop]
+  pull_request:
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: '3.8'
+      - uses: pre-commit/action@v2.0.3

.github/workflows/pythonapp.yml

@@ -1,4 +1,4 @@
-# SpeechBrain lint and unit tests to ease continuous integration
+# SpeechBrain  unit tests to ease continuous integration
 # NOTE: Caching these offers no speedup
 name: SpeechBrain toolkit CI
 
@@ -9,25 +9,6 @@ on:    # yamllint disable-line rule:truthy
     pull_request:
 
 jobs:
-    linters:
-        name: Linters
-        runs-on: ubuntu-latest
-        steps:
-            - uses: actions/checkout@v2
-            - name: Set up Python 3.8
-              uses: actions/setup-python@v1
-              with:
-                  python-version: 3.8
-            - name: Lint dependencies
-              run: |
-                  python -m pip install --upgrade pip
-                  pip install -r lint-requirements.txt
-            - name: Run linters
-              run: |
-                  flake8 . --count --show-source --statistics
-                  black --check --diff .
-                  yamllint .
-
     tests:
         name: Tests
         runs-on: ubuntu-latest
@@ -50,6 +31,9 @@ jobs:
                   pip install -r requirements.txt
                   pip install --editable .
                   pip install ctc-segmentation
+            - name: Consistency tests with pytest
+              run: |
+                  pytest tests/consistency
             - name: Unittests with pytest
               run: |
                   pytest tests/unittests

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

@@ -0,0 +1,26 @@
+name: Verify docs generation
+
+# Runs on pushes to master and all pull requests
+on:    # yamllint disable-line rule:truthy
+    push:
+        branches: [main, develop]
+    pull_request:
+
+jobs:
+    docs:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v2
+            - name: Setup Python 3.8
+              uses: actions/setup-python@v2
+              with:
+                  python-version: '3.8'
+            - name: Full dependencies
+              run: |
+                  pip install -r requirements.txt
+                  pip install --editable .
+                  pip install -r docs/docs-requirements.txt
+            - name: Generate docs
+              run: |
+                  cd docs
+                  make html

.gitignore

@@ -51,6 +51,7 @@ coverage.xml
 .hypothesis/
 .pytest_cache/
 cover/
+tests/tmp/
 
 # Translations
 *.mo
@@ -117,6 +118,9 @@ ENV/
 env.bak/
 venv.bak/
 
+# PyCharm project settings
+.idea
+
 # Spyder project settings
 .spyderproject
 .spyproject
@@ -138,8 +142,16 @@ dmypy.json
 # pytype static type analyzer
 .pytype/
 
+# Pretrained & models folders
+**/model_checkpoints/
+**/pretrained_model_checkpoints/
+**/pretrained_models/
+
 # Results folders
 **/results/
 
+# Log folders
+**/log/
+
 # Mac OS
 .DS_Store

.pre-commit-config.yaml

@@ -18,7 +18,7 @@ repos:
     hooks:
       - id: black
         types: [python]
-
+        additional_dependencies: ['click==8.0.4']
   - repo: https://gitlab.com/pycqa/flake8.git
     rev: 3.7.9
     hooks:

README.md

@@ -1,3 +1,15 @@
+def pytest_addoption(parser):
+    parser.addoption("--device", action="store", default="cpu")
+
+
+def pytest_generate_tests(metafunc):
+    # This is called for every test. Only get/set command line arguments
+    # if the argument is specified in the list of test "fixturenames".
+    option_value = metafunc.config.option.device
+    if "device" in metafunc.fixturenames and option_value is not None:
+        metafunc.parametrize("device", [option_value])
+
+
 collect_ignore = ["setup.py"]
 try:
     import numba  # noqa: F401

conftest.py

@@ -20,6 +20,9 @@ docstrings. Sphinx natively supports reStructuredText directives.
 Automatically generating documentation based on docstrings is not the
 core of Sphinx. For this, after much searching, we use better-apidoc.
 
+It seems better-apidoc doesn't use autodoc\_mock\_imports so we currently just
+add all extra dependencies to docs-requirements.txt
+
 ## Future work
 
 Besides automatic API documentation, Sphinx will facilitate manual prose

docs/README.md

@@ -14,8 +14,7 @@
 import sys
 import hyperpyyaml
 
-
-sys.path.insert(0, os.path.abspath("../speechbrain"))
+sys.path.insert(-1, os.path.abspath("../"))
 
 
 # -- Project information -----------------------------------------------------
@@ -69,7 +68,7 @@
 autodoc_default_options = {}
 
 # Autodoc mock extra dependencies:
-autodoc_mock_imports = ["numba", "sklearn"]
+autodoc_mock_imports = []
 
 # Order of API items:
 autodoc_member_order = "bysource"

docs/conf.py

@@ -25,7 +25,7 @@ on GitHub under your own account.
     (This creates a copy of SpeechBrain under your account, and GitHub
     knows where it came from, and we typically call this "upstream".)
 2. Clone your own speechbrain repository.
-    `git clone https://github.com/<your-account>/speechbrain`
+    `git clone https://github.com/ <your-account> /speechbrain`
     (This downloads the git repository to your machine, git knows where
     it came from, and calls it "origin".)
 3. Create a branch for each specific feature you are developing.