Merge pull request #350 from code-dot-org/rename-simple-trainer

Rename SimpleTrainer to KNNTrainer as that is a more descriptive name

Author: bethanyaconnor

src/oceans/models/loading.js

@@ -5,7 +5,7 @@ import {AppMode, Modes} from '../constants';
 import {initFishData} from '../../utils/fishData';
 import {getAppMode, $time, finishLoading} from '../helpers';
 import modeHelpers from '../modeHelpers';
-import SimpleTrainer from '../../utils/SimpleTrainer';
+import KNNTrainer from '../../utils/KNNTrainer';
 
 export const init = async () => {
   const startTime = $time();
@@ -23,7 +23,7 @@ export const init = async () => {
   ].includes(appModeBase);
 
   if (appModeBase === AppMode.CreaturesVTrashDemo) {
-    const trainer = new SimpleTrainer(oceanObj => oceanObj.getTensor());
+    const trainer = new KNNTrainer(oceanObj => oceanObj.getTensor());
     setState({trainer, word: 'fish'});
   }
 

src/oceans/models/train.js

@@ -1,7 +1,7 @@
 import 'idempotent-babel-polyfill';
 import {setState, getState} from '../state';
 import {ClassType, AppMode} from '../constants';
-import SimpleTrainer from '../../utils/SimpleTrainer';
+import KNNTrainer from '../../utils/KNNTrainer';
 import SVMTrainer from '../../utils/SVMTrainer';
 import {generateOcean} from '../../utils/generateOcean';
 import I18n from '../i18n';
@@ -14,7 +14,7 @@ const init = () => {
     if ([AppMode.FishShort, AppMode.FishLong].includes(state.appMode)) {
       trainer = new SVMTrainer(fish => fish.getKnnData());
     } else {
-      trainer = new SimpleTrainer(oceanObj => oceanObj.getTensor());
+      trainer = new KNNTrainer(oceanObj => oceanObj.getTensor());
     }
   }
 

src/utils/SimpleTrainer.js renamed to src/utils/KNNTrainer.js

@@ -1,7 +1,7 @@
 import * as tf from '@tensorflow/tfjs';
 import * as knnClassifier from '@tensorflow-models/knn-classifier';
 
-export default class SimpleTrainer {
+export default class KNNTrainer {
   constructor(converterFn) {
     this.converterFn = converterFn || (input => input); // Default to returning example as-is
     this.knn = knnClassifier.create();
@@ -41,7 +41,7 @@ export default class SimpleTrainer {
     return result;
   }
 
-  // SimpleTrainer-specific methods below
+  // KNNTrainer-specific methods below
 
   setTopK(k) {
     this.TOPK = k;

test/unit/oceans/models/pond.test.js

@@ -3,7 +3,7 @@ import {setState, getState, resetState} from '@ml/oceans/state';
 import {TrashOceanObject} from '@ml/oceans/OceanObject';
 import {ClassType, Modes} from '@ml/oceans/constants';
 import {init} from '@ml/oceans/models/pond';
-import SimpleTrainer from '@ml/utils/SimpleTrainer';
+import KNNTrainer from '@ml/utils/KNNTrainer';
 import {generateOcean} from '@ml/utils/generateOcean';
 
 describe('Model quality test', () => {
@@ -14,7 +14,7 @@ describe('Model quality test', () => {
   beforeEach(() => {
     resetState();
     setState({
-      trainer: new SimpleTrainer(),
+      trainer: new KNNTrainer(),
       mode: Modes.Pond,
       fishData: generateOcean(100, 0, true, true)
     });
@@ -31,7 +31,7 @@ describe('Model quality test', () => {
   });
 
   test('init state with predictions', async () => {
-    const trainer = new SimpleTrainer();
+    const trainer = new KNNTrainer();
     trainer.predict = jest.fn(async example => {
       if (example instanceof TrashOceanObject) {
         return {predictedClassId: 1, confidenceByClassId: {0: 0, 1: 1}};

test/unit/oceans/models/predict.test.js

@@ -2,7 +2,7 @@ const {initFishData} = require('@ml/utils/fishData');
 import {setState, getState, resetState} from '@ml/oceans/state';
 import {ClassType, Modes, AppMode} from '@ml/oceans/constants';
 import {init, predictFish} from '@ml/oceans/models/predict';
-import SimpleTrainer from '@ml/utils/SimpleTrainer';
+import KNNTrainer from '@ml/utils/KNNTrainer';
 import {TrashOceanObject} from '@ml/oceans/OceanObject';
 
 describe('Predict test', () => {
@@ -12,7 +12,7 @@ describe('Predict test', () => {
   });
 
   beforeEach(() => {
-    const trainer = new SimpleTrainer();
+    const trainer = new KNNTrainer();
     trainer.predict = jest.fn(async example => {
       if (example instanceof TrashOceanObject) {
         return {predictedClassId: 1, confidenceByClassId: {0: 0, 1: 1}};

test/unit/utils/SimpleTrainer.test.js renamed to test/unit/utils/KNNTrainer.test.js

@@ -2,12 +2,12 @@
  *  @jest-environment node
  */
 
-import SimpleTrainer from '@ml/utils/SimpleTrainer';
+import KNNTrainer from '@ml/utils/KNNTrainer';
 import * as tf from '@tensorflow/tfjs';
 
 describe('Simple Trainer tests', () => {
-  test('SimpleTrainer predicts', async () => {
-    const trainer = new SimpleTrainer();
+  test('KNNTrainer predicts', async () => {
+    const trainer = new KNNTrainer();
     trainer.setTopK(3);
 
     trainer.addTrainingExample(tf.tensor([1, 1]), 0);
@@ -24,8 +24,8 @@ describe('Simple Trainer tests', () => {
     trainer.dispose();
   });
 
-  test('SimpleTrainer can be restored', async () => {
-    const trainer = new SimpleTrainer();
+  test('KNNTrainer can be restored', async () => {
+    const trainer = new KNNTrainer();
     trainer.setTopK(3);
 
     trainer.addTrainingExample(tf.tensor([1, 1]), 0);
@@ -42,7 +42,7 @@ describe('Simple Trainer tests', () => {
     const classifierDatasetString = trainer.getDatasetJSON();
     trainer.clearAll();
 
-    const retrainedTrainer = new SimpleTrainer();
+    const retrainedTrainer = new KNNTrainer();
     retrainedTrainer.setTopK(3);
     const untrainedResult = await retrainedTrainer.predict(tf.tensor([1, 1]));
     expect(untrainedResult.predictedClassId).toEqual(null);

test/unit/utils/generateOcean.test.js

@@ -4,7 +4,7 @@
 
 import {initFishData} from '@ml/utils/fishData';
 import {generateOcean, filterOcean} from '@ml/utils/generateOcean';
-import SimpleTrainer from '@ml/utils/SimpleTrainer';
+import KNNTrainer from '@ml/utils/KNNTrainer';
 
 describe('Generate ocean test', () => {
   beforeAll(() => {
@@ -34,7 +34,7 @@ describe('Generate ocean test', () => {
   test('Can generate predictions on a random set of fish', async () => {
     const numFish = 25;
     const trainingOcean = generateOcean(numFish);
-    const trainer = new SimpleTrainer(fish => fish.getTensor());
+    const trainer = new KNNTrainer(fish => fish.getTensor());
     trainingOcean.forEach(fish => {
       trainer.addTrainingExample(fish, Math.round(Math.random()));
     });