Update getting started: add phase1 completion, correct venv info
Browse files- docs/getting_started.md +235 -0
docs/getting_started.md
ADDED
|
@@ -0,0 +1,235 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# 螺钿垂直模型训练项目 - 开始前必读
|
| 2 |
+
|
| 3 |
+
**项目版本**:v2.0 - HuggingFace协作版
|
| 4 |
+
**更新时间**:2026-02-08
|
| 5 |
+
|
| 6 |
+
---
|
| 7 |
+
|
| 8 |
+
## 🎯 快速导航(按角色)
|
| 9 |
+
|
| 10 |
+
### 👨🏫 如果你是教师(项目负责人)
|
| 11 |
+
请按顺序阅读:
|
| 12 |
+
1. **HuggingFace仓库管理指南-教师版.md** ⭐首先看这个
|
| 13 |
+
2. 项目完整说明-给学生.md(了解整体架构)
|
| 14 |
+
3. CLAUDE.md(训练约束和标准)
|
| 15 |
+
|
| 16 |
+
**立即行动**:
|
| 17 |
+
- [ ] 创建HuggingFace模型仓库(数据集仓库已创建✅)
|
| 18 |
+
- [ ] 准备3-5张种子图片并标注
|
| 19 |
+
- [ ] 运行upload_to_hf.py上传种子数据
|
| 20 |
+
- [ ] 分发学生操作手册给学生
|
| 21 |
+
|
| 22 |
+
---
|
| 23 |
+
|
| 24 |
+
### 👨🎓 如果你是学生(参与训练)
|
| 25 |
+
**只需看这一个文档**:
|
| 26 |
+
- **学生操作手册-HuggingFace协作版.md** ⭐只看这个就够了
|
| 27 |
+
|
| 28 |
+
包含:
|
| 29 |
+
- 注册HuggingFace账号
|
| 30 |
+
- 下载种子数据
|
| 31 |
+
- 数据标注流程
|
| 32 |
+
- 上传标注到HF
|
| 33 |
+
- 本地训练(如有GPU)
|
| 34 |
+
- 常见问题FAQ
|
| 35 |
+
|
| 36 |
+
**估计时间**:30分钟即可上手
|
| 37 |
+
|
| 38 |
+
---
|
| 39 |
+
|
| 40 |
+
## 📦 HuggingFace仓库信息
|
| 41 |
+
|
| 42 |
+
### 数据集仓库(已创建)✅
|
| 43 |
+
```
|
| 44 |
+
URL: https://huggingface.co/datasets/KaKa427/luodian-training-data
|
| 45 |
+
Owner: KaKa427
|
| 46 |
+
License: CC BY-NC-SA 4.0 (禁止商业使用)
|
| 47 |
+
Visibility: Public(学生可直接访问)
|
| 48 |
+
用途: 存储图片标注数据
|
| 49 |
+
README: HuggingFace_Dataset_README.md
|
| 50 |
+
上传脚本: upload_to_hf.py
|
| 51 |
+
```
|
| 52 |
+
|
| 53 |
+
### 模型仓库(已创建)✅
|
| 54 |
+
```
|
| 55 |
+
URL: https://huggingface.co/KaKa427/luodian-vertical-model
|
| 56 |
+
Owner: KaKa427
|
| 57 |
+
License: CC BY-NC-SA 4.0
|
| 58 |
+
Visibility: Public
|
| 59 |
+
用途: 存储训练的Checkpoints
|
| 60 |
+
README: HuggingFace_Model_README.md(已准备)
|
| 61 |
+
```
|
| 62 |
+
|
| 63 |
+
---
|
| 64 |
+
|
| 65 |
+
## ⚠️ 许可证重要说明
|
| 66 |
+
|
| 67 |
+
### CC BY-NC-SA 4.0 核心要点
|
| 68 |
+
|
| 69 |
+
**✅ 你可以**:
|
| 70 |
+
- 用于学术研究、课程作业、毕业设计
|
| 71 |
+
- 下载使用、修改改进
|
| 72 |
+
- 论文发表(需署名)
|
| 73 |
+
|
| 74 |
+
**❌ 你不可以**:
|
| 75 |
+
- **商业使用**(这是最重要的限制)
|
| 76 |
+
- 出售数据或模型
|
| 77 |
+
- 用于商业产品或服务
|
| 78 |
+
|
| 79 |
+
**署名要求**:
|
| 80 |
+
```
|
| 81 |
+
数据来源:KaKa427/luodian-training-data
|
| 82 |
+
许可证:CC BY-NC-SA 4.0
|
| 83 |
+
指导教师:[教师姓名]
|
| 84 |
+
```
|
| 85 |
+
|
| 86 |
+
---
|
| 87 |
+
|
| 88 |
+
## 🚀 项目核心目标
|
| 89 |
+
|
| 90 |
+
训练一个**现代螺钿产品设计**专用AI模型,能够:
|
| 91 |
+
1. 生成高质量螺钿产品设计图
|
| 92 |
+
2. 输出包含尺寸、工艺的技术参数(工厂落地)
|
| 93 |
+
3. 结合2026时尚元素(哪吒、京剧、国潮)
|
| 94 |
+
4. 可批量化生产设计图
|
| 95 |
+
|
| 96 |
+
**不是**:复古大漆螺钿、复杂艺术品
|
| 97 |
+
**而是**:木胎贝母螺钿、简约几何、可量产
|
| 98 |
+
|
| 99 |
+
---
|
| 100 |
+
|
| 101 |
+
## 📚 完整文档列表(按重要性)
|
| 102 |
+
|
| 103 |
+
### ⭐⭐⭐ 核心文档(必读)
|
| 104 |
+
| 文档名 | 适用对象 | 说明 |
|
| 105 |
+
|--------|---------|------|
|
| 106 |
+
| **学生操作手册-HuggingFace协作版.md** | 学生 | 完整的上手指南 |
|
| 107 |
+
| **HuggingFace仓库管理指南-教师版.md** | 教师 | 仓库管理、审核PR |
|
| 108 |
+
| **CLAUDE.md** | 所有人 | 训练约束、术语标准 |
|
| 109 |
+
| **项目更新说明-20260208-v2.md** | 所有人 | v2.0重要变更 |
|
| 110 |
+
|
| 111 |
+
### ⭐⭐ 重要文档(参考)
|
| 112 |
+
| 文档名 | 用途 |
|
| 113 |
+
|--------|------|
|
| 114 |
+
| data/dataset_schema.json | 数据格式定义(17字段) |
|
| 115 |
+
| data/tags_mapping.json | 口语→专业术语映射 |
|
| 116 |
+
| data/标注工作流程.md | 详细标注步骤 |
|
| 117 |
+
| 项目完整说明-给学生.md | 项目整体架构 |
|
| 118 |
+
|
| 119 |
+
### ⭐ 技术文档(遇到问题时看)
|
| 120 |
+
| 文档名 | 用途 |
|
| 121 |
+
|--------|------|
|
| 122 |
+
| 显存优化策略.md | 8GB显存训练方案 |
|
| 123 |
+
| 训练监控工具说明.md | TensorBoard使用 |
|
| 124 |
+
| 视觉基座模型评估.md | 技术选型说明 |
|
| 125 |
+
|
| 126 |
+
---
|
| 127 |
+
|
| 128 |
+
## 🛠️ 技术栈总览
|
| 129 |
+
|
| 130 |
+
### 核心组件
|
| 131 |
+
- **基座模型**:LLaVA-1.5-7B (13.16GB) ✅已下载
|
| 132 |
+
- **微调技术**:QLoRA (4bit量化 + LoRA)
|
| 133 |
+
- **显存优化**:xformers + Gradient Checkpointing + PagedAdamW 8bit
|
| 134 |
+
- **协作平台**:HuggingFace(替代Git LFS)
|
| 135 |
+
- **版本管理**:Git(代码) + HuggingFace(数据+模型)
|
| 136 |
+
|
| 137 |
+
### 已安装工具(独立训练环境 venv/)
|
| 138 |
+
- Python: 3.11.9
|
| 139 |
+
- PyTorch: 2.4.0+cu121(CUDA 12.1)
|
| 140 |
+
- transformers: 4.44.2
|
| 141 |
+
- peft: 0.18.1
|
| 142 |
+
- bitsandbytes: 0.49.1
|
| 143 |
+
- accelerate: 1.12.0(已打补丁,修复4bit dispatch bug)
|
| 144 |
+
- sentencepiece: 0.2.1 + protobuf: 6.33.5(tokenizer必须)
|
| 145 |
+
- xformers: 未安装(不影响基础训练)
|
| 146 |
+
- huggingface_hub: 已包含
|
| 147 |
+
- MCP服务器:Filesystem, GitHub, Sequential Thinking
|
| 148 |
+
- **环境位置**: `螺钿垂直模型/venv/`(独立于ComfyUI的venv311)
|
| 149 |
+
|
| 150 |
+
---
|
| 151 |
+
|
| 152 |
+
## 📅 项目时间线
|
| 153 |
+
|
| 154 |
+
| 日期 | 里程碑 | 目标 | 状态 |
|
| 155 |
+
|------|--------|------|------|
|
| 156 |
+
| 2月8日 | 环境搭建 | 所有工具就绪 | ✅已完成 |
|
| 157 |
+
| 2月8日 | HuggingFace集成 | 仓库+文档+脚本 | ✅已完成 |
|
| 158 |
+
| 2月9日 | Phase 1 验证 | 独立venv+单图训练验证 | ✅已完成(loss=0.6076)|
|
| 159 |
+
| 2月10日 | 收集图片 | 10-20张种子图片 | ⏳进行中 |
|
| 160 |
+
| 2月12日 | 开始标注 | 学生熟悉流程 | ⏳待开始 |
|
| 161 |
+
| **2月15日** | **Checkpoint 1** | **50张标注完成+首次训练** | ⏳待开始 |
|
| 162 |
+
| 2月28日 | Checkpoint 2 | 100张标注 | ⏳待开始 |
|
| 163 |
+
| **3月15日** | **最终模型** | **发布HuggingFace** | ⏳待开始 |
|
| 164 |
+
|
| 165 |
+
---
|
| 166 |
+
|
| 167 |
+
## 🔗 快速链接
|
| 168 |
+
|
| 169 |
+
### 在线资源
|
| 170 |
+
- 数据集仓库:https://huggingface.co/datasets/KaKa427/luodian-training-data
|
| 171 |
+
- 模型仓库:https://huggingface.co/KaKa427/luodian-vertical-model(已创建)
|
| 172 |
+
- HuggingFace文档:https://huggingface.co/docs
|
| 173 |
+
- CC BY-NC-SA 4.0许可证:https://creativecommons.org/licenses/by-nc-sa/4.0/
|
| 174 |
+
|
| 175 |
+
### 本地文件
|
| 176 |
+
- 训练脚本:`训练脚本/train_llava_qlora_xformers.py`
|
| 177 |
+
- 标注工具:`data/interactive_labeling.py`
|
| 178 |
+
- 数据格式:`data/dataset_schema.json`
|
| 179 |
+
|
| 180 |
+
---
|
| 181 |
+
|
| 182 |
+
## 💬 获取帮助
|
| 183 |
+
|
| 184 |
+
### 遇到问题?
|
| 185 |
+
1. **查看FAQ**:学生操作手册中的常见问题部分
|
| 186 |
+
2. **查找文档**:根据上面的分类找到对应文档
|
| 187 |
+
3. **询问同学**:在项目群讨论
|
| 188 |
+
4. **联系教师**:复杂技术问题
|
| 189 |
+
|
| 190 |
+
### 汇报进度
|
| 191 |
+
- 定期在群里更新标注进度
|
| 192 |
+
- 遇到阻塞及时提出
|
| 193 |
+
- 完成里程碑后通报
|
| 194 |
+
|
| 195 |
+
---
|
| 196 |
+
|
| 197 |
+
## ✨ 项目亮点
|
| 198 |
+
|
| 199 |
+
1. 🆕 **填补空白**:首个螺钿垂直AI模型
|
| 200 |
+
2. 🏭 **工厂导向**:可落地的设计工具(非艺术概念)
|
| 201 |
+
3. 🌏 **现代审美**:2026时尚+中国传统工艺
|
| 202 |
+
4. 🤝 **完整协作体系**:HuggingFace异地协作
|
| 203 |
+
5. 📐 **标准化流程**:口语输入→专业术语自动转换
|
| 204 |
+
6. ⚖️ **开放许可**:CC BY-NC-SA 4.0(学术使用友好)
|
| 205 |
+
|
| 206 |
+
---
|
| 207 |
+
|
| 208 |
+
## 🎯 成功标准
|
| 209 |
+
|
| 210 |
+
### 数据集目标
|
| 211 |
+
- 最小:50张(可启动训练)
|
| 212 |
+
- 推荐:100-200张(稳定效果)
|
| 213 |
+
- 理想:300+张(生产级)
|
| 214 |
+
|
| 215 |
+
### 质量标准
|
| 216 |
+
- 标注准确率:≥90%
|
| 217 |
+
- 工艺可行性:100%(所有设计必须可工厂生产)
|
| 218 |
+
- 术语一致性:100%(参考tags_mapping.json)
|
| 219 |
+
|
| 220 |
+
---
|
| 221 |
+
|
| 222 |
+
**开始前请确认**:
|
| 223 |
+
- [ ] 我已阅读适合我角色的核心文档
|
| 224 |
+
- [ ] 我理解CC BY-NC-SA 4.0许可证(禁止商用)
|
| 225 |
+
- [ ] 我知道在哪里找到帮助
|
| 226 |
+
- [ ] 我准备好开始标注/管理了
|
| 227 |
+
|
| 228 |
+
**祝项目顺利!** 🎉
|
| 229 |
+
|
| 230 |
+
---
|
| 231 |
+
|
| 232 |
+
*文档版本:v2.0*
|
| 233 |
+
*最后更新:2026-02-08*
|
| 234 |
+
*项目负责:KaKa427*
|
| 235 |
+
*技术支持:Claude Code*
|