docs/getting_started.md

# 螺钿垂直模型训练项目 - 开始前必读

**项目版本**：v2.0 - HuggingFace协作版
**更新时间**：2026-02-08

---

## 🎯 快速导航（按角色）

### 👨‍🏫 如果你是教师（项目负责人）
请按顺序阅读：
1. **HuggingFace仓库管理指南-教师版.md** ⭐首先看这个
2. 项目完整说明-给学生.md（了解整体架构）
3. CLAUDE.md（训练约束和标准）

**立即行动**：
- [ ] 创建HuggingFace模型仓库（数据集仓库已创建✅）
- [ ] 准备3-5张种子图片并标注
- [ ] 运行upload_to_hf.py上传种子数据
- [ ] 分发学生操作手册给学生

---

### 👨‍🎓 如果你是学生（参与训练）
**只需看这一个文档**：
- **学生操作手册-HuggingFace协作版.md** ⭐只看这个就够了

包含：
- 注册HuggingFace账号
- 下载种子数据
- 数据标注流程
- 上传标注到HF
- 本地训练（如有GPU）
- 常见问题FAQ

**估计时间**：30分钟即可上手

---

## 📦 HuggingFace仓库信息

### 数据集仓库（已创建）✅
```
URL: https://huggingface.co/datasets/KaKa427/luodian-training-data
Owner: KaKa427
License: CC BY-NC-SA 4.0 (禁止商业使用)
Visibility: Public（学生可直接访问）
用途: 存储图片标注数据
README: HuggingFace_Dataset_README.md
上传脚本: upload_to_hf.py
```

### 模型仓库（已创建）✅
```
URL: https://huggingface.co/KaKa427/luodian-vertical-model
Owner: KaKa427
License: CC BY-NC-SA 4.0
Visibility: Public
用途: 存储训练的Checkpoints
README: HuggingFace_Model_README.md（已准备）
```

---

## ⚠️ 许可证重要说明

### CC BY-NC-SA 4.0 核心要点

**✅ 你可以**：
- 用于学术研究、课程作业、毕业设计
- 下载使用、修改改进
- 论文发表（需署名）

**❌ 你不可以**：
- **商业使用**（这是最重要的限制）
- 出售数据或模型
- 用于商业产品或服务

**署名要求**：
```
数据来源：KaKa427/luodian-training-data
许可证：CC BY-NC-SA 4.0
指导教师：[教师姓名]
```

---

## 🚀 项目核心目标

训练一个**现代螺钿产品设计**专用AI模型，能够：
1. 生成高质量螺钿产品设计图
2. 输出包含尺寸、工艺的技术参数（工厂落地）
3. 结合2026时尚元素（哪吒、京剧、国潮）
4. 可批量化生产设计图

**不是**：复古大漆螺钿、复杂艺术品
**而是**：木胎贝母螺钿、简约几何、可量产

---

## 📚 完整文档列表（按重要性）

### ⭐⭐⭐ 核心文档（必读）
| 文档名 | 适用对象 | 说明 |
|--------|---------|------|
| **学生操作手册-HuggingFace协作版.md** | 学生 | 完整的上手指南 |
| **HuggingFace仓库管理指南-教师版.md** | 教师 | 仓库管理、审核PR |
| **CLAUDE.md** | 所有人 | 训练约束、术语标准 |
| **项目更新说明-20260208-v2.md** | 所有人 | v2.0重要变更 |

### ⭐⭐ 重要文档（参考）
| 文档名 | 用途 |
|--------|------|
| data/dataset_schema.json | 数据格式定义（17字段） |
| data/tags_mapping.json | 口语→专业术语映射 |
| data/标注工作流程.md | 详细标注步骤 |
| 项目完整说明-给学生.md | 项目整体架构 |

### ⭐ 技术文档（遇到问题时看）
| 文档名 | 用途 |
|--------|------|
| 显存优化策略.md | 8GB显存训练方案 |
| 训练监控工具说明.md | TensorBoard使用 |
| 视觉基座模型评估.md | 技术选型说明 |

---

## 🛠️ 技术栈总览

### 核心组件
- **基座模型**：LLaVA-1.5-7B (13.16GB) ✅已下载
- **微调技术**：QLoRA (4bit量化 + LoRA)
- **显存优化**：xformers + Gradient Checkpointing + PagedAdamW 8bit
- **协作平台**：HuggingFace（替代Git LFS）
- **版本管理**：Git（代码） + HuggingFace（数据+模型）

### 已安装工具（独立训练环境 venv/）
- Python: 3.11.9
- PyTorch: 2.4.0+cu121（CUDA 12.1）
- transformers: 4.44.2
- peft: 0.18.1
- bitsandbytes: 0.49.1
- accelerate: 1.12.0（已打补丁，修复4bit dispatch bug）
- sentencepiece: 0.2.1 + protobuf: 6.33.5（tokenizer必须）
- xformers: 未安装（不影响基础训练）
- huggingface_hub: 已包含
- MCP服务器：Filesystem, GitHub, Sequential Thinking
- **环境位置**: `螺钿垂直模型/venv/`（独立于ComfyUI的venv311）

---

## 📅 项目时间线

| 日期 | 里程碑 | 目标 | 状态 |
|------|--------|------|------|
| 2月8日 | 环境搭建 | 所有工具就绪 | ✅已完成 |
| 2月8日 | HuggingFace集成 | 仓库+文档+脚本 | ✅已完成 |
| 2月9日 | Phase 1 验证 | 独立venv+单图训练验证 | ✅已完成（loss=0.6076）|
| 2月10日 | 收集图片 | 10-20张种子图片 | ⏳进行中 |
| 2月12日 | 开始标注 | 学生熟悉流程 | ⏳待开始 |
| **2月15日** | **Checkpoint 1** | **50张标注完成+首次训练** | ⏳待开始 |
| 2月28日 | Checkpoint 2 | 100张标注 | ⏳待开始 |
| **3月15日** | **最终模型** | **发布HuggingFace** | ⏳待开始 |

---

## 🔗 快速链接

### 在线资源
- 数据集仓库：https://huggingface.co/datasets/KaKa427/luodian-training-data
- 模型仓库：https://huggingface.co/KaKa427/luodian-vertical-model（已创建）
- HuggingFace文档：https://huggingface.co/docs
- CC BY-NC-SA 4.0许可证：https://creativecommons.org/licenses/by-nc-sa/4.0/

### 本地文件
- 训练脚本：`训练脚本/train_llava_qlora_xformers.py`
- 标注工具：`data/interactive_labeling.py`
- 数据格式：`data/dataset_schema.json`

---

## 💬 获取帮助

### 遇到问题？
1. **查看FAQ**：学生操作手册中的常见问题部分
2. **查找文档**：根据上面的分类找到对应文档
3. **询问同学**：在项目群讨论
4. **联系教师**：复杂技术问题

### 汇报进度
- 定期在群里更新标注进度
- 遇到阻塞及时提出
- 完成里程碑后通报

---

## ✨ 项目亮点

1. 🆕 **填补空白**：首个螺钿垂直AI模型
2. 🏭 **工厂导向**：可落地的设计工具（非艺术概念）
3. 🌏 **现代审美**：2026时尚+中国传统工艺
4. 🤝 **完整协作体系**：HuggingFace异地协作
5. 📐 **标准化流程**：口语输入→专业术语自动转换
6. ⚖️ **开放许可**：CC BY-NC-SA 4.0（学术使用友好）

---

## 🎯 成功标准

### 数据集目标
- 最小：50张（可启动训练）
- 推荐：100-200张（稳定效果）
- 理想：300+张（生产级）

### 质量标准
- 标注准确率：≥90%
- 工艺可行性：100%（所有设计必须可工厂生产）
- 术语一致性：100%（参考tags_mapping.json）

---

**开始前请确认**：
- [ ] 我已阅读适合我角色的核心文档
- [ ] 我理解CC BY-NC-SA 4.0许可证（禁止商用）
- [ ] 我知道在哪里找到帮助
- [ ] 我准备好开始标注/管理了

**祝项目顺利！** 🎉

---

*文档版本：v2.0*
*最后更新：2026-02-08*
*项目负责：KaKa427*
*技术支持：Claude Code*