1.0.11 PR

.github/workflows/tests.yml

@@ -14,6 +14,7 @@ jobs:
       matrix:
         python-version:
           - "3.10"
+          - "3.11"
         os:
           - ubuntu-latest
           - windows-latest

.vscode/tasks.json

@@ -2,111 +2,7 @@
     "version": "2.0.0",
     "tasks": [
         {
-            "label": "Create Conda Environment",
-            "type": "shell",
-            "command": "conda env create --file environment.yml",
-            "group": {
-                "kind": "build",
-                "isDefault": true
-            },
-            "presentation": {
-                "reveal": "always"
-            },
-            "problemMatcher": []
-        },
-        {
-            "label": "Update Conda Environment",
-            "type": "shell",
-            "command": "conda env update --file environment.yml --prune",
-            "group": {
-                "kind": "build",
-                "isDefault": true
-            },
-            "presentation": {
-                "reveal": "always"
-            },
-            "problemMatcher": []
-        },
-        {
-            "label": "Remove Conda Environment",
-            "type": "shell",
-            "command": "conda env remove --name svc",
-            "group": {
-                "kind": "build",
-                "isDefault": false
-            },
-            "presentation": {
-                "reveal": "always"
-            },
-            "problemMatcher": []
-        },
-        {
-            "label": "Freeze Conda Environment",
-            "type": "shell",
-            "command": "conda env export -n svc > environment_tmp.yml",
-            "group": {
-                "kind": "build",
-                "isDefault": true
-            },
-            "presentation": {
-                "reveal": "always"
-            },
-            "problemMatcher": []
-        },
-        {
-            "label": "Create Conda Environment (Development)",
-            "type": "shell",
-            "command": "conda env create --file environment_dev.yml",
-            "group": {
-                "kind": "build",
-                "isDefault": true
-            },
-            "presentation": {
-                "reveal": "always"
-            },
-            "problemMatcher": []
-        },
-        {
-            "label": "Update Conda Environment (Development)",
-            "type": "shell",
-            "command": "conda env update --file environment_dev.yml --prune",
-            "group": {
-                "kind": "build",
-                "isDefault": true
-            },
-            "presentation": {
-                "reveal": "always"
-            },
-            "problemMatcher": []
-        },
-        {
-            "label": "Remove Conda Environment (Development)",
-            "type": "shell",
-            "command": "conda env remove --name svc_dev",
-            "group": {
-                "kind": "build",
-                "isDefault": false
-            },
-            "presentation": {
-                "reveal": "always"
-            },
-            "problemMatcher": []
-        },
-        {
-            "label": "Freeze Conda Environment (Development)",
-            "type": "shell",
-            "command": "conda env export -n svc_dev > environment_dev_tmp.yml",
-            "group": {
-                "kind": "build",
-                "isDefault": true
-            },
-            "presentation": {
-                "reveal": "always"
-            },
-            "problemMatcher": []
-        },
-        {
-            "label": "Poetry Install (Development)",
+            "label": "Poetry Install",
             "type": "shell",
             "command": "poetry install",
             "group": {
@@ -119,7 +15,7 @@
             "problemMatcher": []
         },
         {
-            "label": "Poetry Update (Development)",
+            "label": "Poetry Update",
             "type": "shell",
             "command": "poetry update",
             "group": {
@@ -134,7 +30,6 @@
         {
             "label": "Generate Test Coverage Report",
             "type": "shell",
-            // "command": "pytest --cov=src/ --cov-report=html --cov-report=xml -W ignore::DeprecationWarning tests/",
             "command": "poetry run pytest",
             "problemMatcher": [],
             "group": {

README.md

@@ -11,7 +11,7 @@ with Deep U-Net model for vocal separation feature and easy to use GUI.
 
 ### Installation
 
-1. Install [Python](https://www.python.org/downloads/) (3.10 is recommended, but 3.10 - 3.12 should work)
+1. Install [Python](https://www.python.org/downloads/) (3.10 is recommended, but 3.10 - 3.11 should work)
 
 2. Install [pipx](https://pipx.pypa.io/stable/installation/)
 
@@ -66,4 +66,11 @@ For the detailed usage guide, see [Usage](https://jljl1337.github.io/svc-toolkit
 
 ## Development
 
-For the detailed development guide, see [Development](https://jljl1337.github.io/svc-toolkit/development/).
+For the detailed development guide, see [Development](https://jljl1337.github.io/svc-toolkit/development/).
+
+## About
+
+This project is the implementation of the final year project for the Bachelor of
+Science in Computer Science, Department of Computer Science, City University of Hong
+Kong, named "Singing Voice Conversion from Fully Mixed Track with GUI", with project code
+`23CS062`.

config.yml

@@ -1,15 +1,16 @@
 resume_path: ''
-batch_size: 32
+batch_size: 16
 epochs: 1000
 loader_num_workers: 4
 deterministic: True
+precision: bf16
 sample_rate: 44100
 win_length: 4096
 hop_length: 1024
 patch_length: 512
 expand_factor: 12
 neglect_frequency: nyquist
-learning_rate: 1.0e-3
-weight_decay: 1.0e-6
+learning_rate: 1.0e-04
+weight_decay: 1.0e-08
 optimizer: adam
-deeper: False
+deeper: True

docs/development.md

@@ -24,15 +24,15 @@ steps to install for GPU support might be different.
 
 To set up the development environment, follow these steps:
 
-1. Install [Python](https://www.python.org/downloads/) (3.10 is recommended, but 3.10 - 3.12 should work)
+1. Install [Python](https://www.python.org/downloads/) (3.10 is recommended, but 3.10 - 3.11 should work)
 
 2. Install [Poetry](https://python-poetry.org/docs/#installation)
 
 3. Clone the repository and checkout a non-main branch
 
 4. Select the Python version to use with Poetry. For example, to use Python 3.10:
 
-        poetry env use 3.10
+        poetry env use path/to/python3.10
 
 5. Install the package in editable mode
 
@@ -54,4 +54,14 @@ To set up the development environment, follow these steps:
 
         pip install -U torch==2.1.1 torchaudio==2.1.1 --index-url https://download.pytorch.org/whl/cu118
 
-8. Good to go!
+8. Good to go!
+
+## Testing
+
+To run the tests, run the following command:
+
+    poetry run pytest
+
+If the poetry environment is activated, you can just run `pytest` straight away:
+
+    pytest

docs/installation.md

@@ -2,7 +2,7 @@
 
 ## Option 1: pipx
 
-1. Install [Python](https://www.python.org/downloads/) (3.10 is recommended, but 3.10 - 3.12 should work)
+1. Install [Python](https://www.python.org/downloads/) (3.10 is recommended, but 3.10 - 3.11 should work)
 
 2. Install [pipx](https://pipx.pypa.io/stable/installation/)
 

docs/troubleshooting.md

@@ -5,14 +5,14 @@
 If the package is not working as expected, try uninstalling and installing the package
 again.
 
-If the package is installed using pipx, uninstall the package using this command:
+If the package is installed using `pipx`, uninstall the package using this command:
 
 ```
 pipx uninstall svc-toolkit
 ```
 
 If the package is installed using virtual environment, uninstall the package by 
-deactivating the virtual environment and delete it.
+deactivating the virtual environment and removing it.
 
 Then, install the package again. For installation instructions, see [here](./installation.md).