sgiordano commited on
Commit
080d6ec
1 Parent(s): cd5bb3b

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +16 -11
README.md CHANGED
@@ -104,7 +104,7 @@ The general characteristics of this specific model **FLAIR-INC_RVBIE_resnet34_un
104
  - **Developed by:** IGN
105
  - **Compute infrastructure:**
106
  - software: python, pytorch-lightning
107
- - hardware: GENCI, XXX
108
  - **License:** : Apache 2.0
109
 
110
 
@@ -125,13 +125,13 @@ By construction (sampling 75 domains) the model is robust to these shifts, and c
125
 
126
  _**Specification for the Elevation channel**_ :
127
  The fifth dimension of the RGBIE images is the Elevation (height of building and vegetation). This information is encoded in a 8-bit encoding format.
128
- When decoded to [0,255] ints, a difference of 1 coresponds to 20 cm step of elevation difference.
129
 
130
 
131
  _**Land Cover classes of prediction**_ :
132
- The orginial class nomenclature of the FLAIR Dataset is made up of 19 classes(See the [FLAIR dataset](https://huggingface.co/datasets/IGNF/FLAIR) page for details).
133
  However 3 classes corresponding to uncertain labelisation (Mixed (16), Ligneous (17) and Other (19)) and 1 class with very poor labelling (Clear cut (15)) were deasctivated during training.
134
- As a result, the logits produced by the model are of size 19x1, but class 15,16,17 and 19 : (1) should appear at 0 in the logits (2) should never predicted in the Argmax.
135
 
136
 
137
  <!-- ## Bias, Risks, and Limitations -->
@@ -140,7 +140,7 @@ As a result, the logits produced by the model are of size 19x1, but class 15,16,
140
  <!-- This section is meant to convey both technical and sociotechnical limitations. -->
141
 
142
  _**Using the model on input images with other spatial resolution**_ :
143
- The FLAIR-INC_RVBIE_resnet34_unet_15cl_norm model was trained with fixed scale conditions.All patches used for training are derived from aerial images of 0.2 meters spatial resolution. Only flip and rotate augmentation were performed during the training process.
144
  No data augmentation method concerning scale change was used during training. The user should pay attention that generalization issues can occur while applying this model to images that have different spatial resolutions.
145
 
146
  _**Using the model for other remote sensing sensors**_ :
@@ -160,11 +160,12 @@ The user should be aware that applying the model to other type of landscapes may
160
 
161
  ## How to Get Started with the Model
162
 
 
 
163
  Use the code below to get started with the model.
164
  {{ get_started_code | default("[More Information Needed]", true)}}
165
 
166
 
167
-
168
  ## Training Details
169
 
170
  ### Training Data
@@ -186,7 +187,9 @@ Here are the number of patches used for train and validation :
186
  #### Preprocessing [optional]
187
 
188
  For traning the model, input normalization was performed so as the input dataset has **a mean=0** and a **standard deviation = 1** channel wise.
189
- We used the statistics of TRAIN+VALIDATION for input normalization. It is recommended that the user apply the same type of input normalization. Here are the statistics of the TRAIN+VALIDATIOn set :
 
 
190
 
191
  | Modalities | Mean (Train + Validation) |Std (Train + Validation) |
192
  | ----------------------- | ----------- |----------- |
@@ -227,7 +230,8 @@ We used the statistics of TRAIN+VALIDATION for input normalization. It is recomm
227
 
228
  <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
229
 
230
- The FLAIR-INC_RVBIE_resnet34_unet_15cl_norm model was trained on a HPC/AI resources provided by GENCI-IDRIS (Grant 2022-A0131013803). 16 V100 GPUs were requested ( 4 nodes, 4 GPUS per node).
 
231
 
232
  FLAIR-INC_RVBIE_resnet34_unet_15cl_norm was obtained for num_epoch=76 with corresponding val_loss=0.56.
233
 
@@ -250,16 +254,17 @@ FLAIR-INC_RVBIE_resnet34_unet_15cl_norm was obtained for num_epoch=76 with corre
250
  #### Testing Data
251
 
252
  <!-- This should link to a Dataset Card if possible. -->
253
- The evaluation was performed on a TEST set of 31750 patches that are independant from the TRAIN and VALIDATION patches. They represent 15 spatio-temporal domains.
254
  The TEST set corresponds to the reunion of the TEST set of scientific challenges FLAIR#1 and FLAIR#2. See the [FLAIR challenge page](https://ignf.github.io/FLAIR/) for more details.
255
 
256
  The choice of a separate TEST set instead of cross validation was made to be coherent with the FLAIR challenges.
257
- However the metrics for the Challenge were calculated on 12 classes and the TEST set acordingly. As a result the _Snow_ class is unfortunately absent from the TEST set.
 
258
  <!-- {{ testing_data | default("[More Information Needed]", true)}} -->
259
 
260
  #### Metrics
261
 
262
- With the evaluation protocol, the **FLAIR-INC_RVBIE_resnet34_unet_15cl_norm** have been evaluated to **OA= 76.37%** and **mIoU=54.71%**.
263
  The _snow_ class is discarded from the average metrics.
264
 
265
  The following table give the class-wise metrics :
 
104
  - **Developed by:** IGN
105
  - **Compute infrastructure:**
106
  - software: python, pytorch-lightning
107
+ - hardware: HPC/AI resources provided by GENCI-IDRIS
108
  - **License:** : Apache 2.0
109
 
110
 
 
125
 
126
  _**Specification for the Elevation channel**_ :
127
  The fifth dimension of the RGBIE images is the Elevation (height of building and vegetation). This information is encoded in a 8-bit encoding format.
128
+ When decoded to [0,255] ints, a difference of 1 should coresponds to 0.2 meters step of elevation difference.
129
 
130
 
131
  _**Land Cover classes of prediction**_ :
132
+ The orginial class nomenclature of the FLAIR Dataset is made up of 19 classes (See the [FLAIR dataset](https://huggingface.co/datasets/IGNF/FLAIR) page for details).
133
  However 3 classes corresponding to uncertain labelisation (Mixed (16), Ligneous (17) and Other (19)) and 1 class with very poor labelling (Clear cut (15)) were deasctivated during training.
134
+ As a result, the logits produced by the model are of size 19x1, but classes 15, 16, 17 and 19 should appear at 0 in the logits and should never predicted in the Argmax.
135
 
136
 
137
  <!-- ## Bias, Risks, and Limitations -->
 
140
  <!-- This section is meant to convey both technical and sociotechnical limitations. -->
141
 
142
  _**Using the model on input images with other spatial resolution**_ :
143
+ The FLAIR-INC_RVBIE_resnet34_unet_15cl_norm model was trained with fixed scale conditions. All patches used for training are derived from aerial images of 0.2 meters spatial resolution. Only flip and rotate augmentation were performed during the training process.
144
  No data augmentation method concerning scale change was used during training. The user should pay attention that generalization issues can occur while applying this model to images that have different spatial resolutions.
145
 
146
  _**Using the model for other remote sensing sensors**_ :
 
160
 
161
  ## How to Get Started with the Model
162
 
163
+ <!-- ANATOL }}-->
164
+
165
  Use the code below to get started with the model.
166
  {{ get_started_code | default("[More Information Needed]", true)}}
167
 
168
 
 
169
  ## Training Details
170
 
171
  ### Training Data
 
187
  #### Preprocessing [optional]
188
 
189
  For traning the model, input normalization was performed so as the input dataset has **a mean=0** and a **standard deviation = 1** channel wise.
190
+ We used the statistics of TRAIN+VALIDATION for input normalization. It is recommended that the user apply the same type of input normalization.
191
+
192
+ Here are the statistics of the TRAIN+VALIDATIOn set :
193
 
194
  | Modalities | Mean (Train + Validation) |Std (Train + Validation) |
195
  | ----------------------- | ----------- |----------- |
 
230
 
231
  <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
232
 
233
+ The FLAIR-INC_RVBIE_resnet34_unet_15cl_norm model was trained on a HPC/AI resources provided by GENCI-IDRIS (Grant 2022-A0131013803).
234
+ 16 V100 GPUs were requested ( 4 nodes, 4 GPUS per node). With this configuration the approximate learning time is 6 minutes per epoch.
235
 
236
  FLAIR-INC_RVBIE_resnet34_unet_15cl_norm was obtained for num_epoch=76 with corresponding val_loss=0.56.
237
 
 
254
  #### Testing Data
255
 
256
  <!-- This should link to a Dataset Card if possible. -->
257
+ The evaluation was performed on a TEST set of 31 750 patches that are independant from the TRAIN and VALIDATION patches. They represent 15 spatio-temporal domains.
258
  The TEST set corresponds to the reunion of the TEST set of scientific challenges FLAIR#1 and FLAIR#2. See the [FLAIR challenge page](https://ignf.github.io/FLAIR/) for more details.
259
 
260
  The choice of a separate TEST set instead of cross validation was made to be coherent with the FLAIR challenges.
261
+ However the metrics for the Challenge were calculated on 12 classes and the TEST set acordingly.
262
+ As a result the _Snow_ class is unfortunately absent from the TEST set.
263
  <!-- {{ testing_data | default("[More Information Needed]", true)}} -->
264
 
265
  #### Metrics
266
 
267
+ With the evaluation protocol, the **FLAIR-INC_RVBIE_resnet34_unet_15cl_norm** have been evaluated to **OA= 76.37%** and **mIoU=58.63%**.
268
  The _snow_ class is discarded from the average metrics.
269
 
270
  The following table give the class-wise metrics :