trellixvulnteam/mltk_45p5

Silicon Labs Machine Learning Toolkit (MLTK)

This package is considered EXPERIMENTAL - SILICON LABS DOES NOT OFFER ANY WARRANTIES AND DISCLAIMS ALL IMPLIED WARRANTIES CONCERNING THIS SOFTWARE. 
This package is made available as a self-serve reference supported only by the on-line documentation, and community support. 
There are no Silicon Labs support services for this software at this time.

This is a Python package with command-line utilities and scripts to aid the development of machine learning models for Silicon Lab's embedded platforms.

The features of this Python package include:

• Command-line - Execute all ML operations from a simple command-line interface
• Python API - Execute all ML operations from a Python script
• Model Profiler - Determine how efficient an ML model will execute on an embedded platform
• Model Training - Train an ML model using Google Tensorflow
• Remote Training via SSH - Securely and seamlessly train the model on a remote "cloud" machine
• Model Evaluation - Evaluate a trained ML model's accuracy and other metrics
• Model Summary - Generate a summary of the model's contents
• Model Visualization - Interactively view the ML model's structure
• Model Quantization - Reduce the memory footprint of an ML model by using the Tensorflow-Lite Converter
• Model Parameters - Embed custom parameters into the generated model file
• Audio Feature Generator - Library and tools to convert streaming audio into spectrograms
• Audio Utilities - Utilities to aid the development of audio classification models
• C++ Python Wrappers - Enable sharing source code between embedded targets and model training scripts

Refer to Why MLTK? for more details on the benefits of using the MLTK.

Just want to quickly profile a model to see how fast it can run on an embedded target?  
See the [Model Profiler Utility](./docs/guides/model_profiler_utility.md)

Overview

.. raw:: html

   <iframe src="./_static/overview/index.html" height="100%" width="100%" frameborder="0" class="slideshow-iframe" allowfullscreen></iframe>

Installation

Install the pre-built Python package:

.. tabbed:: Windows

   .. code-block:: shell

      pip  install silabs-mltk

.. tabbed:: Linux

   .. code-block:: shell

      pip3 install silabs-mltk

Or, build and install the Python package from Github:

.. tabbed:: Windows

   .. code-block:: shell

      pip  install git+https://github.com/siliconlabs/mltk.git

.. tabbed:: Linux

   .. code-block:: shell

      pip3 install git+https://github.com/siliconlabs/mltk.git

Refer to the Installation Guide for more details on how to install the MLTK.

Other Information

• Frequently Asked Questions
• Model Profiler Utility
• Quick Reference
• Settings File
• Model Specification
• Model Archive File
• Model Search Path
• Environment Variables
• C++ Development

License

SPDX-License-Identifier: Zlib

The licensor of this software is Silicon Laboratories Inc.

This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software.

Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions:

1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.