添加项目说明文件

This commit is contained in:
2024-05-22 11:04:15 +08:00
parent 21c30df5a1
commit 144e70ee5b
3 changed files with 29 additions and 1 deletions

27
README.md Normal file
View File

@@ -0,0 +1,27 @@
# 福村宝照片审核AI辅助
本项目使用PaddleNLP等技术为照片审核提供初步的信息抽取功能
## 项目启动
1. 安装Python环境可以选择Anaconda安装减少环境冲突
2. Gitea或其他远程仓库克隆项目到本地
3. 安装所需依赖,进入项目根目录执行以下代码
```bash
pip install -r requirement.txt
```
4. 通过main.py启动项目可以在Pycharm启动或进入项目根目录执行以下代码
```bash
python main.py
```
## 开发说明
1. 使用sqlalchemy作为ORM框架需要新增实体类时运行项目根目录下的auto_generator.py
2. 项目运行中奔溃时有发送邮件提醒功能请在config/email.py中的收件人处添加自己的邮箱