Update README.md

README.md

@@ -1,53 +1,66 @@
 ---
 base_model:
-- ibm-esa-geospatial/TerraMind-1.0-base
-pipeline_tag: reinforcement-learning
+  - ibm-esa-geospatial/TerraMind-1.0-base
+pipeline_tag: tabular-regression
 tags:
-- geospatial,
-- regression,
-- soil,
-- foundation_model,
+  - geospatial
+  - regression
+  - soil
+  - foundation-model
+  - terratorch
 ---
 
+# FAST-EO Use Case 4 - Estimation of Soil Properties
 
-# FAST-EO Use Case 4- Estimation of Soil Properties
+This repository provides a training and evaluation pipeline for **soil-property regression** (`P`, `K`, `Mg`, `pH`) on **Hyperview** data using **Terratorch** and the `terramind_v1_base` backbone.
 
-This project provides a training and evaluation pipeline for soil-property regression (`P`, `K`, `Mg`, `pH`) on Hyperview data using Terratorch and the `terramind_v1_base` backbone.
+## Overview
 
-## Structure
+The goal of this use case is to fine-tune TerraMind-Base for predicting soil properties from remote-sensing inputs. The codebase supports multiple dataset splits (including external test splits) and multiple configuration variants (full vs. small vs. big vs. intuition/enmap evaluation).
 
-- `configs/`:
-  - Terratorch training/inference configs (`UNetDecoder`, `UperNetDecoder`, `small`/`big`/`i1` variants).
-- `datasets/`:
-  - `hyperview_dataset.py`: dataset with split support (`test`, `test_dat`, `test_intuition`, `test_enmap`) and size filters (`only_11x11`, `exclude_11x11`).
-  - `hyperview_datamodule.py`: DataModule and transforms.
-- `callback_hooks/`:
-  - `loss_logging_callback.py`: callback for epoch-level loss logging.
-- `prepare_submission.py`:
+## Repository structure
+
+- `configs/`
+  - Terratorch training/inference configs.
+  - Decoder variants: `UNetDecoder`, `UperNetDecoder`.
+  - Split/size variants: `none` (full), `small`, `big`, `i1`.
+- `datasets/`
+  - `hyperview_dataset.py`: dataset with split support:
+    - `test`, `test_dat`, `test_intuition`, `test_enmap`
+    - size filters: `only_11x11`, `exclude_11x11`
+  - `hyperview_datamodule.py`: Lightning DataModule and transforms.
+- `callback_hooks/`
+  - `loss_logging_callback.py`: epoch-level loss logging callback.
+- `prepare_submission.py`
   - checkpoint inference and export of `submission.csv` and metrics.
-- `hyperview_subimssion.py`:
+- `hyperview_subimssion.py`
   - baseline, class mapping, and evaluation helpers.
-- `hybrid_models.ipynb`:
+- `hybrid_models.ipynb`
   - notebook for hybrid evaluation and ranking of full/small/big submission combinations.
 
-## Configuration Rules
-
-- In each config, set dataset and label paths correctly:
-  - `data.init_args.data_root`
-  - `data.init_args.label_train_path`
-  - `data.init_args.label_test_path`
-- Training is supported only on standard Hyperview:
-  - full (`test_data`),
-  - `small` (11x11 only),
-  - `big` (excluding 11x11).
-- Testing/evaluation is supported on:
-  - Hyperview full,
-  - Hyperview `small`,
-  - Hyperview `big`,
-  - `test_dat`,
-  - `test_intuition` (`intuition1`),
-  - `test_enmap`.
-- For `test_enmap`, `aoi` is mandatory.
+## Configuration rules
+
+In each config, set dataset and label paths correctly:
+- `data.init_args.data_root`
+- `data.init_args.label_train_path`
+- `data.init_args.label_test_path`
+
+### Supported splits
+
+Training is supported on standard Hyperview:
+- full (`test_data`)
+- `small` (11x11 only)
+- `big` (excluding 11x11)
+
+Testing/evaluation is supported on:
+- Hyperview full
+- Hyperview `small`
+- Hyperview `big`
+- `test_dat`
+- `test_intuition` (`intuition1`)
+- `test_enmap`
+
+For `test_enmap`, `aoi` is mandatory.
 
 ## Training
 
@@ -81,67 +94,47 @@ terratorch fit -c configs/terramind_v1_base_hyperview_upernet_none_i1.yaml
 terratorch fit -c configs/terramind_v1_base_hyperview_unet_none.yaml
 ```
 
-## End-to-End Script
+## End-to-end script
 
 Run the full train+test pipeline with:
 
 ```bash
-./run_train_then_test.sh
+./run_train_test.sh
 ```
 
 The script executes, in order:
-- train `upernet_none` and generate `submissions/upernet_none`,
-- train `upernet_none_small` and generate `submissions/upernet_none_small`,
-- train `upernet_none_big` and generate `submissions/upernet_none_big`,
-- train `unet_none` and generate `submissions/unet_none`,
-- evaluate `upernet_none_i1` using `configs/terramind_v1_base_hyperview_upernet_none_i1.yaml`,
+- train `upernet_none` and generate `submissions/upernet_none`
+- train `upernet_none_small` and generate `submissions/upernet_none_small`
+- train `upernet_none_big` and generate `submissions/upernet_none_big`
+- train `unet_none` and generate `submissions/unet_none`
+- evaluate `upernet_none_i1` using `configs/terramind_v1_base_hyperview_upernet_none_i1.yaml`
 - run external-model evaluations for:
-  - `upernet_none_external`,
-  - `upernet_none_i1_external`,
-  - `upernet_none_enmap_20231109T101043Z_external`,
-  - `upernet_none_enmap_20231109T101043Z`.
+  - `upernet_none_external`
+  - `upernet_none_i1_external`
+  - `upernet_none_enmap_20231109T101043Z_external`
+  - `upernet_none_enmap_20231109T101043Z`
 
-## Submission Generation
+## Submission generation
 
 ```bash
-python3 prepare_submission.py \
-  --model_dir runs/terratorch_hyperview_upernet_none \
-  --config configs/terramind_v1_base_hyperview_upernet_none.yaml \
-  --output_dir submissions/upernet_none
+python3 prepare_submission.py   --model_dir runs/terratorch_hyperview_upernet_none   --config configs/terramind_v1_base_hyperview_upernet_none.yaml   --output_dir submissions/upernet_none
 ```
 
 Example for `small`:
 
 ```bash
-python3 prepare_submission.py \
-  --model_dir runs/terratorch_hyperview_upernet_none_small \
-  --config configs/terramind_v1_base_hyperview_upernet_none_small.yaml \
-  --output_dir submissions/upernet_none_small
+python3 prepare_submission.py   --model_dir runs/terratorch_hyperview_upernet_none_small   --config configs/terramind_v1_base_hyperview_upernet_none_small.yaml   --output_dir submissions/upernet_none_small
 ```
 
 Example for `big`:
 
 ```bash
-python3 prepare_submission.py \
-  --model_dir runs/terratorch_hyperview_upernet_none_big \
-  --config configs/terramind_v1_base_hyperview_upernet_none_big.yaml \
-  --output_dir submissions/upernet_none_big
+python3 prepare_submission.py   --model_dir runs/terratorch_hyperview_upernet_none_big   --config configs/terramind_v1_base_hyperview_upernet_none_big.yaml   --output_dir submissions/upernet_none_big
 ```
 
 Example for `test_intuition`:
 
 ```bash
-python3 prepare_submission.py \
-  --model_dir runs/terratorch_hyperview_upernet_none \
-  --config configs/terramind_v1_base_hyperview_upernet_none_i1.yaml \
-  --output_dir submissions/upernet_none_i1
+python3 prepare_submission.py   --model_dir runs/terratorch_hyperview_upernet_none   --config configs/terramind_v1_base_hyperview_upernet_none_i1.yaml   --output_dir submissions/upernet_none_i1
 ```
 
-## Notes
-
-- `prepare_submission.py` reads `split`, `aoi`, `label_test_path`, `only_11x11`, `exclude_11x11`, and `drop_last` from the config.
-- Metrics and predictions are written to `--output_dir`:
-  - `submission.csv`
-  - `gt.csv`
-  - `all_metrics.json`
-  - `all_metrics.csv`