增加了测试案例
This commit is contained in:
parent
41af8c33de
commit
1919c2e7a8
682
README.md
682
README.md
@ -4,503 +4,243 @@
|
||||
|
||||
## 功能特点
|
||||
|
||||
- **自动选题生成**：根据提供的景点信息和配置的提示词模板，自动生成吸引人的旅游选题（**以JSON格式输出**）。
|
||||
- **内容创作**：基于选题和配置的提示词模板，自动生成文字内容（标题、正文）。
|
||||
- **海报制作**：结合景点图片和生成的文字内容，自动创建精美的宣传海报。
|
||||
- **批量处理**：支持一次性生成多个选题和多个变体内容。
|
||||
- **模块化设计**：核心功能（配置加载、提示词管理、AI交互、选题、内容生成、海报制作）分离，方便维护和扩展。
|
||||
- **配置驱动**：通过 `poster_gen_config.json` 文件集中管理所有运行参数。
|
||||
- **图片拼贴**：自动处理和组合图片，支持多种风格的拼贴效果。
|
||||
- **贴纸装饰**：自动识别和添加适当的装饰贴纸，增强海报视觉效果。
|
||||
- **组件测试**：提供多个测试脚本，方便开发者测试和了解各个组件。
|
||||
- **流式输出**：支持AI内容的流式生成和实时处理。
|
||||
- **自动选题生成**：根据提供的景点信息和配置的提示词模板，自动生成吸引人的旅游选题
|
||||
- **内容创作**：基于选题和配置的提示词模板，自动生成文字内容（标题、正文）
|
||||
- **海报制作**：结合景点图片和生成的文字内容，自动创建精美的宣传海报
|
||||
- **批量处理**：支持一次性生成多个选题和多个变体内容
|
||||
- **模块化设计**：核心功能（配置加载、提示词管理、AI交互、选题、内容生成、海报制作）分离，方便维护和扩展
|
||||
- **配置驱动**：通过配置文件集中管理所有运行参数
|
||||
|
||||
## 安装
|
||||
## 快速开始
|
||||
|
||||
### 环境要求
|
||||
- Python 3.6+
|
||||
- 依赖库安装：
|
||||
### 1. 环境准备
|
||||
|
||||
```bash
|
||||
# 安装依赖库
|
||||
pip install numpy pandas opencv-python pillow openai
|
||||
# 可能还需要安装AI模型的客户端库，例如 requests 或 特定模型的SDK
|
||||
# pip install requests
|
||||
# 克隆项目
|
||||
git clone https://github.com/yourusername/TravelContentCreator.git
|
||||
cd TravelContentCreator
|
||||
|
||||
# 安装依赖 (假设有requirements.txt文件)
|
||||
# pip install -r requirements.txt
|
||||
# 或者手动安装
|
||||
pip install numpy pandas opencv-python pillow requests tqdm
|
||||
```
|
||||
|
||||
### 项目依赖项
|
||||
- OpenCV (cv2)：图像处理
|
||||
- NumPy：数据操作
|
||||
- Pandas：数据处理
|
||||
- PIL (Pillow)：图像处理和绘制
|
||||
- OpenAI：AI模型交互 (即使是调用本地或其他API，通常也使用其接口)
|
||||
### 2. 配置设置
|
||||
|
||||
## 核心组件与目录结构
|
||||
|
||||
- `main.py`: **项目入口与协调器**: 负责加载配置、**生成运行ID (run_id)**、初始化共享资源（如 AI Agent）、并按顺序调用 `utils` 模块中的函数来执行主要流程（选题生成 -> 内容与海报生成协调）。
|
||||
- `poster_gen_config.json`: (用户需从 `example_config.json` 创建) 核心配置文件。
|
||||
- `core/`: 核心算法与功能模块
|
||||
- `ai_agent.py`: **AI代理**: 封装与大语言模型 API 的底层交互逻辑（发送请求、接收响应）。
|
||||
- `topic_parser.py`: **选题解析器**: 解析 AI 模型返回的选题 **JSON 数据**。
|
||||
- `contentGen.py`: **内容处理器**: 对 AI 生成的原始推文内容进行结构化处理，提取适用于海报的元素。
|
||||
- `posterGen.py`: **海报生成器**: 负责将图片和文字元素组合生成最终的海报图片，处理字体、布局等。
|
||||
- `simple_collage.py`: **图片拼贴工具**: 提供图片预处理和拼贴功能。
|
||||
- `ImageCollageCreator` 类：核心拼贴图实现类，提供多种拼贴样式（如标准网格、非对称布局、胶片条、重叠风格等）。
|
||||
- `process_directory` 函数：对外接口，接收图片目录路径和参数，使用 `ImageCollageCreator` 创建一组拼贴图。
|
||||
- 支持多种拼贴样式：标准 2x2 网格、非对称布局、胶片条、重叠效果、马赛克风格等。
|
||||
- 提供图像增强：自动调整对比度、亮度和饱和度，使拼贴图更加美观。
|
||||
- 智能处理不同大小、格式的图片，自动尝试加载所有支持的图片格式（.jpg, .jpeg, .png, .bmp）。
|
||||
- 错误处理与恢复：当部分图片加载失败时，会自动尝试使用其他可用图片代替。
|
||||
- `utils/`: 工具与辅助模块
|
||||
- `resource_loader.py`: **资源加载器**: 负责加载项目所需的各种**原始**资源文件。
|
||||
- `prompt_manager.py`: **提示词管理器**: **集中管理**不同阶段提示词的构建逻辑（**已修正内容生成提示词构建逻辑，正确区分选题JSON中的文件名和描述性文本**）。
|
||||
- `tweet_generator.py`: **主要流程执行与数据结构**: 包含执行**选题生成** (`run_topic_generation_pipeline`)、**单选题内容生成** (`generate_content_for_topic`)、**单选题海报生成** (`generate_posters_for_topic`) 的核心函数，以及相关的数据类（**已修正内容文件保存路径**）。
|
||||
- `genPrompts/`: 内容生成提示词模板目录。
|
||||
- `SelectPrompt/`: 选题生成提示词模板目录（**其中的 `systemPrompt.txt` 已更新为要求 JSON 输出**）。
|
||||
- `resource/`: 存放基础的景点信息 `.txt` 文件等数据资源。
|
||||
- `examples/`: 使用示例和测试脚本。
|
||||
- `result/`: 默认输出结果保存目录。
|
||||
|
||||
## 项目流程与技术细节
|
||||
|
||||
1. **加载配置与生成Run ID**: `main.py` 读取 `poster_gen_config.json` 文件，并生成本次运行的 `run_id`。
|
||||
2. **选题生成**:
|
||||
- `main.py` 调用 `utils.tweet_generator.run_topic_generation_pipeline(config, run_id)`，传入配置和 `run_id`。
|
||||
- 此函数内部：
|
||||
- 调用 `utils.prompt_manager.PromptManager.get_topic_prompts()` 构建提示词（**系统提示词要求 AI 输出 JSON 格式**）。
|
||||
- 初始化 `core.ai_agent.AI_Agent`。
|
||||
- 调用 AI Agent 生成选题文本（应为 JSON 字符串）。
|
||||
- 使用 `core.topic_parser.parse_topics()` **解析 JSON 字符串**。
|
||||
- 保存选题结果 (`tweet_topic.json`) 到 `result/<run_id>/` 目录。
|
||||
- 关闭此阶段的 AI Agent。
|
||||
- 返回 `run_id` 和包含选题列表的 `tweet_topic_record` 给 `main.py`。
|
||||
3. **内容与海报生成协调**: (在 `main.generate_content_and_posters_step` 中执行)
|
||||
- 初始化 `utils.prompt_manager.PromptManager`。
|
||||
- 初始化一个**共享的** `core.ai_agent.AI_Agent` 实例供后续所有内容生成使用。
|
||||
- 遍历上一步返回的每个选题 (`topic_item`)：
|
||||
- **内容生成**: 调用 `utils.tweet_generator.generate_content_for_topic()`，传入共享的 AI Agent、Prompt Manager、配置、当前选题信息、`run_id` 和 `topic_index`。
|
||||
- 此函数内部循环生成该选题的所有内容变体，每次调用 `prompt_manager.get_content_prompts()` 获取特定提示词（**根据修正后的逻辑构建，正确处理 topic_item 中的字段**），并使用共享 AI Agent 执行 `generate_single_content`。
|
||||
- `generate_single_content` 将生成的文章 (`article.json`) 保存到正确的 `result/<run_id>/<topic_index>_<variant_index>/` 目录下。
|
||||
- **海报生成**: 如果内容生成成功，调用 `utils.tweet_generator.generate_posters_for_topic()`，传入配置、选题信息、生成的内容列表、`run_id` 和 `topic_index`。
|
||||
- 此函数内部负责初始化 `ContentGenerator` 和 `PosterGenerator`，调用 `core` 模块中的函数处理图片和文本，并生成所有海报变体到对应的 `result/<run_id>/<topic_index>_<variant_index>/` 目录下。
|
||||
- 所有选题处理完毕后，在 `main.generate_content_and_posters_step` 中关闭共享的 AI Agent。
|
||||
|
||||
## 使用方法
|
||||
|
||||
1. 准备景点资源信息 (`.txt` 文件)，放入 `resource/Object/` 目录（或其他在配置中指定的路径）。确保文件名与选题生成时 AI 可能选择的 `object` 名称匹配（目前使用包含匹配逻辑）。
|
||||
2. 准备图片资源，按照 `README.md` 中"开始使用"部分的说明组织图片目录结构，并确保 `poster_gen_config.json` 中的 `image_base_dir` 指向正确的图片根目录。
|
||||
3. 复制 `example_config.json` 为 `poster_gen_config.json`，并根据你的 API Key、模型端点、文件路径、图片根目录等进行修改。确保 `prompts_dir` 下的 `Style/` 和 `Demand/` 目录包含选题生成 AI 可能输出的文件名 (带 `.txt` 后缀)。确保 `Refer/` 目录下包含所有需要的参考文件。
|
||||
4. **运行完整流程**:
|
||||
```bash
|
||||
python main.py --config poster_gen_config.json
|
||||
```
|
||||
5. **分阶段运行**:
|
||||
```bash
|
||||
# 阶段 1: 仅生成选题
|
||||
python examples/run_step1_topics.py
|
||||
|
||||
# 阶段 2: 处理已生成的选题
|
||||
python examples/run_step2_content_posters.py <your_run_id>
|
||||
```
|
||||
|
||||
6. **测试单个组件**:
|
||||
```bash
|
||||
# 测试图片拼贴功能
|
||||
python examples/test_simple_collage.py
|
||||
|
||||
# 测试海报生成功能
|
||||
python examples/test_poster_generator.py
|
||||
|
||||
# 测试内容生成功能
|
||||
python examples/test_content_generator.py
|
||||
|
||||
# 测试AI流式输出功能
|
||||
python examples/test_stream.py
|
||||
|
||||
# 测试资源加载器
|
||||
python examples/test_resource_loader.py
|
||||
|
||||
# 测试流程步骤
|
||||
python examples/test_pipeline_steps.py
|
||||
```
|
||||
|
||||
更多详细信息，请参阅 `examples/README.md` 文件。
|
||||
|
||||
## 配置说明
|
||||
|
||||
配置文件: `poster_gen_config.json`
|
||||
|
||||
**必须配置项**：
|
||||
|
||||
- `api_url`: 大语言模型 API 地址 (或预设名称如 'vllm', 'ali', 'kimi', 'doubao', 'deepseek')
|
||||
- `api_key`: API 密钥
|
||||
- `model`: 使用的模型名称
|
||||
- `topic_system_prompt`: 选题生成系统提示词文件路径 (应为要求JSON输出的版本)
|
||||
- `topic_user_prompt`: 选题生成基础用户提示词文件路径
|
||||
- `content_system_prompt`: 内容生成系统提示词文件路径
|
||||
- `resource_dir`: 包含**资源文件信息**的列表。列表中的每个元素是一个字典，包含：
|
||||
- `type`: 资源类型，目前支持 `"Object"` (景点/对象信息), `"Description"` (对应的描述文件), `"Product"` (关联产品信息)。
|
||||
- `file_path`: 一个包含该类型所有资源文件**完整路径**的列表。
|
||||
- 对于 `"Object"` 类型，程序会根据选题中的对象名称在此列表中查找匹配的文件。
|
||||
- 对于 `"Description"` 类型，程序会根据选题中的对象名称在此列表中查找对应的描述文件 (文件名应包含对象名以便匹配)。
|
||||
- 对于 `"Product"` 类型，程序会根据选题中的产品名称在此列表中查找匹配的文件。
|
||||
- `num`: (可选，目前似乎未使用) 文件数量。
|
||||
- `prompts_dir`: 存放 Demand/Style/Refer 等提示词片段的目录路径
|
||||
- `output_dir`: 输出结果保存目录路径
|
||||
- `image_base_dir`: **图片资源根目录绝对路径或相对路径** (用于查找源图片)
|
||||
- `poster_assets_base_dir`: **海报素材根目录绝对路径或相对路径** (用于查找字体、边框、贴纸、文本背景等)
|
||||
- `num`: （选题阶段）生成选题数量
|
||||
- `variants`: （内容生成阶段）每个选题生成的变体数量
|
||||
|
||||
**可选配置项**：
|
||||
|
||||
- `date`: 日期标记（用于选题生成提示词，默认为空）
|
||||
- `topic_temperature`, `topic_top_p`, `topic_presence_penalty`: 选题生成 API 相关参数 (默认为 0.2, 0.5, 1.5)
|
||||
- `content_temperature`, `content_top_p`, `content_presence_penalty`: 内容生成 API 相关参数 (默认为 0.3, 0.4, 1.5)
|
||||
- `request_timeout`: AI API 请求的超时时间（秒，默认 30）
|
||||
- `max_retries`: 请求超时或可重试网络错误时的最大重试次数（默认 3）
|
||||
- `stream_chunk_timeout`: 处理流式响应时，允许的两个数据块之间的最大等待时间（秒），用于防止流长时间挂起。
|
||||
- `camera_image_subdir`: 存放原始照片的子目录名（相对于 `image_base_dir`，默认 "相机")
|
||||
- `modify_image_subdir`: 存放处理后/用于拼贴的图片的子目录名（相对于 `image_base_dir`，默认 "modify")
|
||||
- `output_collage_subdir`: 在每个变体输出目录中存放拼贴图的子目录名（默认 "collage_img")
|
||||
- `output_poster_subdir`: 在每个变体输出目录中存放最终海报的子目录名（默认 "poster")
|
||||
- `output_poster_filename`: 输出的最终海报文件名（默认 "poster.jpg")
|
||||
- `poster_target_size`: 海报目标尺寸 `[宽, 高]`（默认 `[900, 1200]`)
|
||||
- `text_possibility`: 海报中第二段附加文字出现的概率 (默认 0.3)
|
||||
|
||||
项目提供了一个示例配置文件 `example_config.json`，请务必复制并修改：
|
||||
|
||||
## 注意事项
|
||||
|
||||
- - 确保已安装所有依赖库，特别是 `openai` 库。
|
||||
- - **选题生成依赖于 AI 模型严格输出有效的 JSON 格式**。如果 AI 输出格式错误，选题解析会失败。
|
||||
- - **内容生成依赖于 AI 在选题 JSON 中提供的 `style` 和 `target_audience` 文件名与 `prompts_dir` 下 `Style/` 和 `Demand/` 目录中的实际文件名（含.txt）完全一致**。请检查这些目录和文件名。
|
||||
- - **图片目录结构和命名**需严格符合预期，以便程序能找到对应景点的图片。
|
||||
- - AI生成内容的质量很大程度上取决于**提示词的设计**和**输入资源信息的质量**。
|
||||
- - 仔细检查 API Key、URL 和文件路径配置。
|
||||
- - 如果遇到问题，检查程序输出的日志信息和错误提示。
|
||||
|
||||
|
||||
## API 集成 / 流式输出使用 (Streaming Usage)
|
||||
|
||||
`AI_Agent` 类提供了 `work_stream` 方法，用于获取 AI 生成内容的流式输出。该方法返回一个 Python 生成器 (generator)，你可以迭代它来逐块获取 AI 生成的文本。
|
||||
|
||||
**同时处理流式块并获取完整结果：**
|
||||
|
||||
如果你既需要实时处理（或传输）每个文本块，又想在流结束后得到完整的拼接结果，可以在迭代生成器的同时进行拼接。
|
||||
|
||||
**用法示例：**
|
||||
|
||||
```python
|
||||
import os
|
||||
import sys
|
||||
import json
|
||||
|
||||
# 假设已正确设置 Python Path
|
||||
from core.ai_agent import AI_Agent
|
||||
|
||||
# 1. 加载配置 (与 main.py 类似)
|
||||
config_path = "poster_gen_config.json"
|
||||
config = {}
|
||||
try:
|
||||
with open(config_path, 'r', encoding='utf-8') as f:
|
||||
config = json.load(f)
|
||||
except Exception as e:
|
||||
print(f"Error loading config: {e}")
|
||||
sys.exit(1)
|
||||
|
||||
# 2. 初始化 AI Agent (读取超时/重试/流式块超时配置)
|
||||
ai_agent = None
|
||||
try:
|
||||
request_timeout = config.get("request_timeout", 30)
|
||||
max_retries = config.get("max_retries", 3)
|
||||
stream_chunk_timeout = config.get("stream_chunk_timeout", 60) # 新增：读取流式块超时
|
||||
|
||||
ai_agent = AI_Agent(
|
||||
config["api_url"],
|
||||
config["model"],
|
||||
config["api_key"],
|
||||
timeout=request_timeout,
|
||||
max_retries=max_retries,
|
||||
stream_chunk_timeout=stream_chunk_timeout # 新增：传递流式块超时
|
||||
)
|
||||
|
||||
# 3. 定义提示词和参数
|
||||
system_prompt = "You are a travel writer."
|
||||
user_prompt = "Describe the Great Wall of China in about 50 words."
|
||||
temperature = config.get("content_temperature", 0.7)
|
||||
top_p = config.get("content_top_p", 0.9)
|
||||
presence_penalty = config.get("content_presence_penalty", 1.0)
|
||||
file_folder = None # 可选的参考文件目录
|
||||
|
||||
# 4. 调用 work_stream 获取生成器
|
||||
stream_generator = ai_agent.work_stream(
|
||||
system_prompt,
|
||||
user_prompt,
|
||||
file_folder,
|
||||
temperature,
|
||||
top_p,
|
||||
presence_penalty
|
||||
)
|
||||
|
||||
# 5. 迭代生成器，处理块并拼接完整结果
|
||||
print("Streaming response:")
|
||||
full_response = "" # 初始化空字符串用于拼接
|
||||
for chunk in stream_generator:
|
||||
# 处理实时块，例如打印或发送给客户端
|
||||
print(chunk, end="", flush=True)
|
||||
# 拼接完整结果
|
||||
full_response += chunk
|
||||
|
||||
print("\\n--- Stream finished ---")
|
||||
|
||||
# 6. 使用拼接好的完整结果
|
||||
print("\\n--- Reconstructed Full Response ---")
|
||||
print(full_response)
|
||||
# 你可以在这里对 full_response 进行进一步处理
|
||||
|
||||
except Exception as e:
|
||||
print(f"An error occurred: {e}")
|
||||
finally:
|
||||
if ai_agent:
|
||||
ai_agent.close()
|
||||
```bash
|
||||
# 复制示例配置（选择一个或从基础开始）
|
||||
cp configs/basic_config.json poster_gen_config.json
|
||||
|
||||
# 编辑配置文件
|
||||
vim poster_gen_config.json
|
||||
# 必须修改：api_url, api_key, image_base_dir
|
||||
```
|
||||
|
||||
这个模式允许你灵活地利用流式输出，同时在需要时也能访问到最终的完整文本。参考 `examples/test_stream.py` 获取可运行的示例（该示例也包含了拼接逻辑，只是默认注释了最后的打印）。
|
||||
### 3. 运行系统
|
||||
|
||||
**注意：** 如果你只需要最终的完整结果而不需要流式处理，可以直接调用 `ai_agent.work(...)` 方法，它会内部处理好拼接并直接返回结果字符串。
|
||||
```bash
|
||||
# 完整流程（从选题到海报生成）
|
||||
python main.py
|
||||
|
||||
### Refactoring Complete: Decoupling Generation and Output Handling
|
||||
# 或分阶段执行 (使用默认配置)
|
||||
python examples/run_step1_topics.py
|
||||
# 记下输出的Run ID
|
||||
python examples/run_step2_content_posters.py YOUR_RUN_ID
|
||||
|
||||
To enhance the flexibility and extensibility of this tool, a refactoring effort has been completed to separate the core content/image generation logic from the output handling (previously, saving results directly to the local filesystem).
|
||||
# 使用特定配置运行
|
||||
# python main.py --config configs/social_media_config.json
|
||||
```
|
||||
|
||||
**Motivation:**
|
||||
### 4. 查看结果
|
||||
|
||||
* **API Integration:** Allow generated results (topics, text content, image URLs/data) to be easily returned via an API endpoint instead of only being saved locally.
|
||||
* **Alternative Storage:** Enable saving results to different backends like databases, cloud storage (e.g., S3, OSS), etc.
|
||||
* **Modularity:** Improve code structure by separating concerns.
|
||||
```bash
|
||||
# 结果保存在配置的output_dir目录下（默认为./result/）
|
||||
ls -la ./result/最新的Run_ID/
|
||||
```
|
||||
|
||||
**Approach Taken:**
|
||||
## 核心组件说明
|
||||
|
||||
1. **Modified Core Functions:** Functions responsible for generating topics, content, and posters (primarily in `utils/tweet_generator.py`, `core/simple_collage.py`, `core/posterGen.py`) have been updated:
|
||||
* Topic generation now returns the generated data (`run_id`, `topics_list`, prompts).
|
||||
* Image generation functions (`simple_collage.process_directory`, `posterGen.create_poster`) now return PIL Image objects instead of saving files.
|
||||
* Content and poster generation workflows accept an `OutputHandler` instance to process results (content JSON, prompts, configurations, image data) immediately after generation.
|
||||
2. **Introduced Output Handlers:** An "Output Handler" pattern has been implemented (`utils/output_handler.py`).
|
||||
* An abstract base class (`OutputHandler`) defines methods for processing different types of results.
|
||||
* A concrete implementation (`FileSystemOutputHandler`) replicates the original behavior of saving all results to the `./result/{run_id}/...` directory structure.
|
||||
3. **Updated Main Workflow:** The main script (`main.py`) now:
|
||||
* Instantiates a specific `OutputHandler` (currently `FileSystemOutputHandler`).
|
||||
* Calls the generation functions, passing the `OutputHandler` where needed.
|
||||
* Uses the `OutputHandler` to process data returned by the topic generation step.
|
||||
4. **Reduced Config Dependency:** Core logic functions (`PromptManager`, `generate_content_for_topic`, `generate_posters_for_topic`, etc.) now receive necessary configuration values as specific parameters rather than relying on the entire `config` dictionary, making them more independent and testable.
|
||||
项目采用模块化设计，主要包含以下组件：
|
||||
|
||||
**Future Possibilities:**
|
||||
- **主流程协调器** (`main.py`): 负责加载配置并协调执行整个生成流程
|
||||
- **AI交互模块** (`core/ai_agent.py`): 封装与大语言模型的通信
|
||||
- **选题生成器** (`utils/tweet_generator.py`): 生成旅游选题
|
||||
- **内容生成器** (`core/contentGen.py`): 处理内容创作
|
||||
- **海报制作器** (`core/posterGen.py`): 合成文字和图片，生成最终海报
|
||||
|
||||
This refactoring makes it straightforward to add new output handlers in the future, such as:
|
||||
## 资源准备指南
|
||||
|
||||
* `ApiOutputHandler`: Formats results for API responses.
|
||||
* `DatabaseOutputHandler`: Stores results in a database.
|
||||
* `CloudStorageOutputHandler`: Uploads results (especially images) to cloud storage and potentially stores metadata elsewhere.
|
||||
### 1. 景点信息文件
|
||||
|
||||
### 配置文件说明 (Configuration)
|
||||
在 `resource/Object/` 目录创建景点信息文件，示例格式：
|
||||
|
||||
主配置文件为 `poster_gen_config.json` (可以复制 `example_config.json` 并修改)。主要包含以下部分：
|
||||
```
|
||||
景点名称：泰宁古城
|
||||
位置：福建省三明市泰宁县
|
||||
简介：泰宁古城始建于宋代...
|
||||
特色：古城墙、古街巷...
|
||||
历史：泰宁古城有着悠久的历史...
|
||||
适合游客：喜欢历史文化的游客、摄影爱好者
|
||||
建议游览时间：2-3小时
|
||||
最佳季节：春季和秋季
|
||||
```
|
||||
|
||||
#### 1. 基本配置 (Basic)
|
||||
> **提示**：景点信息越详细，生成的内容质量越高
|
||||
|
||||
* `api_url` (必须): 大语言模型 API 地址 (或预设名称如 'vllm', 'ali', 'kimi', 'doubao', 'deepseek')
|
||||
* `api_key` (必须): API 密钥
|
||||
* `model` (必须): 使用的模型名称
|
||||
* `topic_system_prompt` (必须): 选题生成系统提示词文件路径 (应为要求JSON输出的版本)
|
||||
* `topic_user_prompt` (必须): 选题生成基础用户提示词文件路径
|
||||
* `content_system_prompt` (必须): 内容生成系统提示词文件路径
|
||||
* `resource_dir` (必须): 包含**资源文件信息**的列表。列表中的每个元素是一个字典，包含：
|
||||
* `type`: 资源类型，目前支持 `"Object"` (景点/对象信息), `"Description"` (对应的描述文件), `"Product"` (关联产品信息)。
|
||||
* `file_path`: 一个包含该类型所有资源文件**完整路径**的列表。
|
||||
* `prompts_dir` (必须): 存放 Demand/Style/Refer 等提示词片段的目录路径
|
||||
* `output_dir` (必须): 输出结果保存目录路径
|
||||
* `image_base_dir` (必须): **图片资源根目录绝对路径或相对路径** (用于查找源图片)
|
||||
* `poster_assets_base_dir` (必须): **海报素材根目录绝对路径或相对路径** (用于查找字体、边框、贴纸、文本背景等)
|
||||
* `num` (必须): （选题阶段）生成选题数量
|
||||
* `variants` (必须): （内容生成阶段）每个选题生成的变体数量
|
||||
### 2. 图片资源结构
|
||||
|
||||
#### 2. 可选配置 (Optional)
|
||||
图片资源应按以下结构组织（可通过配置自定义目录名）：
|
||||
|
||||
* `date` (可选, 默认空): 日期标记（用于选题生成提示词）
|
||||
* `topic_temperature` (可选, 默认 0.2): 选题生成 API 温度参数
|
||||
* `topic_top_p` (可选, 默认 0.5): 选题生成 API top-p 参数
|
||||
* `topic_presence_penalty` (可选, 默认 1.5): 选题生成 API presence penalty 参数
|
||||
* `content_temperature` (可选, 默认 0.3): 内容生成 API 温度参数
|
||||
* `content_top_p` (可选, 默认 0.4): 内容生成 API top-p 参数
|
||||
* `content_presence_penalty` (可选, 默认 1.5): 内容生成 API presence penalty 参数
|
||||
* `request_timeout` (可选, 默认 30): 单个 HTTP 请求的超时时间（秒）。
|
||||
* `max_retries` (可选, 默认 3): API 请求失败时的最大重试次数。
|
||||
* `stream_chunk_timeout` (可选, 默认 60): 处理流式响应时，允许的两个数据块之间的最大等待时间（秒），用于防止流长时间挂起。
|
||||
* `camera_image_subdir` (可选, 默认 "相机"): 存放原始照片的子目录名（相对于 `image_base_dir`）
|
||||
* `modify_image_subdir` (可选, 默认 "modify"): 存放处理后/用于拼贴的图片的子目录名（相对于 `image_base_dir`）
|
||||
* `output_collage_subdir` (可选, 默认 "collage_img"): 在每个变体输出目录中存放拼贴图的子目录名
|
||||
|
||||
#### 3. 选题与内容生成参数 (Topic & Content Generation)
|
||||
|
||||
* `topic_temperature` (可选, 默认 0.2): 选题生成 API 温度参数
|
||||
* `topic_top_p` (可选, 默认 0.5): 选题生成 API top-p 参数
|
||||
* `topic_presence_penalty` (可选, 默认 1.5): 选题生成 API presence penalty 参数
|
||||
* `content_temperature` (可选, 默认 0.3): 内容生成 API 温度参数
|
||||
* `content_top_p` (可选, 默认 0.4): 内容生成 API top-p 参数
|
||||
* `content_presence_penalty` (可选, 默认 1.5): 内容生成 API presence penalty 参数
|
||||
|
||||
#### 4. 图片处理参数 (Image Processing)
|
||||
|
||||
* `camera_image_subdir` (可选, 默认 "相机"): 存放原始照片的子目录名（相对于 `image_base_dir`）
|
||||
* `modify_image_subdir` (可选, 默认 "modify"): 存放处理后/用于拼贴的图片的子目录名（相对于 `image_base_dir`）
|
||||
* `output_collage_subdir` (可选, 默认 "collage_img"): 在每个变体输出目录中存放拼贴图的子目录名
|
||||
|
||||
#### 5. 海报生成参数 (Poster Generation)
|
||||
|
||||
* `output_poster_subdir` (可选, 默认 "poster"): 在每个变体输出目录中存放最终海报的子目录名
|
||||
* `output_poster_filename` (可选, 默认 "poster.jpg"): 输出的最终海报文件名
|
||||
* `poster_target_size` (可选, 默认 [900, 1200]): 海报目标尺寸 `[宽, 高]`
|
||||
* `text_possibility` (可选, 默认 0.3): 海报中第二段附加文字出现的概率
|
||||
|
||||
#### 6. 其他参数 (Miscellaneous)
|
||||
|
||||
* `request_timeout` (可选, 默认 30): 单个 HTTP 请求的超时时间（秒）。
|
||||
* `max_retries` (可选, 默认 3): API 请求失败时的最大重试次数。
|
||||
* `stream_chunk_timeout` (可选, 默认 60): 处理流式响应时，允许的两个数据块之间的最大等待时间（秒），用于防止流长时间挂起。
|
||||
|
||||
项目提供了一个示例配置文件 `example_config.json`，请务必复制并修改：
|
||||
|
||||
## 图片目录要求
|
||||
|
||||
为确保海报生成功能正常工作，请按照以下结构组织图片目录：
|
||||
|
||||
1. **基础图片目录**：在 `poster_gen_config.json` 中设置 `image_base_dir` 参数指向基础图片目录。
|
||||
2. **原始照片目录**：在基础目录下创建 `相机` 子目录（或通过 `camera_image_subdir` 配置），包含原始照片。
|
||||
3. **修改图片目录**：在基础目录下创建 `modify` 子目录（或通过 `modify_image_subdir` 配置），并其中为每个景点创建子目录：
|
||||
```
|
||||
image_base_dir/
|
||||
├── 相机/
|
||||
│ ├── 景点1/
|
||||
│ │ ├── 照片1.jpg
|
||||
│ │ ├── 照片2.jpg
|
||||
│ │ └── ...
|
||||
│ └── 景点2/
|
||||
│ └── ...
|
||||
└── modify/
|
||||
├── 景点1/
|
||||
```
|
||||
<image_base_dir>/ # 配置中的图片根目录
|
||||
├── 相机/ # 存放原始照片 (camera_image_subdir)
|
||||
│ ├── 泰宁古城/
|
||||
│ │ ├── 图片1.jpg
|
||||
│ │ ├── 图片2.jpg
|
||||
│ │ └── description.txt (可选的图片描述)
|
||||
│ └── 其他景点/
|
||||
└── modify/ # 存放处理后的图片 (modify_image_subdir)
|
||||
├── 泰宁古城/
|
||||
│ ├── 图片1.jpg
|
||||
│ ├── 图片2.jpg
|
||||
│ └── ... (至少4-9张图片，建议多于9张)
|
||||
└── 景点2/
|
||||
└── ...
|
||||
```
|
||||
|
||||
**注意事项**：
|
||||
- 每个景点的 `modify` 子目录中至少需要 4 张图片，建议包含 9 张或更多图片以保证拼贴效果多样性。
|
||||
- 图片应当质量良好，清晰、色彩丰富，尺寸适中（过大或过小的图片都可能导致处理问题）。
|
||||
- 支持的图片格式为 JPG (.jpg, .jpeg)、PNG (.png) 和 BMP (.bmp)。
|
||||
- 确保图片文件没有损坏且可以被 PIL 库正常打开。
|
||||
|
||||
## 模块功能划分
|
||||
|
||||
本项目采用模块化设计，各个功能组件清晰分离，便于维护和扩展。主要模块及其功能如下：
|
||||
|
||||
### 核心功能模块 (`core/`)
|
||||
|
||||
| 模块名称 | 文件路径 | 主要功能 | 测试脚本 |
|
||||
|---------|---------|---------|---------|
|
||||
| **AI代理** | `core/ai_agent.py` | 封装与大语言模型API的交互，支持标准请求和流式响应，提供错误重试和超时控制 | `examples/test_stream.py` |
|
||||
| **选题解析器** | `core/topic_parser.py` | 解析AI返回的JSON格式选题数据，提取结构化信息 | 集成于工作流测试 |
|
||||
| **内容处理器** | `core/contentGen.py` | 生成海报文本配置，处理景点描述和文章内容，转换为适合海报展示的文本结构 | `examples/test_content_generator.py` |
|
||||
| **海报生成器** | `core/posterGen.py` | 结合图片和文字创建最终海报，处理字体、布局、装饰贴纸等 | `examples/test_poster_generator.py` |
|
||||
| **图片拼贴工具** | `core/simple_collage.py` | 提供多样化的图片拼贴功能，支持不同布局风格和图像增强 | `examples/test_simple_collage.py` |
|
||||
|
||||
### 工具与辅助模块 (`utils/`)
|
||||
|
||||
| 模块名称 | 文件路径 | 主要功能 | 测试脚本 |
|
||||
|---------|---------|---------|---------|
|
||||
| **资源加载器** | `utils/resource_loader.py` | 加载景点信息、描述文件等资源 | 集成于工作流测试 |
|
||||
| **提示词管理器** | `utils/prompt_manager.py` | 集中管理和构建不同阶段的AI提示词 | 集成于工作流测试 |
|
||||
| **主流程执行** | `utils/tweet_generator.py` | 实现选题生成、内容生成、海报生成的主要工作流 | 集成于`examples/test_workflow.py` |
|
||||
| **输出处理器** | `utils/output_handler.py` | 处理和保存生成的内容、图片和配置 | 集成于工作流测试 |
|
||||
|
||||
### 集成测试与示例 (`examples/`)
|
||||
|
||||
| 测试脚本 | 文件路径 | 测试内容 |
|
||||
|---------|---------|---------|
|
||||
| **工作流测试** | `examples/test_workflow.py` | 测试完整流程和分步流程 |
|
||||
| **流式输出测试** | `examples/test_stream.py` | 测试AI_Agent的流式输出功能 |
|
||||
| **内容生成测试** | `examples/test_content_generator.py` | 测试ContentGenerator组件 |
|
||||
| **图片拼贴测试** | `examples/test_simple_collage.py` | 测试图片拼贴功能和不同风格 |
|
||||
| **海报生成测试** | `examples/test_poster_generator.py` | 测试海报生成功能 |
|
||||
| **阶段1测试** | `examples/run_step1_topics.py` | 测试选题生成阶段 |
|
||||
| **阶段2测试** | `examples/run_step2_content_posters.py` | 测试内容和海报生成阶段 |
|
||||
| **海报示例** | `examples/generate_poster.py` | 简化的海报生成示例 |
|
||||
|
||||
## 测试与验证
|
||||
|
||||
项目提供了多种测试脚本，便于开发者验证各个组件的功能。这些测试脚本位于 `examples/` 目录下：
|
||||
|
||||
### 单组件测试
|
||||
|
||||
1. **AI代理流式输出测试** (`test_stream.py`):
|
||||
- 测试AI_Agent的流式响应功能
|
||||
- 演示如何接收和处理逐块返回的文本内容
|
||||
|
||||
2. **内容生成测试** (`test_content_generator.py`):
|
||||
- 测试ContentGenerator组件
|
||||
- 验证从描述文件和文章内容生成海报文本配置的功能
|
||||
|
||||
3. **图片拼贴测试** (`test_simple_collage.py`):
|
||||
- 测试多种拼贴风格和布局
|
||||
- 自动创建测试图片或使用指定目录中的图片
|
||||
|
||||
4. **海报生成测试** (`test_poster_generator.py`):
|
||||
- 测试将图片和文本组合为海报的功能
|
||||
- 支持使用现有配置文件或随机生成文本数据
|
||||
|
||||
5. **资源加载器测试** (`test_resource_loader.py`):
|
||||
- 测试ResourceLoader组件加载字体、贴纸和背景资源的功能
|
||||
- 创建临时测试目录结构和资源文件，验证加载逻辑
|
||||
- 测试异常处理和资源验证功能
|
||||
|
||||
6. **流程步骤测试** (`test_pipeline_steps.py`):
|
||||
- 顺序测试整个流程的各个步骤：选题生成、内容生成和海报生成
|
||||
- 允许单独测试每个步骤，便于调试和验证各环节
|
||||
- 使用配置文件中的资源目录和参数设置
|
||||
|
||||
### 集成测试
|
||||
|
||||
1. **完整工作流测试** (`test_workflow.py`):
|
||||
- 测试从选题生成到海报制作的完整流程
|
||||
- 支持一次性执行或分步执行
|
||||
|
||||
2. **分阶段测试**:
|
||||
- 阶段1 (`run_step1_topics.py`): 仅执行选题生成
|
||||
- 阶段2 (`run_step2_content_posters.py`): 根据已生成选题执行内容和海报生成
|
||||
|
||||
### 使用测试脚本
|
||||
|
||||
```bash
|
||||
# 测试AI流式输出
|
||||
python examples/test_stream.py
|
||||
|
||||
# 测试内容生成器
|
||||
python examples/test_content_generator.py
|
||||
|
||||
# 测试图片拼贴功能
|
||||
python examples/test_simple_collage.py
|
||||
|
||||
# 测试海报生成功能
|
||||
python examples/test_poster_generator.py
|
||||
|
||||
# 测试完整工作流
|
||||
python examples/test_workflow.py --mode full
|
||||
|
||||
# 测试分步工作流
|
||||
python examples/test_workflow.py --mode steps
|
||||
│ └── ...
|
||||
└── 其他景点/
|
||||
```
|
||||
|
||||
详细参数和用法请参考 `examples/README.md` 文件。
|
||||
> **重要**：确保每个景点的图片目录名与景点信息文件中的名称匹配。海报生成默认从 `modify/` 目录选取图片。
|
||||
|
||||
## 配置文件详解
|
||||
|
||||
`poster_gen_config.json` 是系统的核心配置文件，包含以下主要配置项：
|
||||
|
||||
### 基础配置
|
||||
|
||||
```json
|
||||
{
|
||||
"date": "5月15日", // 日期标记，用于提示词
|
||||
"num": 5, // 生成选题数量
|
||||
"variants": 3 // 每个选题生成的变体数量
|
||||
}
|
||||
```
|
||||
|
||||
### AI模型配置
|
||||
|
||||
```json
|
||||
{
|
||||
"model": "qwen", // 使用的模型名称
|
||||
"api_url": "http://localhost:8000/v1/", // API端点
|
||||
"api_key": "YOUR_API_KEY", // API密钥
|
||||
"topic_temperature": 0.2, // 选题生成的随机性
|
||||
"content_temperature": 0.3 // 内容生成的随机性
|
||||
}
|
||||
```
|
||||
|
||||
### 资源路径配置
|
||||
|
||||
```json
|
||||
{
|
||||
"resource_dir": [ // 景点信息资源
|
||||
{
|
||||
"type": "Object",
|
||||
"num": 3,
|
||||
"file_path": [
|
||||
"./resource/Object/景点信息-泰宁古城.txt",
|
||||
"./resource/Object/景点信息-尚书第.txt"
|
||||
]
|
||||
}
|
||||
],
|
||||
"image_base_dir": "/path/to/your/image/directory", // 图片根目录
|
||||
"camera_image_subdir": "相机", // 原始照片子目录
|
||||
"modify_image_subdir": "modify" // 处理后图片子目录
|
||||
}
|
||||
```
|
||||
|
||||
### 提示词配置
|
||||
|
||||
```json
|
||||
{
|
||||
"topic_system_prompt": "./SelectPrompt/systemPrompt.txt",
|
||||
"topic_user_prompt": "./SelectPrompt/userPrompt.txt",
|
||||
"content_system_prompt": "./genPrompts/systemPrompt.txt",
|
||||
"prompts_dir": "./genPrompts"
|
||||
}
|
||||
```
|
||||
|
||||
### 输出配置
|
||||
|
||||
```json
|
||||
{
|
||||
"output_dir": "./result", // 输出目录
|
||||
"poster_target_size": [900, 1200], // 海报尺寸
|
||||
"text_possibility": 0.3 // 文字元素出现概率
|
||||
}
|
||||
```
|
||||
|
||||
## 配置示例
|
||||
|
||||
本项目提供了多种预设配置文件，适用于不同场景。这些配置文件位于 `configs/` 目录下：
|
||||
|
||||
- **基础配置** (`configs/basic_config.json`): 适合初次使用和测试
|
||||
- **OpenAI配置** (`configs/openai_config.json`): 使用OpenAI API的配置
|
||||
- **高质量配置** (`configs/high_quality_config.json`): 更高质量的生成设置
|
||||
- **批量处理配置** (`configs/batch_processing_config.json`): 处理大量景点信息
|
||||
- **社交媒体配置** (`configs/social_media_config.json`): 针对多个社交平台优化
|
||||
- **本地LLM配置** (`configs/local_llm_config.json`): 使用本地部署的LLM模型
|
||||
|
||||
使用示例配置：
|
||||
|
||||
```bash
|
||||
# 复制适合您场景的配置
|
||||
cp configs/social_media_config.json poster_gen_config.json
|
||||
|
||||
# 按需修改配置
|
||||
vim poster_gen_config.json
|
||||
```
|
||||
|
||||
详细说明请参阅 `configs/README.md` 文件。
|
||||
|
||||
## 高级使用指南
|
||||
|
||||
### 自定义提示词
|
||||
|
||||
编辑 `SelectPrompt/` 和 `genPrompts/` 目录下的提示词文件，可自定义生成内容的风格和侧重点。
|
||||
|
||||
### 调整生成参数
|
||||
|
||||
- 增加 `variants` 值可获得更多内容变体
|
||||
- 调整 `temperature` 参数可以改变生成内容的创造性
|
||||
- 修改 `poster_target_size` 可以设置不同的海报尺寸
|
||||
|
||||
### 分布式执行
|
||||
|
||||
利用分阶段执行功能，可在不同机器上完成选题生成和内容生成：
|
||||
|
||||
1. 机器A执行选题生成 (`run_step1_topics.py`)，将结果保存到共享存储
|
||||
2. 机器B从共享存储读取选题 (`run_step2_content_posters.py <run_id>`)，执行计算密集的内容和海报生成
|
||||
|
||||
## 常见问题
|
||||
|
||||
1. **生成内容质量不高？**
|
||||
- 尝试提供更详细的景点信息
|
||||
- 调整提示词模板
|
||||
- 降低 `temperature` 参数以减少随机性
|
||||
|
||||
2. **找不到景点图片？**
|
||||
- 确保图片目录名与景点信息匹配
|
||||
- 检查配置文件中的 `image_base_dir` 路径是否正确
|
||||
|
||||
3. **API调用失败？**
|
||||
- 验证 API Key 和 URL 是否正确
|
||||
- 检查网络连接和防火墙设置
|
||||
|
||||
## 示例
|
||||
|
||||
查看 `examples/` 目录中的示例脚本及其 `README.md` 文件，了解更多使用方法。
|
||||
|
||||
## 贡献指南
|
||||
|
||||
欢迎提交 Pull Request 或 Issue 来帮助改进本项目。
|
||||
|
||||
## 许可证
|
||||
|
||||
本项目采用 MIT 许可证。
|
||||
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
@ -193,9 +193,12 @@ class AI_Agent():
|
||||
logging.warning(f"Folder {file_folder} provided but no content read.")
|
||||
|
||||
time_start = time.time()
|
||||
result, tokens = self.generate_text(system_prompt, user_prompt, temperature, top_p, presence_penalty)
|
||||
result = self.generate_text_stream(system_prompt, user_prompt, temperature, top_p, presence_penalty)
|
||||
# result, tokens = self.generate_text(system_prompt, user_prompt, temperature, top_p, presence_penalty)
|
||||
|
||||
time_end = time.time()
|
||||
time_cost = time_end - time_start
|
||||
tokens = None
|
||||
logging.info(f"'work' completed in {time_cost:.2f}s. Estimated tokens: {tokens}")
|
||||
|
||||
return result, tokens, time_cost
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
{
|
||||
"date": "5月15日",
|
||||
"num": 2,
|
||||
"date": "5月15日, 5月16日, 5月17日, 6月1日",
|
||||
"num": 30,
|
||||
"model": "qwenQWQ",
|
||||
"api_url": "http://localhost:8000/v1/",
|
||||
"api_key": "EMPTY",
|
||||
@ -46,7 +46,7 @@
|
||||
"content_temperature": 0.3,
|
||||
"content_top_p": 0.4,
|
||||
"content_presence_penalty": 1.5,
|
||||
"request_timeout": 120,
|
||||
"request_timeout": 210,
|
||||
"max_retries": 3,
|
||||
"description_filename": "description.txt",
|
||||
"output_collage_subdir": "collage_img",
|
||||
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading…
x
Reference in New Issue
Block a user