Merge pull request #387 from Renumics/feature/levenshtein-metric

Feature/levenshtein metric

package.json

@@ -53,6 +53,7 @@
         "d3-zoom": "^3.0.0",
         "detect-gpu": "^5.0.12",
         "dompurify": "^3.0.3",
+        "fast-levenshtein": "^3.0.0",
         "file-saver": "^2.0.5",
         "flexlayout-react": "^0.7.6",
         "fuse.js": "^6.6.2",
@@ -98,6 +99,7 @@
         "@types/chroma-js": "^2.4.0",
         "@types/d3": "^7.4.0",
         "@types/d3-cloud": "^1.2.5",
+        "@types/fast-levenshtein": "^0.0.4",
         "@types/file-saver": "^2.0.5",
         "@types/jest": "^29.4.0",
         "@types/lodash": "^4.14.191",

src/widgets/MetricsWidget/metrics.ts

@@ -1,4 +1,5 @@
 import _ from 'lodash';
+import levenshtein from 'fast-levenshtein';
 import { Metric } from './types';
 import { computeConfusion } from './confusion';
 
@@ -97,4 +98,23 @@ export const METRICS: Record<string, Metric> = {
             );
         },
     },
+    levenshtein: {
+        signature: {
+            X: ['str'],
+            Y: ['str'],
+        },
+        compute: ([actualValues, assignedValues]) => {
+            let sum = 0;
+
+            for (let i = 0; i < actualValues.length; i++) {
+                const actual = actualValues[i];
+                const assigned = assignedValues[i];
+
+                const dist = levenshtein.get(actual as string, assigned as string);
+                sum += dist;
+            }
+
+            return sum / actualValues.length;
+        },
+    },
 };

src/widgets/MetricsWidget/types.ts

@@ -1,6 +1,6 @@
 import { DataKind } from '../../datatypes';
 
-export type ValueArray = number[] | Int32Array | boolean[];
+export type ValueArray = number[] | Int32Array | boolean[] | string[];
 
 export interface Metric {
     signature: Record<string, DataKind | DataKind[]>;