3. Getting Started

This section takes you from a fresh install to a trained, quantized and compiled model, and explains what every file in the run folder means.

Contents

• 3.1. Quickstart
  • 3.1.1. Prerequisites
  • 3.1.2. Step 1: Get the Example Config
  • 3.1.3. Step 2: Run Hello World
  • 3.1.4. Step 3: View Results
  • 3.1.5. Step 4: Read the Config
  • 3.1.6. Step 5: Try Another Example
  • 3.1.7. Next Steps
• 3.2. First Example
  • 3.2.1. Overview
  • 3.2.2. Step 1: The Configuration
  • 3.2.3. Step 2: Run
  • 3.2.4. Step 3: Read the Training Log
  • 3.2.5. Step 4: Examine the Output Folder
  • 3.2.6. Step 5: Customize
  • 3.2.7. Next Steps
• 3.3. Running Examples
  • 3.3.1. Finding Examples
  • 3.3.2. The Three Run Scripts
  • 3.3.3. Reading an Example Config
  • 3.3.4. Customizing
  • 3.3.5. Output Location
  • 3.3.6. Troubleshooting
  • 3.3.7. Next Steps
• 3.4. Understanding Config
  • 3.4.1. Minimal Config
  • 3.4.2. Common Keys
  • 3.4.3. Next Steps
• 3.5. How to Create a ModelZoo Config YAML
  • 3.5.1. 1. Config Skeleton and 4-Step Recipe
  • 3.5.2. 2. Feature Extraction: Preset vs. Custom
  • 3.5.3. 3. Useful Knobs
  • 3.5.4. Common Pitfalls
• 3.6. Understanding the Run Output
  • 3.6.1. What a Run Produces
  • 3.6.2. Float vs. Quantized Model
  • 3.6.3. Golden Vectors: user_input_config.h
  • 3.6.4. Golden Vectors: test_vector.c
  • 3.6.5. PCA Graphs: Are Your Features Separable?
  • 3.6.6. Post-Training Analysis: Classification
  • 3.6.7. Post-Training Analysis: Other Tasks
  • 3.6.8. Compilation Output: What Goes on the Device
  • 3.6.9. Next Step

3.7. 5-Minute Quickstart

After Installation, from the tinyml-modelzoo folder:

Linux / macOSWindows (cmd)Windows (PowerShell)

./run_tinyml_modelzoo.sh examples/generic_timeseries_classification/config.yaml

This runs the “Hello World” example: it downloads a waveform dataset (sine, square, sawtooth), extracts FFT features, trains a ~1K-parameter model (CLS_1k_NPU), quantizes it and compiles it for the F28P55. Output is written to ./data/projects/generic_timeseries_classification/run/<date-time>/CLS_1k_NPU/.

Quickstart

Run the hello world example and find the results.

Quickstart

First Example

Walk through DC arc fault detection end to end.

First Example

Understanding the Run Output

What every file in a run folder is and which one to deploy.

Understanding the Run Output

Config YAML Guide

Create or adapt a config for your data and device.

How to Create a ModelZoo Config YAML