Skip to content

Commit 5af8ed1

Browse files
committed
Fix instructions in README
1 parent 3768fad commit 5af8ed1

1 file changed

Lines changed: 10 additions & 5 deletions

File tree

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -82,18 +82,23 @@ Every script inherits settings from the aforementioned files.
8282

8383
#### Using the repo
8484

85-
**For PAD:**
85+
**Preparation**
8686
1. Run `export_medians_multi.py` to precompute the medians needed for training, validation and testing.
87-
2. Run `pad_experiments.py` with the appropriate arguments. Example:
87+
2. If you don't want to use the given COCO files, then export your own using the `coco_data_split.py` script.
88+
3. Uncomment the precomputed class weights in the corresponding section of the configuration file depending on the scenario you are using (or compute your own).
89+
4. If you want to use a fixed window containing the months April through September, check out the branch `use_fixed_window`.
90+
5. Especially for OAD, run `object-based-csv.py` to export the statistics needed for the experiments.
91+
92+
**For PAD:**
93+
1. Run `pad_experiments.py` with the appropriate arguments. Example:
8894
```
8995
python pad_experiments.py --train --model convlstm --parcel_loss --weighted_loss --root_path_coco <coco_folder_path> --prefix_coco <coco_file_prefix> --prefix <run_prefix> --num_epochs 10 --batch_size 32 --bands B02 B03 B04 B08 --saved_medians --img_size 61 61 --requires_norm --num_workers 16 --num_gpus 1 --window_len 12
9096
```
9197
The above command is for training the **ConvLSTM** model using the **weighted parcel loss** described in the associated publication. Training will continue for **10 epochs** with **batch size 32**, using the Sentinel-2 **bands Blue (B02), Green (B03), Red (B04) and NIR (B08)**. The **input image size is 61x61**, the **precomputed medians are used** to speed up training and all input data are **normalized**. The **window length is 12**, including all months. Please use the `--help` argument to find information on all available parameters.
92-
3. Optionally, run `visualize_predictions.py` to visualize the image, ground truth and prediction for a specific model and image.
98+
2. Optionally, run `visualize_predictions.py` to visualize the image, ground truth and prediction for a specific model and image.
9399

94100
**For OAD:**
95-
1. Run `object-based-csv.py` to export the statistics needed for OAD.
96-
2. Run `oad_experiments.py` with the appropriate arguments. Example:
101+
1. Run `oad_experiments.py` with the appropriate arguments. Example:
97102
```
98103
python oad_experiments.py --train --model transformer --prefix <run_prefix> --file <oad_file_name> --num_epochs 10 --batch_size 32 --num_workers 16 --num_gpus 1 --hidden_size 1024 --num_layers 3
99104
```

0 commit comments

Comments
 (0)