upgrade ppmpredictor

Author: willwade

browser/dasher/controlpanelspecification.js

@@ -68,9 +68,25 @@ export default {
       'order': 1, 'control': 'select', 'label': null}},
   },
 
-  'manage': {
+  'prediction': {
     '$': {'order': 5},
 
+    'ppmAlpha': {$: {
+      'order': 0, 'control': 'number', 'value': '0.49', 'label': 'PPM Alpha'}},
+    'ppmBeta': {$: {
+      'order': 1, 'control': 'number', 'value': '0.77', 'label': 'PPM Beta'}},
+    'ppmMaxNodes': {$: {
+      'order': 2, 'control': 'number', 'value': '0', 'label': 'PPM Max Nodes'}},
+    'ppmUseExclusion': {$: {
+      'order': 3, 'control': 'checkbox', 'value': true, 'label': 'Use Exclusion'}},
+    'ppmUpdateExclusion': {$: {
+      'order': 4, 'control': 'checkbox', 'value': true,
+      'label': 'Single-count Updates'}},
+  },
+
+  'manage': {
+    '$': {'order': 6},
+
     'settings': {
       '$': {'after': 'manager'},
       'copy': {$: {
@@ -99,13 +115,13 @@ export default {
     },
   },
   'display': {
-    '$': {'order': 6},
+    '$': {'order': 7},
 
     'popup': {$: {
       'order': 0, 'control': 'button'}},
   },
   'message': {
-    '$': {'order': 7},
+    '$': {'order': 8},
 
     'add': {$: {
       'order': 0, 'control': 'button'}},
@@ -119,7 +135,7 @@ export default {
       'order': 4, 'control': 'button'}},
   },
   'developer': {
-    '$': {'order': 8},
+    '$': {'order': 9},
 
     'pointer': {$: {
       'order': 0, 'control': 'button'}},

browser/dasher/predictor_ppm_new.js

@@ -26,6 +26,12 @@ const config = {
   lexicon: [], // No lexicon by default (can be added via updateConfig)
   errorTolerant: false, // Strict mode by default
   caseSensitive: false, // Case-insensitive matching
+  // PPM tuning options available in @willwade/ppmpredictor >= 0.0.13.
+  ppmAlpha: 0.49,
+  ppmBeta: 0.77,
+  ppmMaxNodes: 0, // 0 = unlimited
+  ppmUseExclusion: true,
+  ppmUpdateExclusion: true, // Single-count updates
 };
 const characterWeightRange = 90;
 const wordCompletionBoost = 1.8;
@@ -524,6 +530,8 @@ export async function ppmNewGetPredictorAsync() {
  * });
  */
 export function ppmNewUpdateConfig(newConfig) {
+  Object.assign(config, newConfig);
+
   if (!isInitialized) {
     initialize();
   }
@@ -533,6 +541,17 @@ export function ppmNewUpdateConfig(newConfig) {
   }
 }
 
+export function ppmNewUpdatePPMConfig(ppmConfig = {}) {
+  ppmNewUpdateConfig(ppmConfig);
+}
+
+export function ppmNewGetPPMStats() {
+  if (!predictor || typeof predictor.getPPMStats !== 'function') {
+    return null;
+  }
+  return predictor.getPPMStats();
+}
+
 /**
  * Add a training corpus for domain-specific predictions.
  *

browser/dasher/userinterface.js

@@ -28,6 +28,8 @@ import predictor_ppm_new, {
   ppmNewAddCorpus,
   ppmNewSetLearningEnabled,
   ppmNewGetLearningEnabled,
+  ppmNewUpdatePPMConfig,
+  ppmNewGetPPMStats,
 } from './predictor_ppm_new.js';
 
 import Speech from './speech.js';
@@ -111,6 +113,8 @@ export default class UserInterface {
     this._keyHandler = new KeyHandler();
 
     this._diagnosticSpans = null;
+    this._ppmStatsTextNode = null;
+    this._lastPPMStatsRefresh = 0;
     this._controlPanel = new ControlPanel(panels);
     this._panels = this._controlPanel.load();
 
@@ -616,6 +620,7 @@ export default class UserInterface {
       ['colour', 'Colour'],
       ['speed', 'Speed'],
       ['speech', 'Speech'],
+      ['prediction', 'Prediction'],
       ['display', 'Display'],
       ['message', 'Messages'],
       ['manage', 'Manage'],
@@ -1267,9 +1272,45 @@ export default class UserInterface {
     }
     this._load_display_controls();
     this._load_message_controls();
+    this._load_prediction_controls();
     this._load_developer_controls();
   }
 
+  _load_prediction_controls() {
+    if (this._panels.prediction === undefined) {
+      return;
+    }
+    const panel = this._panels.prediction;
+    const numberOrFallback = (value, fallback) => {
+      const parsed = Number.parseFloat(value);
+      return Number.isFinite(parsed) ? parsed : fallback;
+    };
+    const intOrFallback = (value, fallback) => {
+      const parsed = Number.parseInt(value, 10);
+      return Number.isFinite(parsed) ? parsed : fallback;
+    };
+    const clamp = (value, min, max) => Math.min(max, Math.max(min, value));
+
+    panel.ppmAlpha.listener = (value) => {
+      const next = clamp(numberOrFallback(value, 0.49), 0.01, 4);
+      ppmNewUpdatePPMConfig({'ppmAlpha': next});
+    };
+    panel.ppmBeta.listener = (value) => {
+      const next = clamp(numberOrFallback(value, 0.77), 0.01, 4);
+      ppmNewUpdatePPMConfig({'ppmBeta': next});
+    };
+    panel.ppmMaxNodes.listener = (value) => {
+      const next = Math.max(0, intOrFallback(value, 0));
+      ppmNewUpdatePPMConfig({'ppmMaxNodes': next});
+    };
+    panel.ppmUseExclusion.listener = (checked) => {
+      ppmNewUpdatePPMConfig({'ppmUseExclusion': !!checked});
+    };
+    panel.ppmUpdateExclusion.listener = (checked) => {
+      ppmNewUpdatePPMConfig({'ppmUpdateExclusion': !!checked});
+    };
+  }
+
   _select_behaviour(index) {
     this._limits.targetRight = (index === 0);
     this._currentSpeed = (index === 0 ? 0.1 : 0.2);
@@ -1549,7 +1590,8 @@ export default class UserInterface {
     this._diagnostic_div_display();
     // Diagnostic area in which to display various numbers. This is an array
     // so that the values can be updated.
-    const diagnosticSpans = this._panels.developer.diagnostic.$.piece
+    const diagnosticPiece = this._panels.developer.diagnostic.$.piece;
+    const diagnosticSpans = diagnosticPiece
         .create(
             'span', {}, [
               'loading sizes ...',
@@ -1562,9 +1604,42 @@ export default class UserInterface {
     this._stopGoTextNode =
             diagnosticSpans[diagnosticSpans.length - 1].firstChild;
 
+    const ppmStats = diagnosticPiece.create('span', {}, ' | PPM: loading ...');
+    this._ppmStatsTextNode = ppmStats.firstChild;
+
     this._diagnosticSpans = diagnosticSpans;
   }
 
+  _update_ppm_stats_diagnostic(timestamp) {
+    if (
+      this._ppmStatsTextNode === null ||
+      timestamp - this._lastPPMStatsRefresh < 500
+    ) {
+      return;
+    }
+    this._lastPPMStatsRefresh = timestamp;
+    const stats = ppmNewGetPPMStats();
+    if (!Array.isArray(stats) || stats.length === 0) {
+      this._ppmStatsTextNode.nodeValue = ' | PPM: unavailable';
+      return;
+    }
+
+    const summary = stats.map((corpusStats, index) => {
+      if (corpusStats === null || typeof corpusStats !== 'object') {
+        return `c${index}:n/a`;
+      }
+      const numNodes = Number.isFinite(corpusStats.numNodes) ?
+        corpusStats.numNodes : 0;
+      const maxNodes = Number.isFinite(corpusStats.maxNodes) ?
+        corpusStats.maxNodes : 0;
+      const skippedNodeAdds = Number.isFinite(corpusStats.skippedNodeAdds) ?
+        corpusStats.skippedNodeAdds : 0;
+      const limit = maxNodes > 0 ? maxNodes : 'inf';
+      return `c${index}:${numNodes}/${limit} skip:${skippedNodeAdds}`;
+    }).join(' ');
+    this._ppmStatsTextNode.nodeValue = ` | PPM: ${summary}`;
+  }
+
   _load_pointer() {
     // Instantiate the pointer. It will draw the cross hairs and pointer
     // line, always in front of the zoombox as drawn by the viewer.
@@ -1677,6 +1752,7 @@ export default class UserInterface {
       // thousand separators.
       this._heightTextNode.nodeValue = this.zoomBox.height.toLocaleString(
           undefined, {maximumFractionDigits: 0});
+      this._update_ppm_stats_diagnostic(Date.now());
       //
       // Update message to be the message of whichever box is across the
       // origin.

browser/vendor/README.md

@@ -2,6 +2,10 @@ This directory contains vendored browser assets that must be served in static de
 
 Current files:
 - `ppmpredictor.esm.js` copied from `node_modules/@willwade/ppmpredictor/dist/ppmpredictor.esm.js`
+- `ppmpredictor.esm.js.map` copied from `node_modules/@willwade/ppmpredictor/dist/ppmpredictor.esm.js.map`
+
+Current pinned package:
+- `@willwade/ppmpredictor@0.0.13`
 
 Update flow:
 1. Run `npm ci` in repo root.