DiTCtrl 项目使用教程

1. 项目目录结构及介绍

DiTCtrl 项目是一个开源项目，其目录结构如下：

DiTCtrl/
├── .github/               # GitHub 相关配置文件
├── assets/                # 资源文件目录
├── metrics/               # 性能指标相关文件
├── prompts_gen_instruction/ # 提示生成指令文件
├── sat/                    # 主程序目录
├── .gitignore              # Git 忽略文件列表
├── LICENSE                # 项目许可证文件
├── README.md              # 项目说明文件
├── pyproject.toml         # Python 项目配置文件
├── requirements.txt       # 项目依赖文件

• .github/：包含GitHub的配置文件，例如issue模板等。
• assets/：存放项目所需的资源文件。
• metrics/：包含项目性能评估的指标和工具。
• prompts_gen_instruction/：存放生成提示指令的文件。
• sat/：项目的主要目录，包含了运行项目所需的脚本和配置文件。
• .gitignore：定义了Git应该忽略的文件和目录。
• LICENSE：项目的开源许可证。
• README.md：项目的介绍和说明。
• pyproject.toml：Python项目配置文件，定义了项目信息和依赖。
• requirements.txt：项目依赖列表，指定了项目运行所需的Python包。

2. 项目的启动文件介绍

项目的启动文件位于sat/目录下，主要包含以下脚本：

• run_multi_prompt.sh：用于运行多提示文本到视频生成。
• run_single_prompt.sh：用于运行单提示文本到视频生成。
• run_edit_video.sh：用于运行视频编辑功能。

这些脚本是为了简化命令行操作而提供的，它们调用了Python脚本并传递了相应的参数。

3. 项目的配置文件介绍

项目的配置文件主要用于设定运行参数和项目依赖，以下是主要的配置文件：

• configs/cogvideox_2b.yaml：CogVideoX-2B模型的配置文件，包含了模型的参数设置。
• configs/inference.yaml：推理阶段的配置文件，用于设置生成视频的参数。
• inference_case_configs/：包含不同用例的配置文件，例如rose.yaml。

这些配置文件使用YAML格式，可以在项目运行时通过参数传入，以便于调整不同的运行选项和模型参数。