Skip to content

icalk-nlp/Personalized-EduChat

Repository files navigation

Personalized-EduChat

EduChat

Code License Data License Generic badge Generic badge

公测地址:https://educhat.xiaoi.com/

目录


🖋️ 介绍

Personalized-EduChat是一个针对教育垂直领域的对话大模型项目,由华东师范大学计算机科学与技术学院的EduNLP团队 开发。该项目旨在贯彻“以人为本”的教育理念,通过预训练大模型为基底的教育对话大模型相关技术,融合多样化的教育垂直领域数据,提供个性化、引导式、身心全面发展的教育支持。

已实现功能概览:

教材问答:针对教材内容,提供精准、实用的问答服务。

模拟教学:基于CAMEL的教学场景模拟,构建了一个教师与一个学生的简单教学场景。

短期发展规划:

多智能体个性化教育架构:计划构建一个多Agent系统,以更全面地满足不同学生的个性化需求。

论文翻译功能:旨在提供高质量的学术论文翻译服务,以支持学术交流。

🗒️ 开源清单

模型

注意:使用前按照模型介绍页面中的使用方法部分解密

数据

🤖 本地部署

下载安装

  1. 环境检查
# 使用conda安装环境,确保python版本为3.9以上,并安装PyTorch>=2.0
conda create --name env_name python=3.9  # env_name为创建环境的名称
# 激活环境
conda activate env_name
  1. 安装依赖
# 拉取仓库
git clone https://github.com/icalk-nlp/Personalized-EduChat.git
# 进入目录
cd Personalized-EduChat
# 安装依赖
pip install -r requirements.txt

配置

config/config.yaml 中配置你的EDUCHAT_SECRET_URL

# 该EDUCHAT_SECRET_URL为启动API服务得到的URL,即先运行educhat_api.py以获取URL
EDUCHAT_SECRET_URL: 'YOUR_EDUCHAT_SECRET_URL'

使用示例

教材问答

  1. 启动 API 服务

先下载对应的模型,放置sever目录下,然后启动API服务 模型部署详情可参考Educhat项目

cd server
# 启动 API 服务,这将返回一个url
python educhat_api.py
  1. 进行教材问答
# 回到项目根目录,然后运行document_conversation.py
python document_conversation.py --document_path ./test.pdf
  1. 简单的教学场景模拟(1个API服务易造成角色混乱,建议开启2个API服务)
# 回到项目根目录,然后运行simulation_conversation.py
python simulation_conversation.py

网页demo

cd server
python educhat_gradio.py

📃 开源协议、模型局限、使用限制与免责声明

本项目所含代码采用Apache 2.0 协议,数据采用CC BY-NC 4.0协议。

尽管我们对EduChat进行了优化,但仍存在以下问题,需要进行改进:

  • 当涉及到事实性指令时,可能会产生错误的回答,与实际事实相悖。

  • 模型回复可能存在偏见,有可能生成危险性言论。

  • 在某些场景中,比如推理、代码、多轮对话等方面,模型的能力仍有待提高。

鉴于上述模型的局限性,我们要求开发者仅将我们开源的代码、数据、模型以及由该项目生成的衍生物用于研究目的,禁止用于商业用途,以及其他可能对社会带来危害的用途。

本项目仅供研究目的使用,项目开发者对于使用本项目(包括但不限于数据、模型、代码等)所导致的任何危害或损失不承担责任。详情请参考该免责声明

引用

EduChat: A Large-Scale Language Model-based Chatbot System for Intelligent Education

链接:https://arxiv.org/abs/2308.02773

如果使用本项目的代码、数据或模型,请引用本项目论文:

@article{educhat2023,
  title={EduChat: A Large-Scale Language Model-based Chatbot System for Intelligent Education},
  author={Yuhao Dan, Zhikai Lei, Yiyang Gu, Yong Li, Jianghao Yin, Jiaju Lin, Linhao Ye, Zhiyan Tie, Yougen Zhou, Yilei Wang, Aimin Zhou, Ze Zhou, Qin Chen, Jie Zhou, Liang He, Xipeng Qiu},
  journal={arXiv preprint arXiv:2308.02773},
  year={2023}
}

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages