paperbanana

环境要求

• Python 3.10 及以上版本
• Gemini API Key（官方 API 或兼容接口的 URL + Key）
• 可选：Docker（使用容器方式运行时需要）
• 可选：PyMuPDF（输入 PDF 时需安装 paperbanana[pdf]）

安装与启动步骤

1. 1安装 PaperBanana

   用 pip 从 PyPI 安装，自动装好命令行工具 paperbanana。建议在独立虚拟环境中执行，避免依赖冲突。

   pip install paperbanana

   复制

2. 2首次交互配置

   运行交互式向导，先选择是否使用官方 Gemini API；若不用官方，则需填入自定义 Gemini 兼容 URL 和 API Key。

   paperbanana setup

   复制

3. 3准备输入文件

   把论文方法部分的文字整理成纯文本文件（如 method.txt）放在当前目录，作为生成的输入素材。

4. 4生成学术图表

   传入输入文件与图注说明，程序会调用模型生成示意图，结果默认写入 outputs 目录。

   paperbanana generate --input method.txt --caption "Overview of our framework"

   复制

5. 5按反馈迭代修改

   对上一轮结果不满意时，用 --continue 加 --feedback 让模型按文字反馈继续调整图表。

   paperbanana generate --continue --feedback "Make arrows thicker and colors more distinct"

   复制

6. 6Docker 方式运行

   先在仓库根目录构建镜像，再挂载输入文件与输出目录到 /work，并把 API Key 通过环境变量传入容器。

   docker build -t paperbanana .
   docker run --rm -e GOOGLE_API_KEY 
     -v "$(pwd)/method.txt:/work/method.txt:ro" 
     -v "$(pwd)/outputs:/work/outputs" 
     paperbanana generate --input method.txt --caption "Overview of our framework"

   复制

7. 7源码开发安装

   需要改代码或跑测试时，克隆仓库后以可编辑模式安装，并带上 dev、openai、google 依赖。

   git clone https://github.com/llmsresearch/paperbanana.git
   cd paperbanana
   pip install -e ".[dev,openai,google]"

   复制

关键配置

如何确认成功

执行 paperbanana generate --help 能正常输出命令帮助，且生成后 outputs 目录内出现图表文件，即表示配置与运行成功。

常见问题

注意事项

• Python 版本要求 3.10 以上，低版本安装会失败。
• Docker 运行时必须通过 -e GOOGLE_API_KEY 传入密钥，并正确挂载输入输出目录。
• PDF 输入需要额外安装 paperbanana[pdf]（即 PyMuPDF 依赖）。
• 生成的图片与元数据默认保存在 outputs 目录，注意及时备份或清理。