YUAI09 commited on
Commit
72a6c8f
·
verified ·
1 Parent(s): df6b56d

docs: add internship contribution workflow

Browse files
Files changed (3) hide show
  1. CONTRIBUTING.md +61 -0
  2. README.md +8 -0
  3. submissions/README.md +16 -0
CONTRIBUTING.md ADDED
@@ -0,0 +1,61 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # 宇哥具身智能线上实习:Hugging Face 提交规范
2
+
3
+ 本仓库是 SO101 PickOrange 任务的官方示例数据集。为避免多人上传造成元数据冲突、目录覆盖和仓库体积失控,学员不要索取或使用仓库所有者的 Access Token,也不要把模型权重混放到 Dataset 仓库。
4
+
5
+ ## 推荐提交流程
6
+
7
+ 1. 在自己的 Hugging Face 账号下创建独立的 Dataset 仓库。
8
+ 2. 第 6 章模型另建 Model 仓库,Dataset 与 Model 不混放。
9
+ 3. 补充 Dataset Card / Model Card,确保导师可以检查和复现。
10
+ 4. 编辑本仓库的 `submissions/README.md`,增加自己的一行记录。
11
+ 5. 保存时选择 **Open as a pull request**,等待宇哥审核后合并。
12
+ 6. 将 Dataset、Model 和 PR 链接同步填写到飞书实习总表。
13
+
14
+ ## 仓库命名建议
15
+
16
+ ```text
17
+ 数据集:YOUR_HF_ID/yuai-ch04-pick-orange-YOUR_GITHUB_ID
18
+ 模型: YOUR_HF_ID/yuai-ch06-pick-orange-MODEL_NAME-YOUR_GITHUB_ID
19
+ ```
20
+
21
+ ## Dataset Card 至少包含
22
+
23
+ - 任务名称、机器人型号和数据来源
24
+ - Episode、Frame、FPS、状态维度和动作维度
25
+ - 相机名称、图像分辨率和视频编码
26
+ - 数据目录结构及主要字段
27
+ - 生成环境、软件版本、随机种子和关键参数
28
+ - 数据质检结果、推荐用途与已知限制
29
+ - 许可证;涉及真实数据时还要说明隐私和授权情况
30
+
31
+ LeRobot Dataset v3 建议保持以下结构:
32
+
33
+ ```text
34
+ data/ 状态、动作、时间戳和索引
35
+ meta/ 数据集说明、统计量、任务和 episode 元数据
36
+ videos/ 相机视频
37
+ README.md Dataset Card
38
+ ```
39
+
40
+ ## Model Card 至少包含
41
+
42
+ - 基础模型和训练代码版本
43
+ - 训练数据集链接
44
+ - 环境、超参数和训练步骤
45
+ - 输入、输出和推理示例
46
+ - 评估方法与结果
47
+ - 已知限制、安全说明和许可证
48
+
49
+ ## Pull Request 规范
50
+
51
+ PR 标题:
52
+
53
+ ```text
54
+ [Intern][HF_ID] Add Chapter 4 dataset / Chapter 6 model
55
+ ```
56
+
57
+ PR 描述写明:学员信息、对应章节、成果链接、数据或模型规模、复现方式、已知问题。每位学员只修改自己的登记行,不覆盖他人记录,也不要在本仓库直接提交 Access Token、密钥、缓存或无关文件。
58
+
59
+ ## 对本示例数据集本体的修改
60
+
61
+ 如果发现 Dataset Card、元数据或文件存在问题,可以直接通过 Hugging Face Pull Request 提出修正。对大规模数据文件的替换,请先在 Discussion 中说明原因、范围和验证结果,再提交 PR。
README.md CHANGED
@@ -55,3 +55,11 @@ videos/ front 与 wrist 两路相机视频
55
  ## 相关项目
56
 
57
  配套代码:[《具身智能从入门到实践》笔记学习代码](https://github.com/YUAI-X/Embodied-AI-Learning-Code)
 
 
 
 
 
 
 
 
 
55
  ## 相关项目
56
 
57
  配套代码:[《具身智能从入门到实践》笔记学习代码](https://github.com/YUAI-X/Embodied-AI-Learning-Code)
58
+
59
+ <!-- YUAI_INTERNSHIP_CONTRIBUTION_ENTRY -->
60
+ ## 线上实习学员提交
61
+
62
+ 本仓库作为宇哥具身智能线上实习的第 4 章官方示例数据集。学员的数据集和模型请分别发布到独立的 Hugging Face 仓库,再通过 Pull Request 登记成果链接,避免不同实验的数据、元数据和模型权重互相覆盖。
63
+
64
+ - [查看学员提交规范](CONTRIBUTING.md)
65
+ - [查看学员成果登记表](submissions/README.md)
submissions/README.md ADDED
@@ -0,0 +1,16 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # 宇哥具身智能线上实习|学员成果登记
2
+
3
+ 本页面用于登记学员独立发布的 Hugging Face Dataset 和 Model。数据与模型保存在各自仓库,本页只收录经过 PR 审核的链接。
4
+
5
+ 提交前请阅读 [CONTRIBUTING.md](../CONTRIBUTING.md)。
6
+
7
+ | 学员昵称/姓名 | 学校与年级 | GitHub ID | Hugging Face ID | 章节 | Dataset 链接 | Model 链接 | 提交 PR | 状态 |
8
+ |---|---|---|---|---|---|---|---|---|
9
+ | 示例学员 | 示例大学·研一 | example-github | example-hf | 第4章/第6章 | 待提交 | 待提交 | 待提交 | 待审核 |
10
+
11
+ ## 填写规则
12
+
13
+ - 第 4 章主要登记 Dataset;第 6 章主要登记 Model。
14
+ - 没有对应成果时填写“—”,不要删除表头或其他学员记录。
15
+ - Dataset、Model 和 PR 必须是可访问的完整链接。
16
+ - 状态由维护者更新:`待审核`、`需补充`、`已通过`。