Remove GitLab CI, introduce GitHub CI

Gastron · Gastron · commit c5bfb094c97b · 2020-04-28T21:28:19.000-04:00
Also removes legacy test.py and brings tools/ upto lint standards.
Also adds full lint tests in pre-push
diff --git a/.flake8 b/.flake8
@@ -5,3 +5,4 @@ ignore = E203, E266, E501, W503
 max-line-length = 80
 max-complexity = 18
 select = B,C,E,F,W,T4,B9
+exclude = tools/kaldi_decoder
diff --git a/.github/workflows/pythonapp.yml b/.github/workflows/pythonapp.yml
@@ -0,0 +1,58 @@
+# SpeechBrain lint and unit tests to ease continuous integration
+# NOTE: Caching these offers no speedup
+name: SpeechBrain toolkit CI
+
+# Runs on pushes to master and all pull requests
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+
+jobs:
+  linters:
+    name: Linters
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python 3.7
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.7
+    - name: Lint dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r lint-requirements.txt
+    - name: Show errors separately 
+      uses: samuelmeuli/lint-action@v1
+      with:
+        github_token: ${{ secrets.github_token }}
+        # Enable linters
+        black: true
+        flake8: true
+    - name: Run lint again for error code
+      run: |
+        flake8 . --count --show-source --statistics
+        black --check --diff .
+
+  unittests:
+    name: Unit Tests
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python 3.7
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.7
+    - name: Install libsndfile
+      run: |
+        sudo apt-get install -y libsndfile1
+    - name: Full dependencies 
+      run: |
+        pip install -r requirements.txt
+        pip install --editable .
+    - name: Unittests with pytest
+      run: |
+        pytest tests
+    - name: Doctests with pytest
+      run: |
+        pytest --doctest-modules speechbrain
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
diff --git a/.pre-push-config.yaml b/.pre-push-config.yaml
@@ -1,4 +1,24 @@
 repos:
+  - repo: local 
+    hooks:
+    - id: flake8-lint 
+      name: flake8-lint
+      entry: flake8 . --count --show-source --statistics
+      language: python
+      pass_filenames: false
+      always_run: true
+      require_serial: false
+
+  - repo: local
+    hooks:
+    - id: black-lint 
+      name: black-lint
+      entry: black --check --diff .
+      language: python
+      pass_filenames: false
+      always_run: true
+      require_serial: false
+
   - repo: local 
     hooks:
     - id: unittests
diff --git a/pyproject.toml b/pyproject.toml
@@ -10,6 +10,7 @@ exclude = '''
     | \.mypy_cache
     | \.tox
     | \.venv
+    | tools/kaldi_decoder
   )/
 )
 '''
diff --git a/setup.py b/setup.py
@@ -1,11 +1,12 @@
 #!/usr/bin/env python3
 from distutils.core import setup
 
-setup(name="SpeechBrain",
-        version="0.0.1",
-        description="All-in-one speech toolkit in pure Python and Pytorch",
-        author="Mirco Ravanelli",
-        author_email = "speechbrain@gmail.com",
-        packages = ["speechbrain"],
-        python_requires = ">=3.6",
+setup(
+    name="SpeechBrain",
+    version="0.0.1",
+    description="All-in-one speech toolkit in pure Python and Pytorch",
+    author="Mirco Ravanelli",
+    author_email="speechbrain@gmail.com",
+    packages=["speechbrain"],
+    python_requires=">=3.6",
 )
diff --git a/test.py b/test.py
diff --git a/tools/compute_wer.py b/tools/compute_wer.py
@@ -1,6 +1,4 @@
 #!/usr/bin/env python3
-import sys
-import collections
 import speechbrain.utils.edit_distance as edit_distance
 import speechbrain.data_io.wer as wer_io
 
@@ -47,6 +45,7 @@ def _utt2spk_keydict(path):
             utt2spk[utt] = spk
     return utt2spk
 
+
 if __name__ == "__main__":
     import argparse
 
@@ -58,8 +57,10 @@ def _split_lines(self, text, width):
             return argparse.HelpFormatter._split_lines(self, text, width)
 
     parser = argparse.ArgumentParser(
-        description=("Compute word error rate or a Levenshtein alignment"
-                     "between a hypothesis and a reference."),
+        description=(
+            "Compute word error rate or a Levenshtein alignment"
+            "between a hypothesis and a reference."
+        ),
         formatter_class=SmartFormatter,
     )
     parser.add_argument(
@@ -89,14 +90,18 @@ def _split_lines(self, text, width):
     parser.add_argument(
         "--print-alignments",
         action="store_true",
-        help=("Print alignments for between all refs and hyps."
-              "Also has details for individual hyps. Outputs a lot of text."),
+        help=(
+            "Print alignments for between all refs and hyps."
+            "Also has details for individual hyps. Outputs a lot of text."
+        ),
     )
     parser.add_argument(
         "--align-separator",
         default=" ; ",
-        help=("When printing alignments, separate tokens with this."
-              "Note the spaces in the default."),
+        help=(
+            "When printing alignments, separate tokens with this."
+            "Note the spaces in the default."
+        ),
     )
     parser.add_argument(
         "--align_empty",
diff --git a/tools/merge_scp.py b/tools/merge_scp.py
@@ -24,13 +24,13 @@
 from utils import scp_to_dict, dict_to_str, logger_write
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
 
     scp_lst = sys.argv[1:]
 
     # Check if the input scp files exist
     for inp_scp_file in scp_lst[:-1]:
-        if not(os.path.isfile(inp_scp_file)):
+        if not (os.path.isfile(inp_scp_file)):
             err_msg = 'the file "%s" does not exist' % (inp_scp_file)
             logger_write(err_msg)
 
diff --git a/tools/visualize_pkl.py b/tools/visualize_pkl.py
@@ -18,15 +18,15 @@
 import sys
 import pickle
 
-if __name__ == '__main__':
+if __name__ == "__main__":
 
     # Try to import matplotlib.pyplot
     try:
 
         import matplotlib.pyplot as plt
 
     except Exception:
-        err_msg = 'cannot import matplotlib. Make sure it is installed.'
+        err_msg = "cannot import matplotlib. Make sure it is installed."
         raise
 
     for pkl_file in sys.argv[1:]:

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@ exclude = '''`
`10`	`10`	`\| \.mypy_cache`
`11`	`11`	`\| \.tox`
`12`	`12`	`\| \.venv`
	`13`	`+ \| tools/kaldi_decoder`
`13`	`14`	`)/`
`14`	`15`	`)`
`15`	`16`	`'''`