Get Started

This document describes how to set up the environment for ESP-DL. You can use any ESP development board by Espressif or other vendors.

Get ESP-IDF

ESP-DL runs based on ESP-IDF. For detailed instructions on how to get ESP-IDF, please see ESP-IDF Programming Guide.

Download ESP-DL using the following command:

git clone https://github.com/espressif/esp-dl.git

Open Terminal and go to the tutorial/convert_tool_example directory:
```
cd ~/esp-dl/tutorial/convert_tool_example
```
or to example projects in the examples directory.
Set the SoC target by running:
```
idf.py set-target [SoC]
```
Replace [SoC] with your SoC target, such as esp32, esp32s2, esp32s3 and esp32c3.

Note that ESP32-C3 is aimed only at applications which do not require PSRAM.
Flash the firmware and print the result:
```
idf.py flash monitor
```
If you go to the tutorial/convert_tool_example directory in Step 2, and
- your SoC target is ESP32, then
```
MNIST::forward: 37294 μs
Prediction Result: 9
```
- your SoC target is ESP32-S3, then
```
MNIST::forward: 6103 μs
Prediction Result: 9
```

ESP-DL is a library that contains various deep-learning APIs. We recommend using ESP-DL as a component in a project.

For example, ESP-DL can be a submodule of the ESP-WHO repository if added to esp-who/components/ directory.