- datasets placeholder for the image classification datasets.
- deployment contains the necessary files for the deployment service.
- pretrained_models points on a collection of optimized pretrained models on different image classification datasets.
- src contains tools to train, evaluate, benchmark and quantize your model on your STM32 target.
The operation_mode top-level attribute specifies the operations or the service you want to execute. This may be single operation or a set of chained operations.
You can refer to readme links below that provide typical examples of operation modes, and tutorials on specific services:
- training, chain_tqe (train + quantize + evaluate), chain_tqeb
- quantization, chain_eqe, chain_qb
- evaluation, chain_eqeb
- benchmarking
- prediction
- For deployment and chain_qd:
- README
- For STM32N6: README_STM32N6
All .yaml configuration examples are located in config_file_examples folder.
The different values of the operation_mode attribute and the corresponding operations are described in the table below. In the names of the chain modes, 't' stands for training, 'e' for evaluation, 'q' for quantization, 'b' for benchmark and 'd' for deployment on an STM32 board.
| operation_mode attribute | Operations |
|---|---|
training |
Train a model from the variety of classification models in the model zoo (BYOD) or your own model (BYOM) |
evaluation |
Evaluate the accuracy of a float or quantized model on a test or validation dataset |
quantization |
Quantize a float model |
prediction |
Predict the classes some images belong to using a float or quantized model |
benchmarking |
Benchmark a float or quantized model on an STM32 board |
deployment |
Deploy a model on an STM32 board |
chain_tqeb |
Sequentially: training, quantization of trained model, evaluation of quantized model, benchmarking of quantized model |
chain_tqe |
Sequentially: training, quantization of trained model, evaluation of quantized model |
chain_eqe |
Sequentially: evaluation of a float model, quantization, evaluation of the quantized model |
chain_qb |
Sequentially: quantization of a float model, benchmarking of quantized model |
chain_eqeb |
Sequentially: evaluation of a float model, quantization, evaluation of quantized model, benchmarking of quantized model |
chain_qd |
Sequentially: quantization of a float model, deployment of quantized model |
There is no model_type on the image classification use case, but here can be found the list of the available models.
Don't forget to follow our tuto below for a quick ramp up :
- How can I define and train my own model?
- How can I fine tune a pretrained model on my own dataset?
- How can I check the accuracy after quantization of my model?
- How can I quickly check the performance of my model using the dev cloud?
Remember that minimalistic yaml files are available here to play with specific services, and that all pre-trained models in the STM32 model zoo are provided with their configuration .yaml file used to generate them. These are very good starting points to start playing with!