vLAR commited on
Commit
344574b
Β·
verified Β·
1 Parent(s): 51f6748

Document normalized public downloads

Browse files
Files changed (1) hide show
  1. README.md +37 -30
README.md CHANGED
@@ -493,29 +493,23 @@ The public 3D asset release is now <strong>50% complete</strong>. It contains th
493
 
494
  The seven training archives add approximately <strong>51.61 GiB</strong> of backgrounds, raw backgrounds, breakable objects, interactable objects, solid objects, appearance materials, and physical materials. Training Scene maps and training Sequence/Trajectory assets are <strong>not released yet</strong>.
495
 
496
- - [Browse the `PhysicBenchmark` project](https://huggingface.co/datasets/vLAR/PhysInOne/tree/main/3D%20Assets/PhysicBenchmark)
497
- - [Download and setup guide](https://huggingface.co/datasets/vLAR/PhysInOne/blob/main/PhysInOne%20Utils/3D_ASSETS_DOWNLOAD.md)
498
- - [Automated downloader](https://huggingface.co/datasets/vLAR/PhysInOne/blob/main/PhysInOne%20Utils/scripts/download_3d_assets.py)
499
- - [Exact validation release list](https://huggingface.co/datasets/vLAR/PhysInOne/blob/main/PhysInOne%20Utils/3d_assets_lists/validation.txt)
500
 
501
- Install <strong>Unreal Engine 5.5.4</strong>. Windows is recommended for the simplest setup; Linux is also supported with additional platform configuration. The automated downloader currently retrieves and assembles the exact 1,000-scene validation project subset, safely extracts its eight ZIP files into their correct parent directories, preserves the Unreal Engine package hierarchy, supports interrupted-run recovery, and records detailed logs. The newly released training resource archives are available in their corresponding category folders in the project browser linked above.
502
 
503
  ```bash
504
- pip install -U huggingface_hub tqdm
505
-
506
- hf download vLAR/PhysInOne \
507
- "PhysInOne Utils/scripts/download_3d_assets.py" \
508
- --repo-type dataset \
509
- --local-dir .
510
-
511
- python "PhysInOne Utils/scripts/download_3d_assets.py" \
512
- --output-dir ./PhysInOne-3D-Assets
513
  ```
514
 
515
  After download and extraction, open:
516
 
517
  ```text
518
- PhysInOne-3D-Assets/3D Assets/PhysicBenchmark/PhysInOne.uproject
519
  ```
520
 
521
  Do not rename or flatten directories such as `Content/PhysInOne/`, `Content/__ExternalActors__/`, or `Content/__ExternalObjects__/`; Unreal Engine asset references depend on the exact project-relative structure. See the full setup guide for manual extraction paths, disk-space guidance, resume behavior, and troubleshooting.
@@ -534,24 +528,37 @@ All user-facing evaluation inputs required for the four PhysInOne Leaderboard ta
534
  | [Physical Properties Estimation](https://huggingface.co/datasets/vLAR/PhysInOne/tree/main/Leaderboard/Physical%20Properties%20Estimation) | 72 scene ZIPs + 2 shared files | Training/novel-view inputs, camera metadata, and shared supplementary resources |
535
  | [Motion Transfer](https://huggingface.co/datasets/vLAR/PhysInOne/tree/main/Leaderboard/Motion%20Transfer) | 217 ZIPs | Source videos, target reference frames, and captions |
536
 
537
- Install the downloader dependency and download any task as follows:
538
 
539
  ```bash
540
- pip install -U huggingface_hub tqdm
 
 
541
 
542
- hf download vLAR/PhysInOne \
543
- "PhysInOne Utils/scripts/download_leaderboard.py" \
544
- --repo-type dataset \
545
- --local-dir .
546
 
547
- python "PhysInOne Utils/scripts/download_leaderboard.py" \
548
- --task future-prediction \
549
- --output-dir ./PhysInOne-Leaderboard
550
- ```
 
 
 
 
 
 
 
 
 
 
 
 
 
 
551
 
552
- The script automatically retrieves the maintained TXT manifest for each selected task and revision from this public repository; users do not need to download any manifest files manually. Use `--task all` to download all four tasks, `--scene SCENE_ID` to select individual scenes, or `--extract` to validate and extract scene ZIPs. Downloads are resumable, and every run records successes and failures for review.
553
 
554
- See the full [Leaderboard download guide](https://huggingface.co/datasets/vLAR/PhysInOne/blob/main/PhysInOne%20Utils/LEADERBOARD_DOWNLOAD.md) for options and examples. The [task manifests](https://huggingface.co/datasets/vLAR/PhysInOne/tree/main/PhysInOne%20Utils/leaderboard_lists) remain available for inspection and reproducibility, but the script fetches them automatically.
555
 
556
  </div>
557
 
@@ -561,10 +568,10 @@ See the full [Leaderboard download guide](https://huggingface.co/datasets/vLAR/P
561
 
562
  <div style="margin-left: 40px; text-align: justify;">
563
 
564
- Please download the [`PhysInOne Utils`](https://huggingface.co/datasets/vLAR/PhysInOne/tree/main/PhysInOne%20Utils) folder from the main dataset repository. It contains:
565
 
566
  ```text
567
- PhysInOne Utils/
568
  β”œβ”€β”€ metadata/
569
  β”‚ β”œβ”€β”€ repo_assignment.txt
570
  β”‚ └── repo_map.json
@@ -589,7 +596,7 @@ PhysInOne Utils/
589
  Run the following commands from inside the downloaded folder so the scripts can find `metadata/` using their default paths:
590
 
591
  ```bash
592
- cd "PhysInOne Utils"
593
  ```
594
 
595
  PhysInOne is distributed across multiple Hugging Face dataset repositories because of its large scale. We provide utilities for selecting and downloading full-dataset cases and Leaderboard evaluation data:
 
493
 
494
  The seven training archives add approximately <strong>51.61 GiB</strong> of backgrounds, raw backgrounds, breakable objects, interactable objects, solid objects, appearance materials, and physical materials. Training Scene maps and training Sequence/Trajectory assets are <strong>not released yet</strong>.
495
 
496
+ - [Browse the `PhysicBenchmark` project](https://huggingface.co/datasets/vLAR/PhysInOne/tree/main/Assets/PhysicBenchmark)
497
+ - [Download and setup guide](https://huggingface.co/datasets/vLAR/PhysInOne/blob/main/Utils/3D_ASSETS_DOWNLOAD.md)
498
+ - [Automated downloader](https://huggingface.co/datasets/vLAR/PhysInOne/blob/main/Utils/scripts/download_3d_assets.py)
499
+ - [Exact validation release list](https://huggingface.co/datasets/vLAR/PhysInOne/blob/main/Utils/3d_assets_lists/validation.txt)
500
 
501
+ Install <strong>Unreal Engine 5.5.4</strong>. Windows is recommended for the simplest setup; Linux is also supported with additional platform configuration. The dependency-free GitHub downloader currently retrieves and assembles the exact 1,000-scene validation project subset, safely extracts its eight ZIP files into their correct parent directories, preserves the Unreal Engine package hierarchy, supports interrupted-run recovery, and records detailed logs. The newly released training resource archives are available in their corresponding category folders in the project browser linked above.
502
 
503
  ```bash
504
+ git clone https://github.com/vLAR-group/PhysInOne.git
505
+ cd PhysInOne
506
+ python scripts/download_data.py --task 3d-assets --output-dir ./PhysInOne_data
 
 
 
 
 
 
507
  ```
508
 
509
  After download and extraction, open:
510
 
511
  ```text
512
+ PhysInOne_data/assets/PhysicBenchmark/PhysInOne.uproject
513
  ```
514
 
515
  Do not rename or flatten directories such as `Content/PhysInOne/`, `Content/__ExternalActors__/`, or `Content/__ExternalObjects__/`; Unreal Engine asset references depend on the exact project-relative structure. See the full setup guide for manual extraction paths, disk-space guidance, resume behavior, and troubleshooting.
 
528
  | [Physical Properties Estimation](https://huggingface.co/datasets/vLAR/PhysInOne/tree/main/Leaderboard/Physical%20Properties%20Estimation) | 72 scene ZIPs + 2 shared files | Training/novel-view inputs, camera metadata, and shared supplementary resources |
529
  | [Motion Transfer](https://huggingface.co/datasets/vLAR/PhysInOne/tree/main/Leaderboard/Motion%20Transfer) | 217 ZIPs | Source videos, target reference frames, and captions |
530
 
531
+ Clone the GitHub repository once. The public downloader uses only the Python standard library and reads its maintained manifests locally:
532
 
533
  ```bash
534
+ git clone https://github.com/vLAR-group/PhysInOne.git
535
+ cd PhysInOne
536
+ ```
537
 
538
+ Each row is a complete command that can be copied directly. The remote Leaderboard folder names remain unchanged, while the downloader creates space-free local task directories.
 
 
 
539
 
540
+ | Task | Copy command | Local directory |
541
+ | --- | --- | --- |
542
+ | Video Generation | `python scripts/download_data.py --task video-generation --output-dir ./PhysInOne_data` | `PhysInOne_data/leaderboard/video_generation/` |
543
+ | Future Prediction | `python scripts/download_data.py --task future-prediction --output-dir ./PhysInOne_data` | `PhysInOne_data/leaderboard/future_prediction/` |
544
+ | Physical Properties Estimation | `python scripts/download_data.py --task physical-properties-estimation --output-dir ./PhysInOne_data` | `PhysInOne_data/leaderboard/physical_properties_estimation/` |
545
+ | Motion Transfer | `python scripts/download_data.py --task motion-transfer --output-dir ./PhysInOne_data` | `PhysInOne_data/leaderboard/motion_transfer/` |
546
+ | All four Leaderboard tasks | `python scripts/download_data.py --task video-generation future-prediction physical-properties-estimation motion-transfer --output-dir ./PhysInOne_data` | `PhysInOne_data/leaderboard/` |
547
+
548
+ | Parameter | Purpose |
549
+ | --- | --- |
550
+ | `--task NAME [NAME ...]` | Select one or more tasks. Use the values in the table above, `3d-assets`, or `all`. |
551
+ | `--output-dir PATH` | Set the space-free local output root. Default: `./PhysInOne_data`. |
552
+ | `--scene TEXT` | Match a scene name or six-character scene ID; repeatable. |
553
+ | `--workers N` | Set concurrent downloads. Default: `4`. |
554
+ | `--extract` / `--no-extract` | Enable or disable safe ZIP extraction. |
555
+ | `--delete-zip-after-extract` | Delete each ZIP only after verified extraction. |
556
+ | `--revision REV` | Select the dataset revision. Default: `main`. |
557
+ | `--dry-run` / `--list-only` | Preview counts/output paths or exact public URLs. |
558
 
559
+ Downloads are resumable, and every run records successes and failures for review. No Hugging Face account, access token, or Python package installation is required.
560
 
561
+ See the [complete GitHub download guide](https://github.com/vLAR-group/PhysInOne/blob/main/docs/DATA_DOWNLOAD.md), [download script](https://github.com/vLAR-group/PhysInOne/blob/main/scripts/download_data.py), and [bundled manifests](https://github.com/vLAR-group/PhysInOne/tree/main/scripts/download_lists). The additional [Hugging Face utility guide](https://huggingface.co/datasets/vLAR/PhysInOne/blob/main/Utils/LEADERBOARD_DOWNLOAD.md) remains available for users who prefer `huggingface_hub`.
562
 
563
  </div>
564
 
 
568
 
569
  <div style="margin-left: 40px; text-align: justify;">
570
 
571
+ Please download the [`Utils`](https://huggingface.co/datasets/vLAR/PhysInOne/tree/main/Utils) folder from the main dataset repository. It contains:
572
 
573
  ```text
574
+ Utils/
575
  β”œβ”€β”€ metadata/
576
  β”‚ β”œβ”€β”€ repo_assignment.txt
577
  β”‚ └── repo_map.json
 
596
  Run the following commands from inside the downloaded folder so the scripts can find `metadata/` using their default paths:
597
 
598
  ```bash
599
+ cd "Utils"
600
  ```
601
 
602
  PhysInOne is distributed across multiple Hugging Face dataset repositories because of its large scale. We provide utilities for selecting and downloading full-dataset cases and Leaderboard evaluation data: