Chinese-Poetry-Generation 项目使用文档

1. 项目目录结构及介绍

Chinese-Poetry-Generation/
├── .gitignore
├── LICENSE
├── README.md
├── char2vec.py
├── char_dict.py
├── data_utils.py
├── generate.py
├── main.py
├── paths.py
├── plan.py
├── poems.py
├── pron_dict.py
├── rank_words.py
├── segment.py
├── singleton.py
├── train.py
└── utils.py

目录结构介绍

• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件，采用 MIT 许可证。
• README.md: 项目介绍和使用说明。
• char2vec.py: 字符向量化处理模块。
• char_dict.py: 字符字典处理模块。
• data_utils.py: 数据处理工具模块。
• generate.py: 诗歌生成模块。
• main.py: 项目主入口文件。
• paths.py: 路径配置模块。
• plan.py: 诗歌规划模块。
• poems.py: 诗歌数据处理模块。
• pron_dict.py: 发音字典处理模块。
• rank_words.py: 词语排序模块。
• segment.py: 分词处理模块。
• singleton.py: 单例模式实现模块。
• train.py: 模型训练模块。
• utils.py: 通用工具模块。

2. 项目的启动文件介绍

main.py

main.py 是项目的启动文件，负责初始化项目并启动诗歌生成过程。用户可以通过运行此文件来生成诗歌。

python main.py

功能介绍

• 初始化: 加载必要的配置和模型。
• 诗歌生成: 根据用户输入的提示生成诗歌。

3. 项目的配置文件介绍

paths.py

paths.py 文件包含了项目中各个模块的路径配置，确保数据和模型的正确加载和保存。

主要配置项

• 数据路径: 配置训练数据和生成数据的路径。
• 模型路径: 配置训练好的模型路径。
• 日志路径: 配置日志文件的保存路径。

示例代码

# paths.py

# 数据路径
DATA_PATH = "path/to/data"

# 模型路径
MODEL_PATH = "path/to/model"

# 日志路径
LOG_PATH = "path/to/log"

通过配置 paths.py 文件，用户可以自定义数据和模型的存储位置，方便项目的管理和扩展。