AgentStudio开源项目使用教程

AgentStudio开源项目使用教程

1. 项目目录结构及介绍

AgentStudio项目的目录结构如下：

agent-studio/
├── .github/                # GitHub工作流和配置文件
│   ├── workflows/
│   └── ...
├── dockerfiles/           # Docker配置文件
├── docs/                  # 项目文档
├── eval_agent_desiderata/ # 评估代理欲望的脚本和数据
├── eval_online_benchmarks/ # 在线基准测试任务
├── scripts/               # 项目相关脚本
├── tests/                 # 测试代码和测试数据
├── .flake8                # Flake8配置文件
├── .gitignore             # Git忽略文件
├── .isort.cfg             # isort配置文件
├── .pre-commit-config.yaml # pre-commit配置文件
├── CONTRIBUTING.md        # 贡献指南
├── LICENSE                # 项目许可证
├── README.md              # 项目自述文件
├── pyproject.toml         # Python项目配置文件
└── ...

• .github/: 存放GitHub Actions工作流文件，用于自动化项目的一些流程，如代码测试、构建等。
• dockerfiles/: 包含用于构建Docker镜像的配置文件。
• docs/: 项目文档，用于存放项目的使用说明、API文档等。
• eval_agent_desiderata/: 包含评估代理欲望的相关脚本和数据。
• eval_online_benchmarks/: 包含在线基准测试任务的相关文件。
• scripts/: 包含项目开发过程中使用的脚本文件。
• tests/: 包含项目测试代码和测试数据。
• .flake8: Flake8配置文件，用于Python代码风格检查。
• .gitignore: Git忽略文件，指定Git应该忽略的文件和目录。
• .isort.cfg: isort配置文件，用于Python代码导入排序。
• .pre-commit-config.yaml: pre-commit配置文件，用于在提交代码前执行一些钩子脚本，如代码风格检查。
• CONTRIBUTING.md: 贡献指南，指导贡献者如何为项目贡献代码。
• LICENSE: 项目许可证，本项目采用AGPL-3.0许可证。
• README.md: 项目自述文件，介绍项目的基本信息、功能等。
• pyproject.toml: Python项目配置文件，用于定义项目的元数据和依赖。

2. 项目的启动文件介绍

项目的启动文件位于项目根目录下的pyproject.toml。这个文件定义了项目的元数据和依赖项。以下是pyproject.toml文件的一个基本示例：

[build-system]
requires = ["setuptools", "wheel"]
build-backend = "setuptools.build_meta"

[tool.setuptools]
packages = find:

[project]
name = "agent-studio"
version = "0.1.0"
description = "A trinity of environments, tools, and benchmarks for general virtual agents"
authors = ["Longtao Zheng <ltzheng@example.com>"]
dependencies = []
classifiers = [
    "Programming Language :: Python :: 3",
    "License :: OSI Approved :: GNU Affero General Public License v3",
    ...
]

在这个文件中，我们定义了项目名称、版本、描述、作者、依赖项以及一些分类信息。

3. 项目的配置文件介绍

项目的配置文件主要指的是agent_studio/config/api_key.json，用于存放项目中需要使用的API密钥。以下是一个配置文件的示例：

{
    "openai_api_key": "your_openai_api_key_here",
    "claude_api_key": "your_claude_api_key_here",
    "gemini_api_key": "your_gemini_api_key_here"
}

在这个文件中，你需要替换your_openai_api_key_here、your_claude_api_key_here和your_gemini_api_key_here为你的实际API密钥。这些API密钥将被项目中的代码使用，以访问相应API提供的服务。

请确保不要将配置文件中的敏感信息泄露到公共代码库中。如果你需要将配置文件包含在版本控制中，请使用.gitignore文件来确保这些敏感信息不会被提交到远程仓库。