Skip to content

Commit c2152be

Browse files
committed
Fixed some typos in README and removed e.g. from example usage
1 parent 33b73df commit c2152be

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,26 +38,29 @@ Leader-board for the ZeroSpeech 2020 challenge can be found [here](https://zeros
3838
Note: `in_dir` must be the path to the `2019` folder.
3939
For `dataset` choose between `2019/english` or `2019/surprise`.
4040
Other datasets will be added in the future.
41+
Example usage:
4142
```
42-
e.g. python preprecess.py in_dir=../datasets/2020/2019 dataset=2019/english
43+
python preprocess.py in_dir=../datasets/2020/2019 dataset=2019/english
4344
```
4445
4546
## Training
4647
47-
1. Train the VQ-CPC model (pretrained weights will be released soon):
48+
1. Train the VQ-CPC model (pretrained weights are given above):
4849
```
4950
python train_cpc.py checkpoint_dir=path/to/checkpoint_dir dataset=[2019/english or 2019/surprise]
5051
```
52+
Example usage:
5153
```
52-
e.g. python train_cpc.py checkpoint_dir=checkpoints/cpc/2019english dataset=2019/english
54+
python train_cpc.py checkpoint_dir=checkpoints/cpc/2019english dataset=2019/english
5355
```
5456
5557
2. Train the vocoder:
5658
```
5759
python train_vocoder.py cpc_checkpoint=path/to/cpc/checkpoint checkpoint_dir=path/to/checkpoint_dir dataset=[2019/english or 2019/surprise]
5860
```
61+
Example usage:
5962
```
60-
e.g. python train_vocoder.py cpc_checkpoint=checkpoints/cpc/english2019/model.ckpt-24000.pt checkpoint_dir=checkpoints/vocoder/english2019
63+
python train_vocoder.py cpc_checkpoint=checkpoints/cpc/english2019/model.ckpt-24000.pt checkpoint_dir=checkpoints/vocoder/english2019
6164
```
6265
6366
## Evaluation
@@ -80,8 +83,9 @@ Note: the `synthesis list` is a `json` file:
8083
containing a list of items with a) the path (relative to `in_dir`) of the source `wav` files;
8184
b) the target speaker (see `datasets/2019/english/speakers.json` for a list of options);
8285
and c) the target file name.
86+
Example usage:
8387
```
84-
e.g. python convert.py cpc_checkpoint=checkpoints/cpc/english2019/model.ckpt-25000.pt vocoder_checkpoint=checkpoints/vocoder/english2019/model.ckpt-150000.pt in_dir=../datasets/2020/2019 out_dir=submission/2019/english/test synthesis_list=datasets/2019/english/synthesis.json in_dir=../../Datasets/2020/2019 dataset=2019/english
88+
python convert.py cpc_checkpoint=checkpoints/cpc/english2019/model.ckpt-25000.pt vocoder_checkpoint=checkpoints/vocoder/english2019/model.ckpt-150000.pt in_dir=../datasets/2020/2019 out_dir=submission/2019/english/test synthesis_list=datasets/2019/english/synthesis.json in_dir=../../Datasets/2020/2019 dataset=2019/english
8589
```
8690
Voice conversion samples will be available soon.
8791

0 commit comments

Comments
 (0)