[sentiment] Add unit tests (tensorflow#250)

Author: caisq

sentiment/README.md

@@ -99,3 +99,13 @@ These files can be directly uploaded to the Embedding Projector
 
 See example screenshot:
 ![image](https://user-images.githubusercontent.com/16824702/52145038-f0fce480-262d-11e9-9313-9a5014ace25f.png)
+
+### Running unit tests
+
+This example comes with unit tests. If you would like to submit changes to the code, 
+be sure to run the tests and ensure they pass first:
+
+```sh
+yarn
+yarn test
+```

sentiment/data.js

@@ -21,7 +21,7 @@ import * as https from 'https';
 import * as os from 'os';
 import * as path from 'path';
 
-import {OOV_INDEX, PAD_INDEX, padSequences} from './sequence_utils';
+import {OOV_INDEX, padSequences} from './sequence_utils';
 
 // `import` doesn't seem to work with extract-zip.
 const extract = require('extract-zip');
@@ -92,7 +92,7 @@ function loadFeatures(filePath, numWords, maxLen, multihot = false) {
     const buffer = tf.buffer([sequences.length, numWords]);
     sequences.forEach((seq, i) => {
       seq.forEach(wordIndex => {
-        if (wordIndex !== OOV_CHAR) {
+        if (wordIndex !== OOV_INDEX) {
           buffer.set(1, i, wordIndex);
         }
       });

sentiment/data_test.js

@@ -0,0 +1,57 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC. All Rights Reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * =============================================================================
+ */
+
+import {loadData} from "./data";
+
+describe('loadData', () => {
+  it('multihot = false', async () => {
+    const numWords = 10;
+    const len = 5;
+    const multihot = false;
+    const data = await loadData(numWords, len, multihot);
+
+    expect(data.xTrain.shape.length).toEqual(2);
+    expect(data.yTrain.shape.length).toEqual(2);
+    expect(data.xTrain.shape[0]).toEqual(data.yTrain.shape[0]);
+    expect(data.xTrain.shape[1]).toEqual(5);
+    expect(data.yTrain.shape[1]).toEqual(1);
+    expect(data.xTest.shape.length).toEqual(2);
+    expect(data.yTest.shape.length).toEqual(2);
+    expect(data.xTest.shape[0]).toEqual(data.yTest.shape[0]);
+    expect(data.xTest.shape[1]).toEqual(5);
+    expect(data.yTest.shape[1]).toEqual(1);
+  });
+
+  it('multihot = true', async () => {
+    const numWords = 10;
+    const len = 5;
+    const multihot = true;
+    const data = await loadData(numWords, len, multihot);
+
+    expect(data.xTrain.shape.length).toEqual(2);
+    expect(data.yTrain.shape.length).toEqual(2);
+    expect(data.xTrain.shape[0]).toEqual(data.yTrain.shape[0]);
+    expect(data.xTrain.shape[1]).toEqual(10);
+    expect(data.yTrain.shape[1]).toEqual(1);
+    expect(data.xTest.shape.length).toEqual(2);
+    expect(data.yTest.shape.length).toEqual(2);
+    expect(data.xTest.shape[0]).toEqual(data.yTest.shape[0]);
+    expect(data.xTest.shape[1]).toEqual(10);
+    expect(data.yTest.shape[1]).toEqual(1);
+  });
+});
+

sentiment/embedding_test.js

@@ -0,0 +1,85 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC. All Rights Reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * =============================================================================
+ */
+
+import * as fs from 'fs';
+
+import * as tf from '@tensorflow/tfjs-node';
+import * as shelljs from 'shelljs';
+import * as tmp from 'tmp';
+
+import {buildModel} from "./train";
+import {writeEmbeddingMatrixAndLabels} from "./embedding";
+
+describe('writeEmbeddingMatrixAndLabels', () => {
+  let tmpDir;
+
+  beforeEach(() => {
+    tmpDir = tmp.dirSync().name;
+  });
+
+  afterEach(() => {
+    if (fs.existsSync(tmpDir)) {
+      shelljs.rm('-rf', tmpDir);
+    }
+  });
+
+  it('writeEmbeddingMatrixAndLabels', async () => {
+    const maxLen = 5;
+    const vocabSize = 4;
+    const embeddingSize = 8;
+    const model = buildModel('cnn', maxLen, vocabSize, embeddingSize);
+    expect(model.inputs.length).toEqual(1);
+    expect(model.inputs[0].shape).toEqual([null, maxLen]);
+    expect(model.outputs.length).toEqual(1);
+    expect(model.outputs[0].shape).toEqual([null, 1]);
+
+    model.compile({
+      loss: 'binaryCrossentropy',
+      optimizer: 'rmsprop',
+      metrics: ['acc']
+    });
+    const xs = tf.ones([2, maxLen])
+    const ys = tf.ones([2, 1]);
+    const history = await model.fit(xs, ys, {epochs: 2, batchSize: 2});
+    expect(history.history.loss.length).toEqual(2);
+    expect(history.history.acc.length).toEqual(2);
+
+    const predictOuts = model.predict(xs);
+    expect(predictOuts.shape).toEqual([2, 1]);
+    const values = predictOuts.arraySync();
+    expect(values[0][0]).toBeGreaterThanOrEqual(0);
+    expect(values[0][0]).toBeLessThanOrEqual(1);
+    expect(values[1][0]).toBeGreaterThanOrEqual(0);
+    expect(values[1][0]).toBeLessThanOrEqual(1);
+
+    const wordIndex = {
+      'foo': 1,
+      'bar': 2,
+      'baz': 3,
+      'qux': 4
+    };
+    await writeEmbeddingMatrixAndLabels(model, `${tmpDir}/embed`, wordIndex, 0);
+    const vectorFileContent =
+        fs.readFileSync(`${tmpDir}/embed_vectors.tsv`, {encoding: 'utf-8'})
+        .trim().split('\n');
+    expect(vectorFileContent.length).toEqual(4);
+    const labelsFileContent =
+        fs.readFileSync(`${tmpDir}/embed_labels.tsv`, {encoding: 'utf-8'})
+        .trim().split('\n');
+    expect(labelsFileContent.length).toEqual(4);
+  });
+});

sentiment/package.json

@@ -16,6 +16,7 @@
     "watch": "./serve.sh",
     "build": "cross-env NODE_ENV=production parcel build index.html  --no-minify --public-url ./",
     "link-local": "yalc link",
+    "test": "babel-node run_tests.js",
     "train": "babel-node train.js"
   },
   "devDependencies": {
@@ -33,6 +34,7 @@
     "http-server": "~0.10.0",
     "parcel-bundler": "~1.10.3",
     "shelljs": "^0.8.3",
+    "tmp": "^0.0.33",
     "yalc": "~1.0.0-pre.22"
   }
 }

sentiment/run_tests.js

@@ -0,0 +1,21 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC. All Rights Reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * =============================================================================
+ */
+
+const jasmine_util = require('@tensorflow/tfjs-core/dist/jasmine_util');
+const runTests = require('../test_util').runTests;
+
+runTests(jasmine_util, ['./*test.js']);

sentiment/sequence_utils_test.js

@@ -0,0 +1,55 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC. All Rights Reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * =============================================================================
+ */
+
+import {padSequences} from "./sequence_utils";
+
+describe('padSequences', () => {
+  it('post pad, post truncate', () => {
+    const sequences = [[10, 20, 30], [5, 15], [], [1, 2, 3, 4, 5, 6]];
+    const output = padSequences(sequences, 4, 'post', 'post');
+    expect(output).toEqual(
+        [[10, 20, 30, 0], [5, 15, 0, 0], [0, 0, 0, 0], [1, 2, 3, 4]]);
+  });
+
+  it('post pad, pre trucnate', () => {
+    const sequences = [[10, 20, 30], [5, 15], [], [1, 2, 3, 4, 5, 6]];
+    const output = padSequences(sequences, 4, 'post', 'pre');
+    expect(output).toEqual(
+        [[10, 20, 30, 0], [5, 15, 0, 0], [0, 0, 0, 0], [3, 4, 5, 6]]);
+  });
+
+  it('pre pad, post trucnate', () => {
+    const sequences = [[10, 20, 30], [5, 15], [], [1, 2, 3, 4, 5, 6]];
+    const output = padSequences(sequences, 4, 'pre', 'post');
+    expect(output).toEqual(
+        [[0, 10, 20, 30], [0, 0, 5, 15], [0, 0, 0, 0], [1, 2, 3, 4]]);
+  });
+
+  it('pre pad, pre trucnate', () => {
+    const sequences = [[10, 20, 30], [5, 15], [], [1, 2, 3, 4, 5, 6]];
+    const output = padSequences(sequences, 4, 'pre', 'pre');
+    expect(output).toEqual(
+        [[0, 10, 20, 30], [0, 0, 5, 15], [0, 0, 0, 0], [3, 4, 5, 6]]);
+  });
+
+  it('custom padding character', () => {
+    const sequences = [[10, 20, 30], [5, 15], [], [1, 2, 3, 4, 5, 6]];
+    const output = padSequences(sequences, 4, 'pre', 'pre', 42);
+    expect(output).toEqual(
+        [[42, 10, 20, 30], [42, 42, 5, 15], [42, 42, 42, 42], [3, 4, 5, 6]]);
+  });
+});

sentiment/serve.sh

@@ -39,4 +39,3 @@ node_modules/parcel-bundler/bin/cli.js serve index.html -d dist --open --no-hmr
 
 # When the Parcel server exits, kill the http-server too.
 kill $HTTP_SERVER_PID
-

sentiment/train.js

@@ -33,7 +33,7 @@ import {writeEmbeddingMatrixAndLabels} from './embedding';
  *   configure the embedding layer.
  * @returns An uncompiled instance of `tf.Model`.
  */
-function buildModel(modelType, maxLen, vocabularySize, embeddingSize) {
+export function buildModel(modelType, maxLen, vocabularySize, embeddingSize) {
   // TODO(cais): Bidirectional and dense-only.
   const model = tf.sequential();
   if (modelType === 'multihot') {
@@ -227,4 +227,6 @@ async function main() {
   }
 }
 
-main();
+if (require.main === module) {
+  main();
+}