FlagAI 建议不要混杂中英文说明，将中英文文档分为独立的文件

建议不要混杂中英文说明，将中英文文档分为独立的文件

Open twang2218 opened this issue 2 years ago • 1 comments

Feature request

当前的文档中充斥着中英文混杂的段落，如：

cd /examples/aquila

配置hostfile文件, 参考这里 ; Configure the hostfile file, refer to here

配置bmtrain_mgpu.sh文件, 将SCRIPT_FILE改成aquila_pretrain.py; configure the bmtrain_mgpu.sh file, change SCRIPT_FILE to aquila_pretrain.py

(可选) 在Aquila-pretrain.yaml文件里更改参数 ; (optional) change parameters in Aquila-pretrain.yaml

这无论是对于中文读者，还是英文读者，都非常的不友好。

建议将文档分为 README_en.md 和 README_zh.md，这样可以给多国语言的用户以最佳的文档阅读体验。

Motivation

对于像

接下来会输出下列信息，注意NODES_NUM应该与节点数相等，LOGFILE是模型运行的日志文件；The following information will be output. Note that NODES_NUM should be equal to the number of nodes, and LOGFILE is the log file for the model run.

这样的文档，中文用户会继续往下读，读了几句后发现是一个意思；对于英文用户来说，如果没有安装中文字体，会看到一团乱码后面才是英文文档，阅读体验也是非常差的。