gonzmg88 commited on
Commit
a234ba0
1 Parent(s): 8e1c328

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +16 -2
README.md CHANGED
@@ -15,15 +15,29 @@ This repository contains the *WorldFloodsv2* dataset released with the publicati
15
  > E. Portalés-Julià, G. Mateo-García, C. Purcell, and L. Gómez-Chova [Global flood extent segmentation in optical satellite images](https://www.nature.com/articles/s41598-023-47595-7). _Scientific Reports 13, 20316_ (2023). DOI: 10.1038/s41598-023-47595-7.
16
 
17
 
18
- The [*WorldFloods* database](https://www.nature.com/articles/s41598-023-47595-7) contains 509 pairs of Sentinel-2 images and flood segmentation masks. Splitted in train, val and test sets.
19
- It requires approximately 310GB of hard-disk storage.
20
 
21
 
22
  <img src="worldfloods_v2.png" alt="licence" width="65%"/>
23
 
 
 
 
 
 
 
 
 
 
 
 
 
24
 
25
  The *WorldFloods* database and all pre-trained models are released under a [Creative Commons non-commercial licence](https://creativecommons.org/licenses/by-nc/4.0/legalcode.txt)
26
 
 
 
27
  If you find this work useful, please cite:
28
 
29
  ```
 
15
  > E. Portalés-Julià, G. Mateo-García, C. Purcell, and L. Gómez-Chova [Global flood extent segmentation in optical satellite images](https://www.nature.com/articles/s41598-023-47595-7). _Scientific Reports 13, 20316_ (2023). DOI: 10.1038/s41598-023-47595-7.
16
 
17
 
18
+ The [*WorldFloodsv2* database](https://www.nature.com/articles/s41598-023-47595-7) contains 509 pairs of Sentinel-2 images and flood segmentation masks. Splitted in train, val and test sets.
19
+ It requires approximately 76GB of hard-disk storage.
20
 
21
 
22
  <img src="worldfloods_v2.png" alt="licence" width="65%"/>
23
 
24
+ ## Download the dataset
25
+
26
+ ```
27
+ huggingface-cli download --cache-dir /path/to/cachedir --local-dir /path/to/localdir/WorldFloodsv2 --repo-type dataset isp-uv-es/WorldFloodsv2
28
+ ```
29
+
30
+ ## Explore the dataset
31
+
32
+ The [exploring *WorldFloodsv2*](https://spaceml-org.github.io/ml4floods/content/prep/exploring_worldfloods.html) tutorial in the [ml4floods](https://github.com/spaceml-org/ml4floods) package shows how to
33
+ process the dataset and plot the images and masks.
34
+
35
+ ## Licence
36
 
37
  The *WorldFloods* database and all pre-trained models are released under a [Creative Commons non-commercial licence](https://creativecommons.org/licenses/by-nc/4.0/legalcode.txt)
38
 
39
+ ## Cite
40
+
41
  If you find this work useful, please cite:
42
 
43
  ```