exBERT 项目安装与使用教程

1. 项目目录结构及介绍

exbert/
├── client/
│   ├── src/
│   │   └── ... (前端源代码)
│   └── dist/ (前端静态文件)
├── server/
│   ├── scripts/ (服务器脚本)
│   ├── main.py (服务器启动文件)
│   └── ... (其他服务器相关文件)
├── dvc/ (数据版本控制相关文件)
├── .dvcignore
├── .gitignore
├── LICENSE
├── Makefile
├── README.md
├── environment-dev.yml (开发环境配置)
├── environment.yml (生产环境配置)
└── ... (其他项目文件)

目录结构说明

• client/: 前端代码目录，包含源代码和编译后的静态文件。
  • src/: 前端源代码。
  • dist/: 前端编译后的静态文件。
• server/: 服务器端代码目录，包含启动文件和相关脚本。
  • scripts/: 服务器端脚本。
  • main.py: 服务器启动文件。
• dvc/: 数据版本控制相关文件。
• .dvcignore: 数据版本控制忽略文件。
• .gitignore: Git 忽略文件。
• LICENSE: 项目许可证。
• Makefile: 项目构建文件。
• README.md: 项目说明文档。
• environment-dev.yml: 开发环境配置文件。
• environment.yml: 生产环境配置文件。

2. 项目启动文件介绍

server/main.py

main.py 是 exBERT 项目的服务器启动文件。它负责加载模型、处理请求并返回结果。启动服务器时，可以通过命令行参数指定模型路径和数据集路径。

启动命令示例

conda activate exbert
python server/main.py --model PATH_TO_MODEL --kind [bidirectional | autoregressive] --corpus PATH_TO_CORPUS

• --model: 指定预训练模型的路径。
• --kind: 指定模型的类型，可选值为 bidirectional（双向模型，如 BERT）或 autoregressive（自回归模型，如 GPT-2）。
• --corpus: 指定数据集的路径。

3. 项目配置文件介绍

environment.yml

environment.yml 是用于创建项目运行环境的配置文件。它定义了项目所需的 Python 包和版本。

创建环境命令

conda env create -f environment.yml

environment-dev.yml

environment-dev.yml 是用于开发环境的配置文件。它包含了开发过程中所需的额外依赖。

更新开发环境命令

conda env update -f environment-dev.yml

Makefile

Makefile 是项目的构建文件，包含了常用的构建命令。

常用命令

• make env: 创建项目运行环境。
• make run: 启动服务器。

通过以上配置文件和启动文件，您可以顺利地安装和运行 exBERT 项目。