DAMO ConvAI

DAMO ConvAI：阿里巴巴达摩院对话式人工智能的官方代码库仓库。

  ____    _    __  __  ___     ____                  _    ___ 
 |  _ \  / \  |  \/  |/ _ \   / ___|___  _ ____   __/ \  |_ _|
 | | | |/ _ \ | |\/| | | | | | |   / _ \| '_ \ \ / / _ \  | | 
 | |_| / ___ \| |  | | |_| | | |__| (_) | | | \ V / ___ \ | | 
 |____/_/   \_\_|  |_|\___/   \____\___/|_| |_|\_/_/   \_\___|
                                                              

🔥 最新消息

• [2024-02]: 5篇论文被LREC-COLING 2024接收！
• [2023-10]: 7篇论文被EMNLP 2023接收！
• [2023-09]: BIRD-SQL被NeurIPS 2023 Spotlight接收！
• [2023-08]: SigDial 2023 DSTC11研讨会最佳论文！
• [2023-05]: 9篇论文被ACL 2023接收！
• [2022-11]: 🏆 在DSTC11-SIMMC赛道上获得第一名！
• [2022-10]: 10篇论文被EMNLP 2022接收！
• [2022-05]: 2篇论文被KDD 2022接收。
• [2022-07]: SPACE 3.0被SIGIR 2022接收。
• [2022-02]: S²SQL被ACL 2022接收，并在Spider排行榜上获得第一名！
• [2021-11]: SPACE 1.0被AAAI 2022接收。
• [2020-11]: R²SQL被AAAI 2021接收，并在SparC和CoSQL排行榜上获得第一名！

📝 许可证

DAMO-ConvAI采用MIT许可证发布。

MIT 许可证

版权所有 © 2022 阿里巴巴研究院

特此授予任何人免费获取本软件及其相关文档文件（以下简称“软件”）副本的权利，以进行处理，
包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售软件副本的权利，
并允许向任何提供软件的人这样做，但须遵守以下条件：

上述版权声明和本许可声明应包含在软件的所有副本或实质性部分中。

DAMO-ConvAI 快速上手指南

DAMO-ConvAI 是阿里巴巴达摩院对话式 AI（Conversational AI）的官方代码库，涵盖了文本到 SQL、多轮对话状态追踪等前沿研究成果。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：Linux (推荐 Ubuntu 18.04+) 或 macOS
• Python 版本：Python 3.7 或更高版本
• 硬件要求：建议配备 NVIDIA GPU 以加速模型训练与推理（需安装 CUDA）
• 前置依赖：
  • git
  • pip (包管理工具)

提示：建议使用 conda 创建独立的虚拟环境以避免依赖冲突。

安装步骤

1. 克隆项目仓库

git clone https://github.com/AlibabaResearch/DAMO-ConvAI.git
cd DAMO-ConvAI

2. 安装依赖包

项目通常依赖 PyTorch 及常见的 NLP 库。请根据官方 requirements.txt 进行安装。

国内用户加速方案： 推荐使用清华源或阿里源加速 pip 安装过程。

# 使用阿里云镜像源安装依赖
pip install -r requirements.txt -i https://mirrors.aliyun.com/pypi/simple/

注：如果项目中包含特定的子模块（如 SPACE, S²SQL 等），请进入对应子目录重复上述安装步骤，或参考各子模块的具体 README。

基本使用

DAMO-ConvAI 包含多个独立的研究项目（如 Text-to-SQL, DST 等）。以下以通用的模型推理流程为例，展示如何加载预训练模型并进行简单测试。

示例：运行 Text-to-SQL 任务 (以 S²SQL 为例)

假设您已下载好对应的预训练权重和数据集，最简单的推理命令如下：

python run.py \
    --mode predict \
    --config_path configs/spider_config.json \
    --checkpoint_path checkpoints/s2sql_spider_best.pt \
    --input_data data/spider/dev.json \
    --output_file predictions/output.json

参数说明

• --mode: 运行模式，predict 表示推理，train 表示训练。
• --config_path: 模型配置文件路径。
• --checkpoint_path: 预训练模型权重文件路径。
• --input_data: 输入测试数据文件。
• --output_file: 预测结果输出路径。

注意：具体任务的脚本名称（如 run.py）和参数可能因子项目不同而有所差异，请务必查阅对应子文件夹（如 S2SQL, SPACE）下的详细文档以获取特定任务的启动命令。