vLAR commited on
Commit
efa80e0
Β·
verified Β·
1 Parent(s): fe24ebb

Simplify public downloader setup and rename Rendered Data section

Browse files
PhysInOne Utils/3D_ASSETS_DOWNLOAD.md CHANGED
@@ -205,9 +205,8 @@ python "PhysInOne Utils/scripts/download_3d_assets.py" \
205
  --workers 2
206
  ```
207
 
208
- Public downloads do not require a Hugging Face token. If authentication is
209
- needed in a particular environment, set the standard `HF_TOKEN` environment
210
- variable instead of placing a token in a script or log.
211
 
212
  ## Contact
213
 
 
205
  --workers 2
206
  ```
207
 
208
+ Public downloads do not require authentication. Do not place access credentials
209
+ in source code, shared shell scripts, commands, or download logs.
 
210
 
211
  ## Contact
212
 
PhysInOne Utils/LEADERBOARD_DOWNLOAD.md CHANGED
@@ -21,22 +21,18 @@ Python 3.9 or newer is recommended.
21
  pip install -U huggingface_hub tqdm
22
  ```
23
 
24
- Download the utility script and the maintained task file lists:
25
 
26
  ```bash
27
  hf download vLAR/PhysInOne \
28
  "PhysInOne Utils/scripts/download_leaderboard.py" \
29
- "PhysInOne Utils/leaderboard_lists/video-generation.txt" \
30
- "PhysInOne Utils/leaderboard_lists/future-prediction.txt" \
31
- "PhysInOne Utils/leaderboard_lists/physical-properties-estimation.txt" \
32
- "PhysInOne Utils/leaderboard_lists/motion-transfer.txt" \
33
- "PhysInOne Utils/LEADERBOARD_DOWNLOAD.md" \
34
  --repo-type dataset \
35
  --local-dir .
36
  ```
37
 
38
- The downloader can also fetch its task list from Hugging Face automatically
39
- when only the Python script is available.
 
40
 
41
  ## Quick start
42
 
@@ -69,9 +65,11 @@ python "PhysInOne Utils/scripts/download_leaderboard.py" \
69
 
70
  ## Task names and file lists
71
 
72
- Each maintained list contains one exact repository file path per line. The
73
- downloader uses these lists instead of scanning or downloading unrelated parts
74
- of the large PhysInOne repository.
 
 
75
 
76
  | `--task` value | Repository directory | Maintained file list |
77
  | --- | --- | --- |
@@ -213,8 +211,6 @@ python "PhysInOne Utils/scripts/download_leaderboard.py" \
213
  --workers 2
214
  ```
215
 
216
- Public downloads do not require authentication. If Hugging Face authentication
217
- is needed in a particular environment, set the standard `HF_TOKEN` environment
218
- variable. Do not place access tokens in source code, shared shell scripts, or
219
- download logs.
220
 
 
21
  pip install -U huggingface_hub tqdm
22
  ```
23
 
24
+ Download the utility script:
25
 
26
  ```bash
27
  hf download vLAR/PhysInOne \
28
  "PhysInOne Utils/scripts/download_leaderboard.py" \
 
 
 
 
 
29
  --repo-type dataset \
30
  --local-dir .
31
  ```
32
 
33
+ The Python script automatically fetches the required task manifest from the
34
+ public Hugging Face repository for the selected `--task` and `--revision`. You
35
+ do not need to download any TXT manifest files manually.
36
 
37
  ## Quick start
38
 
 
65
 
66
  ## Task names and file lists
67
 
68
+ For each selected task, the downloader automatically fetches a maintained TXT
69
+ manifest containing one exact repository file path per line. It uses that
70
+ manifest instead of scanning or downloading unrelated parts of the large
71
+ PhysInOne repository. The links below are provided for inspection and
72
+ reproducibility; manual manifest downloads are not required.
73
 
74
  | `--task` value | Repository directory | Maintained file list |
75
  | --- | --- | --- |
 
211
  --workers 2
212
  ```
213
 
214
+ Public downloads do not require authentication. Do not place access tokens in
215
+ source code, shared shell scripts, commands, or download logs.
 
 
216
 
PhysInOne Utils/scripts/download_3d_assets.py CHANGED
@@ -69,7 +69,6 @@ def get_release_file(name: str, revision: str, cache_dir: Path) -> Path:
69
  repo_type=REPO_TYPE,
70
  revision=revision,
71
  cache_dir=cache_dir,
72
- token=os.environ.get("HF_TOKEN") or None,
73
  )
74
  )
75
 
@@ -309,7 +308,6 @@ def download_one(
309
  revision=revision,
310
  local_dir=output_dir,
311
  cache_dir=cache_dir,
312
- token=os.environ.get("HF_TOKEN") or None,
313
  )
314
  return DownloadResult(remote_path, str(local), "ready")
315
  except Exception as exc:
 
69
  repo_type=REPO_TYPE,
70
  revision=revision,
71
  cache_dir=cache_dir,
 
72
  )
73
  )
74
 
 
308
  revision=revision,
309
  local_dir=output_dir,
310
  cache_dir=cache_dir,
 
311
  )
312
  return DownloadResult(remote_path, str(local), "ready")
313
  except Exception as exc:
PhysInOne Utils/scripts/download_leaderboard.py CHANGED
@@ -114,7 +114,6 @@ def get_task_list(task: str, revision: str, cache_dir: Path) -> list[str]:
114
  filename=remote,
115
  revision=revision,
116
  cache_dir=cache_dir,
117
- token=os.environ.get("HF_TOKEN") or None,
118
  )
119
  )
120
  paths = read_lines(local)
@@ -285,7 +284,6 @@ def download_one(
285
  revision=revision,
286
  local_dir=output_dir,
287
  cache_dir=cache_dir,
288
- token=os.environ.get("HF_TOKEN") or None,
289
  )
290
  )
291
  extracted = "not_requested"
 
114
  filename=remote,
115
  revision=revision,
116
  cache_dir=cache_dir,
 
117
  )
118
  )
119
  paths = read_lines(local)
 
284
  revision=revision,
285
  local_dir=output_dir,
286
  cache_dir=cache_dir,
 
287
  )
288
  )
289
  extracted = "not_requested"
README.md CHANGED
@@ -300,7 +300,7 @@ homepage: https://vlar-group.github.io/PhysInOne.html
300
  <a href="#data-splits">πŸ“Š Data Splits</a><br>
301
  <a href="#three-d-assets">🧱 3D Assets</a><br>
302
  <a href="#leaderboard-evaluation-data">πŸ† Leaderboard Evaluation Data</a><br>
303
- <a href="#how-to-download">πŸ“₯ How to Download</a><br>
304
  &nbsp;&nbsp;&nbsp;<a href="#download-scripts">1. Download Scripts</a><br>
305
  &nbsp;&nbsp;&nbsp;<a href="#install-dependencies">2. Install Dependencies</a><br>
306
  &nbsp;&nbsp;&nbsp;<a href="#filter-cases">3. Filter Cases</a><br>
@@ -473,7 +473,7 @@ Due to the large scale of PhysInOne, the rendered data and annotations are split
473
 
474
  > Download badges query the official Hugging Face API and update automatically. Counts are repository-level download events, not deduplicated users; accessing multiple shards can produce one event in each shard.
475
 
476
- For large-scale downloading and filtering, please refer to the **How to Download** section below.
477
 
478
  </div>
479
 
@@ -541,11 +541,6 @@ pip install -U huggingface_hub tqdm
541
 
542
  hf download vLAR/PhysInOne \
543
  "PhysInOne Utils/scripts/download_leaderboard.py" \
544
- "PhysInOne Utils/leaderboard_lists/video-generation.txt" \
545
- "PhysInOne Utils/leaderboard_lists/future-prediction.txt" \
546
- "PhysInOne Utils/leaderboard_lists/physical-properties-estimation.txt" \
547
- "PhysInOne Utils/leaderboard_lists/motion-transfer.txt" \
548
- "PhysInOne Utils/LEADERBOARD_DOWNLOAD.md" \
549
  --repo-type dataset \
550
  --local-dir .
551
 
@@ -554,13 +549,13 @@ python "PhysInOne Utils/scripts/download_leaderboard.py" \
554
  --output-dir ./PhysInOne-Leaderboard
555
  ```
556
 
557
- 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.
558
 
559
- See the full [Leaderboard download guide](https://huggingface.co/datasets/vLAR/PhysInOne/blob/main/PhysInOne%20Utils/LEADERBOARD_DOWNLOAD.md) and the [task file lists](https://huggingface.co/datasets/vLAR/PhysInOne/tree/main/PhysInOne%20Utils/leaderboard_lists) for details.
560
 
561
  </div>
562
 
563
- <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>
564
 
565
  <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>
566
 
@@ -714,15 +709,6 @@ python scripts/download.py \
714
  --output_dir ./PhysInOne
715
  ```
716
 
717
- If the dataset repositories are gated or private, pass a Hugging Face token:
718
-
719
- ```bash
720
- python scripts/download.py \
721
- --selection selected_cases.json \
722
- --output_dir ./PhysInOne \
723
- --token YOUR_HF_TOKEN
724
- ```
725
-
726
  By default, downloaded zip files are saved into a flat output folder. To preserve shard/split/activity structure:
727
 
728
  ```bash
 
300
  <a href="#data-splits">πŸ“Š Data Splits</a><br>
301
  <a href="#three-d-assets">🧱 3D Assets</a><br>
302
  <a href="#leaderboard-evaluation-data">πŸ† Leaderboard Evaluation Data</a><br>
303
+ <a href="#rendered-data">🎞️ Rendered Data</a><br>
304
  &nbsp;&nbsp;&nbsp;<a href="#download-scripts">1. Download Scripts</a><br>
305
  &nbsp;&nbsp;&nbsp;<a href="#install-dependencies">2. Install Dependencies</a><br>
306
  &nbsp;&nbsp;&nbsp;<a href="#filter-cases">3. Filter Cases</a><br>
 
473
 
474
  > Download badges query the official Hugging Face API and update automatically. Counts are repository-level download events, not deduplicated users; accessing multiple shards can produce one event in each shard.
475
 
476
+ For large-scale rendered-data downloading and filtering, please refer to the **Rendered Data** section below.
477
 
478
  </div>
479
 
 
541
 
542
  hf download vLAR/PhysInOne \
543
  "PhysInOne Utils/scripts/download_leaderboard.py" \
 
 
 
 
 
544
  --repo-type dataset \
545
  --local-dir .
546
 
 
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
 
558
+ <h2 id="rendered-data" style="margin-left: 0; font-size: 1.9em; line-height: 1.22; margin-top: 1.2em; margin-bottom: 0.5em;">🎞️ Rendered Data</h2>
559
 
560
  <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>
561
 
 
709
  --output_dir ./PhysInOne
710
  ```
711
 
 
 
 
 
 
 
 
 
 
712
  By default, downloaded zip files are saved into a flat output folder. To preserve shard/split/activity structure:
713
 
714
  ```bash