# API Examples

These examples demonstrate how to use the various MLTK Python APIs.
They are provided as [Jupyter Notebooks](https://jupyter.org) and  can either run
locally in [VSCode](https://code.visualstudio.com) or they can run in your web-browser using [Google Colab](https://colab.research.google.com/notebooks/welcome.ipynb).

See the [Notebook Examples Guide](./guides/notebook_examples_guide.md) for more details on how to run these examples.
Also, refer to the documentation at the top of each example for specific details.


| Name                                                                                            | Description                                                                                                                                       |
| ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Profile Model](https://siliconlabs.github.io/mltk/mltk/examples/profile_model.html)            | Examples of using the [profile_model()](https://siliconlabs.github.io/mltk/docs/python_api/operations/profile.html) API                           |
| [Train Model](https://siliconlabs.github.io/mltk/mltk/examples/train_model.html)                | Examples of using the [train_model()](https://siliconlabs.github.io/mltk/docs/python_api/operations/train.html) API                               |
| [Evaluate Model](https://siliconlabs.github.io/mltk/mltk/examples/evaluate_model.html)          | Examples of using the [evaluate_model()](https://siliconlabs.github.io/mltk/docs/python_api/operations/evaluate.html) API                         |
| [Summarize Model](https://siliconlabs.github.io/mltk/mltk/examples/summarize_model.html)        | Examples of using the [summarize_model()](https://siliconlabs.github.io/mltk/docs/python_api/operations/summarize.html) API                       |
| [View Model](https://siliconlabs.github.io/mltk/mltk/examples/view_model.html)                  | Examples of using the [view_model()](https://siliconlabs.github.io/mltk/docs/python_api/operations/view.html) API                                 |
| [Update Model Parameters](https://siliconlabs.github.io/mltk/mltk/examples/update_params.html)  | Examples of using the [update_model_parameters()](https://siliconlabs.github.io/mltk/docs/python_api/operations/update_model_parameters.html) API |
| [Quantize Model](https://siliconlabs.github.io/mltk/mltk/examples/quantize_model.html)          | Examples of using the [quantize_model()](https://siliconlabs.github.io/mltk/docs/python_api/operations/quantize.html) API                         |
| [MLTK Model](https://siliconlabs.github.io/mltk/docs/python_api/models/index.html)              | Examples of creating an [MltkModel](https://siliconlabs.github.io/mltk/docs/python_api/mltk_model/index.html) instance                            |
| [TF-Lite Model](https://siliconlabs.github.io/mltk/mltk/examples/tflite_model.html)             | Examples of using a [TfliteModel](https://siliconlabs.github.io/mltk/docs/python_api/tflite_model/index.html) instance                            |
| [TF-Lite Micro Model](https://siliconlabs.github.io/mltk/mltk/examples/tflite_micro_model.html) | Examples of using a [TfliteMicroModel](https://siliconlabs.github.io/mltk/docs/python_api/tflite_micro_model/index.html) instance                 |
| [UART Stream Example](https://siliconlabs.github.io/mltk/cpp/shared/uart_stream/examples/data_test/README.html) | Examples of using the [UartStream](https://siliconlabs.github.io/mltk/docs/python_api/utils/uart_stream/index.html) library       |
| [Audio Feature Generator Example](https://siliconlabs.github.io/mltk/mltk/examples/audio_feature_generator.html) | Shows how to manually process an audio sample in the [Audio Feature Generator](https://siliconlabs.github.io/mltk/docs/python_api/data_preprocessing/audio_feature_generator.html) and run inference using TF-Lite and TF-Lite Micro       |


```{eval-rst}
.. toctree::
   :maxdepth: 1
   :hidden:

   /mltk/examples/profile_model
   /mltk/examples/train_model
   /mltk/examples/evaluate_model
   /mltk/examples/summarize_model
   /mltk/examples/view_model
   /mltk/examples/update_params
   /mltk/examples/quantize_model
   /mltk/examples/tflite_model
   /mltk/examples/tflite_micro_model
   /cpp/shared/uart_stream/examples/data_test/README.md
   /mltk/examples/audio_feature_generator
```