text_to_pinyin.md

comments
true

文本转拼音模块使用教程

一、概述

文本到拼音常用于语音合成的前端，将输入的中文文本转换为带声调的拼音序列，为后续的声学模型和模型生成提供发音依据。

二、支持模型列表

模型	模型下载链接	模型大小	介绍
G2PWModel	G2PWModel	606M	g2pW 开源的文本到拼音模型，常用于语音合成的前端，将输入的中文文本转换为带声调的拼音序列，为后续的声学模型和模型生成提供发音依据

三、快速集成

在快速集成前，首先需要安装 PaddleX 的 wheel 包，wheel的安装方式请参考PaddleX本地安装教程。完成 wheel 包的安装后，几行代码即可完成文本转拼音模块的推理，可以任意切换该模块下的模型，您也可以将文本转拼音模块中的模型推理集成到您的项目中。

from paddlex import create_model
model = create_model(model_name="G2PWModel")
output = model.predict(input="欢迎使用飞桨", batch_size=1)
for res in output:
    res.print()
    res.save_to_json(save_path="./output/res.json")

运行后，得到的结果为：

{'res': {'input_path': '欢迎使用飞桨', 'result': ['huan1', 'ying2', 'shi3', 'yong4', 'fei1', 'jiang3']}}

运行结果参数含义如下：

• input_path: 输入文本
• result: 输入文本转换后的拼音

相关方法、参数等说明如下：

• create_model文本转拼音模型，具体说明如下：

参数	参数说明	参数类型	可选项	默认值
model_name	模型名称	str	G2PWModel	G2PWModel
model_dir	模型存储路径	str	无	无

• 其中，model_name 必须指定，指定 model_name 后，默认使用 PaddleX 内置的模型参数，在此基础上，指定 model_dir 时，使用用户自定义的模型。

• 调用文本转拼音模型的 predict() 方法进行推理预测，predict() 方法参数有 input 和 batch_size，具体说明如下：

参数	参数说明	参数类型	可选项	默认值
input	待预测数据	str	对应文本，如：欢迎使用飞桨	无
batch_size	批大小	int	目前仅支持1	1

• 对预测结果进行处理，每个样本的预测结果均为对应的Result对象，支持保存为json文件的操作:

方法	方法说明	参数	参数类型	参数说明	默认值
print()	打印结果到终端	format_json	bool	是否对输出内容进行使用 JSON 缩进格式化	True
		indent	int	指定缩进级别，以美化输出的 JSON 数据，使其更具可读性，仅当 format_json 为 True 时有效	4
		ensure_ascii	bool	控制是否将非 ASCII 字符转义为 Unicode。设置为 True 时，所有非 ASCII 字符将被转义；False 则保留原始字符，仅当format_json为True时有效	False
save_to_json()	将结果保存为json格式的文件	save_path	str	保存的文件路径，当为目录时，保存文件命名与输入文件类型命名一致	无
		indent	int	指定缩进级别，以美化输出的 JSON 数据，使其更具可读性，仅当 format_json 为 True 时有效	4
		ensure_ascii	bool	控制是否将非 ASCII 字符转义为 Unicode。设置为 True 时，所有非 ASCII 字符将被转义；False 则保留原始字符，仅当format_json为True时有效	False

• 此外，也支持通过属性获取预测结果，具体如下：

属性	属性说明
json	获取预测的json格式的结果

关于更多 PaddleX 的单模型推理的 API 的使用方法，可以参考PaddleX单模型Python脚本使用说明。