more speech docs (#606)

* add speech related docs: tts, text front end, ngram lm, corrector

* format doc

* mergify with doc

.mergify.yml

@@ -47,7 +47,7 @@ pull_request_rules:
         add: ["README"]
   - name: "auto add label=Documentation"
     conditions:
-      - files~=^doc/
+      - files~=^docs/
     actions:
       label:
         add: ["Documentation"]
@@ -74,4 +74,4 @@ pull_request_rules:
       - files~=^docker/
     actions:
       label:
-        add: ["Docker"]
\ No newline at end of file
+        add: ["Docker"]

docs/src/asr_postprocess.md

 # ASR PostProcess
 
-## Text corrector
+* Text Corrector
+* Text Filter
+* Add Punctuation
+
+
+
+## Text Corrector
+
 * [pycorrector](https://github.com/shibing624/pycorrector)
-ERNIE on paddlepaddle.
+  本项目重点解决其中的谐音、混淆音、形似字错误、中文拼音全拼、语法错误带来的纠错任务。PS：[网友源码解读](https://zhuanlan.zhihu.com/p/138981644)
+
+
+
+### Question
+
+中文文本纠错任务，常见错误类型包括：
+
+- 谐音字词，如 配副眼睛-配副眼镜
+- 混淆音字词，如 流浪织女-牛郎织女
+- 字词顺序颠倒，如 伍迪艾伦-艾伦伍迪
+- 字词补全，如 爱有天意-假如爱有天意
+- 形似字错误，如 高梁-高粱
+- 中文拼音全拼，如 xingfu-幸福
+- 中文拼音缩写，如 sz-深圳
+- 语法错误，如 想象难以-难以想象
+
+当然，针对不同业务场景，这些问题并不一定全部存在。
+
+比如输入法中需要处理前四种，搜索引擎需要处理所有类型，语音识别后文本纠错只需要处理前两种， 其中'形似字错误'主要针对五笔或者笔画手写输入等。
+
+
+
+### Solution
+
+#### 规则的解决思路
+
+1. 中文纠错分为两步走，第一步是错误检测，第二步是错误纠正；
+2. 错误检测部分先通过结巴中文分词器切词，由于句子中含有错别字，所以切词结果往往会有切分错误的情况，这样从字粒度和词粒度两方面检测错误， 整合这两种粒度的疑似错误结果，形成疑似错误位置候选集；
+3. 错误纠正部分，是遍历所有的疑似错误位置，并使用音似、形似词典替换错误位置的词，然后通过语言模型计算句子困惑度，对所有候选集结果比较并排序，得到最优纠正词。
+
+#### 深度模型的解决思路
+
+1. 端到端的深度模型可以避免人工提取特征，减少人工工作量，RNN序列模型对文本任务拟合能力强，rnn_attention在英文文本纠错比赛中取得第一名成绩，证明应用效果不错；
+2. CRF会计算全局最优输出节点的条件概率，对句子中特定错误类型的检测，会根据整句话判定该错误，阿里参赛2016中文语法纠错任务并取得第一名，证明应用效果不错；
+3. Seq2Seq模型是使用Encoder-Decoder结构解决序列转换问题，目前在序列转换任务中（如机器翻译、对话生成、文本摘要、图像描述）使用最广泛、效果最好的模型之一；
+4. BERT/ELECTRA/ERNIE/MacBERT等预训练模型强大的语言表征能力，对NLP界带来翻天覆地的改变，海量的训练数据拟合的语言模型效果无与伦比，基于其MASK掩码的特征，可以简单改造预训练模型用于纠错，加上fine-tune，效果轻松达到最优。
+
+
+
+### 规则检测方法
+
+- kenlm：kenlm统计语言模型工具，规则方法，语言模型纠错，利用混淆集，扩展性强
+
+#### 错误检测
+
+- 字粒度：语言模型困惑度（ppl）检测某字的似然概率值低于句子文本平均值，则判定该字是疑似错别字的概率大。
+- 词粒度：切词后不在词典中的词是疑似错词的概率大。
+
+#### 错误纠正
+
+- 通过错误检测定位所有疑似错误后，取所有疑似错字的音似、形似候选词，
+- 使用候选词替换，基于语言模型得到类似翻译模型的候选排序结果，得到最优纠正词。
+
+#### 思考
+
+1. 现在的处理手段，在词粒度的错误召回还不错，但错误纠正的准确率还有待提高，更多优质的纠错集及纠错词库会有提升。
+2. 另外，现在的文本错误不再局限于字词粒度上的拼写错误，需要提高中文语法错误检测（CGED, Chinese Grammar Error Diagnosis）及纠正能力。
+
+
+
+### Reference
+
+* https://github.com/shibing624/pycorrector
+* [基于文法模型的中文纠错系统](https://blog.csdn.net/mingzai624/article/details/82390382)
+* [Norvig’s spelling corrector](http://norvig.com/spell-correct.html)
+* [Chinese Spelling Error Detection and Correction Based on Language Model, Pronunciation, and Shape[Yu, 2013]](http://www.aclweb.org/anthology/W/W14/W14-6835.pdf)
+* [Chinese Spelling Checker Based on Statistical Machine Translation[Chiu, 2013]](http://www.aclweb.org/anthology/O/O13/O13-1005.pdf)
+* [Chinese Word Spelling Correction Based on Rule Induction[yeh, 2014]](http://aclweb.org/anthology/W14-6822)
+* [Neural Language Correction with Character-Based Attention[Ziang Xie, 2016]](https://arxiv.org/pdf/1603.09727.pdf)
+* [Chinese Spelling Check System Based on Tri-gram Model[Qiang Huang, 2014]](http://www.anthology.aclweb.org/W/W14/W14-6827.pdf)
+* [Neural Abstractive Text Summarization with Sequence-to-Sequence Models[Tian Shi, 2018]](https://arxiv.org/abs/1812.02303)
+* [基于深度学习的中文文本自动校对研究与实现[杨宗霖, 2019]](https://github.com/shibing624/pycorrector/blob/master/docs/基于深度学习的中文文本自动校对研究与实现.pdf)
+* [A Sequence to Sequence Learning for Chinese Grammatical Error Correction[Hongkai Ren, 2018]](https://link.springer.com/chapter/10.1007/978-3-319-99501-4_36)
+* [ELECTRA: Pre-training Text Encoders as Discriminators Rather Than Generators](https://openreview.net/pdf?id=r1xMH1BtvB)
+* [Revisiting Pre-trained Models for Chinese Natural Language Processing](https://arxiv.org/abs/2004.13922)
+
+
+
+## Text Filter
+
+* 敏感词（黄暴、涉政、违法违禁等）
+
+
+
+
+
+## Add Punctuation

docs/src/ngram_lm.md

-# Prepare Language Model
+# Ngram LM
+
+
+
+## Prepare Language Model
 
 A language model is required to improve the decoder's performance. We have prepared two language models (with lossy compression) for users to download and try. One is for English and the other is for Mandarin. The bash script to download LM is example's `local/download_lm_*.sh`.
 
@@ -14,7 +18,7 @@ If you wish to train your own better language model, please refer to [KenLM](htt
 Here we provide some tips to show how we preparing our English and Mandarin language models.
 You can take it as a reference when you train your own.
 
-## English LM
+### English LM
 
 The English corpus is from the [Common Crawl Repository](http://commoncrawl.org) and you can download it from [statmt](http://data.statmt.org/ngrams/deduped_en). We use part en.00 to train our English language model. There are some preprocessing steps before training:
 
@@ -24,7 +28,7 @@ The English corpus is from the [Common Crawl Repository](http://commoncrawl.org)
 
 Now the preprocessing is done and we get a clean corpus to train the language model. Our released language model are trained with agruments '-o 5 --prune 0 1 1 1 1'. '-o 5' means the max order of language model is 5. '--prune 0 1 1 1 1' represents count thresholds for each order and more specifically it will prune singletons for orders two and higher. To save disk storage we convert the arpa file to 'trie' binary file with arguments '-a 22 -q 8 -b 8'. '-a' represents the maximum number of leading bits of pointers in 'trie' to chop. '-q -b' are quantization parameters for probability and backoff.
 
-## Mandarin LM
+### Mandarin LM
 
 Different from the English language model, Mandarin language model is character-based where each token is a Chinese character. We use internal corpus to train the released Mandarin language models. The corpus contain billions of tokens. The preprocessing has tiny difference from English language model and main steps include:
 
@@ -33,3 +37,54 @@ Different from the English language model, Mandarin language model is character-
   * A whitespace character between two tokens is inserted.
 
 Please notice that the released language models only contain Chinese simplified characters. After preprocessing done we can begin to train the language model. The key training arguments for small LM is '-o 5 --prune 0 1 2 4 4' and '-o 5' for large LM. Please refer above section for the meaning of each argument. We also convert the arpa file to binary file using default settings.
+
+
+
+## [KenLM](http://kheafield.com/code/kenlm/)
+
+统计语言模型工具有比较多的选择，目前使用比较好的有srilm及kenlm，其中kenlm比srilm晚出来，训练速度也更快，而且支持单机大数据的训练。现在介绍一下kenlm的使用方法。
+
+1. 工具包的下载地址：http://kheafield.com/code/kenlm.tar.gz
+
+2. 使用。该工具在linux环境下使用方便。 先确保linux环境已经按照1.36.0的Boost和zlib
+
+   ```
+   boost:
+   yum install boost
+   yum install boost-devel
+
+   zlib:
+   yum install zlib
+   yum install zlib-devel
+   ```
+
+   然后gcc版本需要是4.8.2及以上。
+
+   ```
+   wget -O - https://kheafield.com/code/kenlm.tar.gz |tar xz
+   mkdir kenlm/build
+   cd kenlm/build
+   cmake ..
+   make -j2
+   ```
+
+3. 训练。使用如下命令进行训练：
+
+   ```
+   build/bin/lmplz -o 3 --verbose_header --text people2014corpus_words.txt --arpa result/people2014corpus_words.arps
+   ```
+
+   其中，
+   1）people2014corpus_words.txt文件必须是分词以后的文件。
+
+   训练语料<人民日报2014版熟语料>，包括： 1）标准人工切词及词性数据people2014.tar.gz， 2）未切词文本数据people2014_words.txt， 3）kenlm训练字粒度语言模型文件及其二进制文件people2014corpus_chars.arps/klm， 4）kenlm词粒度语言模型文件及其二进制文件people2014corpus_words.arps/klm。
+
+   2）-o后面的5表示的是5-gram,一般取到3即可，但可以结合自己实际情况判断。
+
+4. 压缩。压缩模型为二进制，方便模型快速加载：
+
+   ```
+   build/bin/build_binary ./result/people2014corpus_words.arps ./result/people2014corpus_words.klm
+   ```
+
+

docs/src/speech_synthesis.md

+# Speech Synthesis
+
+* [爱丁堡大学公开课](http://speech.zone/courses/speech-synthesis)
+
+* ### 推荐书籍
+
+  1. Daniel Jurafsky and James H. Martin, Speech and language processing: An introduction to natural language processing, computational linguistics, and speech recognition. 这本书之前在学习语音识别的时候也经常翻阅。 推荐阅读章节: Ch 7 & Ch 8 (都读过啦~)
+  2. Xuedong Huang, Alex Aceoro, Hsiao-Wuen Hon, Spoken Language Processing: A guide to theory, algorithm, and system development, Prentice Hall, 2011 这本书的三位作者都是大佬，本书推荐阅读 Ch2, Ch5, Ch6, Part IV: Text-to-Speech Systems. 学习一下基础知识点，如信号处理等
+  3. Paul Taylor, Text-to-Speech Synthesis, Cambridege University Press, 2009. 比较系统地讲述了神经网络之前的语音合成系统。
+
+
+
+### 语音合成
+
+现代语音合成主要包含文本分析和语音合成
+
+
+
+#### 文本分析
+
+文本分析主要分为
+
+- **断句** : 怎么判断一句句子结束了，单纯用句号来切分并不靠谱，比如 ‘B.C.’, ‘Dr.J.M.’,’。。。’
+- **文本归一化** : 根据上下文消除一些词的读法，常见有数字的读法，”In 1950, he went to” -> “nineteen fifty”, “There are 1950 sheep.” => “one thousand and fifty”, “The code number is 1950” -> “one nine five zero”.
+- **分词** : 将句子分成一个个的词，对于中文这种没有空格作为天然分隔符的语言是需要分词单元的。
+- **词性分析** : 将分好的词中的每个词进行标注，”动词，名词，形容词，…”
+- **注音** : 有些词的读音在不同上下文中发音是不一样的，比如 ‘live’ -> /l ih v/ or /l ay v/ 中文中也有多音字的现象，所以需要进行标注。
+- **韵律分析** : 声调，重读，韵律边界
+
+
+
+#### 语音合成方法
+
+**波形拼接** : 将各种语音单元拼接起来，需要考虑目标代价(目标语音单元和候选的语音单元匹配度)和连接代价(相邻语音单元之间的流畅度)
+
+**基于轨迹指导的拼接合成**
+
+**统计参数合成** : 帧级建模包括时长模型(音素序列->帧级文本特征)和声学模型(帧级文本特征->帧级语音输出)。主要方法是基于HMM 的 SPSS (Statistical Parametric Speech Synthesis), 可以用的工具包 HTS。
+
+**神经网络合成方法** : 目前许多商用场景下已经部署了基于神经网络的语音合成模型。目前基于神经网络的方法还不是纯端到端的，分为两个部分，输入文本类信息(音素，时长等)经过神经网络得到输出特征(LF0, UV, 谱特征, bap), 接着将这些特征放到声码器(vocoder) 中得到对应的语音波形。主流方法是 Tactron, Tactron2, 注意力机制，Transformer。正在朝着基于序列到序列的语音合成，纯端到端的语音合成方向发展。
+
+**声码器**的总结如下:
+
+| **模型类型** | **模型**          | **合成语音质量** | **效率**   |
+| ------------ | ----------------- | ---------------- | ---------- |
+| AR           | WaveNet           | 非常好           | 非常差     |
+| AR           | WaveRNN           | 非常好           | 中等       |
+| AR           | Multiband WaveRNN | 非常好           | 中等       |
+| AR           | LPCNET            | 非常好           | 挺好的     |
+| Non-AR       | Parallel WaveNet  | 非常好           | 还不错     |
+| Non-AR       | WaveGlow          | 非常好           | 还不错     |
+| Non-AR       | FlowWaveNet       | 非常好           | 还不错     |
+| GAN          | ParallelWaveGAN   | 非常好           | 挺好的     |
+| GAN          | MelGAN            | 挺好的           | 非常好     |
+| GAN          | MB-MelGAN         | 非常好           | 非常非常好 |
+
+从上面表格中可以看到基于神经网络的声码器效果都挺好的，主要需要优化的就是生成的速度。出现了利用GAN的声码器之后，推理速度也极大的提高了。
+
+
+
+### 高阶话题
+
+* 基于注意力机制的序列要序列的模型框架稳定性问题: 长句、连读、丢字、漏字、重复
+
+* 小样本学习(few shots & one shot)
+
+* 情感/表现力/可控性(句子内部细粒度控制，风格建模)
+
+* 纯端到端
+
+* 抗噪
+
+* 语音转换
+
+* 歌唱合成
+
+
+
+### 语音合成评估
+
+文本分析模块可以有比较客观的指标：precision, recall, fscore 之类的。
+
+生成的语音质量评估方法有：和参考样例之间的距离度量(DTW),  谱包络(MCD),  F0轮廓，V/UV Error， 时长 (Duration RMSE)。
+
+主观指标包括 MOS，CMOS,  AB Best,  MUSHRA。
+
+
+
+### 语音合成数据集
+
+数据质量非常重要
+
+中文: 标贝DB-1，女性说话，1万句，10.3小时
+
+英文: VCTK, LJSpeech, LibriSpeech, LibriTTS
+
+
+
+### 非端到端的语音合
+
+目前非端到端的语音合成算法有两种，
+
+1)**参数语音合成方法**，其中*声学模型*包括基于隐马尔可夫(HMM)的统计参数语音合成和基于神经网络(NN)的统计参数语音合成，而*声码器*包括基于源-滤波器的声码器和基于NN的声码器
+
+2) **单元拼接语音合成方法** 简单地理解是有一个很大的语音库包含了许多词/音素的发音，用一些方法将各个单元拼接起来。
+
+
+
+#### 声学特征
+
+传统声学模型这里的声学特征主要包括 MGC-梅尔生成倒谱, MCEP-梅尔倒谱, LSP-线谱对，这些普参数加上激励参数如基频F0，就是需要拟合的声学特征。而我们的音频通常都是一个个的采样点，谱参数+激励参数是可以还原到音频采样点的。
+
+常用的工具：Straight, World, SPTK, [HTS](http://hts.sp.nitech.ac.jp/), [Pysptk](https://github.com/r9y9/pysptk)。
+
+
+
+#### 基于HMM的统计参数语音合成
+
+HMM 应用到 TTS 这里和 ASR 还是有些区别的。主要参考的论文是 [An Introduction to HMM-Based Speech Synthesis](https://www.researchgate.net/publication/265398553_An_Introduction_to_HMM-Based_Speech_Synthesis):
+
+
+
+#### 基于 NN 的参数语音合成
+
+基于 NN 的参数语音合成主要依赖时长模型和声学模型。
+
+
+
+### 风格化和个性化语音合成
+
+风格化和个性化语音合成，难点有三个方面:
+
+- 风格化: 需要合成丰富且可控的语音，包括语速、停顿、重音、情感等。
+- 个性化: 要求我们利用多说话人建模技术及说话人自适应技术，在少量录音室或非录音室数据的条件下，为某一新说话人定制语音合成模型。
+- 迁移学习: 在只有一种语言的训练数据集下让说话人说另一种语言或者让说话人学习另一说话人的风格。迁移学习使我们能够利用额外的数据进行知识迁移，进而完成一些特定任务。
+
+建模和评估比较困难、数据集标注成本高，标注人员对风格问题容易产生分歧、模型缺乏控制合成语音风格的能力。
+
+
+
+## Reference
+
+* https://slyne.github.io/%E5%85%AC%E5%BC%80%E8%AF%BE/2020/09/26/TTS/
+* https://slyne.github.io/%E5%85%AC%E5%BC%80%E8%AF%BE/2020/10/25/TTS2/
+* https://slyne.github.io/%E5%85%AC%E5%BC%80%E8%AF%BE/2020/12/04/TTS6/

docs/src/text_front_end.md

 # Text Front End
 
+## Text Normalization(文本正则)
 
+文本正则化 文本正则化主要是讲非标准词(NSW)进行转化，比如：  
 
-## MMSEG
+数字、电话号码:  10086 -> 一千零八十六/幺零零八六  
+时间，比分:  23:20 -> 二十三点二十分/二十三比二十  
+分数、小数、百分比:  3/4 -> 四分之三，3.24 -> 三点一四， 15% -> 百分之十五  
+符号、单位:  ￥ -> 元， kg -> 千克  
+网址、文件后缀:  www. -> 三W点  
 
+* https://github.com/google/re2
+
+* https://github.com/speechio/chinese_text_normalization
+
+
+
+## Word Segmentation(分词)
+
+分词之所以重要可以通过这个例子来说明:  
+广州市长隆马戏欢迎你 -> 广州市 长隆 马戏 欢迎你  
+如果没有分词错误会导致句意完全不正确:   
+广州 市长 隆马戏 欢迎你  
+
+分词常用方法分为最大前向匹配(基于字典)和基于CRF的分词方法。用CRF的方法相当于是把这个任务转换成了序列标注，相比于基于字典的方法好处是对于歧义或者未登录词有较强的识别能力，缺点是不能快速fix bug，并且性能略低于词典。
+
+
+中文分词的常见工具:
+* https://github.com/lancopku/PKUSeg-python
+* https://github.com/thunlp/THULAC-Python
+* https://github.com/fxsjy/jieba
+* CRF++
+
+### MMSEG
 * [MMSEG: A Word Identification System for Mandarin Chinese Text Based on Two Variants of the Maximum Matching Algorithm](http://technology.chtsai.org/mmseg/)
 * [`中文分词`简单高效的MMSeg](https://www.cnblogs.com/en-heng/p/5872308.html)
 * [mmseg分词算法及实现](https://blog.csdn.net/daniel_ustc/article/details/50488040)
@@ -15,7 +44,96 @@
 * [jkom-cloud/mmseg](https://github.com/jkom-cloud/mmseg)
 
 
+### CScanner
+* [CScanner - A Chinese Lexical Scanner](http://technology.chtsai.org/cscanner/)
+
 
-## CScanner
 
-* [CScanner - A Chinese Lexical Scanner](http://technology.chtsai.org/cscanner/)
+## Part of Speech(词性预测)
+
+词性解释
+n/名词 np/人名 ns/地名 ni/机构名 nz/其它专名
+m/数词 q/量词 mq/数量词 t/时间词 f/方位词 s/处所词
+v/动词 a/形容词 d/副词 h/前接成分 k/后接成分
+i/习语 j/简称 r/代词 c/连词 p/介词 u/助词 y/语气助词
+e/叹词 o/拟声词 g/语素 w/标点 x/其它
+
+
+
+## G2P(注音)
+
+注音是需要将词转换成对应的发音，对于中文是将其转换成拼音，比如 绿色->(lv4 se4) 这里的数字表示声调。
+
+传统方法是使用字典，但是对于未登录词就很难解决。基于模型的方法是使用 [Phonetisaurus](https://github.com/AdolfVonKleist/Phonetisaurus)。 论文可以参考 - WFST-based Grapheme-to-Phoneme Conversion: Open Source Tools for Alignment, Model-Building and Decoding
+
+当然这个问题也可以看做是序列标注用CRF或者基于神经网络的模型都可以做。 基于神经网络工具: [g2pM](https://github.com/kakaobrain/g2pM)。
+
+
+
+
+## Prosody(韵律预测)
+
+ToBI(an abbreviation of tones and break indices) is a set of conventions for transcribing and annotating the prosody of speech. 中文主要关注break。
+
+
+韵律等级结构:  
+
+音素 -> 音节 -> 韵律词(Prosody Word, PW) -> 韵律短语(prosody phrase, PPH) -> 语调短句(intonational phrase, IPH) -> 子句子 -> 主句子 -> 段落 -> 篇章  
+LP -> LO -> L1(#1) -> L2(#2) -> L3(#3) -> L4(#4) -> L5 -> L6 -> L7  
+主要关注 PW, PPH, IPH  
+
+|     |  停顿时长   | 前后音高特征 |
+| --- | ----------| --- |
+| 韵律词边界 | 不停顿或从听感上察觉不到停顿 | 无 |
+| 韵律短语边界 | 可以感知停顿，但无明显的静音段 | 音高不下倾或稍下倾，韵末不可做句末 |
+| 语调短语边界 | 有较长停顿 | 音高下倾比较完全，韵末可以作为句末 |
+
+常用方法使用的是级联CRF，首先预测如果是PW，再继续预测是否是PPH，再预测是否是IPH
+
+<img src="images/prosody.jpeg" width=450><br/>
+
+
+论文: 2015 .Ding Et al. - Automatic Prosody Prediction For Chinese Speech Synthesis Using BLSTM-RNN and Embedding Features
+
+
+
+## Polyphone(多音字)
+
+
+
+## Linguistic Features(语言学特征)
+
+
+
+## 基于神经网络的前端文本分析模型
+
+最近这两年基本都是基于 BERT，所以这里记录一下相关的论文:
+
+- g2p: 2019. Sevinj Et al. Transformer based Grapheme-to-Phoneme Conversion
+- 分词: 2019 huang Et al. - Toward Fast and Accurate Neural Chinese Word Segmentation with Multi-Criteria Learning
+- 韵律: 2020 Zhang Et al. - Chinese Prosodic Structure Prediction Based on a Pretrained Language Representation Model
+
+除此之外，BLSTM + CRF 也比较主流。
+
+
+
+## 总结
+
+总结一下，文本分析各个模块的方法:
+
+TN: 基于规则的方法
+
+分词: 字典/CRF/BLSTM+CRF/BERT
+
+注音: ngram/CRF/BLSTM/seq2seq
+
+韵律: CRF/BLSTM + CRF/ BERT
+
+
+
+考虑到分词，注音，韵律都是基于序列标注任务，所以理论上来说可以通过一个模型搞定。
+
+
+
+## Reference
+* [Text Front End](https://slyne.github.io/%E5%85%AC%E5%BC%80%E8%AF%BE/2020/10/03/TTS1/)