PhysInOneP02 commited on
Commit
a2cfe1b
ยท
verified ยท
1 Parent(s): 61d2e6c

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +25 -175
README.md CHANGED
@@ -118,10 +118,9 @@ The dataset is designed to support research on physics-aware video generation, f
118
  | Leaderboard | `โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘` 0% | Ongoing | Link will be added when available |
119
  | Baseline code | `โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘` 0% | Not released | Expected around June |
120
  | Data processing | `โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘` 0% | Not released | Expected around June |
 
121
 
122
- ## ๐Ÿ”Ž Dataset Viewer
123
-
124
- The Hugging Face Dataset Viewer is designed to help users quickly search, filter, and export scene-level metadata without downloading the full dataset.
125
 
126
  ### Filtering and Search
127
 
@@ -133,128 +132,49 @@ The viewer should support filtering by:
133
  - **Split:** `train`, `val`, `test`
134
  - **Availability:** rendered data, 3D assets, annotations, benchmark subset
135
 
136
- ### Viewer Table
137
-
138
- After selecting filters, the viewer should display a dataframe-like table with at least the following columns:
139
-
140
- | Column | Description |
141
- | ----------------- | ------------------------------------------------------------- |
142
- | `id` | Unique scene identifier |
143
- | `scene_name` | Human-readable scene name |
144
- | `split` | Train / validation / test split |
145
- | `activity_type` | Single-, double-, or triple-physics activity |
146
- | `physical_domain` | Mechanics, fluid dynamics, optics, or magnetism |
147
- | `phenomena` | Physical phenomena involved in the scene |
148
- | `ue_path` | Unreal Engine scene or asset path |
149
- | `repo_link` | Link to the corresponding repository item or hosted data page |
150
- | `download_link` | Direct download link for the scene package or rendered data |
151
-
152
- ### JSON Export
153
-
154
- The viewer should provide an **Export JSON** button. The exported JSON should contain selected scenes and their download links.
155
-
156
- Example export format:
157
-
158
- ```json
159
- {
160
- "selected_scenes": [
161
- {
162
- "id": "scene_000000",
163
- "scene_name": "TODO",
164
- "download_link": "TODO"
165
- },
166
- {
167
- "id": "scene_000001",
168
- "scene_name": "TODO",
169
- "download_link": "TODO"
170
- }
171
- ]
172
- }
173
- ```
174
-
175
- This JSON file can be passed directly to the download script.
176
-
177
- ## ๐Ÿ“ฅ How to Use
178
-
179
- Install Dependencies
180
 
181
  ```bash
182
  pip install datasets huggingface_hub pandas tqdm
183
  ```
184
 
185
- ### Download Metadata Only
186
-
187
- ```bash
188
- huggingface-cli download TODO/PhysInOne \
189
- --include "metadata/*" \
190
- --local-dir ./PhysInOne
191
- ```
192
-
193
- ### Download by Exported JSON
194
-
195
- After selecting scenes in the Dataset Viewer, export the selected scene list as JSON and download the corresponding files:
196
 
197
  ```bash
198
  python scripts/download.py \
199
- --selection selected_scenes.json \
200
  --output_dir ./PhysInOne
201
  ```
202
 
203
- ### Download a Split
204
 
205
  ```bash
206
  python scripts/download.py \
207
  --split train \
 
 
 
 
208
  --output_dir ./PhysInOne
209
  ```
210
 
 
 
211
  ```bash
212
- python scripts/download.py \
213
- --split val \
214
- --output_dir ./PhysInOne
 
 
 
215
  ```
216
 
217
  ```bash
218
  python scripts/download.py \
219
- --split test \
220
  --output_dir ./PhysInOne
221
  ```
222
 
223
- ### Load Metadata
224
-
225
- ```python
226
- import json
227
- from pathlib import Path
228
-
229
- metadata_path = Path("./PhysInOne/metadata/train.jsonl")
230
-
231
- with open(metadata_path, "r") as f:
232
- sample = json.loads(next(f))
233
-
234
- print("ID:", sample["id"])
235
- print("Scene name:", sample["scene_name"])
236
- print("Split:", sample["split"])
237
- print("Physical domains:", sample["physical_domains"])
238
- print("Phenomena:", sample["physical_phenomena"])
239
- print("Download link:", sample["download_link"])
240
- ```
241
-
242
- ### Visualize a Scene
243
-
244
- ```bash
245
- python scripts/visualize_sample.py \
246
- --scene_id scene_000000 \
247
- --data_root ./PhysInOne
248
- ```
249
-
250
- ## ๐ŸŽฌ Benchmark Subsets
251
-
252
- We provide mini benchmark subsets for lightweight evaluation and quick prototyping.
253
-
254
- | Subset | Size | Intended Use |
255
- | ----------- | ----------:| ------------------------------------------------ |
256
- | `test-mini` | 103 scenes | Long-term and short-term future frame prediction |
257
-
258
  ## ๐ŸŽฌ Visual Overview
259
 
260
  <p align="center">
@@ -303,7 +223,7 @@ PhysInOne/
303
  โ””โ”€โ”€ visualize_sample.py
304
  ```
305
 
306
- ### Data Splits
307
 
308
  PhysInOne is split into train, validation, and test sets. Each split is intended for a different stage of model development and evaluation.
309
 
@@ -516,87 +436,17 @@ annotations/pointclouds/{split}/{scene_id}/points.ply
516
 
517
  Please specify whether point colors, normals, semantic labels, or instance labels are included in the `.ply` file.
518
 
519
- ## Supported Tasks and Benchmarks
520
 
521
  PhysInOne supports the following visual physics learning and reasoning tasks.
522
 
523
- ### Physics-aware Video Generation
524
-
525
- Given text prompts, image conditions, or initial frames, models generate videos that should be visually realistic and physically plausible.
526
-
527
- Representative settings:
528
-
529
- - Text-to-video generation
530
- - Image-to-video generation
531
- - Text-image-to-video generation
532
- - Video model fine-tuning with physics-rich data
533
-
534
- Suggested metrics:
535
-
536
- - PMF: Physical Motion Fidelity
537
- - FVD
538
- - Human physical plausibility rating
539
-
540
- ### Long-term Future Frame Prediction
541
-
542
- Given the first half of a dynamic scene, models predict the second half of the video.
543
-
544
- Representative settings:
545
-
546
- - Seen-view prediction
547
- - Novel-view prediction
548
- - Scene-specific 4D modeling
549
- - Video prediction
550
-
551
- Suggested metrics:
552
-
553
- - PMF
554
- - PSNR
555
- - SSIM
556
- - LPIPS
557
-
558
- ### Continuous Short-term Future Frame Prediction
559
-
560
- Given streaming observations, models continuously predict the next few frames.
561
-
562
- This setting is useful for:
563
-
564
- - Future-aware robot planning
565
- - Embodied AI
566
- - Short-horizon physical prediction
567
- - Dynamic scene understanding
568
-
569
- Suggested metrics:
570
-
571
- - PMF
572
- - PSNR
573
- - SSIM
574
- - LPIPS
575
-
576
- ### Physical Property Estimation
577
-
578
- Given visual observations, models estimate physical properties of scene objects and materials.
579
-
580
- Example target properties:
581
-
582
- - Young's modulus
583
- - Poisson's ratio
584
- - Viscosity
585
- - Bulk modulus
586
- - Yield stress
587
- - Friction angle
588
- - Initial velocity
589
-
590
- ### Motion Transfer
591
 
592
- Given a source video and a target image or target scene, models transfer physically meaningful motion patterns while preserving the target appearance.
593
 
594
- Suggested metrics:
595
 
596
- - PMF
597
- - PSNR
598
- - SSIM
599
- - LPIPS
600
 
601
  ## ๐Ÿ“œ License
602
 
 
118
  | Leaderboard | `โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘` 0% | Ongoing | Link will be added when available |
119
  | Baseline code | `โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘` 0% | Not released | Expected around June |
120
  | Data processing | `โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘` 0% | Not released | Expected around June |
121
+ | SubSet | `โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆ`100% | Released | |
122
 
123
+ ## ๐Ÿ“ฅ How to Use
 
 
124
 
125
  ### Filtering and Search
126
 
 
132
  - **Split:** `train`, `val`, `test`
133
  - **Availability:** rendered data, 3D assets, annotations, benchmark subset
134
 
135
+ ### Install Dependencies
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
136
 
137
  ```bash
138
  pip install datasets huggingface_hub pandas tqdm
139
  ```
140
 
141
+ ### Download a Split
 
 
 
 
 
 
 
 
 
 
142
 
143
  ```bash
144
  python scripts/download.py \
145
+ --split train \
146
  --output_dir ./PhysInOne
147
  ```
148
 
149
+ ### Download by Exported JSON
150
 
151
  ```bash
152
  python scripts/download.py \
153
  --split train \
154
+ --activity_type double \
155
+ --domain mechanics \
156
+ --phenomena P01 P03 \
157
+ --modalities rgb depth seg \
158
  --output_dir ./PhysInOne
159
  ```
160
 
161
+ ### Download by Exported JSON
162
+
163
  ```bash
164
+ python scripts/filter_cases.py \
165
+ --split train \
166
+ --domain mechanics \
167
+ --activity_type double \
168
+ --phenomena P01 P03 \
169
+ --output selected_cases.json
170
  ```
171
 
172
  ```bash
173
  python scripts/download.py \
174
+ --selection selected_scenes.json \
175
  --output_dir ./PhysInOne
176
  ```
177
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
178
  ## ๐ŸŽฌ Visual Overview
179
 
180
  <p align="center">
 
223
  โ””โ”€โ”€ visualize_sample.py
224
  ```
225
 
226
+ ### ๐Ÿ“Š Data Splits
227
 
228
  PhysInOne is split into train, validation, and test sets. Each split is intended for a different stage of model development and evaluation.
229
 
 
436
 
437
  Please specify whether point colors, normals, semantic labels, or instance labels are included in the `.ply` file.
438
 
439
+ ## ๐Ÿงช Supported Tasks and Benchmarks
440
 
441
  PhysInOne supports the following visual physics learning and reasoning tasks.
442
 
443
+ - Physics-aware Video Generation
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
444
 
445
+ - Long-term and Short-term Future Frame Prediction
446
 
447
+ - Physical Property Estimation
448
 
449
+ - Motion Transfer
 
 
 
450
 
451
  ## ๐Ÿ“œ License
452