datasets library

README.md

@@ -269,28 +269,30 @@ The dataset is organized in the following structure:
     
 **Note**: Since the same viewpoint is reproduced across each weather variation, hence ClearNoon annotations can be used for all images pertaining to the different weather variations.
 
-## Dataset Download
-
+## Dataset Download 
 
 
 The dataset can be downloaded using both [datasets](https://huggingface.co/docs/datasets/index) library by Hugging Face and wget. Since SkyScenes offers variations across different axes 
 hence we enable different subsets for download that can aid in model sensitivity analysis across these axes. 
 
+### Download instructions: wget
 
 **Example script for downloading different subsets of data using wget**
-```
+```bash
 #!/bin/bash
 #Change here to download a specific Height and Pitch Variation, for example - H_15_P_0
+#Note- Currently supporting only H_35_P_45 for Instance and Depth Maps
 HP=('H_15_P_0' 'H_15_P_45' 'H_15_P_60' 'H_15_P_90' 'H_35_P_0' 'H_35_P_45' 'H_35_P_60' 'H_35_P_90' 'H_60_P_0' 'H_60_P_45' 'H_60_P_60' 'H_60_P_90')
 
 #Change here to download a specific weather subset, for example - ClearNoon
+#Note - For Segment, Instance and Depth annotations this field should only have ClearNoon variation
 weather=('ClearNoon' 'ClearNight' 'ClearSunset' 'CloudyNoon' 'MidRainyNoon')
 
 #Change here to download a specific Town subset, for example - Town07
 layout=('Town01' 'Town02' 'Town03' 'Town04' 'Town05' 'Town06' 'Town07' 'Town10HD')
 
 #Change here for any specific annotation, for example - https://huggingface.co/datasets/hoffman-lab/SkyScenes/resolve/main/Segment
-base_url=('https://huggingface.co/datasets/hoffman-lab/SkyScenes/resolve/main/Images' 'https://huggingface.co/datasets/hoffman-lab/SkyScenes/resolve/main/Segment' 'https://huggingface.co/datasets/hoffman-lab/SkyScenes/resolve/main/Instance''https://huggingface.co/datasets/hoffman-lab/SkyScenes/resolve/main/Depth') 
+base_url=('https://huggingface.co/datasets/hoffman-lab/SkyScenes/resolve/main/Images')
 
 #Change here for base download folder
 base_download_folder='SkyScenes'
@@ -299,18 +301,92 @@ base_download_folder='SkyScenes'
 for hp in "${HP[@]}"; do
   for w in "${weather[@]}"; do
       for t in "${layout[@]}"; do
-        for url in "${base_url[@]}"; do
-          folder=$(echo "$url" | awk -F '/' '{print $(NF)}')
-          download_url="${url}/${hp}/${w}/${t}/${t}.tar.gz"
-          download_folder="${base_download_folder}/${folder}/${HP}/${w}/${t}"
-          mkdir -p "$download_folder"
-          echo "Downloading: $download_url"
-          echo "SAving: $download_folder"
-        #   wget -P "$download_folder" "$download_url"
+        folder=$(echo "$base_url" | awk -F '/' '{print $(NF)}')
+        download_url="${base_url}/${hp}/${w}/${t}/${t}.tar.gz"
+        download_folder="${base_download_folder}/${folder}/${HP}/${w}/${t}"
+        mkdir -p "$download_folder"
+        echo "Downloading: $download_url"
+        echo "SAving: $download_folder"
+        wget -P "$download_folder" "$download_url"
         done
       done
   done
 done
 ```
 
-### 💡 Support for [datasets](https://huggingface.co/docs/datasets/index) will be made available soon ! 
+### Download instructions: [datasets](https://huggingface.co/docs/datasets/index)
+
+<details>
+<summary>Click to view all the available keys for downloading subsets of the data</summary> 
+
+* **Layout Variations** 
+  - Rural
+  - Urban
+
+* **Weather Variations** 
+  - ClearNoon
+  - ClearNight (only images)
+  - ClearSunset (only images)
+  - CloudyNoon (only images)
+  - MidRainyNoon (only images)
+
+* **Height Variations**
+  - H_15
+  - H_35
+  - H_60
+
+* **Pitch Variations**
+  - P_0
+  - P_45
+  - P_60
+  - P_90
+
+* **Height and Pitch Variations**
+  - H_15_P_0
+  - H_15_P_45
+  - H_15_P_60
+  - H_15_P_90
+  - H_35_P_0
+  - H_35_P_45
+  - H_35_P_60
+  - H_35_P_90
+  - H_60_P_0
+  - H_60_P_45
+  - H_60_P_60
+  - H_60_P_90
+
+  For downloading full dataset key is full
+
+  **💡Notes**: 
+  - To download **images** append subset key with **images**, example - ```H_35_P_45 images```
+  - To download **semantic segmentation** maps append subset key with **semseg**, example - ```H_35_P_45 semseg```
+  - To download **instance segmentation** maps append subset key with **instance**, example - ```H_35_P_45 instance```
+  - To download **depth** maps append subset key with **depth**, example - ```H_35_P_45 depth```
+</details>
+
+
+**Example script for loading H_35_P_45 images**
+```python
+from datasets import load_dataset
+dataset = load_dataset('hoffman-lab/SkyScenes',name="H_35_P_45 images")
+```
+**Example script for loading H_35_P_45 semantic segmentation maps**
+```python
+from datasets import load_dataset
+dataset = load_dataset('hoffman-lab/SkyScenes',name="H_35_P_45 semseg")
+```
+**Example script for loading H_35_P_45 instance segmentation maps**
+```python
+from datasets import load_dataset
+dataset = load_dataset('hoffman-lab/SkyScenes',name="H_35_P_45 instance")
+```
+**Example script for loading H_35_P_45 depth maps**
+```python
+from datasets import load_dataset
+dataset = load_dataset('hoffman-lab/SkyScenes',name="H_35_P_45 depth")
+```
+
+### 💡 Notes
+
+- Depth and Instance segmentation maps are available for only H_35_P_45, other variations will be made available soon.
+- To prevent issues when loading datasets using [datasets](https://huggingface.co/docs/datasets/index) library, it is recommended to avoid downloading subsets that contain overlapping directories. If there are any overlapping directories between the existing downloads and new ones, it's essential to clear the .cache directory of any such overlaps before proceeding with the new downloads. This step will ensure a clean and conflict-free environment for handling datasets.