AutoCodeRover安装与配置指南

AutoCodeRover安装与配置指南

auto-code-rover A project structure aware autonomous software engineer aiming for autonomous program improvement 项目地址: https://gitcode.com/gh_mirrors/au/auto-code-rover

1. 项目基础介绍

AutoCodeRover 是一个由新加坡国立大学（NUS）开发的开源项目，致力于实现自动化的程序改进。该项目通过结合大型语言模型（LLM）和代码分析、调试能力，自动解决 GitHub 上的问题（包括错误修复和功能添加）。AutoCodeRover 能够在代码库中搜索相关上下文，并基于这些上下文生成修复补丁。

主要编程语言：Python

2. 项目使用的关键技术和框架

• 大型语言模型（LLM）：用于理解代码上下文和生成代码补丁。
• 抽象语法树（AST）：用于代码搜索API，实现程序结构感知的代码搜索。
• 统计故障定位（SFL）：在测试用例可用时，通过统计分析定位错误。
• Docker：容器化技术，用于简化项目部署和环境配置。

3. 项目安装和配置的准备工作

在开始安装之前，请确保您的系统中已安装以下工具：

• Docker
• Python 3.x
• pip
• conda（推荐，用于管理Python环境）

详细安装步骤

步骤 1：克隆项目仓库

打开终端（或命令提示符），执行以下命令克隆项目仓库：

git clone https://github.com/nus-apr/auto-code-rover.git
cd auto-code-rover

步骤 2：创建Python虚拟环境

在项目根目录下创建并激活一个conda虚拟环境：

conda env create -f environment.yml
conda activate auto-code-rover

步骤 3：构建Docker镜像（可选）

如果您选择使用Docker，构建Docker镜像：

docker build -f Dockerfile.minimal -t acr

步骤 4：配置环境变量

设置OpenAI API密钥环境变量（如果使用OpenAI模型）：

export OPENAI_KEY=sk-YOUR-OPENAI-API-KEY-HERE

对于其他模型（如Anthropic、Groq等），您需要设置相应的API密钥。

步骤 5：运行AutoCodeRover

以下是在Docker容器中运行AutoCodeRover的示例命令。请根据您的需求替换相应的参数：

docker run -it -e OPENAI_KEY="${OPENAI_KEY:-OPENAI_API_KEY}" acr

或者在虚拟环境中直接运行：

PYTHONPATH=. python app/main.py github-issue --output-dir output --setup-dir setup --model gpt-4o-2024-05-13 --model-temperature 0.2 --task-id <task id> --clone-link <link for cloning the project> --commit-hash <any version that has the issue> --issue-link <link to issue page>

请将 <task id>、<link for cloning the project>、<any version that has the issue> 和 <link to issue page> 替换为实际的值。

完成以上步骤后，您应该已经成功安装和配置了AutoCodeRover项目。

auto-code-rover A project structure aware autonomous software engineer aiming for autonomous program improvement 项目地址: https://gitcode.com/gh_mirrors/au/auto-code-rover