Upload README.md
Browse files
README.md
CHANGED
|
@@ -485,6 +485,9 @@ 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 |
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,10 +499,13 @@ The `filter_cases.py` script supports selection by:
|
|
| 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,38 +516,57 @@ scripts/
|
|
| 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,10 +588,14 @@ python scripts/filter_cases.py \
|
|
| 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,10 +607,16 @@ python scripts/filter_cases.py \
|
|
| 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,6 +652,19 @@ PhysInOne/
|
|
| 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,6 +680,8 @@ In total, assets comply with licenses including CC BY-NC, CC BY-SA, CC BY-NC-SA,
|
|
| 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,6 +699,8 @@ If you use PhysInOne in your research, please cite:
|
|
| 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 |
|
|
|
|
| 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 |
- 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 |
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 |
+
</div>
|
| 552 |
<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>
|
| 553 |
<div style="margin-left: 48px;">
|
| 554 |
+
|
| 555 |
+
|
| 556 |
```bash
|
| 557 |
python scripts/filter_cases.py \
|
| 558 |
--split train \
|
| 559 |
--activity_type double \
|
| 560 |
--output selected_cases.json
|
| 561 |
```
|
|
|
|
| 562 |
|
| 563 |
+
|
| 564 |
+
|
| 565 |
+
</div>
|
| 566 |
<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>
|
| 567 |
<div style="margin-left: 48px;">
|
| 568 |
+
|
| 569 |
+
|
| 570 |
By default, phenomenon matching uses `contains` mode. For example, the following command selects all double-physics cases that contain `FrictionStop`:
|
| 571 |
|
| 572 |
```bash
|
|
|
|
| 588 |
--match_mode exact \
|
| 589 |
--output selected_cases.json
|
| 590 |
```
|
|
|
|
| 591 |
|
| 592 |
+
|
| 593 |
+
|
| 594 |
+
</div>
|
| 595 |
<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>
|
| 596 |
<div style="margin-left: 48px;">
|
| 597 |
+
|
| 598 |
+
|
| 599 |
`--num` is the global number of cases sampled after filtering. The default random seed is `42`.
|
| 600 |
|
| 601 |
```bash
|
|
|
|
| 607 |
--seed 42 \
|
| 608 |
--output selected_cases.json
|
| 609 |
```
|
|
|
|
| 610 |
|
| 611 |
+
|
| 612 |
+
|
| 613 |
+
|
| 614 |
+
</div>
|
| 615 |
<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>
|
| 616 |
<div style="margin-left: 24px;">
|
| 617 |
+
<div style="margin-left: 24px;">
|
| 618 |
+
|
| 619 |
+
|
| 620 |
Each selected case is downloaded as a zip file from the corresponding Hugging Face shard repository.
|
| 621 |
|
| 622 |
```bash
|
|
|
|
| 652 |
DoublePhysics/
|
| 653 |
AccelConcaveSpin_AccelSurfaceSpin__bg070__K5ER39_trajectory.zip
|
| 654 |
```
|
| 655 |
+
|
| 656 |
+
|
| 657 |
+
|
| 658 |
+
|
| 659 |
+
</div>
|
| 660 |
+
</div>
|
| 661 |
+
</div>
|
| 662 |
+
</div>
|
| 663 |
+
</div>
|
| 664 |
+
</div>
|
| 665 |
+
|
| 666 |
+
</div>
|
| 667 |
+
|
| 668 |
<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>
|
| 669 |
<div style="margin-left: 24px;">
|
| 670 |
|
|
|
|
| 680 |
|
| 681 |
> โ ๏ธ Note: PhysInOne is intended for **non-commercial research and educational purposes**. For commercial use, users must verify the licensing terms of individual assets.
|
| 682 |
|
| 683 |
+
</div>
|
| 684 |
+
|
| 685 |
<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>
|
| 686 |
<div style="margin-left: 24px;">
|
| 687 |
|
|
|
|
| 699 |
|
| 700 |
|
| 701 |
|
| 702 |
+
</div>
|
| 703 |
+
|
| 704 |
<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>
|
| 705 |
<div style="margin-left: 24px;">
|
| 706 |
|