badd9yang commited on
Commit
16c8c85
Β·
verified Β·
1 Parent(s): d7d7d2a

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +59 -1
README.md CHANGED
@@ -3,6 +3,64 @@
3
 
4
  ---
5
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
6
  ## **1. Core Features Overview**
7
 
8
  ### **1.1 Song Editing Pipeline**
@@ -167,4 +225,4 @@ We extend gratitude to the open-source community:
167
 
168
  > *"From raw audio to professional vocal production – all in one pipeline."*
169
 
170
- [Contact Support](yangchen@hccl.ioa.ac.cn) | [GitHub Repository](https://github.com/badd9yang) | [API Reference](diffsinger.com)
 
3
 
4
  ---
5
 
6
+ ## **0. System Setup Guide**
7
+
8
+ ### **0.1 Environment Preparation**
9
+
10
+ **Hardware Requirements:**
11
+
12
+ - NVIDIA GPU (β‰₯16GB VRAM recommended)
13
+ - CUDA 11.7+ and cuDNN 8.7+
14
+
15
+ **Installation Steps:**
16
+
17
+ ```bash
18
+ # Create conda environment
19
+ conda create -n songedit python=3.10 -y
20
+ conda activate songedit
21
+
22
+ # Install dependencies (env.sh contents)
23
+ pip install torch==2.0.1+cu117 --extra-index-url https://download.pytorch.org/whl/cu117
24
+ pip install onnxruntime-gpu --extra-index-url https://aiinfra.pkgs.visualstudio.com/PublicPackages/_packaging/onnxruntime-cuda-12/pypi/simple/
25
+ pip install -r requirements.txt
26
+
27
+ # Install audio processing libs
28
+ conda install -c conda-forge ffmpeg libsndfile
29
+ ```
30
+
31
+ ### **0.2 Model Checkpoints**
32
+
33
+ Download pretrained models from HuggingFace:
34
+
35
+ ```bash
36
+ # Install huggingface_hub if needed
37
+ pip install huggingface_hub
38
+
39
+ # Download all checkpoints
40
+ python -c "
41
+ from huggingface_hub import snapshot_download
42
+ snapshot_download(repo_id='badd9yang/songedit',
43
+ local_dir='checkpoints') # Optional for private repos
44
+ "
45
+
46
+ # Expected folder structure:
47
+ checkpoints/
48
+ β”œβ”€β”€ step1/
49
+ β”‚ β”œβ”€β”€ separate_model.pt
50
+ β”‚ β”œβ”€β”€ whisper/
51
+ β”‚ β”œβ”€β”€ ...
52
+ β”‚ └── align.ckpt
53
+ └── step2/
54
+ β”œβ”€β”€ whisper-small/
55
+ β”œβ”€β”€ model_v1.pt
56
+ └── model_v2.pt
57
+
58
+ ```
59
+
60
+ > **Note:** For manual download, get models from [HuggingFace Repo](https://huggingface.co/badd9yang/songedit/tree/main)
61
+
62
+
63
+
64
  ## **1. Core Features Overview**
65
 
66
  ### **1.1 Song Editing Pipeline**
 
225
 
226
  > *"From raw audio to professional vocal production – all in one pipeline."*
227
 
228
+ [Contact Support](yangchen@hccl.ioa.ac.cn) | [GitHub Repository](github.com/badd9yang) | [API Reference](diffsinger.com)