removed stray imports, added soxbindings install option, and updated docs
MODIFY
README.md
README.md
@@ -110,16 +110,25 @@ $ brew install ffmpeg # on mac
$ apt-get install ffmpeg # on linux
```
-To use the Melodia separation algorithm, you'll need one additional package:
+To use the Melodia separation algorithm, you'll need to specify this:
```
-$ pip install vamp
+$ pip install "nussl[melodia]"
```
`vamp` doesn't install on some MacOS versions, so we can't include it by default.
To actually use Melodia, you'll also need the Melodia plugin. For installation
instructions, look [here](https://github.com/justinsalamon/melodia_python_tutorial/blob/master/melodia_python_tutorial.ipynb).
+To call SoX functions directly when applying effects, you will also need to specify this:
+
+```
+$ pip install "nussl[soxbindings]"
+```
+
+`soxbindings` can't be installed from PyPI on Windows, but it may be installable from source.
+For source installation instructions, look [here](https://github.com/pseeth/soxbindings)
+
# Citing
If you are using nussl for your research project, we please ask that you cite it using one of the

MODIFY
docs/changelog.rst
docs/changelog.rst
@@ -4,7 +4,8 @@ Changelog
v1.1.1
------
- Allowed MixSourceFolder to mix sources on the fly.
-- Added effects utilities.
+- Added effects utilities for data augmentation.
+- Fixed bug with ignite 0.4.0
v1.1.0
------

MODIFY
nussl/core/audio_signal.py
nussl/core/audio_signal.py
@@ -697,7 +697,7 @@ class AudioSignal(object):
"""
(:obj:`np.ndarray`): Returns a real valued ``np.array`` with log magnitude spectrogram data.
- The log magnitude spectrogram is defined as 20*log10(Abs(STFT)).
+ The log magnitude spectrogram is defined as 20 * log10(abs(stft)).
Same shape as :attr:`stft_data`.
Raises:
@@ -720,7 +720,11 @@ class AudioSignal(object):
def effects_chain(self):
"""
(``list`` of ``nussl.core.FilterFunction``): Returns a copy of the AudioSignal's
- effect chain.
+ effect chain. Editing this property will not result in a change to the effects chain
+ of the AudioSignal.
+
+ Please use the effects hooks (e.g. :func:`tremolo`, :func:`make_effect`) to make changes
+ to the Audiosignal's effects chain.
See Also:
* :func:`apply_effects`
@@ -730,8 +734,11 @@ class AudioSignal(object):
@property
def effects_applied(self):
"""
- (``list`` of ``nussl.core.FilterFunction``): Returns a list of effects applied to
- the AudioSignal.
+ (``list`` of ``nussl.core.FilterFunction``): Returns a copy of the list of effects
+ applied to the AudioSignal. Editing this property will not result in a change to the
+ effects aplied to the AudioSignal.
+
+ Please use :func:`apply_effects` to apply effects to the AudioSignal.
See Also:
* :func:`apply_effects`

MODIFY
nussl/core/constants.py
nussl/core/constants.py
@@ -97,9 +97,8 @@ STEM_TARGET_DICT = OrderedDict([
('linear_mixture', 'vocals+bass+drums+other')
])
-##### augmentation.py
-# These values are found in the ffmpeg documentation in filters
-# that use the level_in argument, however, not all filters that
-# use this state these bounds in documentation with pytest.raises(ValueError):
+# ################## Effects ################## #
+# These values are found in the ffmpeg documentation for filters
+# that use the level_in argument:
LEVEL_MIN = .015625
LEVEL_MAX = 64

MODIFY
nussl/datasets/transforms.py
nussl/datasets/transforms.py
@@ -3,7 +3,6 @@ import shutil
import logging
import random
from collections import OrderedDict
-import librosa
import torch
import zarr
@@ -12,7 +11,6 @@ import numpy as np
from sklearn.preprocessing import OneHotEncoder
from .. import utils
-from ..core import AudioSignal
# This is for when you're running multiple
# training threads

MODIFY
requirements.txt
requirements.txt
@@ -17,6 +17,6 @@ gpytorch
ffmpeg-python
importlib_resources
pyloudnorm
-sox==1.4.0b0
+sox==1.4.0
numba==0.48
-soxbindings
+

MODIFY
setup.py
setup.py
@@ -11,7 +11,7 @@ with open('extra_requirements.txt') as f:
setup(
name='nussl',
- version='1.1.0',
+ version='1.1.1',
classifiers=[
'Development Status :: 3 - Alpha',
'Environment :: Console',
@@ -30,9 +30,9 @@ setup(
description='A flexible sound source separation library.',
long_description=long_description,
long_description_content_type='text/markdown',
- author='E. Manilow, P. Seetharaman, F. Pishdadian, N. Shelly, B. Pardo',
+ author='E. Manilow, P. Seetharaman, F. Pishdadian, N. Shelly, A. Bugler, B. Pardo',
author_email='ethanmanilow@u.northwestern.edu',
- maintainer='E. Manilow, P. Seetharaman, F. Pishdadian, N. Shelly, B. Pardo',
+ maintainer='E. Manilow, P. Seetharaman, F. Pishdadian, N. Shelly, A. Bugler, B. Pardo',
maintainer_email='ethanmanilow@u.northwestern.edu',
url='https://github.com/interactiveaudiolab/nussl',
license='MIT',
@@ -44,6 +44,9 @@ setup(
'melodia': [
'vamp'
],
- 'extras': extra_requirements
+ 'extras': extra_requirements,
+ 'soxbindings': [
+ 'soxbindings>=1.0.1'
+ ],
}
)

removed stray imports, added soxbindings install option, and updated docs