ArchEGraph commited on
Commit
e11cde2
·
1 Parent(s): 83a906b

Configure demo dataset viewer metadata

Browse files
Files changed (2) hide show
  1. README.md +19 -1
  2. croissant.json +74 -74
README.md CHANGED
@@ -14,6 +14,20 @@ tags:
14
  - demo
15
  size_categories:
16
  - n<1K
 
 
 
 
 
 
 
 
 
 
 
 
 
 
17
  ---
18
 
19
  # ArchEGraph-demo
@@ -54,10 +68,14 @@ Each row in `manifest.csv` contains:
54
  - `split/split_demo.csv` (300 rows)
55
  - `split/split_demo_mesh.csv` (300 rows)
56
 
57
- Each split CSV uses the same columns:
58
 
59
  - `case_id`, `sample_id`, `building_id`, `weather_id`, `subset`, `split`, `scenario`
60
 
 
 
 
 
61
  ## Quick Start
62
 
63
  ```python
 
14
  - demo
15
  size_categories:
16
  - n<1K
17
+ configs:
18
+ - config_name: manifest
19
+ default: true
20
+ data_files:
21
+ - split: train
22
+ path: manifest.csv
23
+ - config_name: split_demo
24
+ data_files:
25
+ - split: train
26
+ path: split/split_demo.csv
27
+ - config_name: split_demo_mesh
28
+ data_files:
29
+ - split: train
30
+ path: split/split_demo_mesh.csv
31
  ---
32
 
33
  # ArchEGraph-demo
 
68
  - `split/split_demo.csv` (300 rows)
69
  - `split/split_demo_mesh.csv` (300 rows)
70
 
71
+ `split/split_demo.csv` uses these columns:
72
 
73
  - `case_id`, `sample_id`, `building_id`, `weather_id`, `subset`, `split`, `scenario`
74
 
75
+ `split/split_demo_mesh.csv` uses these columns:
76
+
77
+ - `building_id`, `split`
78
+
79
  ## Quick Start
80
 
81
  ```python
croissant.json CHANGED
@@ -1,74 +1,68 @@
1
  {
2
  "@context": {
 
3
  "@vocab": "https://schema.org/",
 
 
4
  "cr": "http://mlcommons.org/croissant/",
5
- "ml": "http://mlcommons.org/croissant/",
 
 
 
6
  "dct": "http://purl.org/dc/terms/",
7
- "conformsTo": "dct:conformsTo"
 
 
 
 
 
 
8
  },
9
- "@type": "Dataset",
10
- "name": "PACK",
11
- "description": "Building-energy dataset with building geometry, weather context, and per-case energy simulation outputs.",
12
- "version": "1.0.0",
13
- "license": "Proprietary/Custom",
14
- "conformsTo": "http://mlcommons.org/croissant/1.0",
15
  "distribution": [
16
  {
17
  "@type": "cr:FileObject",
18
- "@id": "manifest-csv",
19
- "name": "manifest.csv",
20
- "contentUrl": "manifest.csv",
21
- "encodingFormat": "text/csv"
22
- },
23
- {
24
- "@type": "cr:FileSet",
25
- "@id": "building-files",
26
- "name": "building npz files",
27
- "includes": "building/*.npz",
28
- "encodingFormat": "application/octet-stream"
29
- },
30
- {
31
- "@type": "cr:FileSet",
32
- "@id": "geometry-files",
33
- "name": "geometry npz files",
34
- "includes": "geometry/*.npz",
35
- "encodingFormat": "application/octet-stream"
36
  },
37
  {
38
- "@type": "cr:FileSet",
39
- "@id": "weather-files",
40
- "name": "weather npz files",
41
- "includes": "weather/*.npz",
42
- "encodingFormat": "application/octet-stream"
43
- },
44
- {
45
- "@type": "cr:FileSet",
46
- "@id": "energy-files",
47
- "name": "energy npz files",
48
- "includes": "energy/**/*.npz",
49
- "encodingFormat": "application/octet-stream"
50
- },
51
- {
52
- "@type": "cr:FileSet",
53
- "@id": "split-files",
54
- "name": "split csv files",
55
- "includes": "split/*.csv",
56
  "encodingFormat": "text/csv"
57
  }
58
  ],
59
  "recordSet": [
60
  {
61
  "@type": "cr:RecordSet",
62
- "name": "manifest_records",
63
- "description": "One row per simulation case.",
 
 
 
 
64
  "field": [
65
  {
66
  "@type": "cr:Field",
67
- "name": "sample_id",
68
- "description": "Unique case identifier.",
69
- "dataType": "Text",
70
  "source": {
71
- "fileObject": "manifest-csv",
 
 
72
  "extract": {
73
  "column": "sample_id"
74
  }
@@ -76,11 +70,12 @@
76
  },
77
  {
78
  "@type": "cr:Field",
79
- "name": "source_job_tag",
80
- "description": "Source job tag.",
81
- "dataType": "Text",
82
  "source": {
83
- "fileObject": "manifest-csv",
 
 
84
  "extract": {
85
  "column": "source_job_tag"
86
  }
@@ -88,11 +83,12 @@
88
  },
89
  {
90
  "@type": "cr:Field",
91
- "name": "weather_id",
92
- "description": "Weather/location identifier.",
93
- "dataType": "Text",
94
  "source": {
95
- "fileObject": "manifest-csv",
 
 
96
  "extract": {
97
  "column": "weather_id"
98
  }
@@ -100,11 +96,12 @@
100
  },
101
  {
102
  "@type": "cr:Field",
103
- "name": "building_id",
104
- "description": "Building identifier.",
105
- "dataType": "Text",
106
  "source": {
107
- "fileObject": "manifest-csv",
 
 
108
  "extract": {
109
  "column": "building_id"
110
  }
@@ -112,11 +109,12 @@
112
  },
113
  {
114
  "@type": "cr:Field",
115
- "name": "energy_file",
116
- "description": "Relative path to case energy file under energy/.",
117
- "dataType": "Text",
118
  "source": {
119
- "fileObject": "manifest-csv",
 
 
120
  "extract": {
121
  "column": "energy_file"
122
  }
@@ -124,11 +122,12 @@
124
  },
125
  {
126
  "@type": "cr:Field",
127
- "name": "n_steps",
128
- "description": "Number of time steps.",
129
- "dataType": "Integer",
130
  "source": {
131
- "fileObject": "manifest-csv",
 
 
132
  "extract": {
133
  "column": "n_steps"
134
  }
@@ -136,11 +135,12 @@
136
  },
137
  {
138
  "@type": "cr:Field",
139
- "name": "n_spaces",
140
- "description": "Number of spaces/zones.",
141
- "dataType": "Integer",
142
  "source": {
143
- "fileObject": "manifest-csv",
 
 
144
  "extract": {
145
  "column": "n_spaces"
146
  }
 
1
  {
2
  "@context": {
3
+ "@language": "en",
4
  "@vocab": "https://schema.org/",
5
+ "column": "cr:column",
6
+ "conformsTo": "dct:conformsTo",
7
  "cr": "http://mlcommons.org/croissant/",
8
+ "dataType": {
9
+ "@id": "cr:dataType",
10
+ "@type": "@vocab"
11
+ },
12
  "dct": "http://purl.org/dc/terms/",
13
+ "extract": "cr:extract",
14
+ "field": "cr:field",
15
+ "fileObject": "cr:fileObject",
16
+ "path": "cr:path",
17
+ "recordSet": "cr:recordSet",
18
+ "sc": "https://schema.org/",
19
+ "source": "cr:source"
20
  },
21
+ "@type": "sc:Dataset",
22
+ "name": "ArchEGraph-demo",
23
+ "description": "Compact demo package of the ArchEGraph building-energy dataset with stable manifest-based metadata.",
24
+ "conformsTo": "http://mlcommons.org/croissant/1.1",
25
+ "license": "other",
26
+ "url": "https://huggingface.co/datasets/ArchEGraph/ArchEGraph-demo",
27
  "distribution": [
28
  {
29
  "@type": "cr:FileObject",
30
+ "@id": "repo",
31
+ "name": "repo",
32
+ "description": "The Hugging Face git repository.",
33
+ "contentUrl": "https://huggingface.co/datasets/ArchEGraph/ArchEGraph-demo/tree/main",
34
+ "encodingFormat": "git+https"
 
 
 
 
 
 
 
 
 
 
 
 
 
35
  },
36
  {
37
+ "@type": "cr:FileObject",
38
+ "@id": "manifest-csv",
39
+ "containedIn": {
40
+ "@id": "repo"
41
+ },
42
+ "name": "manifest.csv",
43
+ "description": "Main case index for ArchEGraph-demo.",
44
+ "contentUrl": "https://huggingface.co/datasets/ArchEGraph/ArchEGraph-demo/resolve/main/manifest.csv",
 
 
 
 
 
 
 
 
 
 
45
  "encodingFormat": "text/csv"
46
  }
47
  ],
48
  "recordSet": [
49
  {
50
  "@type": "cr:RecordSet",
51
+ "@id": "manifest",
52
+ "name": "manifest",
53
+ "description": "Rows from manifest.csv.",
54
+ "key": {
55
+ "@id": "manifest/sample_id"
56
+ },
57
  "field": [
58
  {
59
  "@type": "cr:Field",
60
+ "@id": "manifest/sample_id",
61
+ "dataType": "sc:Text",
 
62
  "source": {
63
+ "fileObject": {
64
+ "@id": "manifest-csv"
65
+ },
66
  "extract": {
67
  "column": "sample_id"
68
  }
 
70
  },
71
  {
72
  "@type": "cr:Field",
73
+ "@id": "manifest/source_job_tag",
74
+ "dataType": "sc:Text",
 
75
  "source": {
76
+ "fileObject": {
77
+ "@id": "manifest-csv"
78
+ },
79
  "extract": {
80
  "column": "source_job_tag"
81
  }
 
83
  },
84
  {
85
  "@type": "cr:Field",
86
+ "@id": "manifest/weather_id",
87
+ "dataType": "sc:Text",
 
88
  "source": {
89
+ "fileObject": {
90
+ "@id": "manifest-csv"
91
+ },
92
  "extract": {
93
  "column": "weather_id"
94
  }
 
96
  },
97
  {
98
  "@type": "cr:Field",
99
+ "@id": "manifest/building_id",
100
+ "dataType": "cr:Int64",
 
101
  "source": {
102
+ "fileObject": {
103
+ "@id": "manifest-csv"
104
+ },
105
  "extract": {
106
  "column": "building_id"
107
  }
 
109
  },
110
  {
111
  "@type": "cr:Field",
112
+ "@id": "manifest/energy_file",
113
+ "dataType": "sc:Text",
 
114
  "source": {
115
+ "fileObject": {
116
+ "@id": "manifest-csv"
117
+ },
118
  "extract": {
119
  "column": "energy_file"
120
  }
 
122
  },
123
  {
124
  "@type": "cr:Field",
125
+ "@id": "manifest/n_steps",
126
+ "dataType": "cr:Int64",
 
127
  "source": {
128
+ "fileObject": {
129
+ "@id": "manifest-csv"
130
+ },
131
  "extract": {
132
  "column": "n_steps"
133
  }
 
135
  },
136
  {
137
  "@type": "cr:Field",
138
+ "@id": "manifest/n_spaces",
139
+ "dataType": "cr:Int64",
 
140
  "source": {
141
+ "fileObject": {
142
+ "@id": "manifest-csv"
143
+ },
144
  "extract": {
145
  "column": "n_spaces"
146
  }