[docs] Update docs about backbone features
authorParichay Kapoor <pk.kapoor@samsung.com>
Tue, 10 Nov 2020 04:57:47 +0000 (13:57 +0900)
committerJijoong Moon <jijoong.moon@samsung.com>
Sun, 15 Nov 2020 23:57:31 +0000 (08:57 +0900)
Update documentation for the ini with the newly added backbone features

**Self evaluation:**
1. Build test: [x]Passed [ ]Failed [ ]Skipped
2. Run test: [x]Passed [ ]Failed [ ]Skipped

Signed-off-by: Parichay Kapoor <pk.kapoor@samsung.com>
docs/configuration-ini.md

index 7f76f61..cf1b621 100644 (file)
@@ -281,7 +281,27 @@ Start with a "[ ${layer name} ]" which must be unique throughtout the model. In
 
 2. ```trainable = <bool>```
 
-   If this backbone must be trained. Only supported for ini backbones (nntrainer models).
+   If this backbone must be trained (defaults to false). Only supported for ini backbones (nntrainer models).
+
+3. ```Preload = <bool>```
+
+   Load pretrained weights from the saved modelfile of backbone (defaults to false). Only supported for ini backbone (nntrainer models).
+
+4. ```ScaleSize = <float>```
+
+   Scale the size of the layers from backbone (defaults to 1.0). This applies for fully connected and convolution layer for now, where the units and the output channels are scaled respectively. Only supported for ini backbone (nntrainer models). If the model is being scaled, it cannot be preloaded from the saved modelfile. Only of the two options, ScaleSize and Preload, must be set at once.
+
+5. ```InputShape = <string>```
+
+   Set the shape of the input layer for the backbone model. Only supported for ini backbones (nntrainer models).
+
+6. ```InputLayer = <string>```
+
+   Choose the start layer for the backbone. This allows taking a subgraph starting with the specified layer name as a backbone. Only supported for ini backbones (nntrainer models).
+
+7. ```OutputLayer = <string>```
+
+   Choose the end layer for the backbone. This allows taking a subgraph ending with the specified layer name as a backbone. Only supported for ini backbones (nntrainer models).
 ``
 Below is sample backbone section.