Update README.md

README.md

@@ -46,45 +46,45 @@ Password: Igarss_2020
 
 ## Data creation
 The script `data_creator.py` expects the following command line arguments:
-* '--band3'
-* '--band4'
-* '--parent_dir_tile'
-* '--test_dir'
-* '--train_dir'
-* '--eval_dir'
-* '--gt'
-* '--A'
-* '--B'
-* '--city'
-* '--custom_filter_active'
-* '--filter_value'
-* '--kernel'
-* '--offset'
-* '--stride'
+* '--band3' directory location of the rgb channels  
+* '--band4' directory location of the I channel
+* '--output_dir' output parent directory 
+* '--test_dir' output directory for json testset
+* '--train_dir' output directory for json trainset
+* '--eval_dir' output directory for json evaluation set
+* '--gt' name and extension for ground-truth patches 
+* '--A' name and extension for T1 patches 
+* '--B'name and extension for T2 patches 
+* '--city' identification code template for patches, by default wv2{}_{}. the first gap corresponds to tile id and the second gap correspond to patch id in the tile
+* '--custom_filter_active' boolean variable to trigger filter operations over the trainset, the filter consist in remove patches from the trainset that contains a ratio of change/no_change bigger than certain threshold
+* '--filter_value, filter threshold value (0, 1)
+* '--kernel' patch size, by default 128
+* '--offset' padding value, by default 0
+* '--stride' stride value, by default 10
 
 
 
 ## Training
 The script `train.py` expects the following command line arguments:
-* '--dataset'
+* '--dataset' specify the path to the trainset json file
 
 ## Test
 The script `test.py` expects the following command line arguments:
-* '--dataset'
-* '--results_dir'
+* '--dataset' specify the path to the testset json file
+* '--results_dir'  specify the path to the output directory 
 
 ## Evaluation
 The script `evaluation.py` expects the following command line arguments:
-* '--dataset'
-* '--results_dir'
-* '--date'
-* '--experiment_n'
+* '--dataset' specify the path to the evaluationtset json file
+* '--results_dir' specify the path to the output directory created by test.py
+* '--date' select the date when the experiment test.py was performed
+* '--experiment_n' specify the experiment id [int]
 
 
 ## Base options
 The general configurations by found under base_options expects the following command line arguments:
-* '--dataroot'
-* '--name'
+* '--dataroot' path to patches folder
+* '--name' network name
 
 
 ## Authors