SketchAgent 项目使用教程

1. 项目目录结构及介绍

SketchAgent 项目主要包含以下目录和文件：

• repo_images/: 存放项目相关的图片文件。
• static/: 存放静态文件，如 CSS、JavaScript 和图片等。
• templates/: 存放 Flask 应用的 HTML 模板文件。
• .env: 环境变量配置文件，用于存储 API 密钥等敏感信息。
• .gitignore: 用于指定 Git 忽略提交的文件和目录。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目说明文件。
• collab_sketch.py: 用于启动协作绘图功能的 Python 脚本。
• gen_sketch.py: 用于生成单个草图概念的 Python 脚本。
• environment.yml: Conda 环境配置文件，用于指定项目所需的 Python环境和依赖。
• mac_environment.yml: 为 Mac 用户提供的 Conda 环境配置文件。
• prompts.py: 存放用于生成草图提示的 Python 脚本。
• utils.py: 存放项目工具函数的 Python 脚本。

2. 项目的启动文件介绍

项目中有两个主要的启动文件：

• collab_sketch.py: 此脚本用于启动 Flask 应用，提供一个交互式界面，用户可以通过这个界面与 SketchAgent 进行协作绘图。运行此脚本后，应用会在终端输出一个本地 IP 地址和端口号，用户通过浏览器访问该地址即可使用。

  python collab_sketch.py
  

• gen_sketch.py: 此脚本用于生成基于文本概念的草图。用户可以通过传递 --concept_to_draw 参数来指定要绘制的概念。

  python gen_sketch.py --concept_to_draw "<your_concept_here>"
  

  例如：

  python gen_sketch.py --concept_to_draw "船"
  

3. 项目的配置文件介绍

项目的主要配置文件是 .env 文件，用于存储敏感信息和配置参数，如 API 密钥。该文件应该包含以下内容：

ANTHROPIC_API_KEY=<your_key>

用户需要将 <your_key> 替换为从 Anthropic 获得的实际 API 密钥。确保 .env 文件不会被 Git 跟踪，它在 .gitignore 文件中已被指定忽略。