TC-Bot 项目启动与配置教程

1. 项目的目录结构及介绍

TC-Bot 是一个开源项目，用于实现端到端的任务完成型神经网络对话系统以及用户模拟器。以下是项目的目录结构及其介绍：

TC-Bot/
├── deep_dialog/            # 存放对话系统的核心代码
│   ├── checkpoints/        # 存放训练好的模型文件
│   ├── data/               # 存放项目所需的数据文件
│   ├── docs/               # 存放项目的文档
│   ├── models/             # 存放模型相关的代码
│   └── run.py              # 项目的启动文件
├── imgs/                   # 存放项目相关的图片文件
├── LICENSE                 # 项目的许可文件
├── README.md               # 项目说明文件
└── src/                    # 存放项目源代码

• deep_dialog/: 包含项目的核心代码，包括模型定义、训练和测试脚本等。
• checkpoints/: 存放训练好的对话模型。
• data/: 包含项目运行所需的数据集，如电影知识库、用户目标等。
• docs/: 存放项目的文档，包括用户手册和API文档等。
• models/: 包含定义模型结构的代码。
• run.py: 项目的启动文件，用于运行对话系统。
• imgs/: 存放项目相关的图片文件，如示例对话流程图等。
• LICENSE: 项目的开源许可文件，通常是MIT许可。
• README.md: 项目的说明文件，介绍项目的基本信息和如何使用。
• src/: 包含项目的源代码，如用户模拟器和对话代理的代码。

2. 项目的启动文件介绍

项目的启动文件是 run.py，它包含了启动对话系统的所有必要参数和函数。以下是一些基本的启动命令：

python run.py --agt <AGENT_ID> --usr <USER_ID> --max_turn <MAX_TURNS> --episodes <EPISODES> ...

其中：

• --agt <AGENT_ID>: 指定使用的对话代理的ID。
• --usr <USER_ID>: 指定用户（模拟器）的ID。
• --max_turn <MAX_TURNS>: 指定对话的最大轮数。
• --episodes <EPISODES>: 指定要运行的对话剧集数。

更多参数可以通过查看 run.py 文件中的参数定义来了解。

3. 项目的配置文件介绍

项目的配置文件主要是通过命令行参数进行配置。在 run.py 文件中，可以找到各种配置参数的定义。以下是一些重要的配置参数：

• --movie_kb_path: 指定电影知识库的路径。
• --goal_file_path: 指定用户目标文件的路径。
• --dqn_hidden_size: 指定DQN网络隐藏层的大小。
• --batch_size: 指定训练时的批量大小。
• --simulation_epoch_size: 指定每个训练周期中模拟的对话数量。
• --write_model_dir: 指定训练模型的保存路径。
• --trained_model_path: 指定加载训练好的模型的路径。
• --run_mode: 指定运行模式，如显示模式、调试模式等。

这些配置参数可以在启动项目时根据需要进行修改，以满足不同的运行需求。