NatalieElizabeth commited on
Commit
96c979f
·
1 Parent(s): e617857

fix readme

Browse files
Files changed (1) hide show
  1. README.md +15 -96
README.md CHANGED
@@ -1,96 +1,15 @@
1
- # Apollo Audio Restoration - PyHarp Wrapper
2
-
3
- High-quality audio restoration for lossy MP3 compressed audio using the Apollo model, wrapped for use with HARP and Gradio.
4
-
5
- ## Features
6
-
7
- - **Band-Sequence Modeling**: Explicit frequency band splitting for coherent high-frequency reconstruction
8
- - **GPU Accelerated**: CUDA support for fast inference
9
- - **DAW Integration**: Use within Digital Audio Workstations via HARP plugin
10
- - **High Quality**: Outperforms SR-GAN models across various bitrates and music genres
11
-
12
- ## Installation
13
-
14
- ### Prerequisites
15
-
16
- - Ubuntu 20.04 or later
17
- - Python 3.10+
18
- - CUDA 11.8+ (recommended, CPU inference supported)
19
-
20
- ### Setup
21
- ```bash
22
- # Clone this repository
23
- git clone <this-repo-url>
24
- cd Apollo-PyHarp
25
-
26
- # Create conda environment
27
- conda create --name apollo-pyharp python=3.10
28
- conda activate apollo-pyharp
29
-
30
- # Install dependencies
31
- pip install -r requirements.txt
32
-
33
- # Download pretrained model
34
- mkdir -p checkpoints
35
- # Download model and place in checkpoints/apollo_model.pt
36
- # See https://github.com/JusperLee/Apollo for model links
37
- ```
38
-
39
- ## Usage
40
-
41
- ### Local Testing
42
- ```bash
43
- conda activate apollo-pyharp
44
- python app.py
45
- ```
46
-
47
- Visit `http://localhost:7860` to test the interface.
48
-
49
- ### With HARP
50
-
51
- 1. Run the app as above
52
- 2. Copy the **local URL** (not the public one for private testing)
53
- 3. Open HARP settings and add the endpoint as a custom path
54
- 4. Select Apollo Audio Restoration from the model list
55
-
56
- ### Deployment to HuggingFace Spaces
57
- ```bash
58
- # Create a Space on HuggingFace, then:
59
- git clone https://huggingface.co/spaces/USERNAME/apollo-restoration
60
- cd apollo-restoration
61
-
62
- # Copy files
63
- cp -r ../Apollo-PyHarp/* .
64
-
65
- # Set up Git LFS for model checkpoint
66
- git lfs install
67
- git lfs track "checkpoints/*.pt"
68
-
69
- # Push to HuggingFace
70
- git add .
71
- git commit -m "Initial Apollo PyHarp deployment"
72
- git push
73
- ```
74
-
75
- ## Citation
76
-
77
- If you use Apollo in your research, please cite:
78
- ```bibtex
79
- @inproceedings{li2025apollo,
80
- title={Apollo: Band-sequence Modeling for High-Quality Music Restoration in Compressed Audio},
81
- author={Li, Kai and Luo, Yi},
82
- booktitle={IEEE International Conference on Acoustics, Speech and Signal Processing (ICASPC)},
83
- year={2025},
84
- organization={IEEE}
85
- }
86
- ```
87
-
88
- ## License
89
-
90
- This wrapper is provided under the same license as Apollo (CC BY-SA 4.0).
91
-
92
- ## References
93
-
94
- - [Apollo GitHub](https://github.com/JusperLee/Apollo)
95
- - [PyHarp GitHub](https://github.com/TEAMuP-dev/pyharp)
96
- - [HARP GitHub](https://github.com/TEAMuP-dev/HARP)
 
1
+ ---
2
+ title: {{title}}
3
+ emoji: {{emoji}}
4
+ colorFrom: {{colorFrom}}
5
+ colorTo: {{colorTo}}
6
+ sdk: {{sdk}}
7
+ sdk_version: "{{sdkVersion}}"
8
+ {{#pythonVersion}}
9
+ python_version: "{{pythonVersion}}"
10
+ {{/pythonVersion}}
11
+ app_file: app.py
12
+ pinned: false
13
+ ---
14
+
15
+ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference