Remove deprecated ml_getLabels() function (& update some comments).

Author: microbit-carlos

mlrunner/example_dataprocessor.c

@@ -5,10 +5,8 @@
  * Copyright 2024 Micro:bit Educational Foundation.
  * SPDX-License-Identifier: MIT
  *
- * TODO: Need to double buffer this so that a model can be run while the
- * next data is being collected.
- * TODO: Need to make isDataReady() more robust as right now it needs to be
- * called after each recordData() call.
+ * This processor is no longer used in testextension.cpp, but it is still
+ * included as a simpler example of how to implement a data processor.
  */
 #include "mldataprocessor.h"
 

mlrunner/filterdataprocessor.c

@@ -5,8 +5,9 @@
  * Copyright 2024 Micro:bit Educational Foundation.
  * SPDX-License-Identifier: MIT
  *
- * TODO: Need to double buffer this so that a model can be run while the
- * next data is being collected.
+ * TODO: Could be double buffered so that an interruptible model could be
+ * run while the data is still being collected. Currently the model run
+ * is quick enough where this is not necessary.
  */
 #include <string.h>
 #include "mldataprocessor.h"

mlrunner/mlrunner.c

@@ -142,78 +142,6 @@ int ml_getOutputLength() {
     return output_length;
 }
 
-// TODO: Remove this function and use ml_getLabels instead
-ml_labels_t* ml_getLabels() {
-    static ml_labels_t labels = {
-        .num_labels = 0,
-        .labels = NULL
-    };
-
-    const ml_model_header_t* const model_header = (ml_model_header_t*)MODEL_ADDRESS;
-    if (model_header == NULL) {
-        labels.num_labels = 0;
-        if (labels.labels != NULL) {
-            free(labels.labels);
-            labels.labels = NULL;
-        }
-        return NULL;
-    }
-
-    // Workout the addresses in flash from each label, there are as many strings
-    // as indicated by model_header->number_of_actions
-    const char* flash_labels[model_header->number_of_actions];
-    ml_header_action_t *action = (ml_header_action_t *)&model_header->actions[0];
-    for (int i = 0; i < model_header->number_of_actions; i++) {
-        flash_labels[i] = &action->label[0];
-        // Check the label has a single null terminator at the end
-        for (int j = 0; j < action->label_length - 1; j++) {
-            if (flash_labels[i][j] == '\0') {
-                return NULL;
-            }
-        }
-        // And check the last character is a null terminator
-        if (flash_labels[i][action->label_length - 1] != '\0') {
-            return NULL;
-        }
-        action = (ml_header_action_t *)((uint32_t)action + ml_action_size_without_label + action->label_length);
-        // Next action address is 4 byte aligned
-        action = (ml_header_action_t *)(((uint32_t)action + 3) & ~3);
-    }
-
-    // First check if the labels are the same, if not we need to set them again
-    bool set_labels = false;
-    if (labels.num_labels == 0 || labels.labels == NULL) {
-        set_labels = true;
-    } else if (labels.num_labels != model_header->number_of_actions) {
-        set_labels = true;
-    } else {
-        for (size_t i = 0; i < labels.num_labels; i++) {
-            if (labels.labels[i] != flash_labels[i]) {
-                set_labels = true;
-                break;
-            }
-        }
-    }
-    if (set_labels) {
-        // First clear them out if needed
-        labels.num_labels = 0;
-        if (labels.labels != NULL) {
-            free(labels.labels);
-        }
-        // Then set them to point to the strings in flash
-        labels.labels = (const char **)malloc(model_header->number_of_actions * sizeof(char *));
-        if (labels.labels == NULL) {
-            return NULL;
-        }
-        labels.num_labels = model_header->number_of_actions;
-        for (size_t i = 0; i < labels.num_labels; i++) {
-            labels.labels[i] = flash_labels[i];
-        }
-    }
-
-    return &labels;
-}
-
 ml_actions_t* ml_allocateActions() {
     const ml_model_header_t* const model_header = (ml_model_header_t*)MODEL_ADDRESS;
     if (model_header == NULL) {

mlrunner/mlrunner.h

@@ -136,15 +136,6 @@ int ml_getInputLength();
  */
 int ml_getOutputLength();
 
-/**
- * @brief Get the model labels.
- *
- * The label pointers point directly to the strings stored in flash.
- *
- * @return A pointer to a ml_labels_t object containing the labels.
- */
-ml_labels_t* ml_getLabels();
-
 /**
  * @brief Allocate memory for the model actions.
  *