GODEL：面向目标导向对话的大规模预训练

新闻

（更新日期：2022年10月23日）我们发布了GODEL V1.1，该模型基于Reddit讨论串中的5.51亿轮多轮对话，以及500万条指令和知识增强型对话进行训练。在我们的基准测试中，它表现出了显著更好的效果，尤其是在零样本设置下。

请查看Hugging Face Transformers仓库中的模型卡片。只需几行代码，就可以轻松地与GODEL进行对话。实时演示请见这里。

基础模型：https://huggingface.co/microsoft/GODEL-v1_1-base-seq2seq

大型模型：https://huggingface.co/microsoft/GODEL-v1_1-large-seq2seq

简介

本仓库展示了如何使用GODEL构建目标导向对话，并包含了以下论文所需的数据集、源代码和预训练模型：

GODEL：面向目标导向对话的大规模预训练
彭宝林、米歇尔·加利、何鹏程、克里斯·布罗克特、拉斯·利登、埃尔纳兹·努里、周宇、比尔·多兰、高剑峰

GODEL是一个用于目标导向对话的大规模预训练模型。它采用基于Transformer的编码器-解码器架构，并在外部文本基础上进行响应生成训练，这使得在需要根据当前对话之外的信息（例如检索到的文档）来调整响应的对话任务上，能够更有效地进行微调。该预训练模型可以通过少量特定任务的对话数据进行高效微调，从而适应新的对话任务。

本仓库基于Hugging Face Transformers框架。部分评估脚本和数据集改编自DSTC7-端到端对话建模、DialoGPT、UnifiedQA、MS MARCO、MultiWOZ、Schema-Guided Dataset等。

包含的脚本可用于复现论文中报告的结果。项目及演示网页：https://aka.ms/GODEL

安装

要求 交互式界面需要node.js和npm。请参考此处进行安装。

请使用以下命令创建环境、克隆仓库并安装所需包。

conda create -n godel-env python=3.8
conda activate godel-env
conda install nodejs
git clone https://github.com/microsoft/GODEL.git
cd GODEL
pip install -r requirements.txt
export PYTHONPATH="`pwd`"

获取并解压预训练模型，以便继续用您自己的数据进行微调。

wget https://bapengstorage.blob.core.windows.net/fileshare/godel_base.tar.gz
tar -zxvf godel_base.tar.gz

流程

数据格式

  {
    "Context": "请提醒我下午2点给杰西打电话。",
    "Knowledge": "reminder_contact_name 是杰西，reminder_time 是下午2点",
    "Response": "好的，已设置提醒：下午2点给杰西打电话"
  },

我们使用JSON格式表示一个训练样本。如上例所示，它包含以下字段：

• Context - 从会话开始到当前轮次的上下文。
• Knowledge - 以纯文本形式表示的外部或环境状态。
• Response - 目标代理的响应。它可以是模板、API调用或自然语言。

微调

DATA_NAME={数据路径}
OUTPUT_DIR={微调后模型保存路径}
MODEL_PATH={预训练模型路径}
EXP_NAME={实验名称}

python train.py --model_name_or_path ${MODEL_PATH} \
	--dataset_name ${DATA_NAME} \
	--output_dir ${OUTPUT_DIR} \
	--per_device_train_batch_size=16 \
	--per_device_eval_batch_size=16 \
	--max_target_length 512 \
	--max_length 512 \
	--num_train_epochs 50 \
	--save_steps 10000 \
	--num_beams 5 \
	--exp_name ${EXP_NAME} --preprocessing_num_workers 24

生成

DATA_NAME={数据路径}
OUTPUT_DIR={保存预测结果的路径}
MODEL_PATH={微调后模型路径}

python generate.py --model_name_or_path ${MODEL_PATH}  \
	--dataset_name ${DATA_NAME}  \
	--output_dir ${OUTPUT_DIR}  \
	--per_device_eval_batch_size=16  \
	--max_target_length 128 \
	--max_length 512  \
	--preprocessing_num_workers 24  \
	--num_beams 5 

交互

我们提供了一个演示界面，用于与微调后的模型进行对话。后端服务器基于flask，界面则基于vue、bootstrap-vue和BasicVueChat。

启动后端服务器：

# 请参照例如dstc9_server.py创建后端服务器
python EXAMPLE_server.py # 启动服务器并暴露8080端口

启动前端页面服务：

cd GODEL/html
npm install
npm run serve 

在您的浏览器中打开localhost:8080，您将看到如下页面。请注意，后端端口应与html/compoents/chat.vue中使用的端口一致。

实时演示请见这里。

模型

我们发布了GODEL V1.1，该模型基于Reddit讨论串中的5.51亿轮多轮对话，以及500万条指令和知识增强型对话进行训练。后续还将发布更多模型。

我们已经发布了三款微调模型，这些模型可以进一步在低资源的用户自定义数据集上进行微调。这些模型的总参数量范围为1.17亿至27亿。

模型	Hugging Face 模型卡片
基础版	microsoft/GODEL-v1_1-base-seq2seq
大型版	microsoft/GODEL-v1_1-large-seq2seq

训练

2023年5月22日：使用我们的代码库对GODEL模型进行预训练已不再支持，但GODEL模型仍然可用。详情请参阅此处。

微调与评估

GODEL 在四个任务上进行了微调和评估。我们提供了以我们的格式创建训练和测试数据的脚本。请参考 create_downstream_dataset.sh 来下载原始数据，并执行以下命令。

cd scripts 
./create_downstream_dataset.sh

GROUNDED_CHECKPOINT={保存检查点的路径}
OUTPUT_DIR={保存预测结果的路径}
TASK=wow
accelerate launch --config_file configs/G16_config.yaml train.py 
	--model_name_or_path ${GROUNDED_CHECKPOINT} \
	--dataset_name ./datasets_loader/${TASK}_dataset.py \
	--output_dir ${OUTPUT_DIR} \
	--per_device_train_batch_size=16 \
	--per_device_eval_batch_size=16 \
	--max_target_length 256 \
	--max_length 512 \
	--num_train_epochs 10 \
	--preprocessing_num_workers 24 \
	--num_beams 5 \
	--exp_name ${TASK}  \
	--learning_rate 5e-5 \	
	--save_every_checkpoint \
	--save_steps 50000 

教程 - 使用 GODEL 添加新任务

在本教程中，您将基于 GODEL 构建一个用于 DSTC9 任务的 grounded 对话模型。详细信息请参见 这里。

首先下载数据并将其转换为 GODEL 格式。

cd examples/dstc9
./create_data.sh

使用预训练的 GODEL 模型进行微调

cd GODEL 
GODEL_MODEL={预训练模型的路径}
python train.py 
	--model_name_or_path ${GODEL_MODEL}   \
	--dataset_name ../examples/dstc9/dstc9_dataset.py   \
	--output_dir ../examples/dstc9/ckpt   \
	--per_device_train_batch_size=16  \
	--per_device_eval_batch_size=16  \
	--max_target_length 128  \
	--max_length 512  \
	--num_train_epochs 50  \
	--save_steps 10000  \
	--num_beams 5  \
	--exp_name wow-test \
	--preprocessing_num_workers 24 \
	--save_every_checkpoint 

与上述训练好的模型交互

cd examples/dstc9
# 将 dstc9_server 中第 49 行的模型路径替换为已训练的检查点
python dstc9_server.py

cd GODEL/html 
npm install
npm run serve

免责声明

本仓库旨在促进大规模构建任务型机器人这一范式转变的研究。该工具包仅包含实际生成运行对话所需模型权重文件的部分建模机制。单独使用此模型只能提供关于各个文本片段权重的信息；研究人员若要真正使用它，还需引入自己的对话数据进行后续预训练，并从预训练或微调后的系统中解码响应生成过程。微软不对第三方利用预训练系统所产生的任何内容负责。

引用

如果您在研究中使用了本代码和数据，请引用我们的 arXiv 论文：

@misc{peng2022godel,
author = {Peng, Baolin and Galley, Michel and He, Pengcheng and Brockett, Chris and Liden, Lars and Nouri, Elnaz and Yu, Zhou and Dolan, Bill and Gao, Jianfeng},
title = {GODEL: Large-Scale Pre-training for Goal-Directed Dialog},
howpublished = {arXiv},
year = {2022},
month = {June},
url = {https://www.microsoft.com/en-us/research/publication/godel-large-scale-pre-training-for-goal-directed-dialog/},
}

贡献

本项目欢迎贡献和建议。大多数贡献都需要您同意贡献者许可协议（CLA），声明您有权且确实授予我们使用您贡献的权利。有关详情，请访问 https://cla.opensource.microsoft.com。

当您提交拉取请求时，CLA 机器人会自动判断您是否需要提供 CLA，并相应地标记 PR（例如状态检查、评论）。只需按照机器人提供的指示操作即可。对于所有使用我们 CLA 的仓库，您只需完成一次此步骤。

本项目已采用 微软开源行为准则。更多信息请参阅 行为准则常见问题解答，或发送电子邮件至 opencode@microsoft.com 咨询更多问题或意见。

商标

本项目可能包含项目、产品或服务的商标或标识。未经授权使用微软商标或标识须遵守并遵循 微软商标与品牌指南。在本项目的修改版本中使用微软商标或标识不得造成混淆或暗示微软的赞助。任何第三方商标或标识的使用均受其各自政策的约束。

GODEL 快速上手指南

GODEL 是一个用于**目标导向对话（Goal-Directed Dialog）**的大规模预训练模型。它基于 Transformer Encoder-Decoder 架构，擅长结合外部知识（如检索文档）生成回复，适用于任务型机器人开发。

1. 环境准备

在开始之前，请确保您的系统满足以下要求：

• 操作系统: Linux 或 macOS (Windows 需使用 WSL)
• Python: 3.8 及以上版本
• 包管理器: Conda (推荐)
• 前端依赖: Node.js 和 npm (仅当需要运行本地交互界面时需要)
• 硬件: 推荐使用 NVIDIA GPU 进行微调或推理

2. 安装步骤

2.1 创建虚拟环境并安装依赖

使用以下命令创建名为 godel-env 的 Conda 环境，克隆代码库并安装 Python 依赖：

conda create -n godel-env python=3.8
conda activate godel-env
conda install nodejs
git clone https://github.com/microsoft/GODEL.git
cd GODEL
pip install -r requirements.txt
export PYTHONPATH="`pwd`"

提示: 如果下载速度较慢，可配置国内 pip 源（如清华源）： pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple

2.2 获取预训练模型

下载并解压基础预训练模型（Base Model），以便进行后续的微调或推理：

wget https://bapengstorage.blob.core.windows.net/fileshare/godel_base.tar.gz
tar -zxvf godel_base.tar.gz

注：您也可以直接从 Hugging Face 加载模型，无需手动下载文件（见下文“基本使用”）。

3. 基本使用

GODEL 提供了多种使用方式，以下是两种最常用的场景。

场景一：直接使用 Hugging Face Transformers 进行对话（最简单）

如果您只想快速体验或与模型交互，无需运行完整的仓库代码，可直接使用 transformers 库。

前提: 确保已安装 transformers (pip install transformers)

from transformers import AutoTokenizer, AutoModelForSeq2SeqLM

# 加载分词器和模型 (Base 版本)
model_name = "microsoft/GODEL-v1_1-base-seq2seq"
tokenizer = AutoTokenizer.from_pretrained(model_name)
model = AutoModelForSeq2SeqLM.from_pretrained(model_name)

# 准备输入数据
# Context: 对话上下文
# Knowledge: 外部知识/信息
context = "Please remind me of calling to Jessie at 2PM."
knowledge = "reminder_contact_name is Jessie, reminder_time is 2PM"

# GODEL 的输入格式通常为：Context + Knowledge
input_text = f"{context} [KNOWLEDGE] {knowledge}"

# 编码
inputs = tokenizer(input_text, return_tensors="pt")

# 生成回复
outputs = model.generate(
    **inputs,
    max_length=128,
    num_beams=5,
    early_stopping=True
)

# 解码结果
response = tokenizer.decode(outputs[0], skip_special_tokens=True)
print(f"AI Response: {response}")

场景二：微调到自定义任务

若需将 GODEL 适配到特定领域，需准备 JSON 格式数据并运行微调脚本。

1. 数据格式示例 (data.json)

{
  "Context": "Please remind me of calling to Jessie at 2PM.",
  "Knowledge": "reminder_contact_name is Jessie, reminder_time is 2PM",
  "Response": "Sure, set the reminder: call to Jesse at 2PM"
}

2. 执行微调命令 替换路径变量后运行：

DATA_NAME=./path/to/your/data.json
OUTPUT_DIR=./output_finetuned_model
MODEL_PATH=./godel_base  # 或者 HuggingFace 模型路径

python train.py --model_name_or_path ${MODEL_PATH} \
	--dataset_name ${DATA_NAME} \
	--output_dir ${OUTPUT_DIR} \
	--per_device_train_batch_size=16 \
	--per_device_eval_batch_size=16 \
	--max_target_length 512 \
	--max_length 512 \
	--num_train_epochs 50 \
	--save_steps 10000 \
	--num_beams 5 \
	--exp_name my_task --preprocessing_num_workers 24

场景三：启动本地交互演示 (Web UI)

如果需要图形化界面与微调后的模型聊天：

1. 启动后端服务 (修改 EXAMPLE_server.py 中的模型路径):

   python EXAMPLE_server.py
   

2. 启动前端页面:

   cd GODEL/html
   npm install
   npm run serve 
   

3. 访问: 打开浏览器访问 http://localhost:8080。

---

更多详情及在线 Demo 体验，请访问 Hugging Face Spaces。