Skip to content

Commit c3755c5

Browse files
gwichernkieranparsons
gwichern
authored and
kieranparsons
committed
Create release 1.0.0
1 parent 2d94a27 commit c3755c5

Some content is hidden

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

52 files changed

+4412
-0
lines changed

‎.gitattributes

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Copyright (C) 2023 Mitsubishi Electric Research Laboratories (MERL)
2+
#
3+
# SPDX-License-Identifier: AGPL-3.0-or-later
4+
5+
*.ckpt filter=lfs diff=lfs merge=lfs -text

‎.github/workflows/build_and_test.yaml

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Copyright (C) 2023 Mitsubishi Electric Research Laboratories (MERL)
2+
#
3+
# SPDX-License-Identifier: AGPL-3.0-or-later
4+
5+
name: Build and Test
6+
7+
on:
8+
pull_request:
9+
push:
10+
branches:
11+
- '**'
12+
tags-ignore:
13+
- '**'
14+
15+
jobs:
16+
build:
17+
runs-on: ubuntu-latest
18+
19+
steps:
20+
- name: Checkout repo
21+
uses: actions/checkout@v3
22+
23+
- name: Set up Python 3.9
24+
uses: actions/setup-python@v4
25+
with:
26+
python-version: 3.9
27+
cache: 'pip'
28+
cache-dependency-path: 'requirements.txt'
29+
30+
- name: Install dependencies
31+
run: |
32+
python -m pip install --upgrade pip
33+
pip install -r requirements.txt
34+
pip install pytest
35+
36+
- name: Run unit tests
37+
run: |
38+
python -m pytest tests

‎.github/workflows/static_checks.yaml

+77
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Copyright (C) 2023 Mitsubishi Electric Research Laboratories (MERL)
2+
#
3+
# SPDX-License-Identifier: AGPL-3.0-or-later
4+
5+
name: Static code checks
6+
7+
on:
8+
pull_request:
9+
push:
10+
branches:
11+
- '**'
12+
tags-ignore:
13+
- '**'
14+
15+
env:
16+
LICENSE: AGPL-3.0-or-later
17+
FETCH_DEPTH: 1
18+
FULL_HISTORY: 0
19+
SKIP_WORD_PRESENCE_CHECK: 0
20+
21+
jobs:
22+
static-code-check:
23+
if: endsWith(github.event.repository.name, 'private')
24+
25+
name: Run static code checks
26+
# See https://github.com/actions/virtual-environments/blob/main/images/linux/Ubuntu1804-Readme.md for list of packages
27+
runs-on: ubuntu-latest
28+
defaults:
29+
run:
30+
shell: bash -l {0}
31+
32+
steps:
33+
- name: Setup history
34+
if: github.ref == 'refs/heads/oss'
35+
run: |
36+
echo "FETCH_DEPTH=0" >> $GITHUB_ENV
37+
echo "FULL_HISTORY=1" >> $GITHUB_ENV
38+
39+
- name: Setup version
40+
if: github.ref == 'refs/heads/melco'
41+
run: |
42+
echo "SKIP_WORD_PRESENCE_CHECK=1" >> $GITHUB_ENV
43+
44+
- name: Check out code
45+
uses: actions/checkout@v3
46+
with:
47+
fetch-depth: ${{ env.FETCH_DEPTH }} # '0' to check full history
48+
49+
- name: Set up environment
50+
run: git config user.email github-bot@merl.com
51+
52+
- name: Set up python
53+
uses: actions/setup-python@v4
54+
with:
55+
python-version: 3.9
56+
cache: 'pip'
57+
cache-dependency-path: 'requirements-dev.txt'
58+
59+
- name: Install python packages
60+
run: pip install -r requirements-dev.txt
61+
62+
- name: Ensure lint and pre-commit steps have been run
63+
uses: pre-commit/action@v3.0.0
64+
65+
- name: Check files
66+
uses: merl-oss-private/merl-file-check-action@v1
67+
with:
68+
license: ${{ env.LICENSE }}
69+
full-history: ${{ env.FULL_HISTORY }} # If true, use fetch-depth 0 above
70+
skip-word-presence-check: ${{ env.SKIP_WORD_PRESENCE_CHECK }}
71+
72+
- name: Check license compatibility
73+
if: github.ref != 'refs/heads/melco'
74+
uses: merl-oss-private/merl_license_compatibility_checker@v1
75+
with:
76+
input-filename: requirements.txt
77+
license: ${{ env.LICENSE }}

‎.gitignore

+176
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
# Copyright (C) 2023 Mitsubishi Electric Research Laboratories (MERL)
2+
#
3+
# SPDX-License-Identifier: AGPL-3.0-or-later
4+
5+
# Default results directories from pytorch_lightning
6+
/**/exp
7+
/**/lightning_logs
8+
9+
# Common results and analysis files
10+
*.wav
11+
*.npy
12+
*.mp4
13+
*.pth
14+
15+
!/interface/audio/*
16+
17+
# Byte-compiled / optimized / DLL files
18+
__pycache__/
19+
*.py[cod]
20+
*$py.class
21+
22+
# C extensions
23+
*.so
24+
25+
# Distribution / packaging
26+
.Python
27+
build/
28+
develop-eggs/
29+
dist/
30+
downloads/
31+
eggs/
32+
.eggs/
33+
lib/
34+
lib64/
35+
parts/
36+
sdist/
37+
var/
38+
wheels/
39+
share/python-wheels/
40+
*.egg-info/
41+
.installed.cfg
42+
*.egg
43+
MANIFEST
44+
45+
# PyInstaller
46+
# Usually these files are written by a python script from a template
47+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
48+
*.manifest
49+
*.spec
50+
51+
# Installer logs
52+
pip-log.txt
53+
pip-delete-this-directory.txt
54+
55+
# Unit test / coverage reports
56+
htmlcov/
57+
.tox/
58+
.nox/
59+
.coverage
60+
.coverage.*
61+
.cache
62+
nosetests.xml
63+
coverage.xml
64+
*.cover
65+
*.py,cover
66+
.hypothesis/
67+
.pytest_cache/
68+
cover/
69+
70+
# Translations
71+
*.mo
72+
*.pot
73+
74+
# Django stuff:
75+
*.log
76+
local_settings.py
77+
db.sqlite3
78+
db.sqlite3-journal
79+
80+
# Flask stuff:
81+
instance/
82+
.webassets-cache
83+
84+
# Scrapy stuff:
85+
.scrapy
86+
87+
# Sphinx documentation
88+
docs/_build/
89+
90+
# PyBuilder
91+
.pybuilder/
92+
target/
93+
94+
# Jupyter Notebook
95+
.ipynb_checkpoints
96+
97+
# IPython
98+
profile_default/
99+
ipython_config.py
100+
101+
# pyenv
102+
# For a library or package, you might want to ignore these files since the code is
103+
# intended to run in multiple environments; otherwise, check them in:
104+
# .python-version
105+
106+
# pipenv
107+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
108+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
109+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
110+
# install all needed dependencies.
111+
#Pipfile.lock
112+
113+
# poetry
114+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
115+
# This is especially recommended for binary packages to ensure reproducibility, and is more
116+
# commonly ignored for libraries.
117+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
118+
#poetry.lock
119+
120+
# pdm
121+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
122+
#pdm.lock
123+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
124+
# in version control.
125+
# https://pdm.fming.dev/#use-with-ide
126+
.pdm.toml
127+
128+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
129+
__pypackages__/
130+
131+
# Celery stuff
132+
celerybeat-schedule
133+
celerybeat.pid
134+
135+
# SageMath parsed files
136+
*.sage.py
137+
138+
# Environments
139+
.env
140+
.venv
141+
env/
142+
venv/
143+
ENV/
144+
env.bak/
145+
venv.bak/
146+
147+
# Spyder project settings
148+
.spyderproject
149+
.spyproject
150+
151+
# Rope project settings
152+
.ropeproject
153+
154+
# mkdocs documentation
155+
/site
156+
157+
# mypy
158+
.mypy_cache/
159+
.dmypy.json
160+
dmypy.json
161+
162+
# Pyre type checker
163+
.pyre/
164+
165+
# pytype static type analyzer
166+
.pytype/
167+
168+
# Cython debug symbols
169+
cython_debug/
170+
171+
# PyCharm
172+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
173+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
174+
# and can be added to the global gitignore or merged into this file. For a more nuclear
175+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
176+
#.idea/

‎.pre-commit-config.yaml

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Copyright (C) 2023 Mitsubishi Electric Research Laboratories (MERL)
2+
#
3+
# SPDX-License-Identifier: AGPL-3.0-or-later
4+
#
5+
# Pre-commit configuration. See https://pre-commit.com
6+
7+
default_language_version:
8+
python: python3.9
9+
repos:
10+
- repo: https://github.com/pre-commit/pre-commit-hooks
11+
rev: v2.3.0
12+
hooks:
13+
- id: check-yaml
14+
- id: end-of-file-fixer
15+
- id: trailing-whitespace
16+
- id: check-added-large-files
17+
args: ['--maxkb=1000']
18+
19+
- repo: https://gitlab.com/bmares/check-json5
20+
rev: v1.0.0
21+
hooks:
22+
- id: check-json5
23+
24+
- repo: https://github.com/homebysix/pre-commit-macadmin
25+
rev: v1.12.3
26+
hooks:
27+
- id: check-git-config-email
28+
args: ['--domains', 'merl.com']
29+
30+
- repo: https://github.com/psf/black
31+
rev: 22.3.0
32+
hooks:
33+
- id: black
34+
args:
35+
- --line-length=119
36+
37+
- repo: https://github.com/pycqa/isort
38+
rev: 5.12.0
39+
hooks:
40+
- id: isort
41+
args: ["--profile", "black", "--filter-files", "--line-length", "119", "--skip-gitignore"]
42+
43+
# Uncomment to use pyupgrade (https://github.com/asottile/pyupgrade) to automatically upgrade syntax for newer python
44+
# - repo: https://github.com/asottile/pyupgrade
45+
# rev: v2.32.0
46+
# hooks:
47+
# - id: pyupgrade
48+
49+
# To stop flake8 error from causing a failure, use --exit-zero. By default, pre-commit will not show the warnings,
50+
# so use verbose: true to see them.
51+
- repo: https://github.com/pycqa/flake8
52+
rev: 4.0.1
53+
hooks:
54+
- id: flake8
55+
# Black compatibility, Eradicate options
56+
args: ["--max-line-length=119", "--extend-ignore=E203", "--eradicate-whitelist-extend","eradicate:\\s*no",
57+
"--exit-zero"]
58+
verbose: true
59+
additional_dependencies: [
60+
# https://github.com/myint/eradicate, https://github.com/wemake-services/flake8-eradicate
61+
"flake8-eradicate"
62+
]

‎.reuse/dep5

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
2+
3+
Files: docs/*.png
4+
Copyright: 2023 Mitsubishi Electric Research Laboratories (MERL)
5+
License: AGPL-3.0-or-later
6+
7+
Files: checkpoints/model.ckpt
8+
Copyright: 2023 Mitsubishi Electric Research Laboratories (MERL)
9+
License: AGPL-3.0-or-later
10+
11+
Files: interface/audio/*.wav
12+
Copyright: 2023 Mitsubishi Electric Research Laboratories (MERL)
13+
License: AGPL-3.0-or-later

‎CONTRIBUTING.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<!--
2+
Copyright (C) 2023 Mitsubishi Electric Research Laboratories (MERL)
3+
4+
SPDX-License-Identifier: AGPL-3.0-or-later
5+
-->
6+
# Contributing
7+
8+
Sorry, but we do not currently accept contributions in the form of pull requests to this repository.
9+
However, you are welcome to post issues (bug reports, feature requests, questions, etc).

0 commit comments

Comments
 (0)