ML4Floods is an end-to-end ML pipeline for flood extent estimation: from data preprocessing, model training, model deployment to visualization. Here you can find the WorldFloodsV2🌊 dataset and trained models 🤗 for flood extent estimation in Sentinel-2 and Landsat.
Install
Install from pip:
pip install ml4floods
Install the latest version from GitHub:
pip install git+https://github.com/spaceml-org/ml4floods#egg=ml4floods
Docs
These tutorials may help you explore the datasets and models:
- Kherson Dam Break end-to-end flood extent map
- Run the model on time series of Sentinel-2 images
- Ingest data from Copernicus EMS
- ML-models step by step
- Training
- Inference on new data (a Sentinel-2 image)
- Perf metrics
- Training
The WorldFloods database
The WorldFloods database contains 509 pairs of Sentinel-2 images and flood segmentation masks. It requires approximately 76GB of hard-disk storage.
The WorldFloods database and all pre-trained models are released under a Creative Commons non-commercial licence
To download the WorldFloods database or the pretrained flood segmentation models see the instructions to download the database.
Cite
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},
}
@article{mateo-garcia_towards_2021,
title = {Towards global flood mapping onboard low cost satellites with machine learning},
volume = {11},
issn = {2045-2322},
doi = {10.1038/s41598-021-86650-z},
number = {1},
urldate = {2021-04-01},
journal = {Scientific Reports},
author = {Mateo-Garcia, Gonzalo and Veitch-Michaelis, Joshua and Smith, Lewis and Oprea, Silviu Vlad and Schumann, Guy and Gal, Yarin and Baydin, Atılım Güneş and Backes, Dietmar},
month = mar,
year = {2021},
pages = {7249},
}
About
ML4Floods has been funded by the United Kingdom Space Agency (UKSA) and led by Trillium Technologies. In addition, this research has been partially supported by the DEEPCLOUD project (PID2019-109026RB-I00) funded by the Spanish Ministry of Science and Innovation (MCIN/AEI/10.13039/501100011033) and the European Union (NextGenerationEU).
Metadata
Release files for ml4floods 1.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| ml4floods-1.1.1.tar.gz | 121.3 kB | Without provenance | Details for ml4floods-1.1.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| ml4floods-1.1.1-py3-none-any.whl | Python 3 | none | any | Details for ml4floods-1.1.1-py3-none-any.whl |
Total release size: 260.4 kB
Release files / ml4floods-1.1.1.tar.gz
| Download URL | ml4floods-1.1.1.tar.gz |
|---|---|
| Size | 121.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
43abf964d977da63e663bd9a4a3cd32a863f7d123f9b4f79377312634d290c92
|
|
BLAKE2b-256 checksum How to use checksums |
cbba0ff93cc51705e0f94a4452d4ab561ea02fdc493b64a5d343d0c2e4eb1eec
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.12
|
Release files / ml4floods-1.1.1-py3-none-any.whl
| Download URL | ml4floods-1.1.1-py3-none-any.whl |
|---|---|
| Size | 139.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8b202c781509aa781df1fafe2b3e996442c4c891ea3109256642754b95fbfec1
|
|
BLAKE2b-256 checksum How to use checksums |
4f090dbf3e0dac3f366e14390922c732e9e6e8e9f3aad1bc8d6ff230b9b0bf2f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.12
|
Security for ml4floods 1.1.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.