Update README.md

README.md

@@ -1,3 +1,48 @@
----
-license: cc-by-nc-4.0
----
+---
+license: cc-by-nc-4.0
+---
+
+
+This repository contains the trained models of the publications:
+
+ Portalés-Julià, Enrique and Mateo-García, Gonzalo and Gómez-Chova, Luis, **Understanding Flood Detection Models Across Sentinel-1 and Sentinel-2 Modalities and Benchmark Datasets.** Available at SSRN: https://ssrn.com/abstract=5118486 or http://dx.doi.org/10.2139/ssrn.5118486 
+
+We include the trained models:
+* **sm_unet_s2** Model trained on the Sentinel-2 L1C bands `["B08", "B04", "B03", "B02"]` from the S1S2Water and WorldFloods datasets. 
+* **sm_unet_s1** Model trained on the Sentinel-1 GRD data  (`[VV, VH]` channels) from the S1S2Water and Kuro Siwo datasets. 
+* **mm_unet_s1s2**  Dual stream with modality token model, trained on the S1S2Water (Sentinel-1 GRD and Sentinel-2 L1C data), WorldFloods (Sentinel-2 L1C) and Kuro Siwo Sentinel-1 GRD data. 
+
+In order to run any of these models in Sentinel-1 and/or Sentinel-2 data see the tutorial [*Run model*](https://github.com/kipoju/udl4fl/blob/main/notebooks/run_in_gee_image.ipynb) in the [udl4fl](https://github.com/kipoju/ufl4fl) package.
+
+<!-- <img src="https://raw.githubusercontent.com/IPL-UV/cloudsen12_models/main/notebooks/example_flood_dubai_2024.png"> -->
+
+If you find this work useful please cite:
+
+```
+@article{portales-julia_global_2023,
+	title = {Global flood extent segmentation in optical satellite images},
+	volume = {13},
+	issn = {2045-2322},
+	doi = {10.1038/s41598-023-47595-7},
+	number = {1},
+	urldate = {2023-11-30},
+	journal = {Scientific Reports},
+	author = {Portalés-Julià, Enrique and Mateo-García, Gonzalo and Purcell, Cormac and Gómez-Chova, Luis},
+	month = nov,
+	year = {2023},
+	pages = {20316},
+}
+```
+
+## Licence
+<img src="https://mirrors.creativecommons.org/presskit/buttons/88x31/png/by-nc.png" alt="licence" width="60"/>
+
+All pre-trained models in this repository are released under a [Creative Commons non-commercial licence](https://creativecommons.org/licenses/by-nc/4.0/legalcode.txt) 
+
+
+The `udl4fl` python package is published under a [GNU Lesser GPL v3 licence](https://www.gnu.org/licenses/lgpl-3.0.en.html)
+
+
+## Acknowledgments
+This research has been supported by the DEEPCLOUD project (PID2019-109026RB-I00, University of Valencia) funded by the Spanish Ministry of Science and Innovation (MCIN/AEI/10.13039/501100011033) and the European Union (NextGenerationEU).
+> <img src="https://www.uv.es/chovago/logos/logoMICIN.jpg" alt="DEEPCLOUD project (PID2019-109026RB-I00, University of Valencia) funded by MCIN/AEI/10.13039/501100011033." title="DEEPCLOUD project (PID2019-109026RB-I00, University of Valencia) funded by MCIN/AEI/10.13039/501100011033." width="300"/>