JeffreyJsam commited on
Commit
8db3195
·
verified ·
1 Parent(s): 7c94a38

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +3 -3
README.md CHANGED
@@ -57,7 +57,7 @@ If you're using models/tools like **YOLO** or others that expect a **flat direct
57
 
58
  ## How to Load
59
 
60
- You can stream the SWiM-SpacecraftWithMasks dataset directly using the HuggingFace datasets library without downloading it entirely. This is particularly useful when working with limited local storage.
61
 
62
  Use the following code to load and iterate over the dataset efficiently:
63
 
@@ -72,14 +72,14 @@ dataset = load_dataset(
72
 
73
  ```
74
 
75
- Note: The directory/folder structure here obtained from HuggingFace's load_dataset API includes chunks(eg, 000, 001, etc). Hence, it does not support YOLO training. For YOLO training or CIFAR-10 based directory structure, kindly use utils/download_swim.py script.
76
 
77
  ## How to Download
78
 
79
  For local use, if you'd like to either sample a small portion or download the entire dataset to your filesystem, we provide two utility scripts under the utils/ folder:
80
 
81
  - sample_swim.py for quick sampling from a single chunk
82
- - download_swim.py is used to download the full dataset, optionally flattening the directory structure.
83
 
84
  These scripts let you work offline or run faster experiments by controlling what and how much data you fetch. Furthermore, the download_swim.py helps download the data in a flattened YOLO/CIFAR-10 supported folder structure.
85
 
 
57
 
58
  ## How to Load
59
 
60
+ Without downloading it entirely, you can stream the SWiM-SpacecraftWithMasks dataset directly using the HuggingFace datasets library. This is particularly useful when working with limited local storage.
61
 
62
  Use the following code to load and iterate over the dataset efficiently:
63
 
 
72
 
73
  ```
74
 
75
+ Note: The directory/folder structure obtained from HuggingFace's load_dataset API includes chunks(eg, 000, 001, etc). Hence, it does not support YOLO training. For YOLO training or CIFAR-10 based directory structure, you can use the use of the tools/download_swim.py script.
76
 
77
  ## How to Download
78
 
79
  For local use, if you'd like to either sample a small portion or download the entire dataset to your filesystem, we provide two utility scripts under the utils/ folder:
80
 
81
  - sample_swim.py for quick sampling from a single chunk
82
+ - download_swim.py downloads the full dataset, optionally flattening the directory structure.
83
 
84
  These scripts let you work offline or run faster experiments by controlling what and how much data you fetch. Furthermore, the download_swim.py helps download the data in a flattened YOLO/CIFAR-10 supported folder structure.
85