Merge pull request #655 from microbit-foundation/main

Fingerpints, validate, and more...

Author: Karlo-Emilo

.github/workflows/math.yml

@@ -0,0 +1,79 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+# GitHub recommends pinning actions to a commit SHA.
+# To get a newer version, you will need to update the SHA.
+# You can also reference a tag or branch, but the action may change without warning.
+
+name: Testing deployment
+
+env:
+  APP_LOCATION: "/" # location of your client code
+  APP_ARTIFACT_LOCATION: "/dist" # location of client code build output
+
+on:
+  push:
+    branches:
+      - production-math
+  pull_request:
+    types: [opened, synchronize, reopened, closed]
+    branches:
+      - production-math
+
+permissions:
+  issues: write
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Run Tests
+        run: |
+          npm ci 
+          npm test
+  formatting_and_linting:
+    name: Prettier / svelte Check
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v3
+      - name: Run prettier
+        shell: bash
+        run: |
+          npm ci
+          npm run checkFormat 
+      - name: Svelte check
+        shell: bash
+        run: npm run check
+
+  build_and_deploy:
+    if: github.event_name == 'push' || (github.event_name == 'pull_request' && github.event.action != 'closed')
+    runs-on: ubuntu-latest
+    name: Build and Deploy
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: true
+      - name: Build And Deploy
+        uses: Azure/static-web-apps-deploy@1a947af9992250f3bc2e68ad0754c0b0c11566c9
+        with:
+          azure_static_web_apps_api_token: ${{ secrets.AZURE_STATIC_WEB_APPS_API_PRODUCTION_MATH_TOKEN }}
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          action: "upload"
+          app_location: ${{ env.APP_LOCATION }}
+          app_artifact_location: ${{ env.APP_ARTIFACT_LOCATION }}
+
+  close:
+    if: github.event_name == 'pull_request' && github.event.action == 'closed'
+    runs-on: ubuntu-latest
+    name: Close
+    steps:
+      - name: Close
+        uses: Azure/static-web-apps-deploy@1a947af9992250f3bc2e68ad0754c0b0c11566c9
+        with:
+          azure_static_web_apps_api_token: ${{ secrets.AZURE_STATIC_WEB_APPS_API_PRODUCTION_MATH_TOKEN }}
+          action: "close"

features.json

@@ -5,5 +5,7 @@
   "makecode": true,
   "liveGraphInputValues": true,
   "recordingScrubberValues": true,
-  "modelValidation": true
+  "modelValidation": true,
+  "modelSettings": true,
+  "fingerprint": true
 }

src/App.svelte

@@ -30,7 +30,6 @@
   import Router from './router/Router.svelte';
   import { Feature, getFeature } from './lib/FeatureToggles';
   import { welcomeLog } from './lib/utils/Logger';
-  import { DeviceRequestStates, state } from './lib/stores/Stores';
   import MediaQuery from './components/layout/MediaQuery.svelte';
   import BottomBarMenuView from './components/layout/BottomBarMenuView.svelte';
   import CookieBanner from './components/features/cookie-bannner/CookieBanner.svelte';
@@ -39,11 +38,17 @@
   import OverlayView from './components/layout/OverlayView.svelte';
   import SideBarMenuView from './components/layout/SideBarMenuView.svelte';
   import PageContentView from './components/layout/PageContentView.svelte';
+  import { stores } from './lib/stores/Stores';
+  import { DeviceRequestStates } from './lib/domain/Devices';
+  import { isLoading } from './lib/stores/ApplicationState';
+
+  const devices = stores.getDevices();
+
   welcomeLog();
 
   if (CookieManager.isReconnectFlagSet()) {
-    $state.offerReconnect = true;
-    $state.reconnectState = DeviceRequestStates.INPUT;
+    $devices.offerReconnect = true;
+    $devices.reconnectState = DeviceRequestStates.INPUT;
     CookieManager.unsetReconnectFlag();
   }
 
@@ -56,7 +61,7 @@
     <!-- Denies mobile users access to the platform -->
     <IncompatiblePlatformView />
   {:else}
-    {#if $state.isLoading}
+    {#if $isLoading}
       <main class="h-screen w-screen bg-primary flex absolute z-10" transition:fade>
         <LoadingSpinner />
       </main>

src/StaticConfiguration.ts

@@ -148,5 +148,10 @@ class StaticConfiguration {
    * Whether the knn model should be normalized by default
    */
   public static readonly knnNormalizedDefault = false;
+
+  /**
+   * Whether fingerprinting should be enabled by default
+   */
+  public static readonly enableFingerprintByDefault: boolean = false;
 }
 export default StaticConfiguration;

src/__tests__/csv/csv.test.ts

@@ -0,0 +1,116 @@
+/**
+ * @vitest-environment jsdom
+ */
+/**
+ * (c) 2023-2025, Center for Computational Thinking and Design at Aarhus University and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+import { writable } from 'svelte/store';
+import type { RecordingData } from '../../lib/domain/RecordingData';
+import Gesture from '../../lib/domain/stores/gesture/Gesture';
+import type { PersistedGestureData } from '../../lib/domain/stores/gesture/Gestures';
+import type GestureConfidence from '../../lib/domain/stores/gesture/GestureConfidence';
+import {
+  serializeGestureRecordingsToCSV,
+  serializeRecordingToCsvWithoutGestureName,
+} from '../../lib/utils/CSVUtils';
+
+describe('CSV Test', () => {
+  // A crude way to enforce direction of dependencies, inspired by ArchUnit for java
+  test('Convert recording', () => {
+    const input: RecordingData = {
+      ID: 123,
+      labels: ['x', 'y', 'z'],
+      samples: [
+        {
+          vector: [1, 2, 3],
+        },
+        {
+          vector: [4, 5, 6],
+        },
+        {
+          vector: [7, 8, 9],
+        },
+      ],
+    };
+    const data = writable({
+      recordings: [input],
+      name: 'Test;Gesture',
+    } as PersistedGestureData);
+    const confidence = writable({}) as unknown as GestureConfidence;
+    const gesture: Gesture = new Gesture(data, confidence, () => void 0);
+    const result = serializeGestureRecordingsToCSV([gesture]);
+    expect(result).toBe(
+      'gesture;sample;x;y;z\nTest\\;Gesture;0;1;2;3\nTest\\;Gesture;1;4;5;6\nTest\\;Gesture;2;7;8;9',
+    );
+  });
+
+  test('Convert multiple gestures', () => {
+    const input1: RecordingData = {
+      ID: 123,
+      labels: ['x', 'y', 'z'],
+      samples: [
+        {
+          vector: [1, 2, 3],
+        },
+        {
+          vector: [4, 5, 6],
+        },
+      ],
+    };
+    const input2: RecordingData = {
+      ID: 456,
+      labels: ['x', 'y', 'z'],
+      samples: [
+        {
+          vector: [7, 8, 9],
+        },
+        {
+          vector: [10, 11, 12],
+        },
+      ],
+    };
+    const data1 = writable({
+      recordings: [input1],
+      name: 'Gesture1',
+    } as PersistedGestureData);
+    const data2 = writable({
+      recordings: [input2],
+      name: 'Gesture2',
+    } as PersistedGestureData);
+    const confidence = writable({}) as unknown as GestureConfidence;
+    const gesture1: Gesture = new Gesture(data1, confidence, () => void 0);
+    const gesture2: Gesture = new Gesture(data2, confidence, () => void 0);
+    const result = serializeGestureRecordingsToCSV([gesture1, gesture2]);
+    expect(result).toBe(
+      'gesture;sample;x;y;z\n' +
+        'Gesture1;0;1;2;3\n' +
+        'Gesture1;1;4;5;6\n' +
+        'Gesture2;0;7;8;9\n' +
+        'Gesture2;1;10;11;12',
+    );
+  });
+
+  test('Serialize recording without gesture name (with headers)', () => {
+    const input: RecordingData = {
+      ID: 123,
+      labels: ['x', 'y', 'z'],
+      samples: [
+        {
+          vector: [1, 2, 3],
+        },
+        {
+          vector: [4, 5, 6],
+        },
+        {
+          vector: [7, 8, 9],
+        },
+      ],
+    };
+
+    const result = serializeRecordingToCsvWithoutGestureName(input);
+    expect(result).toBe('sample;x;y;z\n' + '0;1;2;3\n' + '1;4;5;6\n' + '2;7;8;9');
+  });
+});

src/__tests__/mocks/mlmodel/TestMLModelTrainer.ts

@@ -3,12 +3,17 @@
  *
  * SPDX-License-Identifier: MIT
  */
+import type { ModelInfo } from '../../../lib/domain/ModelRegistry';
+import ModelRegistry from '../../../lib/domain/ModelRegistry';
 import type { ModelTrainer } from '../../../lib/domain/ModelTrainer';
 import type { TrainingDataRepository } from '../../../lib/domain/TrainingDataRepository';
 import TestMLModel from './TestMLModel';
 
 class TestMLModelTrainer implements ModelTrainer<TestMLModel> {
   constructor(private numberOfGestures: number) {}
+  getModelInfo(): ModelInfo {
+    return ModelRegistry.NeuralNetwork;
+  }
   public trainModel(trainingData: TrainingDataRepository): Promise<TestMLModel> {
     return Promise.resolve(new TestMLModel(this.numberOfGestures));
   }

src/__viteBuildVariants__/ml-machine-simple/features.json

@@ -5,5 +5,7 @@
   "makecode": false,
   "liveGraphInputValues": false,
   "recordingScrubberValues": false,
-  "modelValidation": false
+  "modelValidation": false,
+  "modelSettings": false,
+  "fingerprint": false
 }

src/__viteBuildVariants__/ml-machine/features.json

@@ -5,5 +5,7 @@
   "makecode": true,
   "liveGraphInputValues": true,
   "recordingScrubberValues": true,
-  "modelValidation": true
+  "modelValidation": true,
+  "modelSettings": true,
+  "fingerprint": true
 }

src/__viteBuildVariants__/unbranded/features.json

@@ -5,5 +5,7 @@
   "makecode": true,
   "liveGraphInputValues": true,
   "recordingScrubberValues": true,
-  "modelValidation": true
+  "modelValidation": true,
+  "modelSettings": true,
+  "fingerprint": true
 }

src/assets/messages/ui.da.json

@@ -50,6 +50,7 @@
   "content.data.noData.exampleName.shake": "Ryste",
   "content.data.noData.exampleName.still": "Stille",
   "content.data.noData.exampleName.circle": "Cirkel",
+  "content.data.tooltip.remove": "Fjern",
   "content.trainer.failure.header": "Træning mislykkedes",
   "content.trainer.failure.body": "Træningen resulterede ikke i en brugbar model. Grunden til dette ligger sandsynligvis i dataet. Hvis dataet i forskellige klasser minder for meget om hinanden, kan dette resultere i nogle forskellige problemer i træningsprocessen, der ikke gør det muligt at træne modellen ordentligt.",
   "content.trainer.failure.todo": "Gå tilbage til datasiden og ændr i din data.",
@@ -111,8 +112,9 @@
   "content.validation.infobox.classesContent": "Her kan du se de klasser, du har defineret på datasiden.",
   "content.validation.noGestures.title": "Ingen klasser...",
   "content.validation.noGestures.description": "Du har endnu ikke tilføjet nogen klasser. Gå til datatrinnet i menuen til venstre og tilføj nogle.",
-  "content.validation.tutorial.title": "Validierungssätze",
-  "content.validation.tutorial.description": "Erstelle einen separaten Datensatz, um die Leistung deines Modells zu bewerten. Das Modell wird nicht mit diesen Daten trainiert.",
+  "content.validation.tutorial.title": "Valideringssæt",
+  "content.validation.tutorial.description": "Opret et separat datasæt til at evaluere dit models ydeevne. Modellen vil ikke blive trænet på disse data.",
+  "content.validation.tutorial.trainmodelfirst": "Zuerst ein Modell trainieren",
   "footer.connectButtonNotConnected": "Tilslut din BBC micro:bit",
   "footer.disconnectButton": "Frakobl",
   "footer.helpHeader": "Live graf",