zhangjiansunhe/README.md

# SmartNotes (智能笔记助手)

**一句话描述**: 一个利用 AI 将碎片化笔记转化为结构化知识并在生成测验的智能助手。

### 团队成员与贡献

| 姓名 | 学号 | 主要贡献 (具体分工) |
| :--- | :--- | :--- |
| **程俊** | 2411020113 | (组长) 核心逻辑开发、Prompt 编写 |
| **张健** | 2411020104 | 前端界面设计 |
| **孙赫** | 2411020105 | 文档撰写、测试与 Bug 修复 |

## 核心功能
- **智能整理**: 自动将杂乱的文本整理为清晰的层级结构（标题、要点）。
- **自动摘要**: 提炼核心观点，生成简洁摘要。
- **互动测验**: 基于笔记内容生成选择题，帮助巩固记忆。

## 🛠️ 拉取与运行指南 (Installation & Run)

### 1. 克隆项目 (Clone)
首先将项目代码拉取到本地：
```bash
git clone http://hblu.top:3000/Python2025-CourseDesign/zhangjiansunhe.git
cd zhangjiansunhe
```

### 2. 安装依赖 (Install Dependencies)
本项目推荐使用 `uv` 进行快速包管理：
```bash
# 如果未安装 uv
curl -LsSf https://astral.sh/uv/install.sh | sh

# 同步依赖
uv sync
```

### 3. 启动应用 (Run App)
```bash
uv run streamlit run app.py
```

## 📖 操作指南

### 1. 配置设置 (Configuration)
在左侧侧边栏进行基础设置：
- **服务提供商**: 根据你拥有的 API Key 选择 `OpenAI` 或 `DeepSeek`。
- **API Key**: 输入你的 API 密钥（输入框会自动隐藏内容以保护隐私）。
- **Base URL**: 
  - 选择提供商后会自动填充默认地址。
  - 如果使用中转服务（如 AIHubMix），请手动修改为中转商提供的 Base URL。
- **模型选择**:
  - **OpenAI**: 推荐 `gpt-4o` (效果最好) 或 `gpt-4o-mini` (性价比高)。
  - **DeepSeek**: 推荐 `deepseek-chat` (通用) 或 `deepseek-reasoner` (推理增强)。

### 2. 核心功能使用
#### A. 📝 智能整理与摘要
1. 在主界面的文本框中粘贴你的原始笔记（支持杂乱的会议记录、课堂速记等）。
2. 在下方单选框中选择 **"整理 & 摘要"**。
3. 点击 **"🚀 开始处理"** 按钮。
4. **结果**: 右侧栏将显示：
   - **核心摘要**: 3-5句话提炼的内容精华。
   - **结构化笔记**:这是修复语病并重新排版后的 Markdown 笔记。

#### B. 🧠 生成测验
1. 同样粘贴笔记内容。
2. 选择 **"生成测验"** 选项。
3. 点击开始处理。
4. **结果**: AI 将生成 3 道单项选择题，每道题都包含：
   - 题目描述
   - 4 个选项
   - **折叠的答案与解析**（点击可展开查看，方便自测）。

### 3.常见问题
- **报错 "Invalid API Key"**: 请检查 Key 是否复制完整，或是否选对了提供商。
- **响应慢**: AI 思考需要时间，特别是 DeepSeek-R1 (Reasoner) 模型，请耐心等待。


## 心得：
在梳理AI相关知识点的过程中，我们摸索出一套从实践心得转化为专业知识点总结的方法，收获颇丰。
 
此前整理笔记时，我们常陷入主观感受堆砌的误区，写满“这个算法很好用”“调参很关键”之类的表述，既不系统也不便复习。后来我尝试剥离个人感悟，聚焦核心概念、原理与应用逻辑，才发现知识点总结的精髓在于客观与结构化。比如将“用CNN做图像分类调参后准确率提升”的实践，拆解为CNN的特征提取原理、超参数优化方法和适用场景，形成清晰的知识模块。
 
这种转换不仅让我夯实了基础，更培养了系统化的思维方式。它要求我精准提炼专业术语，梳理各知识点的逻辑关联，用标准化的表述替代口语化描述。如今，我能快速将零散的学习心得转化为条理分明的知识点清单，无论是备考复习还是实践应用，都能快速调取所需内容。
 
用AI思维总结知识点，本质是对知识的二次消化，这一方法让我们的学习效率事半功倍。