sofieff commited on
Commit
4e48007
·
verified ·
1 Parent(s): be02a3a

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +4 -4
README.md CHANGED
@@ -21,7 +21,7 @@ A user-friendly, accessible neuro-music studio for motor rehabilitation and crea
21
  - **DJ Mode:** After all four layers are added, apply real-time audio effects (Echo, Low Pass, Compressor, Fade In/Out) to remix your composition using new brain commands.
22
  - **Seamless Playback:** All completed layers play continuously, with smooth transitions and effect toggling.
23
  - **Manual Classifier:** Test the classifier on individual movements and visualize EEG data, class probabilities, and confusion matrix.
24
- - **Accessible UI:** Built with Gradio for easy use in browser or on Hugging Face Spaces.
25
 
26
  ## How It Works
27
 
@@ -35,7 +35,7 @@ A user-friendly, accessible neuro-music studio for motor rehabilitation and crea
35
  - Effects are sticky and only toggle every 4th repetition for smoothness.
36
  3. **Manual Classifier:**
37
  - Switch to the Manual Classifier tab to test the model on random epochs for each movement.
38
- - Visualize predictions, probabilities, and confusion matrix.
39
 
40
  ## Project Structure
41
 
@@ -57,7 +57,7 @@ SoundHelix-Song-6/ # Demo audio stems (bass, drums, instruments, vocals)
57
  pip install -r requirements.txt
58
  ```
59
  2. **Add required data:**
60
- - Ensure the `SoundHelix-Song-1/` folder with all audio stems (`bass.wav`, `drums.wav`, `instruments.wav` or `other.wav`, `vocals.wav`) is present and tracked in your repository.
61
  - Include at least one demo EEG `.mat` file (as referenced in your `DEMO_DATA_PATHS` in `config.py`) for the app to run out-of-the-box. Place it in the correct location and ensure it is tracked by git.
62
  3. **Run the app:**
63
  ```bash
@@ -70,7 +70,7 @@ SoundHelix-Song-6/ # Demo audio stems (bass, drums, instruments, vocals)
70
 
71
  - Ready for Hugging Face Spaces or any Gradio-compatible cloud platform.
72
  - Minimal `.gitignore` and clean repo for easy deployment.
73
- - Make sure to include all required audio stems and at least two demo `.mat` EEG file in your deployment for full functionality.
74
 
75
  ## Credits
76
 
 
21
  - **DJ Mode:** After all four layers are added, apply real-time audio effects (Echo, Low Pass, Compressor, Fade In/Out) to remix your composition using new brain commands.
22
  - **Seamless Playback:** All completed layers play continuously, with smooth transitions and effect toggling.
23
  - **Manual Classifier:** Test the classifier on individual movements and visualize EEG data, class probabilities, and confusion matrix.
24
+ - **Accessible UI:** Built with Gradio for easy use in a browser or on Hugging Face Spaces.
25
 
26
  ## How It Works
27
 
 
35
  - Effects are sticky and only toggle every 4th repetition for smoothness.
36
  3. **Manual Classifier:**
37
  - Switch to the Manual Classifier tab to test the model on random epochs for each movement.
38
+ - Visualize predictions, probabilities, and the confusion matrix.
39
 
40
  ## Project Structure
41
 
 
57
  pip install -r requirements.txt
58
  ```
59
  2. **Add required data:**
60
+ - Ensure the `SoundHelix-Song-6/` folder with all audio stems (`bass.wav`, `drums.wav`, `instruments.wav` or `other.wav`, `vocals.wav`) is present and tracked in your repository.
61
  - Include at least one demo EEG `.mat` file (as referenced in your `DEMO_DATA_PATHS` in `config.py`) for the app to run out-of-the-box. Place it in the correct location and ensure it is tracked by git.
62
  3. **Run the app:**
63
  ```bash
 
70
 
71
  - Ready for Hugging Face Spaces or any Gradio-compatible cloud platform.
72
  - Minimal `.gitignore` and clean repo for easy deployment.
73
+ - Make sure to include all required audio stems and at least two demo `.mat` EEG files in your deployment for full functionality.
74
 
75
  ## Credits
76