Variscite Python API

Overview

The Variscite Python API known as pyvar is a set of high-level abstractions that allows beginning users to develop their own applications pertaining to machine mearning, multimedia, and more. This package aims to provide classes that you can easily import and use on your project, and it also includes quick source code examples to help in your development.

Getting Started

To install the prebuilt pyvar library, see the instructions at python.variscite.com/software section.

Release History

API Release	i.MX 8M Plus BSP Release	TFLite	Ethosu	Date
v1.2.0	5.15-2.0.x	2.8.0	3.5.0	05/02/2023
v1.1.0	5.15-2.0.x	2.8.0	-	16/11/2022
v1.0.0	5.10.52_2.1.0	2.5.0 + ArmNN 24.0.0	-	12/11/2021

Quick Examples

To learn more about how to use the pyvar API, see our guide on how to run quick examples.

Useful Links

• Repository on GitHub. If you find any issue, please report it on the issues section.

• Package on PyPi.

Table of Contents

• Getting Started
  • Introduction
  • Software
    • Python API Package Installation
• Cortex-M API
  • Cortex-M API: Getting Started
    • Introduction
    • Software
  • Utils: pyvar.cm.core
    • Cortex-M Class
  • Utils: pyvar.cm.utils
    • Cortex-M Helper Module
• Machine Learning API
  • Machine Learning API: Getting Started
    • Introduction
    • Hardware
  • Engines: pyvar.ml.engines
    • TensorFlow Lite Inference Engine
    • Ethosu (TensorFlow Lite) Inference Engine
  • Utils: pyvar.ml.utils
    • Label Reader Class
    • Overlay Class
    • Frames Per Second Calculator Class
    • File Transfer Protocol Class
    • Resizer Class
    • Timer Calculator Class
• Multimedia API
  • Multimedia API: Getting Started
    • Introduction
    • Hardware
    • Software
  • pyvar.multimedia
    • pyvar.multimedia.helper
• Quick Examples
  • Classification Examples
    • Image Classification
    • Video Classification
    • Real Time Classification
  • Detection Examples
    • Image Detection Example
    • Video Detection
    • Real Time Detection
  • User Interface Examples
    • Detection User Interface
• LICENSE
  • BSD 3-Clause License
• Contribute
  • Coding Convention and Requirements
  • Signing-off Commits
  • Code Reviews, Pull Requests and Patches
    • Merge Criteria

License

This project is licensed under the BSD-3-Clause terms, which means that it is free for use and you can modify as much as you want as long you retain the copyright notice. You can see a copy of the license below at python.variscite.com/license.