Repository: felixbur/nkululeko (language: python)

Issue:
Change development and GH action to use python3.9
Until now, I have used Python 3.8 to check Nkululeko functionalities, including the GitHub action.

Since python3.8 will reach end-of-life this year's October (2024/10), I plan to move to use python3.9 as my default python, including testing Nkululeko functionalities.

https://devguide.python.org/versions/

The current python3.8 version prevents to update newer packages, e.g, speechbrain>=1.0 which is used by feats_spkrec.py.




Discussion / hints:
i use, since longer, python 3.10
that's fine with you too?
I use Ubuntu 20.04. python 3.10 is not available in the universe, need to install it via ppa that I try to avoid.

Better to stick in the lowest supported version, imho.

Fix patch:
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..d6059be
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,153 @@
+# Python bytecode
+__pycache__/
+*.py[cod]
+*$py.class
+
+
+# IDE settings
+.vscode/
+.idea/
+
+# Logs
+*.log
+
+# Database
+*.db
+*.sqlite3
+
+# OS generated files
+.DS_Store
+Thumbs.db
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# pyenv
+.python-version
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# mypy
+.mypy_cache/
+
+# Pyre type checker
+.pyre/
+
+# cache/tmp
+cache/
+bak/
+bak
+
+
+# others
+*.bak
+*.swp
+*.tmp
+*.tmp.*
+*.pyc
+*.bak*
+*.pkl
+*.wav
+*.csv
+*.onnx
+*.yaml
+*.png
+*.safetensors
+*.pth
+*.bin
+*.pt
+*.ckpt
+*.json
+
+
+# dataset
+data/*/** 
+
+# Ignore all symbolic links
+*.lnk
+*.sym
+*.symlink
+
+# Ignore exp folders
+exp_*/
+results/
+*_orig/
+*_test/
+*_tests/
+*_bak/
+*_tmp/
+*_old/
+*_backup/
+*_backup_*/
+./openXBOW/
+./pretrained_models/
+
+# ignore specific files
+results_*
+result_*
+test_*
+run_*.sh
+tmp*
+test*
+log.*
+
+# xbow
+xbow_codebook/
+nkulu_work/
+
+# ignore docs generated files
+docs/_build/
+docs/_static/
+docs/_templates/
+docs/source/
+docs/build/
diff --git a/data/README.md b/data/README.md
index 6dc07a5..8de3d88 100644
--- a/data/README.md
+++ b/data/README.md
@@ -1,15 +1,15 @@
 # Data
 
-This is the default top directory for data import for Nkululeko.
+This is the default top directory for Nkululeko data import.
 
 Each database should be in its own subfolder (you can also use `ln -sf`` to soft link original database path to these subfolders) and contain a README how to import the data to Nkululeko CSV or audformat.
 
 ## Accessibility
 
-The column `access` in the table below indicates the accessability of the database. The following values are used:
+The column `access` in the table below indicates the database's accessability. The following values are used:
 - `public`: the database is publicly available in the internet and can be downloaded directly without any restrictions.
-- `restricted`: the database is publicly available in the internet but requires registration or other restrictions to download.
-- `private`: the database is not publicly available in the internet and requires to contact privately to the owner of the dataset.
+- `restricted`: the database is publicly available on the internet but requires registration or other restrictions to download.
+- `private`: the database is not publicly available on the internet and requires the private information of the owner of the dataset.
 
 ## Databases
 
@@ -60,4 +60,4 @@ The column `access` in the table below indicates the accessability of the databa
 
 # Performance 
 <!-- include performance from images directory -->
-![Nkululeko performance](../meta/images/nkululeko_performance_202310.png)
+![Nkululeko performance](../meta/images/nkululeko_ser_20240719.png)
diff --git a/meta/images/nkululeko_ser_20240719.png b/meta/images/nkululeko_ser_20240719.png
new file mode 100644
index 0000000..6e930b4
Binary files /dev/null and b/meta/images/nkululeko_ser_20240719.png differ


Test patch:
diff --git a/.github/workflows/basic_tests_for_aud_csv.yaml b/.github/workflows/basic_tests_for_aud_csv.yaml
index 91fb238..2aa9455 100644
--- a/.github/workflows/basic_tests_for_aud_csv.yaml
+++ b/.github/workflows/basic_tests_for_aud_csv.yaml
@@ -10,7 +10,7 @@ jobs:
     - name: Set up Python
       uses: actions/setup-python@v3
       with:
-        python-version: '3.8'
+        python-version: '3.9'
         # cache: 'pip' # caching pip dependencies, causing error due to too large
     - name: Install dependencies
       run: |