luodian-training-data / docs /student_guide.md
KaKa427's picture
Update student guide: fix venv path, update env setup
a493711 verified
|
Raw
History Blame Contribute Delete
14 kB

螺钿垂直模型训练 - 学生操作手册(HuggingFace版)

版本:v2.0 - HuggingFace协作版 更新日期:2026-02-08 适用对象:参与训练的研究生和本科生


📌 项目概述

项目名称:现代螺钿产品设计垂直AI模型 协作平台:HuggingFace(替代Git LFS) 数据集仓库https://huggingface.co/datasets/KaKa427/luodian-training-data 许可证:CC BY-NC-SA 4.0(禁止商业使用


⚠️ 重要:许可证说明(必读)

CC BY-NC-SA 4.0 许可证要点

✅ 你可以

  • 用于学术研究(课程学习、毕业设计、论文发表)
  • 下载和使用数据集和模型
  • 修改和改进数据标注
  • 分享你的改进(需遵循相同许可证)
  • 署名使用(需注明来源和贡献者)

❌ 你不可以

  • 商业用途:不得将数据集或模型用于任何商业产品或服务
  • 出售数据:不得以任何形式出售或转让
  • 闭源改进:如分享改进版本,必须使用相同许可证

署名要求: 使用数据集或模型时,请引用:

数据集来源:KaKa427/luodian-training-data
指导教师:[教师姓名]
贡献学生:[你的姓名]

🚀 快速开始(3步上手)

Step 1: 注册HuggingFace账号(5分钟)

1.1 注册账号

访问:https://huggingface.co/join
- 填写邮箱、用户名、密码
- 验证邮箱
- 完善个人资料(可选)

1.2 获取Access Token

访问:https://huggingface.co/settings/tokens
→ 点击 "Create new token"
→ Token name: luodian-project
→ Type: Read(只读权限即可下载)
→ 复制生成的Token(格式:hf_xxxxxxxxxxxxx)
→ 保存到安全的地方(后面会用)

Step 2: 安装HuggingFace CLI(10分钟)

2.1 激活Python环境

# 使用项目独立环境(推荐,已包含所有训练依赖)
# 在项目根目录(螺钿垂直模型/)执行:
./venv/Scripts/activate

# 或者使用你自己的conda环境
conda activate your_env

2.2 安装huggingface_hub

pip install huggingface_hub --upgrade

2.3 登录HuggingFace

huggingface-cli login

粘贴你的Token,按回车。

验证登录

huggingface-cli whoami

应该显示你的用户名。


Step 3: 下载种子数据(5分钟)

方法A:使用命令行(推荐)

# 进入项目目录
cd "螺钿垂直模型"

# 下载数据集
huggingface-cli download \
    KaKa427/luodian-training-data \
    --repo-type dataset \
    --local-dir ./data/seed_from_hf

方法B:使用Python脚本

from huggingface_hub import snapshot_download

snapshot_download(
    repo_id="KaKa427/luodian-training-data",
    repo_type="dataset",
    local_dir="./data/seed_from_hf"
)

下载后检查

ls data/seed_from_hf/
# 应该看到:
# - images/          (种子图片)
# - annotations/     (标注文件)
# - schema/          (数据格式定义)
# - README.md        (说明文档)

📝 数据标注工作流程

你的任务分工

按产品类型分工(老师会分配):

  • 你负责:______系列(如手持镜)
  • 目标数量:____张
  • 截止日期:____

标注步骤(每张图3-5分钟)

1. 准备你的图片

将你的图片放入:data/raw/你的学号/

命名规范:

你的学号_产品类型_序号.jpg

示例:
2024001_mirror_001.jpg
2024001_mirror_002.jpg
2024001_jewelry_box_001.jpg

2. 使用交互式标注工具

cd data
python interactive_labeling.py

按提示输入(口语即可,系统会自动标准化):

产品类型: mirror
胎体材质: 紫光檀
镶嵌材料: 贝母螺钿 + 银丝
视觉主题: 京剧脸谱
设计风格: geometric_silhouette
复杂度: medium
尺寸: 12x8x0.5
工时: 6-8小时
市场定位: 欧美市场
中文描述: 黑色木头圆镜,嵌了彩色贝壳做的京剧脸谱,很简洁像剪影

3. 检查生成的JSON

工具会自动生成标准化JSON,预览确认后保存到dataset.json


质量检查清单(提交前必查)

每条数据提交前确认:

  • 图片清晰,光线良好
  • 尺寸标注完整(长x宽x高cm)
  • 工艺可行(6-10小时工时)
  • 复杂度合理(simple/medium,避免complex)
  • 市场定位明确
  • 专业术语准确(参考tags_mapping.json)

📤 上传标注到HuggingFace

方法A:通过Git克隆上传(推荐,适合多次上传)

第一次上传:

# 1. 克隆数据集仓库
git clone https://huggingface.co/datasets/KaKa427/luodian-training-data
cd luodian-training-data

# 2. 创建你的分支
git checkout -b student_你的学号

# 3. 复制你的标注文件
mkdir -p images/你的学号
mkdir -p annotations/你的学号

cp ~/螺钿垂直模型/data/raw/你的学号/*.jpg images/你的学号/
cp ~/螺钿垂直模型/data/annotations/*.json annotations/你的学号/

# 4. 提交并推送
git add images/你的学号 annotations/你的学号
git commit -m "Student [你的学号]: Added 20 annotated images"
git push origin student_你的学号

第二次及以后:

# 进入仓库目录
cd luodian-training-data

# 拉取最新更新
git pull origin main

# 切换到你的分支
git checkout student_你的学号

# 添加新标注
cp ~/新标注的图片/*.jpg images/你的学号/
cp ~/新标注的JSON/*.json annotations/你的学号/

# 提交
git add images/你的学号 annotations/你的学号
git commit -m "Student [你的学号]: Added 10 more images"
git push origin student_你的学号

5. 创建Pull Request

访问:https://huggingface.co/datasets/KaKa427/luodian-training-data
→ 点击 "Pull requests"
→ 点击 "New pull request"
→ 选择你的分支: student_你的学号 → main
→ 填写说明:
  Title: Student [你的学号] - Added [数量] annotated images
  Description:
    - 产品类型:手持镜
    - 数量:20张
    - 标注质量已自查
→ 点击 "Create pull request"

等待老师审核合并。


方法B:通过Web界面上传(简单,适合一次性上传)

1. 访问:https://huggingface.co/datasets/KaKa427/luodian-training-data
2. 点击 "Files" 标签
3. 点击 "Add file" → "Upload files"
4. 拖拽你的图片和JSON文件
5. Commit message: "Student [你的学号]: Added 10 images"
6. 点击 "Commit changes"

注意:此方法会直接提交到main分支,建议小量上传时使用。


🏋️ 本地训练流程(有GPU的同学)

前提条件

  • GPU: 至少8GB显存(RTX 3060 Ti以上)
  • 内存: 至少16GB
  • 磁盘空间: 至少30GB

训练步骤

1. 下载完整数据集(包含所有同学的标注)

一键下载脚本(推荐):

cd 螺钿垂直模型

# 运行下载脚本
python download_dataset.py

脚本会自动:

  • ✅ 下载HuggingFace数据集仓库的所有文件
  • ✅ 包含所有同学提交的图片和标注
  • ✅ 保存到 data/training_data/ 目录
  • ✅ 统计图片和标注数量

或使用命令行

# 高级用户可以手动使用CLI
huggingface-cli download \
    KaKa427/luodian-training-data \
    --repo-type dataset \
    --local-dir ./data/training_data

# 检查数据集
python validate_dataset.py --data_dir ./data/training_data

2. 检查环境

python 检查环境.bat

确保:

  • ✅ GPU可用
  • ✅ PyTorch安装正确
  • ✅ xformers已安装

3. 启动训练

cd 训练脚本

# 使用默认配置(推荐)
python train_llava_qlora_xformers.py \
    --data_path ../data/training_data \
    --output_dir ../output

# 或使用TensorBoard监控版(如果存在)
python train_with_tensorboard.py \
    --data_path ../data/training_data \
    --output_dir ../output

注意

  • 训练数据来自 data/training_data/(包含所有同学的标注)
  • Checkpoint保存到 output/目录
  • 每500步自动保存一次checkpoint

4. 监控训练(可选)

# 在另一个终端启动TensorBoard
tensorboard --logdir=../输出/logs

# 在浏览器打开
http://localhost:6006

5. 等待训练完成

  • 预计时间:2-4小时(取决于数据集大小)
  • Loss下降到0.3以下算正常
  • 自动保存checkpoint到output_dir

训练完成后上传Checkpoint

⚠️ 注意

  • Checkpoint文件约600MB-2GB
  • 使用HuggingFace可免费托管(无大小限制)
  • 上传后其他同学可以下载使用

上传步骤:

一键上传脚本(强烈推荐):

cd 螺钿垂直模型

# 运行上传脚本
python upload_checkpoint.py

脚本会自动:

  1. ✅ 列出所有可用的checkpoint和对应的Loss
  2. ✅ 引导你选择要上传的checkpoint
  3. ✅ 输入学号和姓名(用于命名)
  4. ✅ 上传到HuggingFace模型仓库
  5. ✅ 自动组织为:checkpoints/学号_姓名/checkpoint-xxx/

示例交互

找到以下checkpoint:
  [1] checkpoint-500 (Loss: 0.45)
  [2] checkpoint-1000 (Loss: 0.32)
  [3] checkpoint-1500 (Loss: 0.28)

请选择要上传的checkpoint [1-3]: 3

请输入你的信息(用于checkpoint命名):
  学号(如2024001): 2024001
  姓名拼音(如zhangsan): zhangsan

即将上传:
  Checkpoint: checkpoint-1500
  学生: 2024001_zhangsan
  仓库: KaKa427/luodian-vertical-model

确认上传? [y/N]: y

或使用命令行(高级用户):

huggingface-cli upload \
    KaKa427/luodian-vertical-model \
    ./output/checkpoint-1000/ \
    checkpoints/你的学号_姓名/checkpoint-1000/ \
    --repo-type model

记录训练日志

在项目仓库创建文件:训练日志/你的学号_checkpoint1.md

内容模板:

# Checkpoint 1 - Student [你的学号]

## 训练参数
- 数据集大小:50张
- LoRA Rank: 16
- Learning Rate: 2e-4
- Max Steps: 1000
- 训练时间:3小时

## 训练结果
- Final Loss: 0.32
- 最佳Epoch: 800
- GPU: RTX 3070 Ti

## Checkpoint位置
HuggingFace: https://huggingface.co/KaKa427/luodian-vertical-model/tree/main/checkpoints/你的名字

## 测试效果
[可选:上传几张生成的测试图片]

🎓 常见问题FAQ

Q1: 我没有GPU,能参与吗?

A: 可以!你可以专注于数据标注,训练由有GPU的同学负责。或使用Google Colab免费GPU。

Q2: HuggingFace下载很慢怎么办?

A:

# 方法1:设置镜像(如有)
export HF_ENDPOINT=https://hf-mirror.com

# 方法2:使用浏览器直接下载
访问数据集页面 → Files → 点击下载

# 方法3:使用代理
export HTTP_PROXY=http://your-proxy:port

Q3: 标注一张图需要多久?

A:

  • 熟练后:3-5分钟/张
  • 使用interactive_labeling.py:更快
  • 参考种子数据:1-2分钟/张

Q4: 训练失败OOM(显存不足)?

A:

  1. 确认使用了优化脚本(train_llava_qlora_xformers.py)
  2. 检查xformers已安装
  3. 如仍不够,降低image_size到384px
  4. 或联系有更大显存的同学代训练

Q5: Pull Request被拒绝了怎么办?

A: 检查老师的反馈,可能原因:

  • 数据质量不达标
  • 标注格式错误
  • 文件命名不规范 修改后重新提交。

Q6: 可以用这个模型做毕业设计吗?

A: 可以!但请遵守CC BY-NC-SA 4.0许可证:

  • ✅ 学术论文、课程作业、毕业设计
  • ✅ 需要署名数据来源和贡献者
  • ❌ 不能用于商业产品或服务

Q7: 如何引用这个项目?

A:

@misc{luodian2026,
  title={现代螺钿产品设计垂直AI模型训练数据集},
  author={[教师姓名] and [学生姓名列表]},
  year={2026},
  publisher={HuggingFace},
  howpublished={\url{https://huggingface.co/datasets/KaKa427/luodian-training-data}},
  note={License: CC BY-NC-SA 4.0}
}

📞 获取帮助

遇到技术问题?

  1. 查看文档:先看项目根目录的其他md文档
  2. 搜索Issues:GitHub或项目群聊历史记录
  3. 询问同学:在项目群里提问
  4. 联系老师:复杂问题联系指导老师

汇报进度

定期(每周)在群里更新:

  • 已标注数量
  • 遇到的问题
  • 下周计划

⏱️ 项目时间线

日期 里程碑 你的任务
2月8日 项目启动 注册HF账号、下载种子数据
2月12日 开始标注 熟悉流程,标注5-10张练习
2月15日 Checkpoint 1 完成分配的标注任务
2月20日 扩展数据集 继续标注(如分配)
2月28日 Checkpoint 2 有GPU的同学完成训练
3月7日 迭代优化 根据效果改进标注
3月15日 最终模型 项目总结和展示

🎯 成功标准

优秀贡献者(可获加分/推荐信)

  • 标注数量:≥30张
  • 标注质量:审核通过率≥90%
  • 训练参与:至少完成1次训练并上传checkpoint
  • 团队协作:积极帮助其他同学

合格标准

  • 标注数量:≥15张
  • 标注质量:审核通过率≥75%
  • 按时提交

祝你训练顺利!有问题随时在群里问! 🎉


文档版本:v2.0 - HuggingFace协作版 最后更新:2026-02-08 维护者:[教师姓名]