Asteroid

Limit pytorch-lightning version to under 1.x for version 0.3.4 to keep working.

Added
- [hub] Add tmirzaev's model in the string-retrievable ones.
- [src] BaseTasNet -> BaseEncoderMaskerDecoder + add model hooks (266)
- [src & tests] New complex ops + Add DCUNet and DCCRNet (224)
- [src&tests] Improve scheduler's docs + add plot method (268)

Changed
- [hub] Add software version section in published models (261)
- [docs] Add issue 250 to FAQ (260)
- [black] Update black to 20.8b1 (265)
- [black] Fix black 20.8b1 update (267)
- [black] Update to 20.8b1 + always lint

Fixed
- [egs] Fix declared unused variables in DeMask (248)
- [docs] Update article citation.
- [src] Restore linear activation as default in ConvTasNet and DPRNN (258)
- [src] Fix uncalled optimizer in System without LR schedule (259)
- [src] Fix bug for DPTNetScheduler (262)
- [src] Fix LambdaOverlapAdd and improve docs (271)

Added
- [hub] Add DeMask to hubconf (242)
- [models] Add 16k popcornell/DPRNNTasNet_WHAM_enhancesingle enhancement
- [src & egs] Add DeMask: Surgical mask speech enhancement recipes (235)
- [models] Add pretrained DeMask name to URL mapping
- [src & egs] PyTorchLightning upgrade to 0.9.0 (stable from 0.8.1 on) (217)
- [CLI] Add asteroid-infer CLI to enhance/separate from the command line (236)
- [docs] New docs theme ! (230)
- [tests] Improve tests for new model interface (234)
- [docs] Add license info to FUSS Dataset
- [src] Cleaner try/except/else in base_models.py (thanks jonashaag)
- [src] Add LibriMix.loaders_from_mini in librimix_dataset.py (229)
- [src] Add register command to gettable modules (231)
- [models] Add groadabike's pretrained model's URL (228)
- [src] Import MultiScale spectral loss in __init__.py
- [docs] Include new notebook: follow up of 221 (226)
- [src] Add LambdaOverlapAdd usage example (221)

Changed
- [src] Improve BaseModel.separate (236 follow up) (238)
- [hub] Remove args in hub models, don't accept positional args after kwargs
- [src] Refactor BaseTasnNet in two: better loadable/serializable models (232)

Fixed
- [CLI] Fix large output volume in asteroid-infer
- [docs] Fix theme installation, grunt build and import errors in docs (240)
- [tests] Fix wrong `separate` method in model tests (241)
- [src] Recipe name in publisher + dataset name fix (239)

Added
- [tests] Add scheduler tests (220)
- [docs] Add schedulers, activations docs and improve datasets' docs (219)
- [docs] Add DSP section to docs (218)
- [docs] Add FUSSdataset to docs
- [docs] Add schedulers in docs
- [docs] Add activations to docs
- [src] Add FUSS dataset from FUSS PR (215)
- [src & tests] Add TDCN++ to masknn (214)
- [hub] Add LSTMTasNet/DPTNet/SuDORMRFNet to torch.hub! (210)
- [src & tests] Add LSTMTasNet to serializable models (209)
- [src] Continuous Speech separation with LambdaOverlapAdd (193)
- [src] Continuous Speech separation with OverlappadWrapper (191)
- [src & tests] Add SuDoRM-RF model & online mixing collate function (174)
- [src, tests & egs] Batchwise learning rate schedulers + DPProcessing + Dual Path Transformer Network + recipe (200)
- [docs] Add black code-style
- [hub] Add Brij's LibriMix enhancement model
- [src] Adds Dataset for SmsWsj (179)
- [docs] STOI loss example: Add sample rate (189)
- [src & tests] Add feature-wise global layernorm (170)

Changed
- [src & tests] Split SuDORMRF architectures in encoder/masker/decoder (208)
- [src] Code-style + docs
- [src & tests] (BWI) Gather DSP methods in dsp folder (194)
- [egs] EarlyStopping Patience to 30 instead of 10. (178)

Fixed
- [src & tests] Fix bug when scheduler=None in System (223)
- [src] Fix docs append problem in STOI.
- [black] Apply black to recipes (216)
- [tests & CI] Fix tests for publishing (211)
- [notebooks] Fix notebooks (206)
- [src & tests] Fix serialization issues introduced in previous PR + some docs (204)
- [egs] Remove file librimix/model.py as model is imported from asteroid.models (176)
- [egs] Dynamic Mixing fix (173)
- [instal] Fix pytorch-lightning dependency (159)
- [egs] Fix empty audio, multi gpu and reduced storage issues in avspeech (169)
- [egs] Fix style in model.py
- [egs] Fix bugs in generating wsj0-mix dataset with wv1 (166)
- [egs] Fix wrong rel path in wham/DPRNN prepare_data.sh (167)
- [egs] Fix clipping problems when saving estimate wav file for Wham ConvTasNet (160)

Backward incompatible changes
- Move `mixture_consistency` in `dsp` folder.

Use 0.3.2 instead.

Added
[src & egs] Publishing pretrained models!! (wham/ConvTasNet) (125)
[src] Add License info on all (but MUSDB) supported datasets (130)
[src & egs] Kinect-WSJ Dataset and Single channel DC Recipe (131)
[src] Add licenses info and dataset name for model publishing
[docs] Add getting started notebook
[docs] Add notebook summary table
[egs] Enable pretrained models sharing on LibriMix (132)
[egs] Enable wham/DPRNN model sharing (135)
[model_cards] Add message to create model card after publishing
[model_cards] Add ConvTasNet_LibriMix_sepnoisy.md model card (Thanks JorisCos)
[src & egs] Adding AVSpeech AudioVisual source separation (127)
[src] Instantiate LibriMix from download with class method (144)
[src] Add show_available_models in asteroid init
[src & tests] Bidirectional residual RNN (146)
[src & tests] Support filenames at the input of `separate` (154)
Changed
[src & hub] Remove System to reduce torch.hub deps (back to 112)
[src & tests & egs] Refactor utils files into folder (120)
[egs] GPU `id` defaults to $CUDA_VISIBLE_DEVICES in all recipes (128)
[egs] set -e in all recipes to exit or errors (129)
[egs] Remove gpus args in all train.py (--id controls that in run.sh) (134)
[hub] Change dataset name in LibriMix (fix)
[src] Add targets argument (to stack sources) to MUSDB18 (143)
[notebooks] Rename examples to notebooks
[src] Enable using Zenodo without api_key argument (set ACCESS_TOKEN env variable)
Deprecated
[src] Deprecate inputs_and_masks.py (117)
[src] Deprecate PITLossWrapper `mode` argument (119)
Fixed
[src] Fix PMSQE loss (NAN backward + device placement) (121)
[egs] Fix checkpoint.best_k_models in new PL version (123)
[egs] Fix: remove shuffle=True in validation Loader (lightning error) (124)
[egs] Corrections on LibriMix eval and train and evals scripts (137)
[egs] Fix wavfiles saving in eval.py for enh_single and enh_both tasks (closes 139)
[egs] Fix wavfiles saving in eval.py for enh tasks (estimates)
[egs] Fix 139 : correct squeeze for enhancement tasks (142)
[egs] Fix librimix run.sh and eval.py (148)