FWeindel commited on
Commit
da02936
·
verified ·
1 Parent(s): 3bc4734

Explain datasource downloads and automatic image caching

Browse files
Files changed (1) hide show
  1. README.md +29 -0
README.md CHANGED
@@ -44,6 +44,35 @@ kept = load_dataset("FWeindel/validated-tasks", split="train")
44
  archived = load_dataset("FWeindel/validated-tasks", "archive", split="train")
45
  ```
46
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
47
  ## Columns
48
 
49
  | Column | Meaning |
 
44
  archived = load_dataset("FWeindel/validated-tasks", "archive", split="train")
45
  ```
46
 
47
+ ## Download one datasource and its images
48
+
49
+ To run one datasource, download its original Parquet. Replace `SOURCE` with
50
+ its folder name and choose a local workspace:
51
+
52
+ ```python
53
+ from huggingface_hub import hf_hub_download
54
+
55
+ parquet = hf_hub_download(
56
+ repo_id="FWeindel/validated-tasks",
57
+ repo_type="dataset",
58
+ filename="SOURCE/tasks.parquet",
59
+ local_dir="/path/to/workspace/dataset",
60
+ )
61
+ ```
62
+
63
+ This downloads the tasks only. When you run that file with the
64
+ [OT-next-data launcher](https://github.com/MLI-lab/OT-next-data/blob/main/validation/README.md),
65
+ its [image downloader](https://github.com/MLI-lab/OT-next-data/blob/main/validation/publishing/image_release.py)
66
+ automatically downloads the published Apptainer images needed by your selected
67
+ tasks, verifies them, and caches them for later runs. You do not need to download
68
+ other datasources' images.
69
+
70
+ This works for releases with image references in their Parquet metadata.
71
+ Keep the original file to preserve those references. Tasks without published
72
+ images are built as usual. See the
73
+ [download and cache guide](https://github.com/MLI-lab/OT-next-data/blob/main/validation/docs/image-publication.md)
74
+ for details and Docker support.
75
+
76
  ## Columns
77
 
78
  | Column | Meaning |