major refactoring of classes and layout

Author: eloquentarduino

README.md

@@ -8,12 +8,15 @@ interface to load a model and run inferences.
 
 ## Install
 
-Clone this repo in you Arduino libraries folder.
+EloquentTinyML is available from the Arduino IDE Library Manager or
+you can clone this repo in you Arduino libraries folder.
 
 ```bash
 git clone https://github.com/eloquentarduino/EloquentTinyML.git
 ```
 
+**Be sure you install version 2.4.0 or newer.**
+
 ## Export TensorFlow Lite model
 
 To run a model on your microcontroller, you should first have a model.
@@ -22,42 +25,65 @@ I suggest you use [`tinymlgen`](https://github.com/eloquentarduino/tinymlgen) to
 it will export your TensorFlow Lite model to a C array ready to be loaded
 by this library.
 
+```python
+from tinymlgen import port
+
+
+tf_model = create_tf_network()
+print(port(tf_model))
+```
+
 
 ## Use
 
 ```cpp
 #include <EloquentTinyML.h>
+#include <eloquent_tinyml/tensorflow.h>
+
+// sine_model.h contains the array you exported from Python with xxd or tinymlgen
 #include "sine_model.h"
 
-#define NUMBER_OF_INPUTS 1
-#define NUMBER_OF_OUTPUTS 1
+#define N_INPUTS 1
+#define N_OUTPUTS 1
+// in future projects you may need to tweak this value: it's a trial and error process
 #define TENSOR_ARENA_SIZE 2*1024
 
-Eloquent::TinyML::TfLite<
-    NUMBER_OF_INPUTS,
-    NUMBER_OF_OUTPUTS,
-    TENSOR_ARENA_SIZE> ml;
+Eloquent::TinyML::TensorFlow::TensorFlow<N_INPUTS, N_OUTPUTS, TENSOR_ARENA_SIZE> tf;
 
 
 void setup() {
     Serial.begin(115200);
-    ml.begin(sine_model);
+    delay(4000);
+    tf.begin(sine_model);
+    
+    // check if model loaded fine
+    if (!tf.isOk()) {
+        Serial.print("ERROR: ");
+        Serial.println(tf.getErrorMessage());
+        
+        while (true) delay(1000);
+    }
 }
 
 void loop() {
-    float x = 3.14 * random(100) / 100;
-    float y = sin(x);
-    float input[1] = { x };
-    float predicted = ml.predict(input);
-
-    Serial.print("sin(");
-    Serial.print(x);
-    Serial.print(") = ");
-    Serial.print(y);
-    Serial.print("\t predicted: ");
-    Serial.println(predicted);
-    delay(1000);
+    for (float i = 0; i < 10; i++) {
+        // pick x from 0 to PI
+        float x = 3.14 * i / 10;
+        float y = sin(x);
+        float input[1] = { x };
+        float predicted = tf.predict(input);
+        
+        Serial.print("sin(");
+        Serial.print(x);
+        Serial.print(") = ");
+        Serial.print(y);
+        Serial.print("\t predicted: ");
+        Serial.println(predicted);
+    }
+
+    delay(10000);
 }
+
 ```
 
 ## Compatibility

examples/2.4/PersonDetection/ESP32Camera.h

@@ -0,0 +1,24 @@
+#define CAMERA_MODEL_M5STACK_WIDE
+#include <EloquentVision.h>
+
+Eloquent::Vision::ESP32Camera camera;
+camera_fb_t *frame;
+
+
+
+/**
+ * Configure camera
+ */
+void initCamera() {
+  camera.begin(FRAMESIZE_QVGA, PIXFORMAT_GRAYSCALE, 20000000);
+}
+
+
+/**
+ * Capture frame from ESP32 camera
+ */
+uint8_t* captureFrame() {
+  frame = camera.capture();
+
+  return frame->buf;
+}

examples/2.4/PersonDetection/PersonDetection.ino

@@ -0,0 +1,60 @@
+#include <EloquentTinyML.h>
+#include <eloquent_tinyml/tensorflow/person_detection.h>
+
+#if defined(ESP32)
+  #include "ESP32Camera.h"
+#else
+  #include "PortentaVision.h"
+#endif
+
+const uint16_t imageWidth = 320;
+const uint16_t imageHeight = 240;
+
+
+Eloquent::TinyML::TensorFlow::PersonDetection<imageWidth, imageHeight> detector;
+
+
+void setup() {
+  Serial.begin(115200);
+  delay(5000);
+  initCamera();
+  
+  // configure a threshold for "robust" person detection
+  // if no threshold is set, "person" would be detected everytime person_score > not_person_score
+  // even if just by 1 
+  // by trial and error, considering that scores range from 0 to 255, a threshold of 190-200
+  // dramatically reduces the number of false positives
+  detector.setDetectionAbsoluteThreshold(190);
+  detector.begin();
+
+  // abort if an error occurred
+  if (!detector.isOk()) {
+    Serial.print("Setup error: ");
+    Serial.println(detector.getErrorMessage());
+
+    while (true) delay(1000);
+  }
+}
+
+void loop() {
+  uint8_t *frame = captureFrame();
+  bool isPersonInFrame = detector.detectPerson(frame);
+
+  if (!detector.isOk()) {
+    Serial.print("Loop error: ");
+    Serial.println(detector.getErrorMessage());
+
+    delay(10000);
+    return;
+  }
+  
+  Serial.print(isPersonInFrame ? "Person detected" : "No person detected");
+  Serial.print(" (it took ");
+  Serial.print(detector.getElapsedTime());
+  Serial.println("ms to detect)");
+  Serial.print("\t > Person score: ");
+  Serial.println(detector.getPersonScore());
+  Serial.print("\t > Not person score: ");
+  Serial.println(detector.getNotPersonScore());
+  delay(1000);
+}

examples/2.4/PersonDetection/PortentaVision.h

@@ -0,0 +1,22 @@
+#include "camera.h"
+
+CameraClass cam;
+uint8_t frame[320*240];
+
+
+/**
+ * Configure camera
+ */
+void initCamera() {
+  cam.begin(CAMERA_R320x240, 30);
+}
+
+
+/**
+ * Capture frame from Vision shield
+ */
+uint8_t* captureFrame() {
+  cam.grab(frame);
+
+  return frame;
+}

examples/2.4/SineExample/SineExample.ino

@@ -0,0 +1,46 @@
+#include <EloquentTinyML.h>
+#include <eloquent_tinyml/tensorflow.h>
+
+// sine_model.h contains the array you exported from Python with xxd or tinymlgen
+#include "sine_model.h"
+
+#define N_INPUTS 1
+#define N_OUTPUTS 1
+// in future projects you may need to tweak this value: it's a trial and error process
+#define TENSOR_ARENA_SIZE 2*1024
+
+Eloquent::TinyML::TensorFlow::TensorFlow<N_INPUTS, N_OUTPUTS, TENSOR_ARENA_SIZE> tf;
+
+
+void setup() {
+    Serial.begin(115200);
+    delay(4000);
+    tf.begin(sine_model);
+
+    // check if model loaded fine
+    if (!tf.isOk()) {
+      Serial.print("ERROR: ");
+      Serial.println(tf.getErrorMessage());
+
+      while (true) delay(1000);
+    }
+}
+
+void loop() {
+    for (float i = 0; i < 10; i++) {
+        // pick x from 0 to PI
+        float x = 3.14 * i / 10;
+        float y = sin(x);
+        float input[1] = { x };
+        float predicted = tf.predict(input);
+
+        Serial.print("sin(");
+        Serial.print(x);
+        Serial.print(") = ");
+        Serial.print(y);
+        Serial.print("\t predicted: ");
+        Serial.println(predicted);
+    }
+
+    delay(1000);
+}