Update documentation

spaceml-org · Jul 19, 2024 · 0bd80c2 · 0bd80c2
1 parent 4355e3b
commit 0bd80c2
Show file tree

Hide file tree

Showing 28 changed files with 1,324 additions and 12 deletions.
diff --git a/README.html b/README.html
@@ -172,6 +172,7 @@
 <li class="toctree-l1"><a class="reference internal" href="content/ml4ops/HOWTO_postprocess_inference.html">Kherson Dam Break <em>end-to-end</em> floodmap</a></li>
 <li class="toctree-l1"><a class="reference internal" href="content/ml4ops/HOWTO_Run_Inference_multioutput_binary.html">Inference with clouds aware floods segmentation model</a></li>
 <li class="toctree-l1"><a class="reference internal" href="content/ml4ops/HOWTO_inference_on_image_time_series.html">Run inference on time series of Sentinel-2 images</a></li>
+<li class="toctree-l1"><a class="reference internal" href="content/ml4ops/run_with_ml4floods.html">CloudSEN12 and ml4floods in a Sentinel-2 scene</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">WorldFloods</span></p>
 <ul class="nav bd-sidenav">

diff --git a/_images/0c3ed00753481fa39e8784172c1e9f1e3de883a5a6ef9c3e9794905f68451881.png b/_images/0c3ed00753481fa39e8784172c1e9f1e3de883a5a6ef9c3e9794905f68451881.png
diff --git a/_images/6fa5979ccf0f0b9818f883c44458d582b59e9aed0461b3b938ec294a4afbee95.png b/_images/6fa5979ccf0f0b9818f883c44458d582b59e9aed0461b3b938ec294a4afbee95.png
diff --git a/_images/8b391d253e959e3ca937161c1f266fa03f26f53e762b32be6e0fafbb505cdc63.png b/_images/8b391d253e959e3ca937161c1f266fa03f26f53e762b32be6e0fafbb505cdc63.png
diff --git a/_sources/content/ml4ops/run_with_ml4floods.ipynb b/_sources/content/ml4ops/run_with_ml4floods.ipynb
diff --git a/_sources/content/prep/exploring_worldfloods.ipynb b/_sources/content/prep/exploring_worldfloods.ipynb
@@ -74,7 +74,7 @@
     "## Show the dataset with the **interactive viewer** and edit the labels\n",
     "The ml4floods viewer and label editor is a Flask web application to view and manually edit the floodmaps of the *WorldFloods* dataset. This application is in the [ml4floods GitHub package](https://github.com/spaceml-org/ml4floods) in the `viewer` folder.\n",
     "\n",
-    "In order to run the application run:\n",
+    "For launching the viewer, run in a terminal:\n",
     "\n",
     "```\n",
     "pip install flask ml4floods\n",
@@ -593,7 +593,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.9"
+   "version": "3.10.10"
   }
  },
  "nbformat": 4,

diff --git a/_sources/content/worldfloods_dataset.md b/_sources/content/worldfloods_dataset.md
@@ -19,7 +19,7 @@ There are two versions of the database available:
 
 The WorldFloods v2 dataset is stored in Hugging-Face in the repository: [isp-uv-es/WorldFloodsv2](https://huggingface.co/datasets/isp-uv-es/WorldFloodsv2/). 
 
-To download the full dataset (~315GB) run:
+To download the full dataset (~76GB) run:
 
 ```
 huggingface-cli download --cache-dir /path/to/cachedir --local-dir /path/to/localdir/WorldFloodsv2 --repo-type dataset isp-uv-es/WorldFloodsv2

diff --git a/content/config.html b/content/config.html
@@ -173,6 +173,7 @@
 <li class="toctree-l1"><a class="reference internal" href="ml4ops/HOWTO_postprocess_inference.html">Kherson Dam Break <em>end-to-end</em> floodmap</a></li>
 <li class="toctree-l1"><a class="reference internal" href="ml4ops/HOWTO_Run_Inference_multioutput_binary.html">Inference with clouds aware floods segmentation model</a></li>
 <li class="toctree-l1"><a class="reference internal" href="ml4ops/HOWTO_inference_on_image_time_series.html">Run inference on time series of Sentinel-2 images</a></li>
+<li class="toctree-l1"><a class="reference internal" href="ml4ops/run_with_ml4floods.html">CloudSEN12 and ml4floods in a Sentinel-2 scene</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">WorldFloods</span></p>
 <ul class="nav bd-sidenav">

diff --git a/content/intro/introduction.html b/content/intro/introduction.html
@@ -173,6 +173,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../ml4ops/HOWTO_postprocess_inference.html">Kherson Dam Break <em>end-to-end</em> floodmap</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../ml4ops/HOWTO_Run_Inference_multioutput_binary.html">Inference with clouds aware floods segmentation model</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../ml4ops/HOWTO_inference_on_image_time_series.html">Run inference on time series of Sentinel-2 images</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../ml4ops/run_with_ml4floods.html">CloudSEN12 and ml4floods in a Sentinel-2 scene</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">WorldFloods</span></p>
 <ul class="nav bd-sidenav">

diff --git a/content/labeling.html b/content/labeling.html
@@ -174,6 +174,7 @@
 <li class="toctree-l1"><a class="reference internal" href="ml4ops/HOWTO_postprocess_inference.html">Kherson Dam Break <em>end-to-end</em> floodmap</a></li>
 <li class="toctree-l1"><a class="reference internal" href="ml4ops/HOWTO_Run_Inference_multioutput_binary.html">Inference with clouds aware floods segmentation model</a></li>
 <li class="toctree-l1"><a class="reference internal" href="ml4ops/HOWTO_inference_on_image_time_series.html">Run inference on time series of Sentinel-2 images</a></li>
+<li class="toctree-l1"><a class="reference internal" href="ml4ops/run_with_ml4floods.html">CloudSEN12 and ml4floods in a Sentinel-2 scene</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">WorldFloods</span></p>
 <ul class="nav bd-sidenav">

diff --git a/content/ml4ops/HOWTO_Calculate_uncertainty_maps.html b/content/ml4ops/HOWTO_Calculate_uncertainty_maps.html
@@ -174,6 +174,7 @@
 <li class="toctree-l1"><a class="reference internal" href="HOWTO_postprocess_inference.html">Kherson Dam Break <em>end-to-end</em> floodmap</a></li>
 <li class="toctree-l1"><a class="reference internal" href="HOWTO_Run_Inference_multioutput_binary.html">Inference with clouds aware floods segmentation model</a></li>
 <li class="toctree-l1"><a class="reference internal" href="HOWTO_inference_on_image_time_series.html">Run inference on time series of Sentinel-2 images</a></li>
+<li class="toctree-l1"><a class="reference internal" href="run_with_ml4floods.html">CloudSEN12 and ml4floods in a Sentinel-2 scene</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">WorldFloods</span></p>
 <ul class="nav bd-sidenav">

diff --git a/content/ml4ops/HOWTO_Run_Inference_multioutput_binary.html b/content/ml4ops/HOWTO_Run_Inference_multioutput_binary.html
@@ -174,6 +174,7 @@
 <li class="toctree-l1"><a class="reference internal" href="HOWTO_postprocess_inference.html">Kherson Dam Break <em>end-to-end</em> floodmap</a></li>
 <li class="toctree-l1 current active"><a class="current reference internal" href="#">Inference with clouds aware floods segmentation model</a></li>
 <li class="toctree-l1"><a class="reference internal" href="HOWTO_inference_on_image_time_series.html">Run inference on time series of Sentinel-2 images</a></li>
+<li class="toctree-l1"><a class="reference internal" href="run_with_ml4floods.html">CloudSEN12 and ml4floods in a Sentinel-2 scene</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">WorldFloods</span></p>
 <ul class="nav bd-sidenav">

diff --git a/content/ml4ops/HOWTO_Run_Inference_on_new_data.html b/content/ml4ops/HOWTO_Run_Inference_on_new_data.html
@@ -174,6 +174,7 @@
 <li class="toctree-l1"><a class="reference internal" href="HOWTO_postprocess_inference.html">Kherson Dam Break <em>end-to-end</em> floodmap</a></li>
 <li class="toctree-l1"><a class="reference internal" href="HOWTO_Run_Inference_multioutput_binary.html">Inference with clouds aware floods segmentation model</a></li>
 <li class="toctree-l1"><a class="reference internal" href="HOWTO_inference_on_image_time_series.html">Run inference on time series of Sentinel-2 images</a></li>
+<li class="toctree-l1"><a class="reference internal" href="run_with_ml4floods.html">CloudSEN12 and ml4floods in a Sentinel-2 scene</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">WorldFloods</span></p>
 <ul class="nav bd-sidenav">

diff --git a/content/ml4ops/HOWTO_Train_models.html b/content/ml4ops/HOWTO_Train_models.html
@@ -174,6 +174,7 @@
 <li class="toctree-l1"><a class="reference internal" href="HOWTO_postprocess_inference.html">Kherson Dam Break <em>end-to-end</em> floodmap</a></li>
 <li class="toctree-l1"><a class="reference internal" href="HOWTO_Run_Inference_multioutput_binary.html">Inference with clouds aware floods segmentation model</a></li>
 <li class="toctree-l1"><a class="reference internal" href="HOWTO_inference_on_image_time_series.html">Run inference on time series of Sentinel-2 images</a></li>
+<li class="toctree-l1"><a class="reference internal" href="run_with_ml4floods.html">CloudSEN12 and ml4floods in a Sentinel-2 scene</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">WorldFloods</span></p>
 <ul class="nav bd-sidenav">

diff --git a/content/ml4ops/HOWTO_inference_on_image_time_series.html b/content/ml4ops/HOWTO_inference_on_image_time_series.html
@@ -66,7 +66,7 @@
     <link rel="shortcut icon" href="../../_static/ml4cc_logo.png"/>
     <link rel="index" title="Index" href="../../genindex.html" />
     <link rel="search" title="Search" href="../../search.html" />
-    <link rel="next" title="The WorldFloods database" href="../worldfloods_dataset.html" />
+    <link rel="next" title="CloudSEN12 and ml4floods in a Sentinel-2 scene" href="run_with_ml4floods.html" />
     <link rel="prev" title="Inference with clouds aware floods segmentation model" href="HOWTO_Run_Inference_multioutput_binary.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
@@ -174,6 +174,7 @@
 <li class="toctree-l1"><a class="reference internal" href="HOWTO_postprocess_inference.html">Kherson Dam Break <em>end-to-end</em> floodmap</a></li>
 <li class="toctree-l1"><a class="reference internal" href="HOWTO_Run_Inference_multioutput_binary.html">Inference with clouds aware floods segmentation model</a></li>
 <li class="toctree-l1 current active"><a class="current reference internal" href="#">Run inference on time series of Sentinel-2 images</a></li>
+<li class="toctree-l1"><a class="reference internal" href="run_with_ml4floods.html">CloudSEN12 and ml4floods in a Sentinel-2 scene</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">WorldFloods</span></p>
 <ul class="nav bd-sidenav">
@@ -4816,11 +4817,11 @@ <h2>Licence<a class="headerlink" href="#licence" title="Permalink to this headin
       </div>
     </a>
     <a class="right-next"
-       href="../worldfloods_dataset.html"
+       href="run_with_ml4floods.html"
        title="next page">
       <div class="prev-next-info">
         <p class="prev-next-subtitle">next</p>
-        <p class="prev-next-title">The <em>WorldFloods</em> database</p>
+        <p class="prev-next-title">CloudSEN12 and ml4floods in a Sentinel-2 scene</p>
       </div>
       <i class="fa-solid fa-angle-right"></i>
     </a>

diff --git a/content/ml4ops/HOWTO_performance_metrics_workflow.html b/content/ml4ops/HOWTO_performance_metrics_workflow.html
@@ -174,6 +174,7 @@
 <li class="toctree-l1"><a class="reference internal" href="HOWTO_postprocess_inference.html">Kherson Dam Break <em>end-to-end</em> floodmap</a></li>
 <li class="toctree-l1"><a class="reference internal" href="HOWTO_Run_Inference_multioutput_binary.html">Inference with clouds aware floods segmentation model</a></li>
 <li class="toctree-l1"><a class="reference internal" href="HOWTO_inference_on_image_time_series.html">Run inference on time series of Sentinel-2 images</a></li>
+<li class="toctree-l1"><a class="reference internal" href="run_with_ml4floods.html">CloudSEN12 and ml4floods in a Sentinel-2 scene</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">WorldFloods</span></p>
 <ul class="nav bd-sidenav">

diff --git a/content/ml4ops/HOWTO_postprocess_inference.html b/content/ml4ops/HOWTO_postprocess_inference.html
@@ -174,6 +174,7 @@
 <li class="toctree-l1 current active"><a class="current reference internal" href="#">Kherson Dam Break <em>end-to-end</em> floodmap</a></li>
 <li class="toctree-l1"><a class="reference internal" href="HOWTO_Run_Inference_multioutput_binary.html">Inference with clouds aware floods segmentation model</a></li>
 <li class="toctree-l1"><a class="reference internal" href="HOWTO_inference_on_image_time_series.html">Run inference on time series of Sentinel-2 images</a></li>
+<li class="toctree-l1"><a class="reference internal" href="run_with_ml4floods.html">CloudSEN12 and ml4floods in a Sentinel-2 scene</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">WorldFloods</span></p>
 <ul class="nav bd-sidenav">