cadprompt / README.md
Kriscamp's picture
Upload README.md with huggingface_hub
5d2cc2d verified
|
Raw
History Blame Contribute Delete
7.22 kB
---
dataset_info:
features:
- name: query
dtype: string
- name: image
dtype: string
- name: annot
dtype: string
- name: reasoning
dtype: string
- name: cate
dtype: string
- name: task
dtype: string
- name: metadata
dtype: string
splits:
- name: test
num_bytes: 2070110
num_examples: 200
download_size: 401382
dataset_size: 2070110
configs:
- config_name: default
data_files:
- split: test
path: data/test-*
tags:
- smart-manufacturing
- cad
- code-generation
- cadquery
- text-to-cad
extra_gated_fields:
Name: text
Affiliation: text
Intended use: text
pretty_name: CADPrompt
license: unknown
extra_gated_prompt: Released for research use; access granted manually. State your
name, affiliation, and intended use.
---
# CADPrompt (自然语言 -> CadQuery 代码)
CADPrompt(Alrashedy et al., ICLR 2025, *Generating CAD Code with Vision-Language Models for 3D Designs*
已转为团队统一 7 字段 SFT schema。**200** 个样本。
> **按庞威裁决上传原始 dataset 本身**("direct VLM 如果需要 render 的那种可以先传 dataset 本身,我来看看
> 有没有办法弄一下 rendering")。本库是原始文本+代码,**渲染由团队后续统一处理**
## ⚠ 两点必须先看
**1. 这个集没有任何可用作 VLM 输入的图像 —— `image` 全为 `null`。**
全库只有 7 张 png,**没有一张是每样本配图**:3 张是仓库级插图(`Examples.png` / `Statistics.png` /
`CADCodeVerify.png`),另外 4 张散落在 3 个样本目录里(`00001817``00520776``00997300`),
是作者遗留的杂图。所以它**不是 raw-direct**,必须先从 CadQuery 代码渲染才能做 VLM 输入。
(登记表原写 "文本+代码,无稳定图像→非VLM raw-direct" —— 实测**吻合**。)
**2. 许可:无。** 仓库里**零 LICENSE 文件**,GitHub API `license` 字段返回 `null`,README 也无任何许可条款。
上游几何血缘(DeepCAD → ABC)**不构成授权** —— 那两个仓的 MIT 只覆盖**代码**,不覆盖数据;
且 ABC 的几何继承 Onshape ToU。**本库按团队要求"先传上来并在 README 标注"处理,再分发授权状态未解决。**
## ⚠ 批量执行警告:200 份 GT 代码的 export 路径完全同名
`annot` 里 200 份代码结尾全是 `cq.exporters.export(part, 'Ground_Truth.stl')` ——
硬编码相对路径(本次转换实测 export 目标计数 `{'Ground_Truth.stl': 200}`,缺 export 的 0 份)。
**同一个 cwd** 里批量执行这些代码(GT 代码或模型生成的代码都一样)会**静默互相覆写**同一个文件,
不报错,最后只剩最后一个物体。必须**逐样本 chdir 到独立目录**,或执行前把 export 目标改写成带
`model_id` 的路径。做渲染/评测前先解决这个,否则渲出来只有一个物体。
## Schema
`query`(自然语言描述,取的是**带具体尺寸的变体**,见下面的对表警告) · `image`**null** —— 见上) ·
`annot`(CadQuery Python 代码,ground truth) · `reasoning`(null) ·
`cate`=`E` / `task`=**`T-E1`** ·
`metadata``model_id``prompt_plain``prompt_with_measurements``geometry_ground_truth`
`deepcad_sequence_json`、网格路径)
**`query` 与论文对表警告**:本库 `query` 用带精确尺寸的 prompt 变体
`..._with_specific_measurements.txt`,200/200 含数字)。但论文全文 **0 次**提到该变体
(§4.1 只说 "manually annotated with a natural language prompt",单数),其报的数大概率用的是
朴素版(朴素版 109/200 一个数字都没有)。所以本库 **`query` 列不能直接跟论文 Table 2 对表**
要复现论文数字请改用 `metadata.prompt_plain`(朴素版原文,每个样本都有)。
### `metadata.geometry_ground_truth` 字段语义(照字段名字面用会全错)
来自每样本的 `Ground_Truth.json`。字段名有坑,实测语义(OBJ 顶点/面复算,全部 200 个)如下——
**生成几何属性问答前必须先按这张表重解释字段**
| 字段 | 实测语义 |
|---|---|
| `Number_of_Faces` | **网格三角面数**(200/200 等于 `Ground_Truth.obj``f` 行数),**不是 B-rep 面数**——一个圆柱在这里就有 140 个 "face"。拿它答"这个零件有几个面"会 200/200 全错 |
| `Width_mm` | X 跨度(200/200 吻合) |
| `Height_mm` | **Y 跨度**(200/200 吻合),**不是 CadQuery 拉伸方向**:碰巧等于 Z 跨度的只有 8/200。照字面当"高度"做问答/校验会系统性错 192/200 |
| `Depth_mm` | **Z 跨度**(200/200 吻合)= CadQuery 拉伸方向,即代码和 measurements prompt 里说的 "high" |
| `_mm` 后缀 | **是假的**:DeepCAD 几何已归一化,会出现 `Depth_mm: 0.00391` 这种物理上荒谬的值;prompt 里则统一说 "units" |
> `deepcad_sequence_json` 是该 `model_id` 对应的 DeepCAD/Onshape 构造序列 json 原文,但它
> **与 `annot`/网格不共享坐标系**:逐样本尺度比不定(独立复核 **0/200** 在 1× 对齐)。
> **禁止当监督信号,也不能拿来交叉校验 STL**,只作编号溯源用。
>
> 网格 `.obj`/`.stl` **没有上传到本 HF 库**:`metadata.mesh_files` 里是相对上游 zip 解压后
> `CAD_Code_Generation-main/CADPrompt/` 的相对路径,`load_dataset` 拿不到这些文件,
> 需要自行下载原仓库(见 Provenance)。
> **task 码依据(照团队官方文档,非臆断)**:`sft_task_merge_plan_v3` 定义
> **`T-E1` = CAD Code Generation & Editing(cate E)**,原文 *"Generate executable parametric CAD
> (CadQuery) code… **Executable CAD-code output is distinct from CAD perception/QA (which is
> T-B4 / T-B3)**"*,输出为 `CadQuery code`。本集产出正是 CadQuery 代码,故归 T-E1 / cate E。
> (注:文档 T-E1 的生成路径写的是「4 orthographic renders → CadQuery code」,本集是
> **自然语言 → 代码**,属同族但输入模态不同,已如实标注。)
## Load
```python
from datasets import load_dataset
ds = load_dataset("AI4Manufacturing/cadprompt", split="test")
```
原集**无 train/val/test 划分**,整集就是测试集(论文零训练、纯 prompting 评测的 benchmark),
所以本库显式落成 **`test`** 单分片——**不要**把它当训练数据混进 SFT 池。
_Gated — request access; granted manually._
## Provenance
- 源:https://github.com/Kamel773/CAD_Code_Generation (数据在 `CADPrompt/` 子目录,200 个以 DeepCAD 编号命名的样本目录)
- 论文:Alrashedy, K. et al. *Generating CAD Code with Vision-Language Models for 3D Designs.*
ICLR 2025. [arXiv:2410.05340](https://arxiv.org/abs/2410.05340)
- **许可:无(all rights reserved)** —— 见上。请引用上游。
- 取舍说明:`00998698` 目录下有第二份构造方式不同的 GT 代码 `Code_Ground_Truth_symmetrical.py`
(导出名也不同,是 `Code_Ground_Truth.stl`);本转换统一只取每目录的 `Python_Code.py`