karolyartur commited on
Commit
9e22f81
·
verified ·
1 Parent(s): 78cadc0

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +18 -1
README.md CHANGED
@@ -136,7 +136,10 @@ The dataset contains only a training split for all image collections, but provid
136
 
137
  ## Usage
138
 
139
- You can load the dataset using 🤗 Datasets:
 
 
 
140
 
141
  ```python
142
  from datasets import load_dataset
@@ -155,6 +158,20 @@ example = ds["train"][0]
155
  image, mask, depth = example["image"], example["mask"], example["depth"]
156
  ```
157
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
158
  ### Intended Use
159
 
160
  The dataset is intended for research in:
 
136
 
137
  ## Usage
138
 
139
+ You can load the dataset using 🤗 Datasets.
140
+
141
+ ⚠️ **Note**: By default, `load_dataset` will download the *entire* dataset locally.
142
+ If you only want to iterate over the data without downloading everything first, use the `streaming=True` argument (see example below).
143
 
144
  ```python
145
  from datasets import load_dataset
 
158
  image, mask, depth = example["image"], example["mask"], example["depth"]
159
  ```
160
 
161
+ **Streaming mode (recommended for large datasets):**
162
+
163
+ ```python
164
+ from datasets import load_dataset
165
+
166
+ # Load in streaming mode: data is streamed on the fly without full download
167
+ ds_stream = load_dataset("ABC-iRobotics/SynWBM", name="all", streaming=True)
168
+
169
+ # Iterate through samples
170
+ for example in ds_stream["train"]:
171
+ image, mask, depth = example["image"], example["mask"], example["depth"]
172
+ # process the example...
173
+ ```
174
+
175
  ### Intended Use
176
 
177
  The dataset is intended for research in: