|
1 | | -# TensorFlow Lite Micro Library for Arduino |
| 1 | +# TensorFlow Lite Micro Library for RTduino |
2 | 2 |
|
3 | | -This repository has the code (including examples) needed to use Tensorflow Lite Micro on an Arduino. |
4 | | - |
5 | | -## Table of contents |
6 | | -<!--ts--> |
7 | | -* [Table of contents](#table-of-contents) |
8 | | -* [Build Status](#build-status) |
9 | | -* [How to Install](#how-to-install) |
10 | | - * [GitHub](#github) |
11 | | - * [Checking your Installation](#checking-your-installation) |
12 | | -* [Compatibility](#compatibility) |
13 | | -* [License](#license) |
14 | | -* [Contributing](#contributing) |
15 | | -<!--te--> |
16 | | - |
17 | | -## Build Status |
18 | | - |
19 | | -Build Type | Status | |
20 | | ---------------- | ------------- | |
21 | | -Arduino CLI on Linux | [](https://github.com/tensorflow/tflite-micro-arduino-examples/actions/workflows/ci.yml) |
22 | | -Sync from tflite-micro | [](https://github.com/tensorflow/tflite-micro-arduino-examples/actions/workflows/sync.yml) |
23 | | - |
24 | | -## How to Install |
25 | | - |
26 | | -### GitHub |
27 | | - |
28 | | -The officially supported TensorFlow Lite Micro library for Arduino resides |
29 | | -in the [tflite-micro-arduino-examples](https://github.com/tensorflow/tflite-micro-arduino-examples) |
30 | | -GitHub repository. |
31 | | -To install the in-development version of this library, you can use the |
32 | | -latest version directly from the GitHub repository. This requires you clone the |
33 | | -repo into the folder that holds libraries for the Arduino IDE. The location for |
34 | | -this folder varies by operating system, but typically it's in |
35 | | -`~/Arduino/libraries` on Linux, `~/Documents/Arduino/libraries/` on MacOS, and |
36 | | -`My Documents\Arduino\Libraries` on Windows. |
37 | | - |
38 | | -Once you're in that folder in the terminal, you can then grab the code using the |
39 | | -git command line tool: |
40 | | - |
41 | | -``` |
42 | | -git clone https://github.com/tensorflow/tflite-micro-arduino-examples Arduino_TensorFlowLite |
43 | | -``` |
44 | | - |
45 | | -To update your clone of the repository to the latest code, use the following terminal commands: |
46 | | -``` |
47 | | -cd Arduino_TensorFlowLite |
48 | | -git pull |
49 | | -``` |
50 | | - |
51 | | -### Checking your Installation |
52 | | - |
53 | | -Once the library has been installed, you should then start the Arduino IDE. |
54 | | -You will now see an `Arduino_TensorFlowLite` |
55 | | -entry in the `File -> Examples` menu of the Arduino IDE. This submenu contains a list |
56 | | -of sample projects you can try out. |
57 | | - |
58 | | - |
59 | | - |
60 | | -## Compatibility |
61 | | - |
62 | | -This library is designed for the `Arduino Nano 33 BLE Sense` board. The framework |
63 | | -code for running machine learning models should be compatible with most Arm Cortex |
64 | | -M-based boards, such as the `Raspberry Pi Pico`, but the code to access peripherals |
65 | | -like microphones, cameras, and accelerometers is specific to the `Nano 33 BLE Sense`. |
| 3 | +This repository has the code (including examples) needed to use Tensorflow Lite Micro on [RTduino](https://github.com/RTduino/RTduino). |
66 | 4 |
|
67 | 5 | ## License |
68 | 6 |
|
69 | 7 | This code is made available under the Apache 2 license. |
70 | | - |
71 | | -## Contributing |
72 | | - |
73 | | -Forks of this library are welcome and encouraged. If you have bug reports or |
74 | | -fixes to contribute, the source of this code is at [https://github.com/tensorflow/tflite-micro](http://github.com/tensorflow/tflite-micro) |
75 | | -and all issues and pull requests should be directed there. |
76 | | - |
77 | | -The code here is created through an automatic project generation process |
78 | | -and may differ from |
79 | | -that source of truth, since it's cross-platform and needs to be modified to |
80 | | -work within the Arduino IDE. |
0 commit comments