Story-Adapter 项目使用教程

Story-Adapter 项目使用教程

story-adapter A Training-free Iterative Framework for Long Story Visualization 项目地址: https://gitcode.com/gh_mirrors/st/story-adapter

1. 项目目录结构及介绍

Story-Adapter 项目是一个用于长故事可视化的开源项目，其目录结构如下：

story-adapter/
├── docs/                   # 项目文档
├── ip_adapter/             # IP-Adapter 相关文件
│   ├── sdxl_models/        # 模型文件存放目录
│   └── ...                 # 其他相关文件
├── LICENSE                 # 项目许可证文件
├── README.md               # 项目说明文件
├── requirements.txt        # 项目依赖文件
├── run.py                  # 项目启动文件
└── ...                     # 其他项目文件

主要目录和文件说明：

• docs/: 存放项目文档的目录。
• ip_adapter/: 包含与 IP-Adapter 相关的文件和模型。
• LICENSE: 项目使用的许可证文件，本项目采用 MIT 许可。
• README.md: 项目说明文件，介绍了项目的详细信息。
• requirements.txt: 项目依赖文件，列出了运行项目所需的所有 Python 包。
• run.py: 项目的启动文件，用于执行项目的主要功能。

2. 项目的启动文件介绍

项目的启动文件是 run.py，它负责初始化和运行整个故事可视化流程。以下是 run.py 的基本使用方法：

python run.py --base_model_path <模型路径> --image_encoder_path <图像编码器路径> --ip_ckpt <IP-Adapter 模型文件路径>

启动时，需要提供以下参数：

• --base_model_path: 指定基础模型文件的路径。
• --image_encoder_path: 指定图像编码器模型的路径。
• --ip_ckpt: 指定 IP-Adapter 模型文件的路径。

此外，还可以根据需要添加自定义故事提示：

python run.py --base_model_path <模型路径> --image_encoder_path <图像编码器路径> --ip_ckpt <IP-Adapter 模型文件路径> --story "自定义故事提示"

自定义故事提示应遵循模板：[角色定义 + 交互定义 + 场景定义]。

3. 项目的配置文件介绍

在 Story-Adapter 项目中，主要的配置是通过命令行参数来完成的，并没有一个单独的配置文件。所有的运行参数都在 run.py 中通过 argparse 库进行解析。

如果需要修改项目的默认行为或设置，可以直接修改 run.py 文件中对应的参数解析部分，或者创建一个新的脚本文件来包装 run.py，并在其中设置默认参数值。

例如，可以在一个新的 Python 脚本中添加以下内容来设置默认参数：

import subprocess

# 设置默认参数
default_args = [
    'run.py',
    '--base_model_path', '/path/to/base/model',
    '--image_encoder_path', '/path/to/image/encoder',
    '--ip_ckpt', '/path/to/ip-adapter/ckpt',
    # 添加其他需要的参数
]

# 执行 run.py 脚本
subprocess.run(default_args)

通过上述方式，用户可以根据自己的需求调整项目配置，实现个性化的项目运行。

story-adapter A Training-free Iterative Framework for Long Story Visualization 项目地址: https://gitcode.com/gh_mirrors/st/story-adapter