LLM-Planner 使用指南

LLM-Planner 使用指南

1. 目录结构及介绍

OSU-NLP-Group 的 LLM-Planner 是一个旨在实现基于大型语言模型的实体代理的少样本地面规划的研究项目。以下是该仓库的基本目录结构及其简要说明：

.
├── LICENSE                # 许可证文件
├── README.md              # 项目概述和快速入门指南
├── gitignore              # Git 忽略文件
├── hlp_planner.py         # 核心脚本，用于通过KNN数据集生成高级任务计划
├── knn_set.pkl            # 邻近搜索集的数据文件
└── [其他相关代码和数据文件夹]

• LICENSE: 包含了项目使用的MIT许可证条款。
• README.md: 提供项目综述，演示链接，快速启动命令以及其他重要信息。
• gitignore: 指示Git在版本控制中忽略哪些类型的文件。
• hlp_planner.py: 这是项目的核心，执行时利用KNN数据来生成特定任务的高层计划。
• knn_set.pkl: 存储了KNN算法所需的预处理数据，用于规划逻辑。

2. 项目的启动文件介绍

hlp_planner.py

此脚本是项目的主要运行入口，它演示了如何利用预先训练好的模型和数据集生成高阶任务计划。通过运行这个脚本，用户可以体验到少样本环境下，大型语言模型如何辅助实体代理进行计划生成。基础的启动命令如下所示：

python hlp_planner.py

这将会基于已有的数据（如knn_set.pkl）生成并展示一个计划案例。用户应当参考源码和文档以自定义输入和环境配置。

3. 项目的配置文件介绍

尽管提供的直接指导中没有明确提到一个单独的配置文件路径，但配置主要通过修改脚本参数或环境变量来完成。在hlp_planner.py或其他关键实现文件中，开发者应查找可调整的变量如数据路径、模型参数等进行配置。例如，如果想要改变KNN数据集的位置或者模型的某些超参数，可以直接在脚本里定位这些设置并做相应的更改。

为了更灵活和模块化的管理配置，社区实践中可能会推荐引入外部配置文件（如.yaml或.json），但在当前仓库版本中，这种实践未被直接展示。因此，用户需依据实际代码中的注释和变量声明来定制化配置。