文件最后提交记录最后更新时间
!8033 【bugfix】修改telechat3的README中不合理的部分 From: @lanshaozuishuai Reviewed-by: @hss-shuai, @zyw-hw See merge request: mindspore/mindformers!80332 个月前
telechat3_infer 3 个月前
修改telechat3的README中不合理的部分 4 个月前
README.md

TeleChat3

模型描述

星辰语义大模型TeleChat3是由中国电信人工智能研究院研发训练的大语言模型,该系列模型完全基于国产算力训练。

支持规格

模型名称 规格 支持任务 模型架构 支持设备 模型级别
TeleChat3 36B 预训练 Mcore Atlas 800T A2/Atlas 800I A2/Atlas 900 A3 SuperPoD Released
TeleChat3 36B 推理 Mcore Atlas 800T A2/Atlas 800I A2/Atlas 900 A3 SuperPoD Released

说明:

  • 模型架构:Mcore 表示 1.6.0 发布的新模型架构,Legacy 表示原有模型架构。详见架构说明
  • 模型级别:训练和推理各分为5个级别,分别代表该模型遵循不同的标准上线。每个级别的介绍详见模型级别介绍

版本配套

TeleChat3 当前支持的版本配套如下。

Mindspore Transformers MindSpore CANN HDK
当前支持的版本 在研版本 在研版本 在研版本 在研版本

前期准备

环境安装

按照上述版本配套,参考环境安装指南安装运行环境。

模型下载

用户可以从Modelers、Hugging Face、ModelScope等开源社区下载所需的模型文件,包括模型权重、Tokenizer、配置等(重头预训练不需加载权重)。链接如下:

模型名称 下载链接 说明
TeleChat/TeleChat3-36B ModelScope

数据集下载

MindSpore Transformers 以下面的数据集为例提供了 TeleChat3 的预训练流程的使用案例,实际训练时可参考数据集章节制作数据集。请在执行任务前提前下载所需数据集。链接如下:

任务 数据集名称 下载链接 说明
预训练 WikiText-103 Download 用于预训练的大规模文本数据集

预训练样例

预训练是指在大规模无标注数据上训练模型,使其能够全面捕捉语言的广泛特性。在MindSpore官网提供了详细的指导

1. 数据预处理

MindSpore Transformers 预训练阶段当前已支持Megatron格式的数据集。用户可以参考数据集章节,使用 MindSpore 提供的工具将原始数据集转换为 Megatron 格式。

制作Megatron格式数据集,需要经过两个步骤。首先将原始文本数据集转换为jsonl格式数据,然后使用MindSpore Transformers提供的脚本将jsonl格式数据转换为Megatron格式的.bin和.idx文件。

  • wiki.train.tokens 转为 jsonl格式数据

用户需要自行将wiki.train.tokens数据集处理成jsonl格式的文件。作为参考,文档末尾的FAQ部分提供了一个临时转换方案,用户需要根据实际需求自行开发和验证转换逻辑。

下面是jsonl格式文件的示例:

{"src": "www.nvidia.com", "text": "The quick brown fox", "type": "Eng", "id": "0", "title": "First Part"}
{"src": "The Internet", "text": "jumps over the lazy dog", "type": "Eng", "id": "42", "title": "Second Part"}
...
  • jsonl格式数据 转为 bin格式数据

MindSpore Transformers提供了数据预处理脚本toolkit/data_preprocess/megatron/preprocess_indexed_dataset.py用于将jsonl格式的原始文本预料转换成.bin或.idx文件。

这里需要提前下载TeleChat3-36B模型的tokenizer文件。

例如:

python toolkit/data_preprocess/megatron/preprocess_indexed_dataset.py \
  --input /path/to/data.jsonl \
  --output-prefix /path/to/wiki103-megatron \
  --tokenizer-type HuggingFaceTokenizer \
  --tokenizer-dir /path/to/TeleChat3-36B # 其他规格的模型可以调整为对应的tokenizer路径

运行完成后会生成/path/to/wiki103-megatron_text_document.bin/path/to/wiki103-megatron_text_document.idx文件。 填写数据集路径时需要使用/path/to/wiki103-megatron_text_document,不需要带后缀名。

2. 修改任务配置

MindSpore Transformers 提供了预训练任务的配置文件,用户可以根据实际情况修改配置文件。以下是一个示例配置文件片段,用户需要根据自己的数据集路径和其他参数进行相应修改。

  • 数据集配置
# Dataset configuration
train_dataset: &train_dataset
  data_loader:
    ...
    sizes:
      - 8000  # 数据集的大小,可以根据实际数据集大小进行调整
      ...
    config:
      ...
      data_path:  # 采样比例和Megatron格式数据集路径
        - '1'
        - "/path/to/wiki103-megatron_text_document" # 替换为实际的Megatron格式数据集路径,此处不带后缀名

数据集路径需要替换为实际的Megatron格式数据集路径。

不同规格和序列长度的并行配置可参考并行配置建议

3. 启动预训练任务

通过指定模型路径和配置文件configs/telechat3/pretrain_telechat3_36b.yamlmsrun的方式启动run_mindformer.py脚本,进行16卡分布式训练。您可参考如下方式,拉起两台Atlas 800T A2(64G)训练。

在每台服务器上执行如下命令。设置master_ip为主节点IP地址,即Rank 0服务器的IP;node_rank为每个节点的序号;port为当前进程的端口号(可在50000~65536中选择)。

master_ip=192.168.1.1
node_rank=0
port=50001
bash scripts/msrun_launcher.sh "run_mindformer.py \
--config configs/telechat3/pretrain_telechat3_36b.yaml \
--auto_trans_ckpt False \
--use_parallel True \
--run_mode train" \
16 8 $master_ip $port $node_rank output/msrun_log False 7200

此处样例代码假设主节点为192.168.1.1、当前Rank序号为0。实际执行时请将master_ip设置为实际的主节点IP地址;将node_rank设置为当前节点的Rank序号;将port设置为当前进程的端口号。

上述命令执行完毕后,训练任务将在后台执行,过程日志保存在./output/msrun_log下,使用以下命令可查看训练状态(由于开启了流水并行,真实loss只显示在最后一个pipeline stage的日志中,其余pipeline stage会显示loss0

tail -f ./output/msrun_log/worker_0.log

训练过程中的权重checkpoint将会保存在./output/checkpoint下。

如有关于TeleChat3预训练的相关问题,可以在MindSpore Transformers的AtomGit仓库中提交ISSUE以获取支持。

推理样例

推理是指在预训练模型的基础上,利用已学习到的语言知识对新的输入数据进行预测或生成。在MindSpore官网提供了详细的指导

1. 修改任务配置

MindSpore Transformers 提供了推理任务的配置文件,用户可以根据实际情况修改此配置文件中的权重路径和其他参数。

当前推理可以直接复用Hugging Face的配置文件和tokenizer,并且在线加载Hugging Face的safetensors格式的权重,使用时配置修改如下:

pretrained_model_dir: '/path/hf_dir'
parallel_config:
  data_parallel: 1
  model_parallel: 1

参数说明:

  • pretrained_model_dir:Hugging Face模型目录路径,放置模型配置、Tokenizer等文件。/path/hf_dir中的内容如下:
📂Telechat3-36B
├── 📄config.json
├── 📄generation_config.json
├── 📄model-xxx.safetensors
├── 📄model-xxx.safetensors
├── 📄model.safetensors.index.json
├── 📄special_tokens_map.json
├── 📄tokenizer.model
└── 📄tokenizer_config.json
  • data_parallel:数据并行,当前推理并不支持此并行策略,默认为1;
  • model_parallel:模型并行,默认值为 1。需根据实际模型规模及硬件资源情况,调整该参数为相应的device_num(即实际使用的卡数)。

不同规格和序列长度的并行配置可参考并行配置建议

2. 启动推理任务

使用 run_mindformer 统一脚本执行推理任务。

单卡推理可以直接执行run_mindformer.py脚本,多卡推理需要借助scripts/msrun_launcher.sh来启动。

run_mindformer.py的参数说明如下:

参数 参数说明
config yaml配置文件的路径
run_mode 运行的模式,推理设置为predict
use_parallel 是否使用多卡推理
predict_data 推理的输入数据,多batch推理时需要传入输入数据的txt文件路径,包含多行输入
predict_batch_size 多batch推理的batch_size大小
pretrained_model_dir Hugging Face模型目录路径,放置模型配置、Tokenizer等文件
parallel_config.data_parallel 数据并行,当前推理们模式下设置为1
parallel_config.model_parallel 模型并行,默认值为 1。需根据实际模型规模及硬件资源情况,调整该参数为相应的device_num(即实际使用的卡数)

msrun_launcher.sh包括run_mindformer.py命令和推理卡数两个参数。

TeleChat3-36B模型至少需要两卡推理,多卡推理需参考下面修改配置:

  1. 模型并行model_parallel的配置和使用的卡数需保持一致,下文用例为2卡推理,需将model_parallel设置成2;
  2. 当前版本的多卡推理不支持数据并行,需将data_parallel设置为1。

当使用完整权重推理时,需要开启在线切分方式加载权重,参考以下命令:

bash scripts/msrun_launcher.sh "run_mindformer.py \
 --config configs/telechat3/predict_telechat3_36b.yaml \
 --run_mode predict \
 --use_parallel True \
 --pretrained_model_dir '/path/hf_dir' \
 --parallel_config.data_parallel 1 \
 --parallel_config.model_parallel 2 \
 --trust_remote_code True \
 --predict_data '帮助我制定一份去上海的旅游攻略'" 2

出现如下结果,证明推理成功。推理结果也会保存到当前目录下的 text_generation_result.txt 文件中。详细日志可通过./output/msrun_log目录查看。

'text_generation_text': [帮助我制定一份去上海的旅游攻略,包括景点推荐、美食推荐和交通指南......]

附录

模型文件说明

TeleChat3-36B的模型文件包括以下内容:

📦mindformers
├── 📂mindformers
│   └── 📂models
│       └── 📂TeleChat3
│           ├── 📄__init__.py                       # TeleChat3模块初始化文件
│           ├── 📄configuration_telechat3.py        # TeleChat3模型配置类定义
│           ├── 📄modeling_telechat3.py             # TeleChat3模型主体实现
│           ├── 📄modeling_telechat3_train.py       # TeleChat3训练模型实现
│           ├── 📄modeling_telechat3_infer.py       # TeleChat3推理模型实现
│           └── 📄utils.py                          # TeleChat3工具函数和基础类
├── 📂configs
│   └── 📂telechat3
│       ├── 📄pretrain_telechat3_36b.yaml           # TeleChat3-36B 预训练配置
        └── 📄predict_telechat3_36b.yaml            # TeleChat3-36B 推理配置
└── 📄run_mindformer.py                             # 主要执行脚本

并行配置建议

以下配置为训练或推理场景下,不同模型规格的推荐配置。其中部分配置为经过验证的最佳配置,部分配置为可以运行的配置。用户可根据实际情况选择合适的配置。

注意:max_device_memory 在 Atlas 800T A2 和 Atlas 900 A3 SuperPoD 等机器上一般设置≤60GB,在 Atlas 800I A2 上一般设置≤30GB。

  • 预训练:
模型 规格 设备 卡数 序列长度 并行配置 重计算配置 内存配置 模型级别
TeleChat3 36B 6 × Atlas 800T A2 (8P) 16 8192
parallel_config:
  data_parallel: &dp 1
  model_parallel: 8
  pipeline_stage: 2
  micro_batch_num: 4
  use_seq_parallel: True
  gradient_aggregation_group: 4
recompute_config:
  recompute: [[14, 14], [14, 14]]
  select_recompute: False
  parallel_optimizer_comm_recompute: False
  mp_comm_recompute: False
context:
  ...
  max_device_memory: "58GB"
Validated
  • 推理:
模型 规格 设备 卡数 并行配置 内存配置 模型级别
TeleChat3 36B 1 × Atlas 800T A2 (2P) 2
parallel_config:
  data_parallel: 1
  model_parallel: 2
context:
  ...
  max_device_memory: "59GB"
Released

FAQ

Q1:我有两台Atlas 800T A2服务器,如何进行TeleChat3的预训练?拉起任务的指令是什么?

A1:根据指导修改配置后,参考如下命令拉起任务:

  • 机器1 IP: 192.168.1.1 (作为主节点)
# 机器1的启动指令
master_ip=192.168.1.1
node_rank=0
port=50001

bash scripts/msrun_launcher.sh "run_mindformer.py \
--config configs/TeleChat3/pretrain_TeleChat3_32b_4k.yaml \
--auto_trans_ckpt False \
--use_parallel True \
--run_mode train" \
16 8 $master_ip $port $node_rank output/msrun_log False 7200
  • 机器2 IP: 192.168.1.2
# 机器2的启动指令
master_ip=192.168.1.1
node_rank=1
port=50001

bash scripts/msrun_launcher.sh "run_mindformer.py \
--config configs/telechat3/pretrain_TeleChat3_30b_a3b_4k.yaml \
--auto_trans_ckpt False \
--use_parallel True \
--run_mode train" \
16 8 $master_ip $port $node_rank output/msrun_log False 7200

Q2: 数据集准备部分中,应该如何将wiki.train.tokens 转为 jsonl格式数据?

A2: 社区issue中提供了一个临时转换脚本,仅作为参考使用。用户需要根据自己的数据特点和需求,自行开发和验证适合的转换逻辑。

Q3:如果修改了配置中的参数,使用run_mindformer.py拉起任务时,还需要重新传参吗?

A3:根据指导修改配置后,参数值已被修改,无需重复传参,run_mindformer.py会自动读取解析配置中的参数;如果没有修改配置中的参数,则需要在命令中添加参数。