API Reference

Once the YZLITE is installed into the Python environment, it may be imported into a python script using:

import yzlite

Once the YZLITE is imported, it’s various APIs may be accessed.

API Overview

The following provides a general overview of the YZLITE Python API:

Name Description
Model Operations Modeling operations such as profiling and training
YZLITE Model Provides the root object of a model specification
Tensorflow-Lite Model Enables reading/writing .tflite model flatbuffer
Tensorflow-Lite Micro Model Enables running .tflite models in the Tensorflow-Lite Micro interpreter
Keras Model The model object used by Tensorflow during model training
Data Preprocessing Dataset preprocessing utilities
Utilities Common utilities
Reference Models Pre-trained reference models
Reference Datasets Datasets used by reference models

Package Directory Structure

The YZLITE Python package has the following structure:

Name Description
yzlite The root of the YZLITE package
yzlite.core Core modeling utilities, see the Model Operations docs for more details
yzlite.core.model Provides the root object of a model specification, more details in the YZLITE Model docs
yzlite.core.preprocess Data pre-processing utilities, see the Data Preprocessing docs for more info
yzlite.core.tflite_model Enables reading/writing .tflite model flatbuffers, more details in the TfliteModel docs
yzlite.core.tflite_model_parameters Enables read/writing custom parameters in a .tflite model flatbuffer
yzlite.core.tflite_micro Enables running .tflite models in the Tensorflow-Lite Micro interpreter, more details in the Tensorflow-Lite Micro Wrapper docs
yzlite.core.keras Helper scripts for the Keras API
yzlite.utils Common utility scripts, more details in the utilities docs
yzlite.cli YZLITE Command-Line Interface (CLI) scripts
yzlite.models Reference models, more details in the Reference models docs
yzlite.datasets Reference datasets, more details in the Reference datasets docs