Skip to content

Commit 0e7bdb2

Browse files
committed
Update the readme files and configuration file examples.
Signed-off-by: khaoula boutiche <[email protected]>
1 parent ff424ea commit 0e7bdb2

File tree

14 files changed

+59
-20
lines changed

14 files changed

+59
-20
lines changed

image_classification/src/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,7 @@ data_augmentation:
211211

212212
The data augmentation functions are applied to the input images in their order of appearance in the configuration file. If an argument of a given function is omitted, the default value is used. There are no constraints on the number of functions, types of functions and order of functions.
213213

214-
Please refer to [the data augmentation documentation](https://codex.cro.st.com/plugins/git/external-model-zoo/external_model_zoo?a=blob&hb=8e976faa7f22a7d9954295f0e74cdb99fbb6572a&h=27f56a5b1d5a6b96d256afbb889b8e5e1c8d196b&f=image_classification%2Fsrc%2Fdata_augmentation%2FREADME.md) for a list of functions that are available and the transforms they apply to the input images.
214+
Please refer to [the data augmentation documentation](data_augmentation/README.md) for a list of functions that are available and the transforms they apply to the input images.
215215

216216
#### <a id="2-6">2.6 Set the training parameters</a>
217217

@@ -354,7 +354,7 @@ Finally, in the `deployment` section, users must provide information about the h
354354

355355
#### <a id="2-10">2.10 Hydra and MLflow settings</a>
356356

357-
The `mlflow` and `hydra` sections must always be present in the YAML configuration file. The `hydra` section can be used to specify the name of the directory where experiment directories are saved and/or the pattern used to name experiment directories. In the YAML code below, it is set to save the outputs as explained in the section <a id="4">visualize the chained services results</a>:
357+
The `mlflow` and `hydra` sections must always be present in the YAML configuration file. The `hydra` section can be used to specify the name of the directory where experiment directories are saved and/or the pattern used to name experiment directories. In the YAML code below, it is set to save the outputs as explained in the section <a href="#4">visualize the chained services results</a> :
358358

359359
```yaml
360360
hydra:

image_classification/src/config_file_examples/chain_eqe_config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ operation_mode: chain_eqe
66
dataset:
77
name: flowers
88
class_names: [daisy, dandelion, roses, sunflowers, tulips]
9-
test_path: ../datasets/flower_photos
9+
test_path: ../datasets/flower_photos_testset
1010
quantization_path: ../datasets/flower_photos
1111

1212
preprocessing:

image_classification/src/config_file_examples/chain_qd_config.yaml

Lines changed: 44 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,51 @@
11
general:
22
model_path: ../pretrained_models/squeezenetv1.1/ST_pretrainedmodel_public_dataset/plant-village/squeezenetv1.1_128_tfs/squeezenetv1.1_128_tfs.h5
3-
operation_mode: chain_eqeb
3+
4+
operation_mode: chain_qd
45

56
dataset:
6-
quantization_path: ../datasets/plant-village
7-
quantization_split: 0.5
7+
class_names:
8+
- Apple___Apple_scab
9+
- Apple___Black_rot
10+
- Apple___Cedar_apple_rust
11+
- Apple___healthy
12+
- Background_without_leaves
13+
- Blueberry___healthy
14+
- Cherry___healthy
15+
- Cherry___Powdery_mildew
16+
- Corn___Cercospora_leaf_spot Gray_leaf_spot
17+
- Corn___Common_rust
18+
- Corn___healthy
19+
- Corn___Northern_Leaf_Blight
20+
- Grape___Black_rot
21+
- Grape___Esca_(Black_Measles)
22+
- Grape___healthy
23+
- Grape___Leaf_blight_(Isariopsis_Leaf_Spot)
24+
- Orange___Haunglongbing_(Citrus_greening)
25+
- Peach___Bacterial_spot
26+
- Peach___healthy
27+
- Pepper,_bell___Bacterial_spot
28+
- Pepper,_bell___healthy
29+
- Potato___Early_blight
30+
- Potato___healthy
31+
- Potato___Late_blight
32+
- Raspberry___healthy
33+
- Soybean___healthy
34+
- Squash___Powdery_mildew
35+
- Strawberry___healthy
36+
- Strawberry___Leaf_scorch
37+
- Tomato___Bacterial_spot
38+
- Tomato___Early_blight
39+
- Tomato___healthy
40+
- Tomato___Late_blight
41+
- Tomato___Leaf_Mold
42+
- Tomato___Septoria_leaf_spot
43+
- Tomato___Spider_mites Two-spotted_spider_mite
44+
- Tomato___Target_Spot
45+
- Tomato___Tomato_mosaic_virus
46+
- Tomato___Tomato_Yellow_Leaf_Curl_Virus
47+
quantization_path: ../datasets/Plant_leave_diseases_dataset_without_augmentation
48+
quantization_split: 0.5
849

950
preprocessing:
1051
rescaling:

image_classification/src/config_file_examples/evaluation_config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ general:
44
operation_mode: evaluation
55

66
dataset:
7-
test_path: ../datasets/flower_test_set
7+
test_path: ../datasets/flower_photos_testset
88

99
preprocessing:
1010
rescaling:

image_classification/src/config_file_examples/quantization_config.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ operation_mode: quantization
66
dataset:
77
name: flowers
88
class_names: [daisy, dandelion, roses, sunflowers, tulips]
9-
test_path:
109
quantization_path: ../datasets/flower_photos
1110
quantization_split: 0.4
1211

image_classification/src/evaluation/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Alternatively, you can follow the tutorial below, which shows how to evaluate yo
2525

2626
### <a id="1-1">1.1 Setting the model and the operation mode</a>
2727

28-
As mentioned previously, all the sections of the YAML file must be set in accordance with this **[README.md](../config_file_examples/evaluation_config.yaml)**.
28+
As mentioned previously, all the sections of the YAML file must be set in accordance with this **[evaluation_config.yaml](../config_file_examples/evaluation_config.yaml)**.
2929
In particular, `operation_mode` should be set to evaluation and the `evaluation` section should be filled as in the following example:
3030

3131
```yaml

image_classification/src/training/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ training:
223223
decay_steps: 170
224224
alpha: 0.001
225225
```
226-
Refer to <a href="#A">Appendix A: Learning rate schedulers</a> for a list of the available learning rate schedulers.
226+
Refer to [Appendix A: Learning rate schedulers](#A) for a list of the available learning rate schedulers.
227227

228228
### <a id="2-8">2.8 Hydra and MLflow settings</a>
229229

object_detection/pretrained_models/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ The STM32 model zoo includes several models for object detection use case pre-tr
55
Under each model directory, you can find the following model categories:
66

77
- `Public_pretrainedmodel_public_dataset` contains public object detection models trained on public datasets.
8-
- `ST_pretrainedmodel_custom_dataset` contains different object detection models trained on ST custom datasets using our [training scripts](../src/training/README.md).
8+
- `ST_pretrainedmodel_custom_dataset` contains different object detection models trained on ST custom datasets using our [training scripts](../src/training).
99
- `ST_pretrainedmodel_public_dataset` contains different object detection models trained on various public datasets following the [training section](../src/training/README.md) in STM32 model zoo.
1010

1111

object_detection/src/config_file_examples/chain_eqe_config.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ operation_mode: chain_eqe
66
dataset:
77
name: coco_2017_person
88
class_names: [person]
9-
test_path: ../datasets/coco_2017_person/
10-
quantization_path: ../datasets/coco_2017_person/
9+
test_path: ../datasets/coco_2017_person/test
10+
quantization_path: ../datasets/coco_2017_person/train
1111

1212
preprocessing:
1313
rescaling:

object_detection/src/config_file_examples/chain_eqeb_config.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ operation_mode: chain_eqeb
55

66
dataset:
77
class_names: [person]
8-
training_path: ../datasets/coco_person_2017/
8+
training_path: ../datasets/coco_person_2017/train
99
validation_split: 0.1
10-
quantization_path: ../datasets/coco_person_2017/
10+
quantization_path: ../datasets/coco_person_2017/train
1111
quantization_split: 0.05
1212

1313
preprocessing:

0 commit comments

Comments
 (0)