vLAR commited on
Commit
28a27f3
·
verified ·
1 Parent(s): ab4cc78

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +189 -191
README.md CHANGED
@@ -182,25 +182,25 @@ homepage: https://vlar-group.github.io/PhysInOne.html
182
  <a href="#dataset-structure">📦 Dataset Structure</a><br>
183
  <a href="#data-splits">📊 Data Splits</a><br>
184
  <a href="#data-fields">🧩 Data Fields</a><br>
185
- &nbsp;&nbsp;&nbsp;• <a href="#physical-phenomena">Physical Phenomena</a><br>
186
  <a href="#annotation-details">📝 Annotation Details</a><br>
187
- &nbsp;&nbsp;&nbsp;• <a href="#depth">Depth</a><br>
188
- &nbsp;&nbsp;&nbsp;• <a href="#segmentation">Segmentation</a><br>
189
- &nbsp;&nbsp;&nbsp;• <a href="#captions">Captions</a><br>
190
- &nbsp;&nbsp;&nbsp;• <a href="#trajectories">Trajectories</a><br>
191
- &nbsp;&nbsp;&nbsp;• <a href="#cameras">Cameras</a><br>
192
- &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;◦ <a href="#camera-json-structure">Camera JSON structure</a><br>
193
- &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;◦ <a href="#dynamic-camera-behavior">Dynamic camera behavior</a><br>
194
- &nbsp;&nbsp;&nbsp;• <a href="#point-clouds">Point Clouds</a><br>
195
  <a href="#how-to-download">📥 How to Download</a><br>
196
- &nbsp;&nbsp;&nbsp;<a href="#download-scripts">1. Download Scripts</a><br>
197
- &nbsp;&nbsp;&nbsp;<a href="#install-dependencies">2. Install Dependencies</a><br>
198
- &nbsp;&nbsp;&nbsp;<a href="#filter-cases">3. Filter Cases</a><br>
199
- &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#filter-by-split">3.1 Split</a><br>
200
- &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#filter-by-split-and-activity">3.2 Split + Activity</a><br>
201
- &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#filter-by-phenomenon">3.3 Phenomenon</a><br>
202
- &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#random-sampling">3.4 Random Sampling</a><br>
203
- &nbsp;&nbsp;&nbsp;<a href="#download-selected-cases">4. Download Cases</a><br>
204
  <a href="#license">📜 License</a><br>
205
  <a href="#citation">📚 Citation</a><br>
206
  <a href="#contact">📮 Contact</a><br>
@@ -265,6 +265,172 @@ For large-scale downloading and filtering, please refer to the **How to Download
265
 
266
  </div>
267
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
268
  <h2 id="dataset-structure" style="margin-left: 0; font-size: 1.9em; line-height: 1.22; margin-top: 1.2em; margin-bottom: 0.5em;">📦 Dataset Structure</h2>
269
  <div style="margin-left: 24px;">
270
 
@@ -293,20 +459,18 @@ This design guarantees that training, validation, and test sets are fully separa
293
  <h3 id="physical-phenomena" style="font-size: 1.35em; margin-top: 0.75em; margin-bottom: 0.22em; line-height: 1.2; margin-left: 0;"><span style="display: inline-block; width: 1.08em;">•</span>Physical Phenomenon and Abbreviations</h3>
294
  <div style="margin-left: 16px;">
295
 
296
- | ID | Physical Phenomenon | Abbreviation | Related Physical Laws |
297
- | ----- | ------------------------------------------------------------------------- | --------------------- | ------------------------------------------------------- |
298
- | `P01` | Object collide with static, stationary objects | MovingHitsFixed | Laws of Momentum |
299
- | `P02` | Moving objects collide with non-static stationary objects | MovingHitsStationary | Laws of Momentum |
300
- | `P03` | Two moving objects collide | MovingHitsMoving | Laws of Momentum |
 
301
 
302
  <details>
303
  <summary>Click to expand full abbreviation table</summary>
304
 
305
  | ID | Physical Phenomenon | Abbreviation | Related Physical Laws |
306
  | ----- | ------------------------------------------------------------------------- | --------------------- | ------------------------------------------------------- |
307
- | `P01` | Object collide with static, stationary objects | MovingHitsFixed | Laws of Momentum |
308
- | `P02` | Moving objects collide with non-static stationary objects | MovingHitsStationary | Laws of Momentum |
309
- | `P03` | Two moving objects collide | MovingHitsMoving | Laws of Momentum |
310
  | `P04` | Objects in equilibrium of wind and gravity | WindGravityBalance | Equilibrium, Aerodynamics, Gravity |
311
  | `P05` | Wind applied to a stationary object | WindPushStationary | Aerodynamics |
312
  | `P06` | Wind applied to objects moving in same direction | WindPushSameDir | Aerodynamics |
@@ -475,172 +639,6 @@ The initial point cloud was obtained by back-projecting the pixels from each cam
475
 
476
  </div>
477
 
478
- <h2 id="how-to-download" style="margin-left: 0; font-size: 1.9em; line-height: 1.22; margin-top: 1.2em; margin-bottom: 0.5em;">📥 How to Download</h2>
479
-
480
- <div style="margin-left: 24px;">
481
-
482
- PhysInOne is distributed across multiple Hugging Face dataset repositories because of its large scale. We provide two scripts for selecting and downloading cases:
483
-
484
- - `filter_cases.py`: parses the case-to-repository assignment file and exports selected cases to JSON.
485
- - `download.py`: downloads the selected case zip files from the corresponding Hugging Face shard repositories.
486
-
487
- The `filter_cases.py` script supports selection by:
488
-
489
- - Split: `train`, `val`, `test`
490
- - Activity complexity: `single`, `double`, `triple`
491
- - Physical phenomenon abbreviation: `MovingHitsFixed`, `FrictionStop`, `LiquidTension`, ..., `GranularFall`
492
- - Number of cases: globally sample `num` cases after filtering
493
-
494
- </div>
495
-
496
- <h3 id="download-scripts" style="font-size: 1.35em; margin-top: 0.75em; margin-bottom: 0.22em; line-height: 1.2; margin-left: 24px;">1. Download Scripts</h3>
497
-
498
- <div style="margin-left: 40px;">
499
-
500
- Please download the `assets` folder, which contains:
501
-
502
- ```text
503
- metadata/
504
- repo_assignment.txt
505
- repo_map.json
506
- scripts/
507
- filter_cases.py
508
- download.py
509
- ```
510
-
511
- </div>
512
-
513
- <h3 id="install-dependencies" style="font-size: 1.35em; margin-top: 0.75em; margin-bottom: 0.22em; line-height: 1.2; margin-left: 24px;">2. Install Dependencies</h3>
514
-
515
- <div style="margin-left: 40px;">
516
-
517
- ```bash
518
- pip install huggingface_hub tqdm
519
- ```
520
-
521
- </div>
522
-
523
- <h3 id="filter-cases" style="font-size: 1.35em; margin-top: 0.75em; margin-bottom: 0.22em; line-height: 1.2; margin-left: 24px;">3. Filter Cases</h3>
524
-
525
- <div style="margin-left: 40px;">
526
-
527
- The following examples show common filtering workflows.
528
-
529
- </div>
530
-
531
- <h4 id="filter-by-split" style="font-size: 1.12em; margin-top: 0.55em; margin-bottom: 0.14em; line-height: 1.18; margin-left: 48px;">3.1 Filter by split</h4>
532
-
533
- <div style="margin-left: 64px;">
534
-
535
- ```bash
536
- python scripts/filter_cases.py \
537
- --split train \
538
- --output selected_cases.json
539
- ```
540
-
541
- </div>
542
-
543
- <h4 id="filter-by-split-and-activity" style="font-size: 1.12em; margin-top: 0.55em; margin-bottom: 0.14em; line-height: 1.18; margin-left: 48px;">3.2 Filter by split and activity complexity</h4>
544
-
545
- <div style="margin-left: 64px;">
546
-
547
- ```bash
548
- python scripts/filter_cases.py \
549
- --split train \
550
- --activity_type double \
551
- --output selected_cases.json
552
- ```
553
-
554
- </div>
555
-
556
- <h4 id="filter-by-phenomenon" style="font-size: 1.12em; margin-top: 0.55em; margin-bottom: 0.14em; line-height: 1.18; margin-left: 48px;">3.3 Filter by physical phenomenon abbreviation</h4>
557
-
558
- <div style="margin-left: 64px;">
559
-
560
- By default, phenomenon matching uses `contains` mode. For example, the following command selects all double-physics cases that contain `FrictionStop`:
561
-
562
- ```bash
563
- python scripts/filter_cases.py \
564
- --split train \
565
- --activity_type double \
566
- --phenomena FrictionStop \
567
- --match_mode contains \
568
- --output selected_cases.json
569
- ```
570
-
571
- For exact matching, use `--match_mode exact`. Order does not matter. For example, this command selects cases whose phenomenon set is exactly `{AccelConcaveSpin, AccelSurfaceSpin}`:
572
-
573
- ```bash
574
- python scripts/filter_cases.py \
575
- --split train \
576
- --activity_type double \
577
- --phenomena AccelConcaveSpin AccelSurfaceSpin \
578
- --match_mode exact \
579
- --output selected_cases.json
580
- ```
581
-
582
- </div>
583
-
584
- <h4 id="random-sampling" style="font-size: 1.12em; margin-top: 0.55em; margin-bottom: 0.14em; line-height: 1.18; margin-left: 48px;">3.4 Randomly sample a fixed number of cases</h4>
585
-
586
- <div style="margin-left: 64px;">
587
-
588
- `--num` is the global number of cases sampled after filtering. The default random seed is `42`.
589
-
590
- ```bash
591
- python scripts/filter_cases.py \
592
- --split train \
593
- --activity_type double \
594
- --phenomena FrictionStop \
595
- --num 3000 \
596
- --seed 42 \
597
- --output selected_cases.json
598
- ```
599
-
600
- </div>
601
-
602
- <h3 id="download-selected-cases" style="font-size: 1.35em; margin-top: 0.75em; margin-bottom: 0.22em; line-height: 1.2; margin-left: 24px;">4. Download Selected Cases</h3>
603
-
604
- <div style="margin-left: 40px;">
605
-
606
- Each selected case is downloaded as a zip file from the corresponding Hugging Face shard repository.
607
-
608
- ```bash
609
- python scripts/download.py \
610
- --selection selected_cases.json \
611
- --output_dir ./PhysInOne
612
- ```
613
-
614
- If the dataset repositories are gated or private, pass a Hugging Face token:
615
-
616
- ```bash
617
- python scripts/download.py \
618
- --selection selected_cases.json \
619
- --output_dir ./PhysInOne \
620
- --token YOUR_HF_TOKEN
621
- ```
622
-
623
- By default, downloaded zip files are saved into a flat output folder. To preserve shard/split/activity structure:
624
-
625
- ```bash
626
- python scripts/download.py \
627
- --selection selected_cases.json \
628
- --output_dir ./PhysInOne \
629
- --keep_shard_structure
630
- ```
631
-
632
- The preserved structure is:
633
-
634
- ```text
635
- PhysInOne/
636
- physinone_part1/
637
- Train/
638
- DoublePhysics/
639
- AccelConcaveSpin_AccelSurfaceSpin__bg070__K5ER39_trajectory.zip
640
- ```
641
-
642
- </div>
643
-
644
  <h2 id="license" style="margin-left: 0; font-size: 1.9em; line-height: 1.22; margin-top: 1.2em; margin-bottom: 0.5em;">📜 License</h2>
645
 
646
  <div style="margin-left: 24px;">
 
182
  <a href="#dataset-structure">📦 Dataset Structure</a><br>
183
  <a href="#data-splits">📊 Data Splits</a><br>
184
  <a href="#data-fields">🧩 Data Fields</a><br>
185
+ • <a href="#physical-phenomena">Physical Phenomena</a><br>
186
  <a href="#annotation-details">📝 Annotation Details</a><br>
187
+ • <a href="#depth">Depth</a><br>
188
+ • <a href="#segmentation">Segmentation</a><br>
189
+ • <a href="#captions">Captions</a><br>
190
+ • <a href="#trajectories">Trajectories</a><br>
191
+ • <a href="#cameras">Cameras</a><br>
192
+ ◦ <a href="#camera-json-structure">Camera JSON structure</a><br>
193
+ ◦ <a href="#dynamic-camera-behavior">Dynamic camera behavior</a><br>
194
+ • <a href="#point-clouds">Point Clouds</a><br>
195
  <a href="#how-to-download">📥 How to Download</a><br>
196
+ <a href="#download-scripts">1. Download Scripts</a><br>
197
+ <a href="#install-dependencies">2. Install Dependencies</a><br>
198
+ <a href="#filter-cases">3. Filter Cases</a><br>
199
+ <a href="#filter-by-split">3.1 Split</a><br>
200
+ <a href="#filter-by-split-and-activity">3.2 Split + Activity</a><br>
201
+ <a href="#filter-by-phenomenon">3.3 Phenomenon</a><br>
202
+ <a href="#random-sampling">3.4 Random Sampling</a><br>
203
+ <a href="#download-selected-cases">4. Download Cases</a><br>
204
  <a href="#license">📜 License</a><br>
205
  <a href="#citation">📚 Citation</a><br>
206
  <a href="#contact">📮 Contact</a><br>
 
265
 
266
  </div>
267
 
268
+ <h2 id="how-to-download" style="margin-left: 0; font-size: 1.9em; line-height: 1.22; margin-top: 1.2em; margin-bottom: 0.5em;">📥 How to Download</h2>
269
+
270
+ <div style="margin-left: 24px;">
271
+
272
+ PhysInOne is distributed across multiple Hugging Face dataset repositories because of its large scale. We provide two scripts for selecting and downloading cases:
273
+
274
+ - `filter_cases.py`: parses the case-to-repository assignment file and exports selected cases to JSON.
275
+ - `download.py`: downloads the selected case zip files from the corresponding Hugging Face shard repositories.
276
+
277
+ The `filter_cases.py` script supports selection by:
278
+
279
+ - Split: `train`, `val`, `test`
280
+ - Activity complexity: `single`, `double`, `triple`
281
+ - Physical phenomenon abbreviation: `MovingHitsFixed`, `FrictionStop`, `LiquidTension`, ..., `GranularFall`
282
+ - Number of cases: globally sample `num` cases after filtering
283
+
284
+ </div>
285
+
286
+ <h3 id="download-scripts" style="font-size: 1.35em; margin-top: 0.75em; margin-bottom: 0.22em; line-height: 1.2; margin-left: 24px;">1. Download Scripts</h3>
287
+
288
+ <div style="margin-left: 40px;">
289
+
290
+ Please download the `assets` folder, which contains:
291
+
292
+ ```text
293
+ metadata/
294
+ repo_assignment.txt
295
+ repo_map.json
296
+ scripts/
297
+ filter_cases.py
298
+ download.py
299
+ ```
300
+
301
+ </div>
302
+
303
+ <h3 id="install-dependencies" style="font-size: 1.35em; margin-top: 0.75em; margin-bottom: 0.22em; line-height: 1.2; margin-left: 24px;">2. Install Dependencies</h3>
304
+
305
+ <div style="margin-left: 40px;">
306
+
307
+ ```bash
308
+ pip install huggingface_hub tqdm
309
+ ```
310
+
311
+ </div>
312
+
313
+ <h3 id="filter-cases" style="font-size: 1.35em; margin-top: 0.75em; margin-bottom: 0.22em; line-height: 1.2; margin-left: 24px;">3. Filter Cases</h3>
314
+
315
+ <div style="margin-left: 40px;">
316
+
317
+ The following examples show common filtering workflows.
318
+
319
+ </div>
320
+
321
+ <h4 id="filter-by-split" style="font-size: 1.12em; margin-top: 0.55em; margin-bottom: 0.14em; line-height: 1.18; margin-left: 48px;">3.1 Filter by split</h4>
322
+
323
+ <div style="margin-left: 64px;">
324
+
325
+ ```bash
326
+ python scripts/filter_cases.py \
327
+ --split train \
328
+ --output selected_cases.json
329
+ ```
330
+
331
+ </div>
332
+
333
+ <h4 id="filter-by-split-and-activity" style="font-size: 1.12em; margin-top: 0.55em; margin-bottom: 0.14em; line-height: 1.18; margin-left: 48px;">3.2 Filter by split and activity complexity</h4>
334
+
335
+ <div style="margin-left: 64px;">
336
+
337
+ ```bash
338
+ python scripts/filter_cases.py \
339
+ --split train \
340
+ --activity_type double \
341
+ --output selected_cases.json
342
+ ```
343
+
344
+ </div>
345
+
346
+ <h4 id="filter-by-phenomenon" style="font-size: 1.12em; margin-top: 0.55em; margin-bottom: 0.14em; line-height: 1.18; margin-left: 48px;">3.3 Filter by physical phenomenon abbreviation</h4>
347
+
348
+ <div style="margin-left: 64px;">
349
+
350
+ By default, phenomenon matching uses `contains` mode. For example, the following command selects all double-physics cases that contain `FrictionStop`:
351
+
352
+ ```bash
353
+ python scripts/filter_cases.py \
354
+ --split train \
355
+ --activity_type double \
356
+ --phenomena FrictionStop \
357
+ --match_mode contains \
358
+ --output selected_cases.json
359
+ ```
360
+
361
+ For exact matching, use `--match_mode exact`. Order does not matter. For example, this command selects cases whose phenomenon set is exactly `{AccelConcaveSpin, AccelSurfaceSpin}`:
362
+
363
+ ```bash
364
+ python scripts/filter_cases.py \
365
+ --split train \
366
+ --activity_type double \
367
+ --phenomena AccelConcaveSpin AccelSurfaceSpin \
368
+ --match_mode exact \
369
+ --output selected_cases.json
370
+ ```
371
+
372
+ </div>
373
+
374
+ <h4 id="random-sampling" style="font-size: 1.12em; margin-top: 0.55em; margin-bottom: 0.14em; line-height: 1.18; margin-left: 48px;">3.4 Randomly sample a fixed number of cases</h4>
375
+
376
+ <div style="margin-left: 64px;">
377
+
378
+ `--num` is the global number of cases sampled after filtering. The default random seed is `42`.
379
+
380
+ ```bash
381
+ python scripts/filter_cases.py \
382
+ --split train \
383
+ --activity_type double \
384
+ --phenomena FrictionStop \
385
+ --num 3000 \
386
+ --seed 42 \
387
+ --output selected_cases.json
388
+ ```
389
+
390
+ </div>
391
+
392
+ <h3 id="download-selected-cases" style="font-size: 1.35em; margin-top: 0.75em; margin-bottom: 0.22em; line-height: 1.2; margin-left: 24px;">4. Download Selected Cases</h3>
393
+
394
+ <div style="margin-left: 40px;">
395
+
396
+ Each selected case is downloaded as a zip file from the corresponding Hugging Face shard repository.
397
+
398
+ ```bash
399
+ python scripts/download.py \
400
+ --selection selected_cases.json \
401
+ --output_dir ./PhysInOne
402
+ ```
403
+
404
+ If the dataset repositories are gated or private, pass a Hugging Face token:
405
+
406
+ ```bash
407
+ python scripts/download.py \
408
+ --selection selected_cases.json \
409
+ --output_dir ./PhysInOne \
410
+ --token YOUR_HF_TOKEN
411
+ ```
412
+
413
+ By default, downloaded zip files are saved into a flat output folder. To preserve shard/split/activity structure:
414
+
415
+ ```bash
416
+ python scripts/download.py \
417
+ --selection selected_cases.json \
418
+ --output_dir ./PhysInOne \
419
+ --keep_shard_structure
420
+ ```
421
+
422
+ The preserved structure is:
423
+
424
+ ```text
425
+ PhysInOne/
426
+ physinone_part1/
427
+ Train/
428
+ DoublePhysics/
429
+ AccelConcaveSpin_AccelSurfaceSpin__bg070__K5ER39_trajectory.zip
430
+ ```
431
+
432
+ </div>
433
+
434
  <h2 id="dataset-structure" style="margin-left: 0; font-size: 1.9em; line-height: 1.22; margin-top: 1.2em; margin-bottom: 0.5em;">📦 Dataset Structure</h2>
435
  <div style="margin-left: 24px;">
436
 
 
459
  <h3 id="physical-phenomena" style="font-size: 1.35em; margin-top: 0.75em; margin-bottom: 0.22em; line-height: 1.2; margin-left: 0;"><span style="display: inline-block; width: 1.08em;">•</span>Physical Phenomenon and Abbreviations</h3>
460
  <div style="margin-left: 16px;">
461
 
462
+ | ID | Physical Phenomenon | Abbreviation | Related Physical Laws |
463
+ | ----- | --------------------------------------------------------- | -------------------- | --------------------- |
464
+ | `P01` | Object collide with static, stationary objects | MovingHitsFixed | Laws of Momentum |
465
+ | `P02` | Moving objects collide with non-static stationary objects | MovingHitsStationary | Laws of Momentum |
466
+ | `P03` | Two moving objects collide | MovingHitsMoving | Laws of Momentum |
467
+ | `...` | ... | ... | ... |
468
 
469
  <details>
470
  <summary>Click to expand full abbreviation table</summary>
471
 
472
  | ID | Physical Phenomenon | Abbreviation | Related Physical Laws |
473
  | ----- | ------------------------------------------------------------------------- | --------------------- | ------------------------------------------------------- |
 
 
 
474
  | `P04` | Objects in equilibrium of wind and gravity | WindGravityBalance | Equilibrium, Aerodynamics, Gravity |
475
  | `P05` | Wind applied to a stationary object | WindPushStationary | Aerodynamics |
476
  | `P06` | Wind applied to objects moving in same direction | WindPushSameDir | Aerodynamics |
 
639
 
640
  </div>
641
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
642
  <h2 id="license" style="margin-left: 0; font-size: 1.9em; line-height: 1.22; margin-top: 1.2em; margin-bottom: 0.5em;">📜 License</h2>
643
 
644
  <div style="margin-left: 24px;">