Update README.md
Browse files
README.md
CHANGED
|
@@ -1,3 +1,73 @@
|
|
| 1 |
-
---
|
| 2 |
-
license: apache-2.0
|
| 3 |
-
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: apache-2.0
|
| 3 |
+
---
|
| 4 |
+
---
|
| 5 |
+
title: BCI
|
| 6 |
+
emoji: 🏃
|
| 7 |
+
colorFrom: indigo
|
| 8 |
+
colorTo: red
|
| 9 |
+
sdk: gradio
|
| 10 |
+
sdk_version: 4.36.1
|
| 11 |
+
app_file: app.py
|
| 12 |
+
pinned: false
|
| 13 |
+
license: apache-2.0
|
| 14 |
+
---
|
| 15 |
+
# EEG Signal Processing and Classification
|
| 16 |
+
|
| 17 |
+
This Gradio Space allows you to process and classify EEG signals. You can upload EEG data, label it, preprocess the data, and train a machine learning model directly in your browser.
|
| 18 |
+
|
| 19 |
+
## Overview
|
| 20 |
+
|
| 21 |
+
This project provides an interface for:
|
| 22 |
+
|
| 23 |
+
1. Uploading and previewing EEG data.
|
| 24 |
+
2. Labeling data segments.
|
| 25 |
+
3. Preprocessing data to extract features.
|
| 26 |
+
4. Training a machine learning model.
|
| 27 |
+
5. Downloading the trained model and scaler.
|
| 28 |
+
|
| 29 |
+
## Demo
|
| 30 |
+
|
| 31 |
+
Check out the video demonstration below to see how to use the interface:
|
| 32 |
+
|
| 33 |
+
[](https://www.youtube.com/watch?v=_vWz-p26roY)
|
| 34 |
+
|
| 35 |
+
## Full Instructable
|
| 36 |
+
|
| 37 |
+
For a detailed step-by-step guide, visit Instructable page [here](https://www.instructables.com/Controlling-Video-Game-Using-Brainwaves-EEG/).
|
| 38 |
+
|
| 39 |
+
## Usage
|
| 40 |
+
|
| 41 |
+
### Uploading Data
|
| 42 |
+
|
| 43 |
+
1. Click on the "Upload CSV File" button to upload your EEG data.
|
| 44 |
+
2. Preview the uploaded data in the "Data Preview" section.
|
| 45 |
+
|
| 46 |
+
### Labeling Data
|
| 47 |
+
|
| 48 |
+
1. Enter the start index, end index, and label for each segment in the "Ranges for Labeling" section.
|
| 49 |
+
2. Click on the "Label Data" button to apply the labels.
|
| 50 |
+
|
| 51 |
+
### Training the Model
|
| 52 |
+
|
| 53 |
+
1. Click on the "Train Model" button to preprocess the data and train the model.
|
| 54 |
+
2. Download the trained model and scaler using the provided links.
|
| 55 |
+
|
| 56 |
+
## File Descriptions
|
| 57 |
+
|
| 58 |
+
- `app.py`: Contains the Gradio interface and main application logic.
|
| 59 |
+
- `requirements.txt`: Lists the dependencies required to run the project.
|
| 60 |
+
- `model.pkl`: The trained machine learning model (generated after training).
|
| 61 |
+
- `scaler.pkl`: The scaler used to preprocess the data (generated after training).
|
| 62 |
+
|
| 63 |
+
## License
|
| 64 |
+
|
| 65 |
+
This project is licensed under the apache-2.0.
|
| 66 |
+
|
| 67 |
+
## Acknowledgments
|
| 68 |
+
|
| 69 |
+
- Special thanks to the contributors and the open-source community.
|
| 70 |
+
- Thanks to the authors of the libraries used in this project.
|
| 71 |
+
|
| 72 |
+
|
| 73 |
+
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|