Paper2Poster 项目启动与配置教程

Paper2Poster 项目启动与配置教程

Paper2Poster Open-source Multi-agent Poster Generation from Papers 项目地址: https://gitcode.com/gh_mirrors/pa/Paper2Poster

1. 项目的目录结构及介绍

Paper2Poster 项目是一个开源的多代理海报生成系统，旨在从科学论文自动化生成多模态海报。以下是项目的目录结构及其简要说明：

Paper2Poster/
├── assets/               # 存储项目所需的静态资源
├── camel/                # 与 CAMEL 相关的代码和配置
├── docling/              # 与 Docling 相关的代码和配置
├── LICENSE               # 项目许可证文件
├── README.md             # 项目说明文件
├── requirements.txt      # 项目依赖文件
├── utils/                # 项目工具类代码
├── __init__.py           # 初始化文件
└── PosterAgent/          # 主程序代码，包括海报生成逻辑

• assets/：存放项目所需的高分辨率图片和其他静态资源。
• camel/：包含与 CAMEL 项目相关的代码。
• docling/：包含与 Docling 项目相关的代码。
• LICENSE：项目的开源许可证，本项目采用 MIT 许可证。
• README.md：项目说明文档，介绍了项目的目的、功能和如何使用。
• requirements.txt：列出项目运行所需的 Python 包依赖。
• utils/：包含项目使用到的工具类和辅助函数。
• __init__.py：Python 包初始化文件，确保目录作为包使用。
• PosterAgent/：项目的核心代码库，包含了生成海报的多代理系统。

2. 项目的启动文件介绍

项目的启动文件主要位于 PosterAgent/ 目录下。以下是主要的启动文件及其功能：

• new_pipeline.py：这是主要的启动脚本，用于根据提供的参数和配置生成海报。
• create_dataset.py：用于创建评估所需的数据集。

以 new_pipeline.py 为例，以下是一个简单的启动命令，用于生成海报：

python -m PosterAgent.new_pipeline --poster_path="/path/to/paper.pdf" --model_name_t="model_name" --model_name_v="model_name" --poster_width_inches=48 --poster_height_inches=36

其中：

• --poster_path：指定论文文件的路径。
• --model_name_t：指定文本模型的名称。
• --model_name_v：指定视觉模型的名称。
• --poster_width_inches 和 --poster_height_inches：指定生成海报的宽度和高度。

3. 项目的配置文件介绍

项目的配置文件主要用于定义项目运行时的参数，例如模型选择、端口配置等。在 Paper2Poster 项目中，配置通常通过环境变量和 .env 文件进行管理。

• .env：该文件用于存储项目的环境变量，如 OpenAI API 密钥等敏感信息。

以下是一个 .env 文件的示例：

OPENAI_API_KEY=your_openai_api_key

确保在运行项目之前设置好所有必要的环境变量，以确保项目可以正确访问依赖的服务和资源。

Paper2Poster Open-source Multi-agent Poster Generation from Papers 项目地址: https://gitcode.com/gh_mirrors/pa/Paper2Poster