Upload README
Browse files
README.md
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Audio Enhancement API
|
| 2 |
+
|
| 3 |
+
This repository contains a FastAPI-based audio enhancement model API with the following endpoints:
|
| 4 |
+
|
| 5 |
+
1. `/status/` : Communicates API status
|
| 6 |
+
2. `/prepare/` : Makes necessary preparations (downloading checkpoints, etc.) and initializes model
|
| 7 |
+
3. `/upload-audio/` : Upload audio files, save to noisy audio directory
|
| 8 |
+
4. `/enhance/` : Initialize model, enhance audio files, save to enhanced audio directory
|
| 9 |
+
5. `/download-enhanced/` : Download enhanced audio files
|
| 10 |
+
|
| 11 |
+
## Setup and Usage
|
| 12 |
+
|
| 13 |
+
1. Install the requirements:
|
| 14 |
+
```
|
| 15 |
+
pip install -r app/requirements.txt
|
| 16 |
+
```
|
| 17 |
+
|
| 18 |
+
2. Run the API:
|
| 19 |
+
```
|
| 20 |
+
python -m app.app
|
| 21 |
+
```
|
| 22 |
+
|
| 23 |
+
3. Access the API documentation at `http://localhost:8000/docs`
|