Skip to content

Commit aac4405

Browse files
authored
Updated README (tensorflow#37)
1 parent 927b370 commit aac4405

File tree

1 file changed

+52
-6
lines changed

1 file changed

+52
-6
lines changed

README.md

+52-6
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,63 @@
1-
This repository will have the code (including examples) needed to use Tensorflow Lite Micro on an Arduino.
1+
# TensorFlow Lite Micro Library for Arduino
22

3-
# Build Status
3+
This repository has the code (including examples) needed to use Tensorflow Lite Micro on an Arduino.
4+
5+
## Build Status
46

57
Build Type | Status |
68
--------------- | ------------- |
79
Arduino CLI on Linux | [![Arduino](https://github.com/tensorflow/tflite-micro-arduino-examples/actions/workflows/ci.yml/badge.svg?event=schedule)](https://github.com/tensorflow/tflite-micro-arduino-examples/actions/workflows/ci.yml)
810
Sync from tflite-micro | [![Sync from tflite-micro](https://github.com/tensorflow/tflite-micro-arduino-examples/actions/workflows/sync.yml/badge.svg)](https://github.com/tensorflow/tflite-micro-arduino-examples/actions/workflows/sync.yml)
911

10-
# Trying out the Code
12+
## How to Install
13+
14+
### Arduino IDE
15+
16+
The easiest way to install this library is through the Arduino's library manager.
17+
In the menus, go to Sketch->Include Library->Manage Libraries. This will pull
18+
the latest stable version.
19+
20+
### GitHub
21+
22+
If you want to install an in-development version of this library, you can use the
23+
latest version directly from this GitHub repository. This requires you clone the
24+
repo into the folder that holds libraries for the Arduino IDE. The location for
25+
this folder varies by operating system, but typically it's in
26+
`~/Arduino/libraries` on Linux, `~/Documents/Arduino/libraries/` on MacOS, and
27+
`My Documents\Arduino\Libraries` on Windows.
28+
29+
Once you're in that folder in the terminal, you can then grab the code using the
30+
git command line tool:
31+
32+
```bash
33+
git clone https://github.com/tensorflow/tflite-micro-arduino-examples Arduino_TensorFlowLite
34+
```
1135

12-
To use the latest version of the TFLM Arduino examples directly from this GitHib
13-
repository, you can clone the repo into `~/Arduino/libraries` and then open up the
14-
TFLM examples in your Arduino IDE.
36+
### Checking your Installation
37+
38+
Once the library has been installed, you should see an Arduino_TensorFlowLite
39+
entry in the File->Examples menu of the Arduino IDE. This submenu contains a list
40+
of sample projects you can try out.
1541

1642
![Hello World](docs/hello_world_screenshot.png)
1743

44+
## Compatibility
45+
46+
This library is designed for the Arduino Nano BLE Sense 33 board. The framework
47+
code for running machine learning models should be compatible with most Arm Cortex
48+
M-based boards, such as the Raspberry Pi Pico, but the code to access peripherals
49+
like microphones, cameras, and accelerometers is specific to the Nano.
50+
51+
## License
52+
53+
This code is made available under the Apache 2 license.
54+
55+
## Contributing
56+
57+
Forks of this library are welcome and encouraged. If you have bug reports or
58+
fixes to contribute, the source of this code is at [https:://github.com/tensorflow/tflite-micro](github.com/tensorflow/tflite-micro)
59+
and all issues and pull requests should be directed there.
60+
61+
The code here is created through an automatic project generation process from
62+
that source of truth, since it's cross-platform and needs to be modified to
63+
work within the Arduino IDE.

0 commit comments

Comments
 (0)