cemsubakan commited on
Commit
6281c4a
1 Parent(s): 39c3cce

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +38 -6
README.md CHANGED
@@ -35,41 +35,73 @@ The paper for the REAL-M dataset can be found on [this arxiv link](https://arxiv
35
 
36
  ## Install SpeechBrain
37
 
38
- First of all, please install SpeechBrain with the following command:
 
 
 
 
 
 
39
 
40
  ```
41
- pip install speechbrain
 
 
 
 
 
 
 
 
 
 
42
  ```
43
 
44
- Please notice that we encourage you to read our tutorials and learn more about
45
- [SpeechBrain](https://speechbrain.github.io).
46
 
47
 
48
  ### Inference on GPU
49
  To perform inference on the GPU, add `run_opts={"device":"cuda"}` when calling the `from_hparams` method.
50
 
51
  ### Training
 
52
  The model was trained with SpeechBrain (fc2eabb7).
 
53
  To train it from scratch follows these steps:
 
54
  1. Clone SpeechBrain:
 
55
  ```bash
 
56
  git clone https://github.com/speechbrain/speechbrain/
 
57
  ```
 
58
  2. Install it:
 
59
  ```
 
60
  cd speechbrain
 
61
  pip install -r requirements.txt
 
62
  pip install -e .
 
63
  ```
64
 
65
  3. Run Training:
 
66
  ```
67
- cd recipes/WSJ0Mix/separation
68
- python train.py hparams/sepformer.yaml --data_folder=your_data_folder
 
 
 
69
  ```
70
 
71
  You can find our training results (models, logs, etc) [here](https://drive.google.com/drive/folders/1NGncbjvLeGfbUqmVi6ej-NH9YQn5vBmI).
72
 
 
73
  ### Limitations
74
  The SpeechBrain team does not provide any warranty on the performance achieved by this model when used on other datasets.
75
 
 
35
 
36
  ## Install SpeechBrain
37
 
38
+ First of all, currently you need to install SpeechBrain from the source:
39
+
40
+ 1. Clone SpeechBrain:
41
+
42
+ ```bash
43
+
44
+ git clone https://github.com/speechbrain/speechbrain/
45
 
46
  ```
47
+
48
+ 2. Install it:
49
+
50
+ ```
51
+
52
+ cd speechbrain
53
+
54
+ pip install -r requirements.txt
55
+
56
+ pip install -e .
57
+
58
  ```
59
 
60
+ Please notice that we encourage you to read our tutorials and learn more about [SpeechBrain](https://speechbrain.github.io).
 
61
 
62
 
63
  ### Inference on GPU
64
  To perform inference on the GPU, add `run_opts={"device":"cuda"}` when calling the `from_hparams` method.
65
 
66
  ### Training
67
+
68
  The model was trained with SpeechBrain (fc2eabb7).
69
+
70
  To train it from scratch follows these steps:
71
+
72
  1. Clone SpeechBrain:
73
+
74
  ```bash
75
+
76
  git clone https://github.com/speechbrain/speechbrain/
77
+
78
  ```
79
+
80
  2. Install it:
81
+
82
  ```
83
+
84
  cd speechbrain
85
+
86
  pip install -r requirements.txt
87
+
88
  pip install -e .
89
+
90
  ```
91
 
92
  3. Run Training:
93
+
94
  ```
95
+
96
+ cd recipes/REAL-M/sisnr-estimation
97
+
98
+ python train.py hparams/pool_sisnrestimator.yaml --data_folder /yourLibri2Mixpath --base_folder_dm /yourLibriSpeechpath --rir_path /yourpathforwhamrRIRs --dynamic_mixing True --use_whamr_train True --whamr_data_folder /yourpath/whamr --base_folder_dm_whamr /yourpath/wsj0-processed/si_tr_s
99
+
100
  ```
101
 
102
  You can find our training results (models, logs, etc) [here](https://drive.google.com/drive/folders/1NGncbjvLeGfbUqmVi6ej-NH9YQn5vBmI).
103
 
104
+
105
  ### Limitations
106
  The SpeechBrain team does not provide any warranty on the performance achieved by this model when used on other datasets.
107