GPT-Code-Learner 项目安装与使用指南

GPT-Code-Learner 项目安装与使用指南

1. 项目目录结构及介绍

GPT-Code-Learner/
├── docs/
│   └── README.md
├── code_learner.py
├── code_searcher.py
├── knowledge_base.py
├── repo_parser.py
├── requirements.txt
├── run.py
├── tool_planner.py
├── util.py
├── .gitignore
└── LICENSE

目录结构说明

• docs/: 存放项目文档，包括README.md文件。
• code_learner.py: 项目的主文件，负责与用户交互并调用其他模块。
• code_searcher.py: 用于在代码库中搜索特定函数或变量的工具。
• knowledge_base.py: 生成和管理代码库的向量数据库。
• repo_parser.py: 解析代码库，构建代码的向量数据库。
• requirements.txt: 项目依赖的Python包列表。
• run.py: 项目的启动文件。
• tool_planner.py: 工具规划器，负责调用和协调其他工具。
• util.py: 项目中使用的通用工具函数。
• .gitignore: Git忽略文件配置。
• LICENSE: 项目许可证文件。

2. 项目启动文件介绍

run.py

run.py 是 GPT-Code-Learner 项目的启动文件。通过运行该文件，用户可以在本地启动项目，并在浏览器中访问项目的图形用户界面（GUI）。

# run.py
import os
from code_learner import CodeLearner

def main():
    learner = CodeLearner()
    learner.run()

if __name__ == "__main__":
    main()

启动步骤

1. 确保已安装所有依赖包：

   pip install -r requirements.txt
   

2. 运行启动文件：

   python run.py
   

3. 打开浏览器，访问 http://127.0.0.1:7860，即可开始使用 GPT-Code-Learner。

3. 项目配置文件介绍

.env

.env 文件用于配置项目的API密钥和其他环境变量。用户需要在该文件中填写OpenAI的API密钥。

OPENAI_API_KEY=sk-xxxxxx
LLM_TYPE="OpenAI"
EMBEDDING_TYPE="OpenAI"

配置说明

• OPENAI_API_KEY: OpenAI API的密钥，用于访问GPT模型。
• LLM_TYPE: 指定使用的语言模型类型，默认为 "OpenAI"。
• EMBEDDING_TYPE: 指定使用的嵌入模型类型，默认为 "OpenAI"。

本地运行配置

如果用户希望在本地运行大型语言模型（LLM），可以将 .env 文件中的 LLM_TYPE 和 EMBEDDING_TYPE 修改为 "local"：

LLM_TYPE="local"
EMBEDDING_TYPE="local"

注意事项

• 如果使用本地LLM模型，请确保在运行 run.py 之前启动本地模型。
• 本地模型的详细配置和启动方法请参考项目的 README.md 文件。