Upload README.md
Browse files
README.md
CHANGED
|
@@ -484,9 +484,8 @@ The initial point cloud was obtained by back-projecting the pixels from each cam
|
|
| 484 |
</div>
|
| 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 |
|
|
@@ -501,10 +500,10 @@ The `filter_cases.py` script supports selection by:
|
|
| 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 |
|
|
@@ -517,28 +516,29 @@ scripts/
|
|
| 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 |
-
|
| 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 \
|
|
@@ -546,12 +546,11 @@ python scripts/filter_cases.py \
|
|
| 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 \
|
|
@@ -560,12 +559,11 @@ python scripts/filter_cases.py \
|
|
| 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 |
|
|
@@ -589,12 +587,11 @@ python scripts/filter_cases.py \
|
|
| 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 |
|
|
@@ -608,14 +605,11 @@ python scripts/filter_cases.py \
|
|
| 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 |
|
|
@@ -653,21 +647,11 @@ PhysInOne/
|
|
| 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 |
|
|
|
|
| 671 |
|
| 672 |
All 3D assets and materials included in PhysInOne have been sourced from publicly available platforms and verified to carry licenses compatible with non-commercial use. These include:
|
| 673 |
|
|
@@ -683,8 +667,8 @@ In total, assets comply with licenses including CC BY-NC, CC BY-SA, CC BY-NC-SA,
|
|
| 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 |
|
|
|
|
| 688 |
|
| 689 |
If you use PhysInOne in your research, please cite:
|
| 690 |
|
|
@@ -697,13 +681,11 @@ If you use PhysInOne in your research, please cite:
|
|
| 697 |
}
|
| 698 |
```
|
| 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 |
|
|
|
|
| 707 |
|
| 708 |
For questions about the dataset, please contact:
|
| 709 |
|
|
|
|
| 484 |
</div>
|
| 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 |
|
| 488 |
+
<div style="margin-left: 24px;">
|
| 489 |
|
| 490 |
PhysInOne is distributed across multiple Hugging Face dataset repositories because of its large scale. We provide two scripts for selecting and downloading cases:
|
| 491 |
|
|
|
|
| 500 |
- Number of cases: globally sample `num` cases after filtering
|
| 501 |
|
| 502 |
</div>
|
| 503 |
+
|
| 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 |
|
| 506 |
+
<div style="margin-left: 24px;">
|
| 507 |
|
| 508 |
Please download the `assets` folder, which contains:
|
| 509 |
|
|
|
|
| 516 |
download.py
|
| 517 |
```
|
| 518 |
|
|
|
|
| 519 |
</div>
|
| 520 |
+
|
| 521 |
<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>
|
|
|
|
|
|
|
| 522 |
|
| 523 |
+
<div style="margin-left: 24px;">
|
| 524 |
|
| 525 |
```bash
|
| 526 |
pip install huggingface_hub tqdm
|
| 527 |
```
|
| 528 |
|
|
|
|
| 529 |
</div>
|
| 530 |
+
|
| 531 |
<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>
|
| 532 |
+
|
| 533 |
<div style="margin-left: 24px;">
|
| 534 |
|
| 535 |
+
The following examples show common filtering workflows.
|
| 536 |
|
| 537 |
</div>
|
| 538 |
+
|
| 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 |
|
| 541 |
+
<div style="margin-left: 48px;">
|
| 542 |
|
| 543 |
```bash
|
| 544 |
python scripts/filter_cases.py \
|
|
|
|
| 546 |
--output selected_cases.json
|
| 547 |
```
|
| 548 |
|
|
|
|
|
|
|
| 549 |
</div>
|
| 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 |
|
| 553 |
+
<div style="margin-left: 48px;">
|
| 554 |
|
| 555 |
```bash
|
| 556 |
python scripts/filter_cases.py \
|
|
|
|
| 559 |
--output selected_cases.json
|
| 560 |
```
|
| 561 |
|
|
|
|
|
|
|
| 562 |
</div>
|
| 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 |
|
| 566 |
+
<div style="margin-left: 48px;">
|
| 567 |
|
| 568 |
By default, phenomenon matching uses `contains` mode. For example, the following command selects all double-physics cases that contain `FrictionStop`:
|
| 569 |
|
|
|
|
| 587 |
--output selected_cases.json
|
| 588 |
```
|
| 589 |
|
|
|
|
|
|
|
| 590 |
</div>
|
| 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 |
|
| 594 |
+
<div style="margin-left: 48px;">
|
| 595 |
|
| 596 |
`--num` is the global number of cases sampled after filtering. The default random seed is `42`.
|
| 597 |
|
|
|
|
| 605 |
--output selected_cases.json
|
| 606 |
```
|
| 607 |
|
|
|
|
|
|
|
|
|
|
| 608 |
</div>
|
| 609 |
+
|
| 610 |
<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>
|
|
|
|
|
|
|
| 611 |
|
| 612 |
+
<div style="margin-left: 24px;">
|
| 613 |
|
| 614 |
Each selected case is downloaded as a zip file from the corresponding Hugging Face shard repository.
|
| 615 |
|
|
|
|
| 647 |
AccelConcaveSpin_AccelSurfaceSpin__bg070__K5ER39_trajectory.zip
|
| 648 |
```
|
| 649 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 650 |
</div>
|
| 651 |
|
| 652 |
<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>
|
|
|
|
| 653 |
|
| 654 |
+
<div style="margin-left: 24px;">
|
| 655 |
|
| 656 |
All 3D assets and materials included in PhysInOne have been sourced from publicly available platforms and verified to carry licenses compatible with non-commercial use. These include:
|
| 657 |
|
|
|
|
| 667 |
</div>
|
| 668 |
|
| 669 |
<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>
|
|
|
|
| 670 |
|
| 671 |
+
<div style="margin-left: 24px;">
|
| 672 |
|
| 673 |
If you use PhysInOne in your research, please cite:
|
| 674 |
|
|
|
|
| 681 |
}
|
| 682 |
```
|
| 683 |
|
|
|
|
|
|
|
| 684 |
</div>
|
| 685 |
|
| 686 |
<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>
|
|
|
|
| 687 |
|
| 688 |
+
<div style="margin-left: 24px;">
|
| 689 |
|
| 690 |
For questions about the dataset, please contact:
|
| 691 |
|