ArchEGraph commited on
Commit
ef1bbb8
·
1 Parent(s): cc8280b

Adapt dataset card to demo package

Browse files
Files changed (1) hide show
  1. README.md +21 -22
README.md CHANGED
@@ -1,5 +1,5 @@
1
  ---
2
- pretty_name: PACK
3
  license: other
4
  task_categories:
5
  - graph-ml
@@ -11,30 +11,31 @@ tags:
11
  - simulation
12
  - graph
13
  - weather
 
14
  size_categories:
15
- - 10K<n<100K
16
  ---
17
 
18
- # PACK
19
 
20
- PACK is a building-energy dataset organized for graph-based and weather-conditioned learning.
21
 
22
  ## Dataset Summary
23
 
24
- - Total cases in `manifest.csv`: 49,326
25
- - Unique buildings: 5,481
26
- - Unique weather IDs: 64
27
- - `n_steps` range: 968 to 8,760
28
- - `n_spaces` range: 1 to 231
29
 
30
- This repository currently stores:
31
 
32
- - `manifest.csv` (index of all cases)
33
- - `building/` (5,481 files)
34
- - `geometry/` (5,482 files)
35
- - `weather/` (64 files)
36
- - `energy/` (49,326 files; nested under subfolders like `00/`)
37
- - `split/` (predefined split CSV files)
38
 
39
  ## Data Layout
40
 
@@ -50,11 +51,8 @@ Each row in `manifest.csv` contains:
50
 
51
  ## Included Split Files
52
 
53
- - `split/split_p.csv` (30,658 rows)
54
- - `split/split_m.csv` (18,668 rows)
55
  - `split/split_demo.csv` (300 rows)
56
- - `split/split_building_bias.csv` (3,000 rows)
57
- - `split/split_weather_bias.csv` (3,000 rows)
58
 
59
  Each split CSV uses the same columns:
60
 
@@ -80,8 +78,9 @@ print(energy_path, building_path, weather_path)
80
 
81
  ## Notes
82
 
83
- - Energy files are stored in nested folders referenced by `energy_file`; do not assume all files are directly under `energy/`.
84
- - If you need a smaller download, use a demo subset generated from `split/split_demo.csv`.
 
85
 
86
  ## Citation
87
 
 
1
  ---
2
+ pretty_name: ArchEGraph-demo
3
  license: other
4
  task_categories:
5
  - graph-ml
 
11
  - simulation
12
  - graph
13
  - weather
14
+ - demo
15
  size_categories:
16
+ - n<1K
17
  ---
18
 
19
+ # ArchEGraph-demo
20
 
21
+ ArchEGraph-demo is a compact demo package of the ArchEGraph building-energy dataset for graph-based and weather-conditioned learning.
22
 
23
  ## Dataset Summary
24
 
25
+ - Total cases in `manifest.csv`: 300
26
+ - Unique buildings: 75
27
+ - Unique weather IDs: 48
28
+ - `n_steps`: always 8,760
29
+ - `n_spaces` range: 2 to 132
30
 
31
+ This package currently stores:
32
 
33
+ - `manifest.csv` (index of all demo cases)
34
+ - `building/` (75 files)
35
+ - `geometry/` (75 files)
36
+ - `weather/` (48 files)
37
+ - `energy/` (300 files)
38
+ - `split/` (demo split CSV files)
39
 
40
  ## Data Layout
41
 
 
51
 
52
  ## Included Split Files
53
 
 
 
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
 
 
78
 
79
  ## Notes
80
 
81
+ - This repository is the demo package, not the full PACK release.
82
+ - Energy files in this demo package are referenced by `energy_file` from `manifest.csv`.
83
+ - `split/split_demo.csv` and `split/split_demo_mesh.csv` provide ready-to-use predefined splits for the packaged demo samples.
84
 
85
  ## Citation
86