File size: 10,008 Bytes
1d8c46a 0d75da0 1d8c46a 0d75da0 1d8c46a 0d75da0 1d8c46a 0d75da0 1d8c46a | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 | ---
license: other
license_name: educational-use-only
license_link: LICENSE
language:
- zh
- en
pretty_name: SCUT-SS 软件学院课程复习资料（可用于 RAG）
size_categories:
- 1K<n<10K
task_categories:
- question-answering
- text-retrieval
task_ids:
- document-retrieval
- extractive-qa
tags:
- rag
- retrieval-augmented-generation
- course-notes
- exam-preparation
- chinese
- software-engineering
- scut
configs:
- config_name: chunks
data_files:
- split: train
path: data/dataset/chunks.jsonl
- config_name: pages
data_files:
- split: train
path: data/dataset/pages.jsonl
- config_name: tree
data_files:
- split: train
path: data/dataset/tree.jsonl
---
# SCUT-SS：华南理工大学软件学院课程复习资料数据集（RAG-ready）
从飞书知识库「期末必修复习讲义」完整抓取并清洗的课程复习资料，
附带**开箱即用的本地向量库**与**纯浏览器端静态检索演示**，
供华南理工软件学院的同学用 AI 辅助复习（问答、出题、抽认卡、错题整理）。
> 数据内容版权归原作者所有，本仓库仅做格式整理；**仅供学习用途**，详见 [LICENSE](LICENSE)。
| 指标 | 数值 |
| --- | --- |
| 知识库节点 | 115（97 篇 docx + 16 份 PDF 课件 + 目录节点） |
| `pages` 记录数 | 113（97 篇文档 + 16 份 PDF） |
| `chunks` 记录数 | 2386 |
| 正文总字符 | 979,790 |
| 课程分类 | 9 |
| 语言 | 中英混排（课程多为中英双语） |
覆盖课程：软件体系结构、软件测试、数据库系统、软件项目管理、C++ 高级程序设计、
线性代数、历年回忆版试卷、大二下总结、暑期实习总结等。
**不含什么。** 原始知识库里还混着三样非课程内容：飞书官方帮助文档（「管理员手册」「成员手册」）、
一个与本课程无关的高考回忆卷分支、以及一个「期末休息区」留言页。它们会被当成"课程"出现在筛选里，
所以构建时按分支整体剔除，共 38 页 / 98 个片段，剩余 113 页 / 2,386 片段。
剔除清单写在 `data/dataset/stats.json` 的 `excluded_courses` 字段，`scripts/build_dataset.py` 可复现。
课程内容一条未删，各课程的历年真题回忆版全部保留。
另外剔除 41 个「只有标题重复、没有正文」的空壳片段（切分时留下的页标题），这类片段会对任何提到课程名的查询命中并挤掉真实内容。判定规则见 `scripts/build_dataset.py` 的 `is_low_information()`。
---
## 数据集结构
### `chunks`（推荐直接用于向量检索，2386 行）
| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `id` | string | 唯一 ID：`docx::<node>::<序号>` / `pdf::<文件名>::<序号>` |
| `page_id` | string | 所属页面 ID |
| `title` | string | 文档标题 |
| `course` | string | 一级分类（课程名） |
| `path` | string | 知识库完整路径，用 `/` 分隔 |
| `section` | string | 所在章节标题链（按 Markdown 标题切分） |
| `text` | string | 正文块（约 700 字符，带重叠） |
| `url` | string | 原飞书页面链接，可回查原文 |
| `source_type` | string | `docx` / `pdf` |
| `n_chars` | int | 正文块字符数 |
### `pages`（页面级全文，113 行）
`id`、`title`、`course`、`path`、`url`、`source_type`、`obj_token`、`n_chars`、`text`（整篇全文）。
### `tree`（知识库节点树，115 行）
`node_token`、`title`、`obj_type`、`path`（`/` 分隔）、`course`、`url`、
`file`（对应 `data/raw/` 的 Markdown 文件名）、`file_path`（对应 `data/files/` 的附件路径）。
### 其他文件
| 路径 | 说明 |
| --- | --- |
| `data/raw/*.md` | 138 篇文档的 Markdown 原文（含 front-matter 元信息） |
| `data/files/*.pdf` | 16 份软件测试课程 PDF 课件（Git LFS） |
| `vectorstore/` | 已建好的字符 n-gram TF-IDF 索引（`tfidf.npz` + 词表 + `chunks.jsonl`） |
| `scripts/` | 抓取 → 清洗 → 建库 → 检索的完整流水线 |
| `space/` | 可直接部署的**静态** HF Space（浏览器端 RAG） |
---
## 使用方式一：加载数据集（Python）
```python
from datasets import load_dataset
ds = load_dataset("NoahIsARider/SCUT-SS", "chunks")["train"]
print(ds[0]["course"], ds[0]["section"])
print(ds[0]["text"][:200])
# 按课程过滤
db = ds.filter(lambda x: x["course"].startswith("3.5➡️3.0 数据库系统"))
```
直接当 JSONL 读也行：`data/dataset/chunks.jsonl`（每行一个 JSON 对象）。
## 使用方式二：用自带向量库本地检索（无需任何模型）
```bash
git clone https://huggingface.co/datasets/NoahIsARider/SCUT-SS
cd SCUT-SS
pip install -r requirements.txt
python scripts/rag_query.py "黑盒测试有哪些方法" -k 5
python scripts/rag_query.py "数据库范式分解" -k 5 --course "数据库系统"
```
`vectorstore/` 里是构建好的 TF-IDF 索引，克隆下来即可检索，**不下载任何模型、不需要 API Key**。
自建/换后端（可选）：
```bash
python scripts/build_vectorstore.py # TF-IDF（默认，离线）
python scripts/build_vectorstore.py --backend sbert # 本地句向量
python scripts/build_vectorstore.py --backend openai --provider siliconflow # 云端 embedding
```
## 使用方式三：没有本地模型也能用（三种路径）
1. **云端模型直连**：配置后加 `--ask`
```powershell
$env:OPENAI_API_KEY = "sk-xxx"
$env:OPENAI_BASE_URL = "https://api.siliconflow.cn/v1"
$env:OPENAI_MODEL = "deepseek-ai/DeepSeek-V3"
python scripts/rag_query.py "简述 V 模型的四个测试层次" --ask
```
内置厂商预设：`deepseek` / `siliconflow` / `moonshot` / `zhipu` / `qwen` / `volcengine` / `openai` / `ollama`，
也可用 `--provider <预设>` 或写 `config/llm.json`（模板见 `config.example.json`）。
2. **导出上下文给外部 AI**（IDE / 聊天模型都行）
```bash
python scripts/rag_query.py "事务隔离级别" -k 5 --save-context notes/context.md
```
生成的文件自带「只依据资料作答、未覆盖要说明、标注来源编号」的约束，
在 IDE 里 `@` 该文件，或粘给任意模型即可。
3. **MCP 服务器**：让 IDE / 编程工具里的云端模型自己检索
```json
{ "mcpServers": { "scut-ss": { "command": "python",
"args": ["<仓库路径>/scripts/mcp_server.py"] } } }
```
提供 `search_materials(query, k, course)`、`list_courses()`、`get_material(title)` 三个工具。
## 使用方式四：静态 Space（浏览器端，零后端）
`space/` 是一个 **static** SDK 的 Space：所有检索在浏览器里完成，
HF 静态托管即可运行；可填自己的 API Key 让云端模型直接作答，不填也能纯检索 + 复制上下文。
部署：
```bash
# 1) 新建 Space（SDK 选 Static），克隆后把 space/ 内容复制到仓库根目录
cp space/index.html space/README.md <space-repo>/
cp data/dataset/chunks.jsonl <space-repo>/ # 内置数据，离线可用
# 2) 提交即可；别人 Duplicate 这个 Space 就能拿到一份自己的副本
```
Space 会自动从同目录 `chunks.jsonl` 加载；也可在界面里改成从任意数据集仓库
（`https://huggingface.co/datasets/<repo>/resolve/main/data/dataset/chunks.jsonl`）在线拉取。
---
## 复现 / 更新数据
```bash
npm i -g @larksuite/cli # 提供 lark-cli
lark-cli config bind --source hermes --identity user-default
lark-cli auth login --domain all
python scripts/crawl_wiki.py # 遍历节点树 + 抓正文 -> data/raw
python scripts/download_files.py # 下载 PDF 附件 -> data/files
python scripts/build_dataset.py # 清洗切分 -> data/dataset
python scripts/build_vectorstore.py # 建库 -> vectorstore
```
默认空间 `space_id=7351449686093365276`，换知识库用 `--space-id` / `--root` 覆盖。
---
## 发布到 HuggingFace
`hf`（huggingface_hub 1.x）取代了已废弃的 `huggingface-cli`。
```bash
hf auth login
# 1) 数据集仓库（根目录 README.md 已含数据集卡片 YAML）
hf repo create NoahIsARider/SCUT-SS --type dataset --public
hf upload NoahIsARider/SCUT-SS . --type dataset --commit-message "SCUT-SS: 华南理工软件学院课程复习资料，RAG-ready"
# 2) 静态 Space（index.html + chunks.jsonl 必须在同一目录）
hf repo create NoahIsARider/SCUT-SS-search --type space --space-sdk static --public
uv run --with huggingface_hub python -c "
from huggingface_hub import HfApi
HfApi().upload_folder(repo_id='NoahIsARider/SCUT-SS-search', repo_type='space',
folder_path='space', delete_patterns=['style.css'], commit_message='SCUT-SS 检索')"
```
向**已存在**的 Space 推送时 `hf upload` 仍会调用创建接口并返回 402（免费账号不能建
Gradio/Docker Space，静态 Space 可以），所以用 `HfApi.upload_folder`。静态 Space 的
访问域名是 `<owner>-<repo>.static.hf.space`。
上传后 Hub 会把 `chunks` / `pages` / `tree` 三个 config 转成 Parquet，
数据集页面可直接预览，也能用 `load_dataset("NoahIsARider/SCUT-SS", "chunks")` 加载。
## 许可与免责
- 原始内容版权归原作者（学院老师与同学），本仓库仅做技术整理，
采用 `other / educational-use-only`：允许个人学习与学术研究，禁止商业售卖与对外商用模型训练。
- 若你是原作者且不希望内容被收录，请提 issue，48 小时内移除。
- 检索结果附 `url` 字段，请与飞书原文核对；资料可能过时或有错漏，考试请以教材和老师口径为准。
|