Promptify 项目使用教程

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

Promptify 项目的目录结构如下：

Promptify/
├── README.md
├── setup.py
├── promptify/
│   ├── __init__.py
│   ├── main.py
│   ├── config.py
│   ├── utils/
│   │   ├── __init__.py
│   │   ├── helper.py
│   ├── models/
│   │   ├── __init__.py
│   │   ├── model.py
│   ├── tasks/
│   │   ├── __init__.py
│   │   ├── ner.py
│   │   ├── classification.py

目录结构介绍

• README.md: 项目说明文档。
• setup.py: 项目安装脚本。
• promptify/: 项目主目录。
  • __init__.py: 初始化文件。
  • main.py: 项目启动文件。
  • config.py: 项目配置文件。
  • utils/: 工具函数目录。
    • helper.py: 辅助函数文件。
  • models/: 模型相关文件目录。
    • model.py: 模型定义文件。
  • tasks/: 任务相关文件目录。
    • ner.py: 命名实体识别任务文件。
    • classification.py: 分类任务文件。

2. 项目的启动文件介绍

项目的启动文件是 promptify/main.py。该文件包含了项目的主要入口点，负责初始化配置、加载模型和启动任务。

主要功能

• 初始化配置：从 config.py 中读取配置信息。
• 加载模型：根据配置信息加载相应的模型。
• 启动任务：根据用户输入启动相应的任务（如命名实体识别、分类等）。

3. 项目的配置文件介绍

项目的配置文件是 promptify/config.py。该文件包含了项目的各种配置信息，如模型路径、任务类型、超参数等。

主要配置项

• MODEL_PATH: 模型文件路径。
• TASK_TYPE: 任务类型（如 ner 或 classification）。
• HYPER_PARAMETERS: 超参数配置。

通过修改 config.py 文件中的配置项，可以灵活地调整项目的行为和性能。

---

以上是 Promptify 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该项目。