Text2Text Generation
speechbrain
English
G2P
Grapheme-to-Phoneme
speechbrainteam commited on
Commit
2992f6d
1 Parent(s): 6509079

Upload 7 files

Browse files
Files changed (8) hide show
  1. .gitattributes +1 -0
  2. LICENSE +201 -0
  3. README.md +130 -0
  4. config.json +3 -0
  5. ctc_lin.ckpt +0 -0
  6. gitattributes +41 -0
  7. hyperparams.yaml +440 -0
  8. model.ckpt +3 -0
.gitattributes ADDED
@@ -0,0 +1 @@
 
1
+ model.ckpt filter=lfs diff=lfs merge=lfs -text
LICENSE ADDED
@@ -0,0 +1,201 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
README.md ADDED
@@ -0,0 +1,130 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: apache-2.0
3
+ language: "en"
4
+ thumbnail:
5
+ tags:
6
+ - G2P
7
+ - Grapheme-to-Phoneme
8
+ - speechbrain
9
+ - text2text-generation
10
+ datasets:
11
+ - Librispeech
12
+ metrics:
13
+ - Phone-Error-Rate
14
+ widget:
15
+ - text: "English is tough. It can be understood through thorough thought though."
16
+ ---
17
+ # SoundChoice: Grapheme-to-Phoneme Models with Semantic Disambiguation
18
+
19
+ This repository provides all the necessary tools to perform English grapheme-to-phoneme conversion with a pretrained SoundChoice G2P model using SpeechBrain. It is trained on LibriG2P training data derived from [LibriSpeech Alignments](https://zenodo.org/record/2619474#.YuCdaC8r1ZF) and [Google Wikipedia](https://github.com/google/WikipediaHomographData)
20
+
21
+
22
+ ## Install SpeechBrain
23
+
24
+ First of all, please install SpeechBrain with the following command (local installation):
25
+
26
+ ```bash
27
+ pip install speechbrain
28
+ pip install transformers
29
+ ```
30
+
31
+ Please notice that we encourage you to read our tutorials and learn more about
32
+ [SpeechBrain](https://speechbrain.github.io).
33
+
34
+ ## Perform G2P Conversion
35
+
36
+ Please follow the example below to perform grapheme-to-phoneme conversion with a high-level wrapper.
37
+
38
+ ```python
39
+ from speechbrain.pretrained import GraphemeToPhoneme
40
+ g2p = GraphemeToPhoneme.from_hparams("speechbrain/soundchoice-g2p")
41
+ text = "To be or not to be, that is the question"
42
+ phonemes = g2p(text)
43
+ ```
44
+
45
+ Given below is the expected output
46
+ ```python
47
+ >>> phonemes
48
+ ['T', 'UW', ' ', 'B', 'IY', ' ', 'AO', 'R', ' ', 'N', 'AA', 'T', ' ', 'T', 'UW', ' ', 'B', 'IY', ' ', 'DH', 'AE', 'T', ' ', 'IH', 'Z', ' ', 'DH', 'AH', ' ', 'K', 'W', 'EH', 'S', 'CH', 'AH', 'N']
49
+ ```
50
+
51
+ To perform G2P conversion on a batch of text, pass
52
+ an array of strings to the interface:
53
+
54
+ ```python
55
+ items = [
56
+ "All's Well That Ends Well",
57
+ "The Merchant of Venice",
58
+ "The Two Gentlemen of Verona",
59
+ "The Comedy of Errors"
60
+ ]
61
+ transcriptions = g2p(items)
62
+ ```
63
+
64
+ Given below is the expected output:
65
+
66
+ ```python
67
+ >>> transcriptions
68
+ [['AO', 'L', 'Z', ' ', 'W', 'EH', 'L', ' ', 'DH', 'AE', 'T', ' ', 'EH', 'N', 'D', 'Z', ' ', 'W', 'EH', 'L'], ['DH', 'AH', ' ', 'M', 'ER', 'CH', 'AH', 'N', 'T', ' ', 'AH', 'V', ' ', 'V', 'EH', 'N', 'AH', 'S'], ['DH', 'AH', ' ', 'T', 'UW', ' ', 'JH', 'EH', 'N', 'T', 'AH', 'L', 'M', 'IH', 'N', ' ', 'AH', 'V', ' ', 'V', 'ER', 'OW', 'N', 'AH'], ['DH', 'AH', ' ', 'K', 'AA', 'M', 'AH', 'D', 'IY', ' ', 'AH', 'V', ' ', 'EH', 'R', 'ER', 'Z']]
69
+ ```
70
+
71
+ ### Inference on GPU
72
+ To perform inference on the GPU, add `run_opts={"device":"cuda"}` when calling the `from_hparams` method.
73
+
74
+ ### Limitations
75
+ The SpeechBrain team does not provide any warranty on the performance achieved by this model when used on other datasets.
76
+
77
+ ### Training
78
+ The model was trained with SpeechBrain (aa018540).
79
+ To train it from scratch follows these steps:
80
+ 1. Clone SpeechBrain:
81
+ ```bash
82
+ git clone https://github.com/speechbrain/speechbrain/
83
+ ```
84
+ 2. Install it:
85
+ ```
86
+ cd speechbrain
87
+ pip install -r requirements.txt
88
+ pip install -e .
89
+ ```
90
+
91
+ 3. Run Training:
92
+ ```
93
+ cd recipes/LibriSpeech/G2P
94
+ python train.py hparams/hparams_g2p_rnn.yaml --data_folder=your_data_folder
95
+ ```
96
+
97
+ Adjust hyperparameters as needed by passing additional arguments.
98
+
99
+ # **Citing SpeechBrain**
100
+ Please, cite SpeechBrain if you use it for your research or business.
101
+
102
+ ```bibtex
103
+ @misc{speechbrain,
104
+ title={{SpeechBrain}: A General-Purpose Speech Toolkit},
105
+ author={Mirco Ravanelli and Titouan Parcollet and Peter Plantinga and Aku Rouhe and Samuele Cornell and Loren Lugosch and Cem Subakan and Nauman Dawalatabad and Abdelwahab Heba and Jianyuan Zhong and Ju-Chieh Chou and Sung-Lin Yeh and Szu-Wei Fu and Chien-Feng Liao and Elena Rastorgueva and François Grondin and William Aris and Hwidong Na and Yan Gao and Renato De Mori and Yoshua Bengio},
106
+ year={2021},
107
+ eprint={2106.04624},
108
+ archivePrefix={arXiv},
109
+ primaryClass={eess.AS},
110
+ note={arXiv:2106.04624}
111
+ }
112
+ ```
113
+
114
+ Also please cite the SoundChoice G2P paper on which this pretrained model is based:
115
+
116
+ ```bibtex
117
+ @misc{ploujnikov2022soundchoice,
118
+ title={SoundChoice: Grapheme-to-Phoneme Models with Semantic Disambiguation},
119
+ author={Artem Ploujnikov and Mirco Ravanelli},
120
+ year={2022},
121
+ eprint={2207.13703},
122
+ archivePrefix={arXiv},
123
+ primaryClass={cs.SD}
124
+ }
125
+ ```
126
+
127
+ # **About SpeechBrain**
128
+ - Website: https://speechbrain.github.io/
129
+ - Code: https://github.com/speechbrain/speechbrain/
130
+ - HuggingFace: https://huggingface.co/speechbrain/
config.json ADDED
@@ -0,0 +1,3 @@
 
 
 
1
+ {
2
+ "speechbrain_interface": "GraphemeToPhoneme"
3
+ }
ctc_lin.ckpt ADDED
Binary file (177 kB). View file
gitattributes ADDED
@@ -0,0 +1,41 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ *.7z filter=lfs diff=lfs merge=lfs -text
2
+ *.arrow filter=lfs diff=lfs merge=lfs -text
3
+ *.bin filter=lfs diff=lfs merge=lfs -text
4
+ *.bz2 filter=lfs diff=lfs merge=lfs -text
5
+ *.ckpt filter=lfs diff=lfs merge=lfs -text
6
+ *.ftz filter=lfs diff=lfs merge=lfs -text
7
+ *.gz filter=lfs diff=lfs merge=lfs -text
8
+ *.h5 filter=lfs diff=lfs merge=lfs -text
9
+ *.joblib filter=lfs diff=lfs merge=lfs -text
10
+ *.lfs.* filter=lfs diff=lfs merge=lfs -text
11
+ *.mlmodel filter=lfs diff=lfs merge=lfs -text
12
+ *.model filter=lfs diff=lfs merge=lfs -text
13
+ *.msgpack filter=lfs diff=lfs merge=lfs -text
14
+ *.npy filter=lfs diff=lfs merge=lfs -text
15
+ *.npz filter=lfs diff=lfs merge=lfs -text
16
+ *.onnx filter=lfs diff=lfs merge=lfs -text
17
+ *.ot filter=lfs diff=lfs merge=lfs -text
18
+ *.parquet filter=lfs diff=lfs merge=lfs -text
19
+ *.pb filter=lfs diff=lfs merge=lfs -text
20
+ *.pickle filter=lfs diff=lfs merge=lfs -text
21
+ *.pkl filter=lfs diff=lfs merge=lfs -text
22
+ *.pt filter=lfs diff=lfs merge=lfs -text
23
+ *.pth filter=lfs diff=lfs merge=lfs -text
24
+ *.rar filter=lfs diff=lfs merge=lfs -text
25
+ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
26
+ *.tar.* filter=lfs diff=lfs merge=lfs -text
27
+ *.safetensors filter=lfs diff=lfs merge=lfs -text
28
+ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
29
+ *.tar.* filter=lfs diff=lfs merge=lfs -text
30
+ *.tar filter=lfs diff=lfs merge=lfs -text
31
+ *.tflite filter=lfs diff=lfs merge=lfs -text
32
+ *.tgz filter=lfs diff=lfs merge=lfs -text
33
+ *.wasm filter=lfs diff=lfs merge=lfs -text
34
+ *.xz filter=lfs diff=lfs merge=lfs -text
35
+ *.zip filter=lfs diff=lfs merge=lfs -text
36
+ *.zstandard filter=lfs diff=lfs merge=lfs -text
37
+ *tfevents* filter=lfs diff=lfs merge=lfs -text
38
+ ctc_lin.ckpt filter=lfs diff=lfs merge=lfs -text
39
+ model.ckpt filter=lfs diff=lfs merge=lfs -text
40
+ *.zst filter=lfs diff=lfs merge=lfs -text
41
+ *tfevents* filter=lfs diff=lfs merge=lfs -text
hyperparams.yaml ADDED
@@ -0,0 +1,440 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Generated 2022-07-09 from:
2
+ # /notebooks/speechbrain/recipes/LibriSpeech/G2P/hparams/hparams_g2p_rnn.yaml
3
+ # yamllint disable
4
+ # ################################
5
+ # Model: LSTM (encoder) + GRU (decoder) (tokenized)
6
+ # Authors:
7
+ # Loren Lugosch & Mirco Ravanelli 2020
8
+ # Artem Ploujnikov 2021
9
+ # ################################
10
+
11
+ # Seed needs to be set at top of yaml, before objects with parameters are made
12
+ seed: 1234
13
+ __set_seed: !apply:torch.manual_seed [!ref <seed>]
14
+
15
+
16
+ # Tokenizers
17
+ char_tokenize: False
18
+ char_token_type: unigram # ["unigram", "bpe", "char"]
19
+ char_token_output: 512
20
+ char_token_wordwise: True
21
+ phn_tokenize: False
22
+ phn_token_type: unigram # ["unigram", "bpe", "char"]
23
+ phn_token_output: 512 # index(blank/eos/bos/unk) = 0
24
+ phn_token_wordwise: True
25
+ character_coverage: 1.0
26
+
27
+
28
+ phonemes_count: 43
29
+ graphemes_count: 31
30
+ phonemes_enable_space: True
31
+
32
+ ctc_weight: 0.5
33
+ ctc_window_size: 0
34
+ homograph_loss_weight: 2.0
35
+
36
+ # Model parameters
37
+ output_neurons: !apply:speechbrain.utils.hparams.choice
38
+ value: !ref <phn_tokenize>
39
+ choices:
40
+ True: !ref <phn_token_output> + 1
41
+ False: !ref <phonemes_count>
42
+
43
+ enc_num_embeddings: !apply:speechbrain.utils.hparams.choice
44
+ value: !ref <char_tokenize>
45
+ choices:
46
+ True: !ref <char_token_output> + 1
47
+ False: !ref <graphemes_count>
48
+
49
+ enc_dropout: 0.5
50
+ enc_neurons: 512
51
+ enc_num_layers: 4
52
+ dec_dropout: 0.5
53
+ dec_neurons: 512
54
+ dec_att_neurons: 256
55
+ dec_num_layers: 4
56
+ embedding_dim: 512
57
+
58
+ # Determines whether to use BOS (beginning-of-sequence) or EOS (end-of-sequence) tokens
59
+ # Available modes:
60
+ # raw: no BOS/EOS tokens are added
61
+ # bos: a beginning-of-sequence token is added
62
+ # eos: an end-of-sequence token is added
63
+ grapheme_sequence_mode: bos
64
+ phoneme_sequence_mode: bos
65
+
66
+
67
+ # Special Token information
68
+ bos_index: 0
69
+ eos_index: 1
70
+ blank_index: 2
71
+ unk_index: 2
72
+ token_space_index: 512
73
+
74
+
75
+ # Language Model
76
+ lm_emb_dim: 256 # dimension of the embeddings
77
+ lm_rnn_size: 512 # dimension of hidden layers
78
+ lm_layers: 2 # number of hidden layers
79
+ lm_output_neurons: 43
80
+
81
+ # Beam Searcher
82
+ beam_search_min_decode_ratio: 0
83
+ beam_search_max_decode_ratio: 1.0
84
+ beam_search_beam_size: 16
85
+ beam_search_beam_size_valid: 16
86
+ beam_search_eos_threshold: 10.0
87
+ beam_search_using_max_attn_shift: false
88
+ beam_search_max_attn_shift: 10
89
+ beam_search_coverage_penalty: 5.0
90
+ beam_search_lm_weight: 0.5
91
+ beam_search_ctc_weight_decode: 0.4
92
+ beam_search_temperature: 1.25
93
+ beam_search_temperature_lm: 1.0
94
+
95
+ # Word embeddings
96
+ use_word_emb: true
97
+ word_emb_model: bert-base-uncased
98
+ word_emb_dim: 768
99
+ word_emb_enc_dim: 256
100
+ word_emb_norm_type: batch
101
+
102
+ graphemes:
103
+ - A
104
+ - B
105
+ - C
106
+ - D
107
+ - E
108
+ - F
109
+ - G
110
+ - H
111
+ - I
112
+ - J
113
+ - K
114
+ - L
115
+ - M
116
+ - N
117
+ - O
118
+ - P
119
+ - Q
120
+ - R
121
+ - S
122
+ - T
123
+ - U
124
+ - V
125
+ - W
126
+ - X
127
+ - Y
128
+ - Z
129
+ - "'"
130
+ - ' '
131
+
132
+ phonemes:
133
+ - AA
134
+ - AE
135
+ - AH
136
+ - AO
137
+ - AW
138
+ - AY
139
+ - B
140
+ - CH
141
+ - D
142
+ - DH
143
+ - EH
144
+ - ER
145
+ - EY
146
+ - F
147
+ - G
148
+ - HH
149
+ - IH
150
+ - IY
151
+ - JH
152
+ - K
153
+ - L
154
+ - M
155
+ - N
156
+ - NG
157
+ - OW
158
+ - OY
159
+ - P
160
+ - R
161
+ - S
162
+ - SH
163
+ - T
164
+ - TH
165
+ - UH
166
+ - UW
167
+ - V
168
+ - W
169
+ - Y
170
+ - Z
171
+ - ZH
172
+ - ' '
173
+
174
+ enc_input_dim: !apply:speechbrain.lobes.models.g2p.model.input_dim
175
+ use_word_emb: !ref <use_word_emb>
176
+ word_emb_enc_dim: !ref <word_emb_enc_dim>
177
+ embedding_dim: !ref <embedding_dim>
178
+
179
+ phn_char_map: !apply:speechbrain.lobes.models.g2p.dataio.build_token_char_map
180
+ tokens: !ref <phonemes>
181
+
182
+ char_phn_map: !apply:speechbrain.lobes.models.g2p.dataio.flip_map
183
+ map_dict: !ref <phn_char_map>
184
+
185
+ enc: !new:speechbrain.nnet.RNN.LSTM
186
+ input_shape: [null, null, !ref <enc_input_dim>]
187
+ bidirectional: True
188
+ hidden_size: !ref <enc_neurons>
189
+ num_layers: !ref <enc_num_layers>
190
+ dropout: !ref <enc_dropout>
191
+
192
+ lin: !new:speechbrain.nnet.linear.Linear
193
+ input_size: !ref <dec_neurons>
194
+ n_neurons: !ref <output_neurons>
195
+ bias: false
196
+
197
+ ctc_lin: !new:speechbrain.nnet.linear.Linear
198
+ input_size: !ref 2 * <enc_neurons>
199
+ n_neurons: !ref <output_neurons>
200
+
201
+ encoder_emb: !new:speechbrain.nnet.embedding.Embedding
202
+ num_embeddings: !ref <enc_num_embeddings>
203
+ embedding_dim: !ref <embedding_dim>
204
+
205
+ emb: !new:speechbrain.nnet.embedding.Embedding
206
+ num_embeddings: !ref <output_neurons>
207
+ embedding_dim: !ref <embedding_dim>
208
+
209
+ dec: !new:speechbrain.nnet.RNN.AttentionalRNNDecoder
210
+ enc_dim: !ref <enc_neurons> * 2
211
+ input_size: !ref <embedding_dim>
212
+ rnn_type: gru
213
+ attn_type: content
214
+ dropout: !ref <dec_dropout>
215
+ hidden_size: !ref <dec_neurons>
216
+ attn_dim: !ref <dec_att_neurons>
217
+ num_layers: !ref <dec_num_layers>
218
+
219
+ word_emb_enc: !new:speechbrain.lobes.models.g2p.model.WordEmbeddingEncoder
220
+ word_emb_dim: !ref <word_emb_dim>
221
+ word_emb_enc_dim: !ref <word_emb_enc_dim>
222
+ norm_type: batch
223
+
224
+ word_emb: !apply:speechbrain.lobes.models.g2p.dataio.lazy_init
225
+ init: !name:speechbrain.wordemb.transformer.TransformerWordEmbeddings
226
+ model: bert-base-uncased
227
+
228
+ log_softmax: !new:speechbrain.nnet.activations.Softmax
229
+ apply_log: true
230
+
231
+ model: !new:speechbrain.lobes.models.g2p.model.AttentionSeq2Seq
232
+ enc: !ref <enc>
233
+ encoder_emb: !ref <encoder_emb>
234
+ emb: !ref <emb>
235
+ dec: !ref <dec>
236
+ lin: !ref <lin>
237
+ out: !ref <log_softmax>
238
+ use_word_emb: !ref <use_word_emb>
239
+ word_emb_enc: !ref <word_emb_enc>
240
+
241
+ modules:
242
+ model: !ref <model>
243
+ enc: !ref <enc>
244
+ encoder_emb: !ref <encoder_emb>
245
+ emb: !ref <emb>
246
+ dec: !ref <dec>
247
+ lin: !ref <lin>
248
+ ctc_lin: !ref <ctc_lin>
249
+ out: !ref <log_softmax>
250
+ word_emb: !ref <word_emb>
251
+ word_emb_enc: !ref <word_emb_enc>
252
+
253
+ lm_model: !new:speechbrain.lobes.models.RNNLM.RNNLM
254
+ embedding_dim: !ref <lm_emb_dim>
255
+ rnn_layers: !ref <lm_layers>
256
+ rnn_neurons: !ref <lm_rnn_size>
257
+ output_neurons: !ref <lm_output_neurons>
258
+ return_hidden: True
259
+
260
+ ctc_scorer: !new:speechbrain.decoders.scorer.CTCScorer
261
+ eos_index: !ref <eos_index>
262
+ blank_index: !ref <blank_index>
263
+ ctc_fc: !ref <ctc_lin>
264
+ ctc_window_size: !ref <ctc_window_size>
265
+
266
+ coverage_scorer: !new:speechbrain.decoders.scorer.CoverageScorer
267
+ vocab_size: !ref <output_neurons>
268
+
269
+ scorer: !new:speechbrain.decoders.scorer.ScorerBuilder
270
+ full_scorers: [!ref <coverage_scorer>, !ref <ctc_scorer>]
271
+ weights:
272
+ coverage: !ref <beam_search_coverage_penalty>
273
+ ctc: !ref <ctc_weight>
274
+
275
+ beam_searcher: !new:speechbrain.decoders.S2SRNNBeamSearcher
276
+ embedding: !ref <emb>
277
+ decoder: !ref <dec>
278
+ linear: !ref <lin>
279
+ bos_index: !ref <bos_index>
280
+ eos_index: !ref <eos_index>
281
+ min_decode_ratio: !ref <beam_search_min_decode_ratio>
282
+ max_decode_ratio: !ref <beam_search_max_decode_ratio>
283
+ beam_size: !ref <beam_search_beam_size>
284
+ eos_threshold: !ref <beam_search_eos_threshold>
285
+ using_max_attn_shift: !ref <beam_search_using_max_attn_shift>
286
+ max_attn_shift: !ref <beam_search_max_attn_shift>
287
+ temperature: !ref <beam_search_temperature>
288
+ scorer: !ref <scorer>
289
+
290
+ beam_searcher_valid: !new:speechbrain.decoders.S2SRNNBeamSearcher
291
+ embedding: !ref <emb>
292
+ decoder: !ref <dec>
293
+ linear: !ref <lin>
294
+ bos_index: !ref <bos_index>
295
+ eos_index: !ref <eos_index>
296
+ min_decode_ratio: !ref <beam_search_min_decode_ratio>
297
+ max_decode_ratio: !ref <beam_search_max_decode_ratio>
298
+ beam_size: !ref <beam_search_beam_size>
299
+ eos_threshold: !ref <beam_search_eos_threshold>
300
+ using_max_attn_shift: !ref <beam_search_using_max_attn_shift>
301
+ max_attn_shift: !ref <beam_search_max_attn_shift>
302
+ temperature: !ref <beam_search_temperature>
303
+ scorer: !ref <scorer>
304
+
305
+ homograph_extractor: !new:speechbrain.lobes.models.g2p.homograph.SubsequenceExtractor
306
+
307
+ model_output_keys:
308
+ - p_seq
309
+ - char_lens
310
+ - encoder_out
311
+
312
+ grapheme_encoder: &id027 !new:speechbrain.dataio.encoder.TextEncoder
313
+ phoneme_encoder: &id024 !new:speechbrain.dataio.encoder.TextEncoder
314
+
315
+
316
+ grapheme_tokenizer: !apply:speechbrain.lobes.models.g2p.dataio.lazy_init
317
+ init: !name:speechbrain.tokenizers.SentencePiece.SentencePiece
318
+ model_dir: grapheme_tokenizer
319
+ bos_id: !ref <bos_index>
320
+ eos_id: !ref <eos_index>
321
+ unk_id: !ref <unk_index>
322
+ vocab_size: !ref <char_token_output>
323
+ annotation_train: null
324
+ annotation_read: char
325
+ model_type: !ref <char_token_type> # ["unigram", "bpe", "char"]
326
+ character_coverage: !ref <character_coverage>
327
+ annotation_format: json
328
+ text_file: grapheme_annotations.txt
329
+
330
+ phoneme_tokenizer: !apply:speechbrain.lobes.models.g2p.dataio.lazy_init
331
+ init: !name:speechbrain.tokenizers.SentencePiece.SentencePiece
332
+ model_dir: phoneme_tokenizer
333
+ bos_id: !ref <bos_index>
334
+ eos_id: !ref <eos_index>
335
+ unk_id: !ref <unk_index>
336
+ vocab_size: !ref <phn_token_output>
337
+ annotation_train: null
338
+ annotation_read: phn
339
+ model_type: !ref <phn_token_type> # ["unigram", "bpe", "char"]
340
+ character_coverage: !ref <character_coverage>
341
+ annotation_format: json
342
+ text_file: null
343
+
344
+ out_phoneme_decoder_tok: !apply:speechbrain.lobes.models.g2p.dataio.char_map_detokenize
345
+ tokenizer: !ref <phoneme_tokenizer>
346
+ char_map: !ref <char_phn_map>
347
+ token_space_index: !ref <token_space_index>
348
+ wordwise: !ref <phn_token_wordwise>
349
+
350
+ out_phoneme_decoder_raw: !name:speechbrain.lobes.models.g2p.dataio.text_decode
351
+ encoder: !ref <phoneme_encoder>
352
+
353
+ out_phoneme_decoder: !apply:speechbrain.utils.hparams.choice
354
+ value: false
355
+ choices:
356
+ True: !ref <out_phoneme_decoder_tok>
357
+ False: !ref <out_phoneme_decoder_raw>
358
+ encode_pipeline:
359
+ batch: false
360
+ use_padded_data: true
361
+ output_keys:
362
+ - grapheme_list
363
+ - grapheme_encoded_list
364
+ - grapheme_encoded
365
+ - word_emb
366
+ init:
367
+ - func: !name:speechbrain.lobes.models.g2p.dataio.enable_eos_bos
368
+ encoder: !ref <grapheme_encoder>
369
+ tokens: !ref <graphemes>
370
+ bos_index: !ref <bos_index>
371
+ eos_index: !ref <eos_index>
372
+ - func: !name:speechbrain.lobes.models.g2p.dataio.enable_eos_bos
373
+ encoder: !ref <phoneme_encoder>
374
+ tokens: !ref <phonemes>
375
+ bos_index: !ref <bos_index>
376
+ eos_index: !ref <eos_index>
377
+ steps:
378
+ - func: !name:speechbrain.lobes.models.g2p.dataio.clean_pipeline
379
+ graphemes: !ref <graphemes>
380
+ takes: txt
381
+ provides: txt_cleaned
382
+ - func: !name:speechbrain.lobes.models.g2p.dataio.grapheme_pipeline
383
+ grapheme_encoder: !ref <grapheme_encoder>
384
+ takes: txt_cleaned
385
+ provides:
386
+ - grapheme_list
387
+ - grapheme_encoded_list
388
+ - grapheme_encoded_raw
389
+
390
+ - func: !name:speechbrain.lobes.models.g2p.dataio.add_bos_eos
391
+ encoder: !ref <grapheme_encoder>
392
+ takes: grapheme_encoded_list
393
+ provides:
394
+ - grapheme_encoded
395
+ - grapheme_len
396
+ - grapheme_encoded_eos
397
+ - grapheme_len_eos
398
+ - func: !name:speechbrain.lobes.models.g2p.dataio.word_emb_pipeline
399
+ word_emb: !ref <word_emb>
400
+ grapheme_encoder: !ref <grapheme_encoder>
401
+ use_word_emb: !ref <use_word_emb>
402
+ takes:
403
+ - txt
404
+ - grapheme_encoded
405
+ - grapheme_len
406
+ provides: word_emb
407
+
408
+ decode_pipeline:
409
+ batch: true
410
+ output_keys:
411
+ - phonemes
412
+ steps:
413
+ - func: !name:speechbrain.lobes.models.g2p.dataio.beam_search_pipeline
414
+ beam_searcher: !ref <beam_searcher>
415
+ takes:
416
+ - char_lens
417
+ - encoder_out
418
+ provides:
419
+ - hyps
420
+ - scores
421
+ - func: !apply:speechbrain.utils.hparams.choice
422
+ value: false
423
+ choices:
424
+ True: !apply:speechbrain.lobes.models.g2p.dataio.char_map_detokenize
425
+ tokenizer: !ref <phoneme_tokenizer>
426
+ char_map: !ref <char_phn_map>
427
+ token_space_index: !ref <token_space_index>
428
+ wordwise: !ref <phn_token_wordwise>
429
+ False: !name:speechbrain.lobes.models.g2p.dataio.phoneme_decoder_pipeline
430
+ phoneme_encoder: !ref <phoneme_encoder>
431
+ takes:
432
+ - hyps
433
+ provides:
434
+ - phonemes
435
+
436
+
437
+ pretrainer: !new:speechbrain.utils.parameter_transfer.Pretrainer
438
+ loadables:
439
+ model: !ref <model>
440
+ ctc_lin: !ref <ctc_lin>
model.ckpt ADDED
@@ -0,0 +1,3 @@
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:71bf7a7b290f88de5fdd7364fa4ab249bdd94a29e6cdc742ee6f69edeae64f61
3
+ size 128643257