Merge pull request #54 from SuperKogito/last-tweaks-for-v0.2.1

fix docs & version and update accordingly

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## v0.3.0
+- improve code based on Joss reviewers recommendations.
+- add type hinting.
+- fix documentation typos.
+
 ## v0.2.0
 - add spectrogram implementations.
 - add predefined filter banks input to the spafe features functions for faster batch processing.

CONTRIBUTING.md

@@ -39,17 +39,17 @@ The preferred way to contribute to spafe is to fork the [main repository](https:
 
 5.	Start making changes.
 
-	\`\``diff
-
-	-	Please never work directly on the `master` branch!\`\`\`
+	```diff
+	-> Please never work directly on the `master` branch!
+	```
 
 6.	Once you are done, make sure to format the code using black to fit spafe's codestyle.
 
-	\`\``black spafe/\`\`\`
+	```black spafe/```
 
 7.	Make sure that the tests succeed and have enough coverage.
 
-	\`\``pytest -x --cov-report term-missing --cov=spafe spafe/tests/test_*.py \`\`\`
+	```pytest -x --cov-report term-missing --cov=spafe spafe/tests/test_*.py ```
 
 8.	Use Git for the to do the version controlling of this copy. When you're done editing, you know the drill `add`, `commit` then `push`:
 
@@ -111,7 +111,6 @@ we use Github issues to track all bugs and feature requests. In the case of comi
 	import spafe
 	import platform
 
-
 	print(platform.platform())
 	print("Python", sys.version)
 	print("NumPy", numpy.__version__)

docs/source/_static/switcher.json

@@ -1,4 +1,14 @@
 [
+    {
+        "name": "dev",
+        "version": "dev",
+        "url": "https://superkogito.github.io/spafe/v0.3.0/index.html"
+    },
+    {
+        "name": "v0.3.0",
+        "version": "0.3.0",
+        "url": "https://superkogito.github.io/spafe/v0.3.0/index.html"
+    },
     {
         "name": "v0.2.0",
         "version": "0.2.0",

docs/source/conf.py

@@ -25,9 +25,9 @@
 html_favicon = "_static/favicon_io/favicon.ico"
 
 # The short X.Y version
-version = "0.2.0"
+version = "0.3.0"
 # The full version, including alpha/beta/rc tags
-release = "0.2.0"
+release = "0.3.0"
 
 # -- General configuration ---------------------------------------------------
 

paper/paper.md

@@ -17,7 +17,7 @@ bibliography: paper.bib
 ---
 
 # Summary
-This paper describes version 0.2.0 of spafe: a python package for audio features extraction based on the Numpy [@numpy:2020] and Scipy [@scipy:2019] libraries.
+This paper describes version 0.3.0 of spafe: a python package for audio features extraction based on the Numpy [@numpy:2020] and Scipy [@scipy:2019] libraries.
 Spafe implements various features extraction techniques that can be used to solve a wide variety of recognition and classification tasks (speaker verification, spoken emotion recognition, spoken language identification etc.).
 The paper provides a brief overview of the library’s structure, theory and functionalities.
 

spafe/features/bfcc.py

@@ -114,7 +114,7 @@ def bark_spectrogram(
             from scipy.io.wavfile import read
 
             # read audio
-            fpath = "../../../data/test.wav"
+            fpath = "../../../tests/data/test.wav"
             fs, sig = read(fpath)
 
             # compute bark spectrogram
@@ -272,7 +272,7 @@ def bfcc(
             from spafe.utils.vis import show_features
 
             # read audio
-            fpath = "../../../data/test.wav"
+            fpath = "../../../tests/data/test.wav"
             fs, sig = read(fpath)
 
             # compute bfccs

spafe/features/cqcc.py

@@ -86,7 +86,7 @@ def cqt_spectrogram(
             from scipy.io.wavfile import read
 
             # read audio
-            fpath = "../../../data/test.wav"
+            fpath = "../../../tests/data/test.wav"
             fs, sig = read(fpath)
 
             # compute spectrogram
@@ -243,7 +243,7 @@ def cqcc(
             from spafe.utils.vis import show_features
 
             # read audio
-            fpath = "../../../data/test.wav"
+            fpath = "../../../tests/data/test.wav"
             fs, sig = read(fpath)
 
             # compute cqccs

spafe/features/gfcc.py

@@ -91,7 +91,7 @@ def erb_spectrogram(
             from scipy.io.wavfile import read
 
             # read audio
-            fpath = "../../../data/test.wav"
+            fpath = "../../../tests/data/test.wav"
             fs, sig = read(fpath)
 
             # compute erb spectrogram
@@ -258,7 +258,7 @@ def gfcc(
             from spafe.utils.vis import show_features
 
             # read audio
-            fpath = "../../../data/test.wav"
+            fpath = "../../../tests/data/test.wav"
             fs, sig = read(fpath)
 
             # compute mfccs and mfes

spafe/features/lfcc.py

@@ -84,7 +84,7 @@ def linear_spectrogram(
             from scipy.io.wavfile import read
 
             # read audio
-            fpath = "../../../data/test.wav"
+            fpath = "../../../tests/data/test.wav"
             fs, sig = read(fpath)
 
             # compute spectrogram
@@ -230,7 +230,7 @@ def lfcc(
             from spafe.utils.vis import show_features
 
             # read audio
-            fpath = "../../../data/test.wav"
+            fpath = "../../../tests/data/test.wav"
             fs, sig = read(fpath)
 
             # compute lfccs

spafe/features/lpc.py

@@ -136,7 +136,7 @@ def lpc(
             from spafe.utils.vis import show_features
 
             # read audio
-            fpath = "../../../data/test.wav"
+            fpath = "../../../tests/data/test.wav"
             fs, sig = read(fpath)
 
             # compute lpcs
@@ -276,7 +276,7 @@ def lpcc(
             from spafe.utils.vis import show_features
 
             # read audio
-            fpath = "../../../data/test.wav"
+            fpath = "../../../tests/data/test.wav"
             fs, sig = read(fpath)
 
             # compute lpccs

spafe/features/mfcc.py

@@ -92,7 +92,7 @@ def mel_spectrogram(
             from scipy.io.wavfile import read
 
             # read audio
-            fpath = "../../../data/test.wav"
+            fpath = "../../../tests/data/test.wav"
             fs, sig = read(fpath)
 
             mSpec, _ = mel_spectrogram(sig,
@@ -253,7 +253,7 @@ def mfcc(
             from spafe.utils.vis import show_features
 
             # read audio
-            fpath = "../../../data/test.wav"
+            fpath = "../../../tests/data/test.wav"
             fs, sig = read(fpath)
 
             # compute mfccs and mfes
@@ -403,7 +403,7 @@ def imfcc(
             from spafe.utils.vis import show_features
 
             # read audio
-            fpath = "../../../data/test.wav"
+            fpath = "../../../tests/data/test.wav"
             fs, sig = read(fpath)
 
             # compute mfccs and mfes

spafe/features/msrcc.py

@@ -104,7 +104,7 @@ def msrcc(
             from spafe.utils.vis import show_features
 
             # read audio
-            fpath = "../../../data/test.wav"
+            fpath = "../../../tests/data/test.wav"
             fs, sig = read(fpath)
 
             # compute msrccs

spafe/features/ngcc.py

@@ -107,7 +107,7 @@ def ngcc(
             from spafe.utils.vis import show_features
 
             # read audio
-            fpath = "../../../data/test.wav"
+            fpath = "../../../tests/data/test.wav"
             fs, sig = read(fpath)
 
             # compute ngccs

spafe/features/pncc.py

@@ -369,7 +369,7 @@ def pncc(
             from spafe.utils.vis import show_features
 
             # read audio
-            fpath = "../../../data/test.wav"
+            fpath = "../../../tests/data/test.wav"
             fs, sig = read(fpath)
 
             # compute pnccs

spafe/features/psrcc.py

@@ -110,7 +110,7 @@ def psrcc(
             from spafe.utils.vis import show_features
 
             # read audio
-            fpath = "../../../data/test.wav"
+            fpath = "../../../tests/data/test.wav"
             fs, sig = read(fpath)
 
             # compute psrccs

spafe/features/rplp.py

@@ -254,7 +254,7 @@ def plp(
             from spafe.utils.vis import show_features
 
             # read audio
-            fpath = "../../../data/test.wav"
+            fpath = "../../../tests/data/test.wav"
             fs, sig = read(fpath)
 
             # compute plps
@@ -367,7 +367,7 @@ def rplp(
             from spafe.utils.vis import show_features
 
             # read audio
-            fpath = "../../../data/test.wav"
+            fpath = "../../../tests/data/test.wav"
             fs, sig = read(fpath)
 
             # compute rplps

spafe/features/spfeats.py

@@ -302,7 +302,7 @@ def extract_feats(sig: np.ndarray, fs: int, nfft: int = 512) -> SpectralFeats:
             from pprint import pprint
 
             # read audio
-            fpath = "../../../data/test.wav"
+            fpath = "../../../tests/data/test.wav"
             fs, sig = read(fpath)
 
             # compute erb spectrogram

spafe/frequencies/dominant_frequencies.py

@@ -71,7 +71,7 @@ def get_dominant_frequencies(
             win_hop = 0.010
 
             # read audio
-            fpath = "../../../data/test.wav"
+            fpath = "../../../tests/data/test.wav"
             fs, sig = read(fpath)
 
             # compute dominant frequencies
@@ -83,7 +83,7 @@ def get_dominant_frequencies(
                                                             nfft=nfft,
                                                             win_len=win_len,
                                                             win_hop=win_hop,
-                                                            win_type: WindowType="hamming")
+                                                            win_type="hamming")
 
             # compute FFT, Magnitude, Power spectra
             fourrier_transform = np.absolute(np.fft.fft(sig, nfft))

spafe/frequencies/fundamental_frequencies.py

@@ -177,7 +177,7 @@ def compute_yin(
 
 
             # read audio
-            fpath = "../../../data/test.wav"
+            fpath = "../../../tests/data/test.wav"
             fs, sig = read(fpath)
             duration = len(sig) / fs
             harmonic_threshold = 0.85

spafe/version.py

@@ -6,4 +6,4 @@
   For a copy, see <https://github.com/SuperKogito/spafe/blob/master/LICENSE>.
 
 """
-__version__ = "0.2.0"
+__version__ = "0.3.0"