# CourseGraph

**Repository Path**: github-mirrorrs/CourseGraph

## Basic Information

- **Project Name**: CourseGraph
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: dev
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-08-21
- **Last Updated**: 2025-08-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<div align="center">
<img src="docs/public/logo.png" width="200"  alt="" />
<h2>CourseGraph: 使用大模型自动构建课程知识图谱</h2>

<p>
    <b>中文</b> | <a href="README_en.md">English</a>
</p>
</div>

CourseGraph 使用大模型，利用多种 prompt 优化技术, 自动从教材、书籍中抽取知识点, 构成以课程-章节-知识点为主题的知识图谱。为增加每个知识点的信息, CourseGraph 可以为知识点链接相应的习题、扩展阅读材料等资源, 另外也可利用多模态大模型从 pptx、图片、视频中提取信息并与之相关联。

## 🤔 局限性

- 目前只实现了基本的知识图谱抽取和对 pptx 的解析，效果有待优化
- 对视频的解析还处于规划中

## 📈 未来发展方向

- 改进提示词工程，并尝试使用 Agent 完成相关工作
- 增加多种策略对比实验
- 基于图谱的问答 (KBQA 或 Graph-RAG)

## 🚀 快速使用

首先申请阿里云百炼 [API Key](https://help.aliyun.com/zh/model-studio/developer-reference/get-api-key)，然后选择使用本地安装或使用 Docker 安装：

### 方式一：本地安装

#### 安装依赖

请确保已安装 [uv](https://docs.astral.sh/uv/)、[neo4j](https://neo4j.com/) 和 [rust](https://www.rust-lang.org/) ，然后执行：

```bash
uv sync
```

Linux 下还需安装 libreoffice 以完成文档转换，以 Debian 系为例：

```bash
sudo apt install libreoffice
```

#### 执行示例

提供 Neo4j 连接密码和待抽取的文件路径，然后执行：

```bash
uv run examples/get_knowledge_graph_pdf.py -p neo4j -f assets/deep-learning-from-scratch.pdf
```

### 方式二：使用 Docker 安装

```bash
docker-compose -f docker/docker-compose.yml up -d
uv run examples/get_knowledge_graph_pdf.py -f assets/deep-learning-from-scratch.pdf
```

## 📚 文档

可以在 `docs` 目录下查看文档, 也可以访问 [在线文档](https://CPU-DS.github.io/CourseGraph/) (由于项目功能仍处于快速开发中，故在线文档暂时还没有准备好)。

如果你希望自定义在线文档请依照以下步骤：

#### 依赖安装和预览

文档使用 [vitepress](https://vitepress.dev/) 构建, 需安装 [node.js](https://nodejs.org/) 18 或以上版本，然后执行：

```bash
cd docs
npm i
npm run dev
```

使用浏览器打开 [http://localhost:5173/](http://localhost:5173/) 即可进行预览。


## 🛠️ 贡献、协议和引用

欢迎提交 [PR](https://github.com/CPU-DS/CourseGraph/pulls) 或 [Issues](https://github.com/CPU-DS/CourseGraph/issues)，也欢迎参与任何形式的贡献。

本项目基于 [MIT 协议](LICENSE) 开源。

如果觉得 CourseGraph 项目有助于你的工作，请点击 Repository 右侧的 `Cite this repository` 按钮进行引用。