edge-impulse-linux 1.16.2 → 1.17.2

package/build/library/classifier/linux-impulse-runner-types.d.ts

@@ -0,0 +1,177 @@
+export type RunnerErrorResponse = {
+    success: false;
+    error: string;
+};
+export type RunnerHelloRequest = {
+    hello: 1;
+};
+export declare enum RunnerHelloHasAnomaly {
+    None = 0,
+    KMeans = 1,
+    GMM = 2,
+    VisualGMM = 3,
+    VisualPatchcore = 4
+}
+export declare enum RunnerHelloInferencingEngine {
+    None = 255,
+    Utensor = 1,
+    Tflite = 2,
+    Cubeai = 3,
+    TfliteFull = 4,
+    TensaiFlow = 5,
+    TensorRT = 6,
+    Drpai = 7,
+    TfliteTidl = 8,
+    Akida = 9,
+    Syntiant = 10,
+    OnnxTidl = 11,
+    Memryx = 12
+}
+export type RunnerHelloResponseModelParameters = {
+    axis_count: number;
+    frequency: number;
+    has_anomaly: RunnerHelloHasAnomaly;
+    /**
+     * NOTE: This field is _experimental_. It might change when object tracking
+     * is released publicly.
+     */
+    has_object_tracking?: boolean;
+    input_features_count: number;
+    image_input_height: number;
+    image_input_width: number;
+    image_input_frames: number;
+    image_channel_count: number;
+    image_resize_mode?: 'none' | 'fit-shortest' | 'fit-longest' | 'squash';
+    interval_ms: number;
+    label_count: number;
+    sensor: number;
+    labels: string[];
+    model_type: 'classification' | 'object_detection' | 'constrained_object_detection';
+    slice_size: undefined | number;
+    use_continuous_mode: undefined | boolean;
+    inferencing_engine?: undefined | RunnerHelloInferencingEngine;
+    thresholds: ({
+        id: number;
+        type: 'anomaly_gmm';
+        min_anomaly_score: number;
+    } | {
+        id: number;
+        type: 'object_detection';
+        min_score: number;
+    } | {
+        id: number;
+        type: 'object_tracking';
+        keep_grace: number;
+        max_observations: number;
+        threshold: number;
+    })[] | undefined;
+};
+export type RunnerHelloResponseProject = {
+    deploy_version: number;
+    id: number;
+    name: string;
+    owner: string;
+};
+export type RunnerHelloResponseInferencingEngine = {
+    inferencing_engine?: undefined | RunnerHelloInferencingEngine;
+    properties?: undefined | string[];
+};
+export type RunnerHelloResponse = {
+    features_shm?: {
+        name: string;
+        size_bytes: number;
+        type: 'float32';
+        elements: number;
+    };
+    features_shm_error?: string;
+    model_parameters: RunnerHelloResponseModelParameters;
+    project: RunnerHelloResponseProject;
+    inferencing_engine: RunnerHelloResponseInferencingEngine;
+    success: true;
+} | RunnerErrorResponse;
+export type RunnerClassifyRequest = {
+    classify: number[];
+} | {
+    classify_shm: {
+        elements: number;
+    };
+};
+export type RunnerClassifyContinuousRequest = {
+    classify_continuous: number[];
+} | {
+    classify_continuous_shm: {
+        elements: number;
+    };
+};
+export type RunnerClassifyResponseSuccess = {
+    result: {
+        classification?: {
+            [k: string]: number;
+        };
+        bounding_boxes?: {
+            label: string;
+            value: number;
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        }[];
+        /**
+         * NOTE: This field is _experimental_. It might change when object tracking
+         * is released publicly.
+         */
+        object_tracking?: {
+            object_id: number;
+            label: string;
+            value: number;
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        }[];
+        visual_anomaly_grid?: {
+            label: string;
+            value: number;
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        }[];
+        visual_anomaly_max?: number;
+        visual_anomaly_mean?: number;
+        anomaly?: number;
+    };
+    timing: {
+        dsp: number;
+        classification: number;
+        anomaly: number;
+    };
+    info?: string;
+};
+export type RunnerClassifyResponse = ({
+    success: true;
+} & RunnerClassifyResponseSuccess) | RunnerErrorResponse;
+export type RunnerSetThresholdRequest = {
+    set_threshold: {
+        id: number;
+        min_anomaly_score: number;
+    } | {
+        id: number;
+        min_score: number;
+    } | {
+        id: number;
+        keep_grace: number;
+        max_observations: number;
+        threshold: number;
+    };
+};
+export type RunnerSetThresholdResponse = {
+    success: true;
+} | RunnerErrorResponse;
+export type ModelInformation = {
+    project: RunnerHelloResponseProject;
+    modelParameters: RunnerHelloResponseModelParameters & {
+        sensorType: 'unknown' | 'accelerometer' | 'microphone' | 'camera' | 'positional';
+    };
+    inferencingEngine: RunnerHelloResponseInferencingEngine;
+};

package/build/library/classifier/linux-impulse-runner-types.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RunnerHelloInferencingEngine = exports.RunnerHelloHasAnomaly = void 0;
+var RunnerHelloHasAnomaly;
+(function (RunnerHelloHasAnomaly) {
+    RunnerHelloHasAnomaly[RunnerHelloHasAnomaly["None"] = 0] = "None";
+    RunnerHelloHasAnomaly[RunnerHelloHasAnomaly["KMeans"] = 1] = "KMeans";
+    RunnerHelloHasAnomaly[RunnerHelloHasAnomaly["GMM"] = 2] = "GMM";
+    RunnerHelloHasAnomaly[RunnerHelloHasAnomaly["VisualGMM"] = 3] = "VisualGMM";
+    RunnerHelloHasAnomaly[RunnerHelloHasAnomaly["VisualPatchcore"] = 4] = "VisualPatchcore";
+})(RunnerHelloHasAnomaly = exports.RunnerHelloHasAnomaly || (exports.RunnerHelloHasAnomaly = {}));
+var RunnerHelloInferencingEngine;
+(function (RunnerHelloInferencingEngine) {
+    RunnerHelloInferencingEngine[RunnerHelloInferencingEngine["None"] = 255] = "None";
+    RunnerHelloInferencingEngine[RunnerHelloInferencingEngine["Utensor"] = 1] = "Utensor";
+    RunnerHelloInferencingEngine[RunnerHelloInferencingEngine["Tflite"] = 2] = "Tflite";
+    RunnerHelloInferencingEngine[RunnerHelloInferencingEngine["Cubeai"] = 3] = "Cubeai";
+    RunnerHelloInferencingEngine[RunnerHelloInferencingEngine["TfliteFull"] = 4] = "TfliteFull";
+    RunnerHelloInferencingEngine[RunnerHelloInferencingEngine["TensaiFlow"] = 5] = "TensaiFlow";
+    RunnerHelloInferencingEngine[RunnerHelloInferencingEngine["TensorRT"] = 6] = "TensorRT";
+    RunnerHelloInferencingEngine[RunnerHelloInferencingEngine["Drpai"] = 7] = "Drpai";
+    RunnerHelloInferencingEngine[RunnerHelloInferencingEngine["TfliteTidl"] = 8] = "TfliteTidl";
+    RunnerHelloInferencingEngine[RunnerHelloInferencingEngine["Akida"] = 9] = "Akida";
+    RunnerHelloInferencingEngine[RunnerHelloInferencingEngine["Syntiant"] = 10] = "Syntiant";
+    RunnerHelloInferencingEngine[RunnerHelloInferencingEngine["OnnxTidl"] = 11] = "OnnxTidl";
+    RunnerHelloInferencingEngine[RunnerHelloInferencingEngine["Memryx"] = 12] = "Memryx";
+})(RunnerHelloInferencingEngine = exports.RunnerHelloInferencingEngine || (exports.RunnerHelloInferencingEngine = {}));
+//# sourceMappingURL=linux-impulse-runner-types.js.map

package/build/library/classifier/linux-impulse-runner-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"linux-impulse-runner-types.js","sourceRoot":"","sources":["../../../library/classifier/linux-impulse-runner-types.ts"],"names":[],"mappings":";;;AASA,IAAY,qBAMX;AAND,WAAY,qBAAqB;IAC7B,iEAAQ,CAAA;IACR,qEAAU,CAAA;IACV,+DAAO,CAAA;IACP,2EAAa,CAAA;IACb,uFAAmB,CAAA;AACvB,CAAC,EANW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAMhC;AAED,IAAY,4BAcX;AAdD,WAAY,4BAA4B;IACpC,iFAAU,CAAA;IACV,qFAAW,CAAA;IACX,mFAAU,CAAA;IACV,mFAAU,CAAA;IACV,2FAAc,CAAA;IACd,2FAAc,CAAA;IACd,uFAAY,CAAA;IACZ,iFAAS,CAAA;IACT,2FAAc,CAAA;IACd,iFAAS,CAAA;IACT,wFAAa,CAAA;IACb,wFAAa,CAAA;IACb,oFAAW,CAAA;AACf,CAAC,EAdW,4BAA4B,GAA5B,oCAA4B,KAA5B,oCAA4B,QAcvC"}

package/build/library/classifier/linux-impulse-runner.d.ts

@@ -1,125 +1,5 @@
-export declare enum RunnerHelloHasAnomaly {
-    None = 0,
-    KMeans = 1,
-    GMM = 2,
-    VisualGMM = 3
-}
-export declare enum RunnerHelloInferencingEngine {
-    None = 255,
-    Utensor = 1,
-    Tflite = 2,
-    Cubeai = 3,
-    TfliteFull = 4,
-    TensaiFlow = 5,
-    TensorRT = 6,
-    Drpai = 7,
-    TfliteTidl = 8,
-    Akida = 9,
-    Syntiant = 10,
-    OnnxTidl = 11,
-    Memryx = 12
-}
-export type RunnerHelloResponseModelParameters = {
-    axis_count: number;
-    frequency: number;
-    has_anomaly: RunnerHelloHasAnomaly;
-    /**
-     * NOTE: This field is _experimental_. It might change when object tracking
-     * is released publicly.
-     */
-    has_object_tracking?: boolean;
-    input_features_count: number;
-    image_input_height: number;
-    image_input_width: number;
-    image_input_frames: number;
-    image_channel_count: number;
-    image_resize_mode?: 'none' | 'fit-shortest' | 'fit-longest' | 'squash';
-    interval_ms: number;
-    label_count: number;
-    sensor: number;
-    labels: string[];
-    model_type: 'classification' | 'object_detection' | 'constrained_object_detection';
-    slice_size: undefined | number;
-    use_continuous_mode: undefined | boolean;
-    inferencing_engine?: undefined | RunnerHelloInferencingEngine;
-    thresholds: ({
-        id: number;
-        type: 'anomaly_gmm';
-        min_anomaly_score: number;
-    } | {
-        id: number;
-        type: 'object_detection';
-        min_score: number;
-    } | {
-        id: number;
-        type: 'object_tracking';
-        keep_grace: number;
-        max_observations: number;
-        threshold: number;
-    })[] | undefined;
-};
-export type RunnerHelloResponseProject = {
-    deploy_version: number;
-    id: number;
-    name: string;
-    owner: string;
-};
-export type RunnerHelloResponseInferencingEngine = {
-    inferencing_engine?: undefined | RunnerHelloInferencingEngine;
-    properties?: undefined | string[];
-};
-export type RunnerClassifyResponseSuccess = {
-    result: {
-        classification?: {
-            [k: string]: number;
-        };
-        bounding_boxes?: {
-            label: string;
-            value: number;
-            x: number;
-            y: number;
-            width: number;
-            height: number;
-        }[];
-        /**
-         * NOTE: This field is _experimental_. It might change when object tracking
-         * is released publicly.
-         */
-        object_tracking?: {
-            object_id: number;
-            label: string;
-            value: number;
-            x: number;
-            y: number;
-            width: number;
-            height: number;
-        }[];
-        visual_anomaly_grid?: {
-            label: string;
-            value: number;
-            x: number;
-            y: number;
-            width: number;
-            height: number;
-        }[];
-        visual_anomaly_max?: number;
-        visual_anomaly_mean?: number;
-        anomaly?: number;
-    };
-    timing: {
-        dsp: number;
-        classification: number;
-        anomaly: number;
-    };
-    info?: string;
-};
-export type ModelInformation = {
-    project: RunnerHelloResponseProject;
-    modelParameters: RunnerHelloResponseModelParameters & {
-        sensorType: 'unknown' | 'accelerometer' | 'microphone' | 'camera' | 'positional';
-    };
-    inferencingEngine: RunnerHelloResponseInferencingEngine;
-};
+import { ModelInformation, RunnerClassifyResponseSuccess } from './linux-impulse-runner-types';
+export * from './linux-impulse-runner-types';
 export declare class LinuxImpulseRunner {
     private _path;
     private _runner;
@@ -128,11 +8,21 @@ export declare class LinuxImpulseRunner {
     private _id;
     private _stopped;
     private _socket;
+    private _shm;
+    private _verbose;
+    private _shmBehavior;
+    private _valgrind;
+    private _stdout;
     /**
      * Start a new impulse runner
      * @param path Path to the runner's executable
      */
-    constructor(path: string);
+    constructor(path: string, opts?: {
+        valgrind?: boolean;
+        verbose?: boolean;
+        shmBehavior?: 'auto' | 'always' | 'never';
+        throwOnShmInitFailed?: boolean;
+    });
     /**
      * Initialize the runner
      * This returns information about the model
@@ -146,7 +36,7 @@ export declare class LinuxImpulseRunner {
     /**
      * Stop the classification process
      */
-    stop(): Promise<void>;
+    stop(): Promise<string>;
     /**
      * Get information about the model, this is only available
      * after the runner has been initialized
@@ -163,7 +53,7 @@ export declare class LinuxImpulseRunner {
      * @param data An array of numbers, already formatted according to the rules in
      *             https://docs.edgeimpulse.com/docs/running-your-impulse-locally-1
      */
-    classifyContinuous(data: number[]): Promise<RunnerClassifyResponseSuccess>;
+    classifyContinuous(data: number[], timeout?: number): Promise<RunnerClassifyResponseSuccess>;
     setLearnBlockThreshold(obj: {
         id: number;
         type: 'anomaly_gmm';