vLAR commited on
Commit
3d6463e
ยท
verified ยท
1 Parent(s): ff7e346

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +7 -55
README.md CHANGED
@@ -485,9 +485,6 @@ The initial point cloud was obtained by back-projecting the pixels from each cam
485
 
486
  <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>
487
  <div style="margin-left: 24px;">
488
- <div style="margin-left: 24px;">
489
-
490
-
491
  PhysInOne is distributed across multiple Hugging Face dataset repositories because of its large scale. We provide two scripts for selecting and downloading cases:
492
 
493
  - `filter_cases.py`: parses the case-to-repository assignment file and exports selected cases to JSON.
@@ -499,13 +496,10 @@ The `filter_cases.py` script supports selection by:
499
  - Activity complexity: `single`, `double`, `triple`
500
  - Physical phenomenon abbreviation: `MovingHitsFixed`, `FrictionStop`, `LiquidTension`, ..., `GranularFall`
501
  - Number of cases: globally sample `num` cases after filtering
502
-
503
  </div>
 
504
  <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>
505
  <div style="margin-left: 24px;">
506
- <div style="margin-left: 24px;">
507
-
508
-
509
  Please download the `assets` folder, which contains:
510
 
511
  ```text
@@ -516,55 +510,38 @@ scripts/
516
  filter_cases.py
517
  download.py
518
  ```
519
-
520
-
521
  </div>
 
522
  <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>
523
  <div style="margin-left: 24px;">
524
- <div style="margin-left: 24px;">
525
-
526
-
527
  ```bash
528
  pip install huggingface_hub tqdm
529
  ```
530
-
531
-
532
  </div>
533
- <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>
534
- <div style="margin-left: 24px;">
535
- <div style="margin-left: 24px;">
536
 
 
537
 
538
- </div>
539
  <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>
540
  <div style="margin-left: 48px;">
541
-
542
-
543
  ```bash
544
  python scripts/filter_cases.py \
545
  --split train \
546
  --output selected_cases.json
547
  ```
548
-
549
-
550
 
551
  <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>
552
  <div style="margin-left: 48px;">
553
-
554
-
555
  ```bash
556
  python scripts/filter_cases.py \
557
  --split train \
558
  --activity_type double \
559
  --output selected_cases.json
560
  ```
561
-
562
-
563
 
564
  <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>
565
  <div style="margin-left: 48px;">
566
-
567
-
568
  By default, phenomenon matching uses `contains` mode. For example, the following command selects all double-physics cases that contain `FrictionStop`:
569
 
570
  ```bash
@@ -586,13 +563,10 @@ python scripts/filter_cases.py \
586
  --match_mode exact \
587
  --output selected_cases.json
588
  ```
589
-
590
-
591
 
592
  <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>
593
  <div style="margin-left: 48px;">
594
-
595
-
596
  `--num` is the global number of cases sampled after filtering. The default random seed is `42`.
597
 
598
  ```bash
@@ -604,15 +578,10 @@ python scripts/filter_cases.py \
604
  --seed 42 \
605
  --output selected_cases.json
606
  ```
607
-
608
-
609
-
610
 
611
  <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>
612
  <div style="margin-left: 24px;">
613
- <div style="margin-left: 24px;">
614
-
615
-
616
  Each selected case is downloaded as a zip file from the corresponding Hugging Face shard repository.
617
 
618
  ```bash
@@ -648,19 +617,6 @@ PhysInOne/
648
  DoublePhysics/
649
  AccelConcaveSpin_AccelSurfaceSpin__bg070__K5ER39_trajectory.zip
650
  ```
651
-
652
-
653
-
654
-
655
- </div>
656
- </div>
657
- </div>
658
- </div>
659
- </div>
660
- </div>
661
-
662
- </div>
663
-
664
  <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>
665
  <div style="margin-left: 24px;">
666
 
@@ -676,8 +632,6 @@ In total, assets comply with licenses including CC BY-NC, CC BY-SA, CC BY-NC-SA,
676
 
677
  > โš ๏ธ Note: PhysInOne is intended for **non-commercial research and educational purposes**. For commercial use, users must verify the licensing terms of individual assets.
678
 
679
- </div>
680
-
681
  <h2 id="citation" style="margin-left: 0; font-size: 1.9em; line-height: 1.22; margin-top: 1.2em; margin-bottom: 0.5em;">๐Ÿ“š Citation</h2>
682
  <div style="margin-left: 24px;">
683
 
@@ -695,8 +649,6 @@ If you use PhysInOne in your research, please cite:
695
 
696
 
697
 
698
- </div>
699
-
700
  <h2 id="contact" style="margin-left: 0; font-size: 1.9em; line-height: 1.22; margin-top: 1.2em; margin-bottom: 0.5em;">๐Ÿ“ฎ Contact</h2>
701
  <div style="margin-left: 24px;">
702
 
 
485
 
486
  <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>
487
  <div style="margin-left: 24px;">
 
 
 
488
  PhysInOne is distributed across multiple Hugging Face dataset repositories because of its large scale. We provide two scripts for selecting and downloading cases:
489
 
490
  - `filter_cases.py`: parses the case-to-repository assignment file and exports selected cases to JSON.
 
496
  - Activity complexity: `single`, `double`, `triple`
497
  - Physical phenomenon abbreviation: `MovingHitsFixed`, `FrictionStop`, `LiquidTension`, ..., `GranularFall`
498
  - Number of cases: globally sample `num` cases after filtering
 
499
  </div>
500
+
501
  <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>
502
  <div style="margin-left: 24px;">
 
 
 
503
  Please download the `assets` folder, which contains:
504
 
505
  ```text
 
510
  filter_cases.py
511
  download.py
512
  ```
 
 
513
  </div>
514
+
515
  <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>
516
  <div style="margin-left: 24px;">
 
 
 
517
  ```bash
518
  pip install huggingface_hub tqdm
519
  ```
 
 
520
  </div>
 
 
 
521
 
522
+ <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>
523
 
 
524
  <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>
525
  <div style="margin-left: 48px;">
 
 
526
  ```bash
527
  python scripts/filter_cases.py \
528
  --split train \
529
  --output selected_cases.json
530
  ```
531
+ </div>
 
532
 
533
  <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>
534
  <div style="margin-left: 48px;">
 
 
535
  ```bash
536
  python scripts/filter_cases.py \
537
  --split train \
538
  --activity_type double \
539
  --output selected_cases.json
540
  ```
541
+ </div>
 
542
 
543
  <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>
544
  <div style="margin-left: 48px;">
 
 
545
  By default, phenomenon matching uses `contains` mode. For example, the following command selects all double-physics cases that contain `FrictionStop`:
546
 
547
  ```bash
 
563
  --match_mode exact \
564
  --output selected_cases.json
565
  ```
566
+ </div>
 
567
 
568
  <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>
569
  <div style="margin-left: 48px;">
 
 
570
  `--num` is the global number of cases sampled after filtering. The default random seed is `42`.
571
 
572
  ```bash
 
578
  --seed 42 \
579
  --output selected_cases.json
580
  ```
581
+ </div>
 
 
582
 
583
  <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>
584
  <div style="margin-left: 24px;">
 
 
 
585
  Each selected case is downloaded as a zip file from the corresponding Hugging Face shard repository.
586
 
587
  ```bash
 
617
  DoublePhysics/
618
  AccelConcaveSpin_AccelSurfaceSpin__bg070__K5ER39_trajectory.zip
619
  ```
 
 
 
 
 
 
 
 
 
 
 
 
 
620
  <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>
621
  <div style="margin-left: 24px;">
622
 
 
632
 
633
  > โš ๏ธ Note: PhysInOne is intended for **non-commercial research and educational purposes**. For commercial use, users must verify the licensing terms of individual assets.
634
 
 
 
635
  <h2 id="citation" style="margin-left: 0; font-size: 1.9em; line-height: 1.22; margin-top: 1.2em; margin-bottom: 0.5em;">๐Ÿ“š Citation</h2>
636
  <div style="margin-left: 24px;">
637
 
 
649
 
650
 
651
 
 
 
652
  <h2 id="contact" style="margin-left: 0; font-size: 1.9em; line-height: 1.22; margin-top: 1.2em; margin-bottom: 0.5em;">๐Ÿ“ฎ Contact</h2>
653
  <div style="margin-left: 24px;">
654