speechbrainteam commited on
Commit
18c0d36
1 Parent(s): 8931a14

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +23 -1
README.md CHANGED
@@ -68,6 +68,28 @@ asr_model.transcribe_file("speechbrain/asr-transformer-aishell/example.wav")
68
  ### Inference on GPU
69
  To perform inference on the GPU, add `run_opts={"device":"cuda"}` when calling the `from_hparams` method.
70
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
71
  ### Limitations
72
  The SpeechBrain team does not provide any warranty on the performance achieved by this model when used on other datasets.
73
 
@@ -80,7 +102,7 @@ The SpeechBrain team does not provide any warranty on the performance achieved b
80
  year = {2021},
81
  publisher = {GitHub},
82
  journal = {GitHub repository},
83
- howpublished = {\url{https://github.com/speechbrain/speechbrain}},
84
  }
85
  ```
86
 
 
68
  ### Inference on GPU
69
  To perform inference on the GPU, add `run_opts={"device":"cuda"}` when calling the `from_hparams` method.
70
 
71
+ ### Training
72
+ The model was trained with SpeechBrain (Commit hash: '986a2175').
73
+ To train it from scratch follow these steps:
74
+ 1. Clone SpeechBrain:
75
+ ```bash
76
+ git clone https://github.com/speechbrain/speechbrain/
77
+ ```
78
+ 2. Install it:
79
+ ```bash
80
+ cd speechbrain
81
+ pip install -r requirements.txt
82
+ pip install -e .
83
+ ```
84
+
85
+ 3. Run Training:
86
+ ```bash
87
+ cd recipes/AISHELL-1/ASR/transformer/
88
+ python train.py hparams/train_ASR_transformer.yaml --data_folder=your_data_folder
89
+ ```
90
+
91
+ You can find our training results (models, logs, etc) [here](https://drive.google.com/drive/folders/1QU18YoauzLOXueogspT0CgR5bqJ6zFfu?usp=sharing).
92
+
93
  ### Limitations
94
  The SpeechBrain team does not provide any warranty on the performance achieved by this model when used on other datasets.
95
 
 
102
  year = {2021},
103
  publisher = {GitHub},
104
  journal = {GitHub repository},
105
+ howpublished = {\\url{https://github.com/speechbrain/speechbrain}},
106
  }
107
  ```
108