开源项目 Question-Generation 使用文档

开源项目 Question-Generation 使用文档

Question-GenerationGenerating multiple choice questions from text using Machine Learning.项目地址:https://gitcode.com/gh_mirrors/qu/Question-Generation

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

Question-Generation/
├── data/
│   ├── input/
│   └── output/
├── models/
│   ├── __init__.py
│   ├── model.py
│   └── utils.py
├── scripts/
│   ├── generate_questions.py
│   └── train_model.py
├── config/
│   ├── config.json
│   └── logging.conf
├── README.md
├── requirements.txt
└── setup.py

目录结构介绍

• data/: 存放输入数据和生成的问题数据。
  • input/: 存放输入文本文件。
  • output/: 存放生成的问题文件。
• models/: 包含项目的模型代码。
  • init.py: 初始化文件。
  • model.py: 定义模型的主要代码。
  • utils.py: 包含一些辅助函数。
• scripts/: 包含项目的脚本文件。
  • generate_questions.py: 用于生成问题的脚本。
  • train_model.py: 用于训练模型的脚本。
• config/: 包含项目的配置文件。
  • config.json: 项目的配置文件。
  • logging.conf: 日志配置文件。
• README.md: 项目介绍和使用说明。
• requirements.txt: 项目依赖的Python包列表。
• setup.py: 项目的安装脚本。

2. 项目的启动文件介绍

项目的启动文件是 scripts/generate_questions.py。该文件用于从输入文本生成问题。

启动文件介绍

• generate_questions.py: 该脚本读取 data/input/ 目录下的文本文件，使用预训练的模型生成问题，并将生成的结果保存到 data/output/ 目录下。

使用方法

python scripts/generate_questions.py --input_file data/input/example.txt --output_file data/output/generated_questions.txt

3. 项目的配置文件介绍

项目的配置文件位于 config/ 目录下，主要包括 config.json 和 logging.conf。

配置文件介绍

• config.json: 该文件包含项目的配置参数，如模型路径、数据路径等。
• logging.conf: 该文件配置项目的日志记录方式，包括日志级别、输出格式等。

配置文件示例

config.json:

{
  "model_path": "models/pretrained_model.pth",
  "input_dir": "data/input/",
  "output_dir": "data/output/"
}

logging.conf:

[loggers]
keys=root

[handlers]
keys=consoleHandler

[formatters]
keys=simpleFormatter

[logger_root]
level=DEBUG
handlers=consoleHandler

[handler_consoleHandler]
class=StreamHandler
level=DEBUG
formatter=simpleFormatter
args=(sys.stdout,)

[formatter_simpleFormatter]
format=%(asctime)s - %(name)s - %(levelname)s - %(message)s

以上是开源项目 Question-Generation 的使用文档，涵盖了项目的目录结构、启动文件和配置文件的详细介绍。

Question-GenerationGenerating multiple choice questions from text using Machine Learning.项目地址:https://gitcode.com/gh_mirrors/qu/Question-Generation