# RT-AK

**Repository Path**: mirrors_RT-Thread/RT-AK

## Basic Information

- **Project Name**: RT-AK
- **Description**: RT-Thread AI Kit
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2021-04-15
- **Last Updated**: 2026-08-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

Other Language: [Chinese](README.md)

### Table of Contents

- [1. RT-AK](#intro)
- [2. CI Status](#ci-status)
  - [Official Builds](#official-builds)
  - [Community Builds](#community-builds)
- [3. Get Help](#get-help)
- [4. Developer Documents](#developer-documents)

# Intro

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](./LICENSE) [![](https://img.shields.io/badge/Plugin-STM32-brightgreen)](https://github.com/RT-Thread/RT-AK-plugin-stm32) [![](https://img.shields.io/badge/Plugin-K210-brightgreen)](https://github.com/RT-Thread/RT-AK-plugin-k210)

**`RT-AK`: `RT-Thread AI Kit`**

`RT-AK` is AI toolkit for RT-Thread RTOS, which makes it possible to just-one-command deploy the AI model into a RT-Thread project.

`RT-AK` not only provides `API` to support application development, but also takes advantage of the target platform facility for better performance.

With `RT-AK`, it requires just one command to integrage an `AI` model into RT-Thread application project, like this:

```bash
$ python aitools.py --model xxx...
```

For more details, please refer [RT-AK README.md](./RT-AK/README_en.md) and [Quick Start](./RT-AK/documents/RT-AK%20Quick%20Start%EN.md).

---

**We focus on making it easy to land AI on the edge.**

# CI Status

## Official Builds

`RT-AK` Tools Support PC OS:

| Build Type   | Status                                                       | Artifacts |
| ------------ | ------------------------------------------------------------ | --------- |
| Windows 10   | ![](https://img.shields.io/badge/RT--AK-passing-blackgreen.svg) |           |
| Ubuntu 18.04 | ![](https://img.shields.io/badge/RT--AK-passing-blackgreen.svg) |           |
| Mac          | -                                                            |           |

`RT-AK` Plugins For Target Platform:

| Build Type | Status                                                       | Artifacts                                                    |
| ---------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| STM32      | [![](https://img.shields.io/badge/Plugin-STM32-brightgreen)](https://github.com/RT-Thread/RT-AK-plugin-stm32) | [RT-AK STM32 Quick Start](./RT-AK/documents/RT-AK%20STM32%20Quick%20Start.md) |
| K210       | [![](https://img.shields.io/badge/Plugin-K210-brightgreen)](https://github.com/RT-Thread/RT-AK-plugin-k210) | [RT-AK K210 Quick Start](https://github.com/RT-Thread/RT-AK-plugin-k210/blob/main/docs/RT-AK%20K210%20Quick%20Start.md) |
| -          | -                                                            | -                                                            |

Both `STM32` and `K210` original toolchain come with model optimization support, so far only `K210` plugin enabled qunatilization. `STM32` plugin didn't enable it, yet.


Notes:

- For `STM32` platform, please qunatilize the model before run RT-AK, or it will generate codes using float.
- For `K210`, the neural model must be raw model (not quantilized), RT-AK plugin will take care internally per your specification.

For more details, please refer documents in main project (RT-AK) and corresponding platform plugin.

## Community Builds

| Build Type | Status | Artifacts |
| ---------- | ------ | --------- |
|            |        |           |

# Get Help

- [RT-AK FAQ](./RT-AK/documents/RT-AK FAQ EN.md)

- [RT-Thread Forums](https://club.rt-thread.io/)

  <img src="./RT-AK/documents/imgs/20210114105417.png" style="zoom:50%;" />
  
- Business: please contact business@rt-thread.com for commercial support, like develop plugin for proprietary hardware or consultant service.

# Developer Documents

For more internals, please read documents in [RT-AK/documents](RT-AK/documents) and source code, welcome to contribute document, demo project and platform plugin. (PS, please use stand-alone repository for new plugin then PR for `RT-AK/rt_ai_tools/platforms/support_platforms.json` registry.)

- [RT-AK FAQ.md](RT-AK/documents/RT-AK FAQ EN.md)
- [RT-AK Contributor Guide.md](RT-AK/documents/RT-AK Contributor Guide EN.md)
- [RT-AK Dev Guide.md](RT-AK/documents/RT-AK Dev Guide EN.md)
- [RT-AK Quick Start.md](RT-AK/documents/RT-AK%20Quick%20Start%20EN.md)
- [RT-AK Notes on AI Model.md](RT-AK/documents/RT-AK AI Model Notes EN.md)

- [RT-Thread Prgramming Guide.pdf ](RT-AK/documents/RT-Thread编程指南.pdf) (PDF is Chinese Only,yet. Please visit https://www.rt-thread.io/document/site/ for online English version)