Merge branch 'master' into use_precomputed_tensor_size

Author: tedhtchang

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tensorflow/tfjs-core",
-  "version": "1.0.0-alpha3",
+  "version": "1.0.0",
   "description": "Hardware-accelerated JavaScript library for machine intelligence",
   "private": false,
   "main": "dist/index.js",
@@ -23,11 +23,11 @@
     "clang-format": "~1.2.4",
     "jasmine": "~3.1.0",
     "jasmine-core": "~3.1.0",
-    "karma": "~2.0.2",
-    "karma-browserstack-launcher": "~1.3.0",
+    "karma": "~4.0.0",
+    "karma-browserstack-launcher": "~1.4.0",
     "karma-chrome-launcher": "~2.2.0",
     "karma-jasmine": "~1.1.0",
-    "karma-typescript": "~3.0.12",
+    "karma-typescript": "~4.0.0",
     "npm-run-all": "~4.1.3",
     "rimraf": "~2.6.2",
     "rollup": "~0.58.2",

scripts/publish-npm.sh

@@ -50,5 +50,5 @@ fi
 yarn build-npm
 ./scripts/make-version # This is for safety in case you forgot to do 2).
 ./scripts/tag-version
-npm publish --tag next # Remove --tag net when prereleases are done.
+npm publish
 echo 'Yay! Published a new package to npm.'

src/io/browser_files.ts

@@ -23,7 +23,7 @@
 import {ENV} from '../environment';
 import {basename, concatenateArrayBuffers, getModelArtifactsInfoForJSON} from './io_utils';
 import {IORouter, IORouterRegistry} from './router_registry';
-import {IOHandler, ModelArtifacts, SaveResult, WeightsManifestConfig, WeightsManifestEntry} from './types';
+import {IOHandler, ModelArtifacts, ModelJSON, SaveResult, WeightsManifestConfig, WeightsManifestEntry} from './types';
 
 const DEFAULT_FILE_NAME_PREFIX = 'model';
 const DEFAULT_JSON_EXTENSION_NAME = '.json';
@@ -71,8 +71,11 @@ export class BrowserDownloads implements IOHandler {
         paths: ['./' + this.weightDataFileName],
         weights: modelArtifacts.weightSpecs
       }];
-      const modelTopologyAndWeightManifest = {
+      const modelTopologyAndWeightManifest: ModelJSON = {
         modelTopology: modelArtifacts.modelTopology,
+        format: modelArtifacts.format,
+        generatedBy: modelArtifacts.generatedBy,
+        convertedBy: modelArtifacts.convertedBy,
         weightsManifest
       };
       const modelTopologyAndWeightManifestURL =
@@ -124,8 +127,8 @@ class BrowserFiles implements IOHandler {
       const jsonReader = new FileReader();
       jsonReader.onload = (event: Event) => {
         // tslint:disable-next-line:no-any
-        const modelJSON = JSON.parse((event.target as any).result);
-        const modelTopology = modelJSON.modelTopology as {};
+        const modelJSON = JSON.parse((event.target as any).result) as ModelJSON;
+        const modelTopology = modelJSON.modelTopology;
         if (modelTopology == null) {
           reject(new Error(
               `modelTopology field is missing from file ${jsonFile.name}`));
@@ -136,8 +139,7 @@ class BrowserFiles implements IOHandler {
           resolve({modelTopology});
         }
 
-        const weightsManifest =
-            modelJSON.weightsManifest as WeightsManifestConfig;
+        const weightsManifest = modelJSON.weightsManifest;
         if (weightsManifest == null) {
           reject(new Error(
               `weightManifest field is missing from file ${jsonFile.name}`));

src/io/browser_files_test.ts

@@ -74,6 +74,9 @@ const artifacts1: tf.io.ModelArtifacts = {
   modelTopology: modelTopology1,
   weightSpecs: weightSpecs1,
   weightData: weightData1,
+  format: 'layers-model',
+  generatedBy: 'TensorFlow.js v0.0.0',
+  convertedBy: null
 };
 
 describeWithFlags('browserDownloads', BROWSER_ENVS, () => {
@@ -127,6 +130,10 @@ describeWithFlags('browserDownloads', BROWSER_ENVS, () => {
         JSON.parse(await jsonContent.text());
     expect(modelTopologyAndWeightsManifest.modelTopology)
         .toEqual(modelTopology1);
+    expect(modelTopologyAndWeightsManifest.format).toEqual('layers-model');
+    expect(modelTopologyAndWeightsManifest.generatedBy)
+        .toEqual('TensorFlow.js v0.0.0');
+    expect(modelTopologyAndWeightsManifest.convertedBy).toEqual(null);
     const weightsManifest = modelTopologyAndWeightsManifest.weightsManifest as
         WeightsManifestConfig;
     expect(weightsManifest.length).toEqual(1);

src/io/browser_http.ts

@@ -22,49 +22,55 @@
  */
 
 import {assert} from '../util';
-
 import {concatenateArrayBuffers, getModelArtifactsInfoForJSON} from './io_utils';
 import {IORouter, IORouterRegistry} from './router_registry';
-import {IOHandler, ModelArtifacts, SaveResult, WeightsManifestConfig, WeightsManifestEntry} from './types';
+import {IOHandler, LoadOptions, ModelArtifacts, ModelJSON, OnProgressCallback, SaveResult, WeightsManifestConfig, WeightsManifestEntry} from './types';
 import {loadWeightsAsArrayBuffer} from './weights_loader';
 
 const OCTET_STREAM_MIME_TYPE = 'application/octet-stream';
 const JSON_TYPE = 'application/json';
 
 export class BrowserHTTPRequest implements IOHandler {
-  protected readonly path: string|string[];
+  protected readonly path: string;
   protected readonly requestInit: RequestInit;
 
-  private readonly fetchFunc: Function;
+  private readonly fetchFunc: (path: string, init?: RequestInit) => Response;
 
   readonly DEFAULT_METHOD = 'POST';
 
   static readonly URL_SCHEME_REGEX = /^https?:\/\//;
 
-  constructor(
-      path: string|string[], requestInit?: RequestInit,
-      private readonly weightPathPrefix?: string, fetchFunc?: Function,
-      private readonly onProgress?: Function) {
-    if (fetchFunc == null) {
+  private readonly weightPathPrefix: string;
+  private readonly onProgress: OnProgressCallback;
+
+  constructor(path: string, loadOptions?: LoadOptions) {
+    if (loadOptions == null) {
+      loadOptions = {};
+    }
+    this.weightPathPrefix = loadOptions.weightPathPrefix;
+    this.onProgress = loadOptions.onProgress;
+
+    if (loadOptions.fetchFunc == null) {
       if (typeof fetch === 'undefined') {
         throw new Error(
             'browserHTTPRequest is not supported outside the web browser ' +
             'without a fetch polyfill.');
       }
       // Make sure fetch is always bound to window (the
       // original object) when available.
-      fetchFunc = fetch.bind(typeof window === 'undefined' ? null : window);
+      loadOptions.fetchFunc =
+          fetch.bind(typeof window === 'undefined' ? null : window);
     } else {
       assert(
-          typeof fetchFunc === 'function',
+          typeof loadOptions.fetchFunc === 'function',
           () => 'Must pass a function that matches the signature of ' +
               '`fetch` (see ' +
               'https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)');
     }
 
     this.fetchFunc = (path: string, requestInits: RequestInit) => {
       // tslint:disable-next-line:no-any
-      return fetchFunc(path, requestInits).catch((error: any) => {
+      return loadOptions.fetchFunc(path, requestInits).catch((error: any) => {
         throw new Error(`Request for ${path} failed due to error: ${error}`);
       });
     };
@@ -83,11 +89,12 @@ export class BrowserHTTPRequest implements IOHandler {
     }
     this.path = path;
 
-    if (requestInit != null && requestInit.body != null) {
+    if (loadOptions.requestInit != null &&
+        loadOptions.requestInit.body != null) {
       throw new Error(
           'requestInit is expected to have no pre-existing body, but has one.');
     }
-    this.requestInit = requestInit || {};
+    this.requestInit = loadOptions.requestInit || {};
   }
 
   async save(modelArtifacts: ModelArtifacts): Promise<SaveResult> {
@@ -104,8 +111,11 @@ export class BrowserHTTPRequest implements IOHandler {
       paths: ['./model.weights.bin'],
       weights: modelArtifacts.weightSpecs,
     }];
-    const modelTopologyAndWeightManifest = {
+    const modelTopologyAndWeightManifest: ModelJSON = {
       modelTopology: modelArtifacts.modelTopology,
+      format: modelArtifacts.format,
+      generatedBy: modelArtifacts.generatedBy,
+      convertedBy: modelArtifacts.convertedBy,
       weightsManifest
     };
 
@@ -123,7 +133,7 @@ export class BrowserHTTPRequest implements IOHandler {
           'model.weights.bin');
     }
 
-    const response = await this.getFetchFunc()(this.path as string, init);
+    const response = await this.getFetchFunc()(this.path, init);
 
     if (response.ok) {
       return {
@@ -146,59 +156,37 @@ export class BrowserHTTPRequest implements IOHandler {
    * @returns The loaded model artifacts (if loading succeeds).
    */
   async load(): Promise<ModelArtifacts> {
-    return Array.isArray(this.path) ? this.loadBinaryModel() :
-                                      this.loadJSONModel();
-  }
-
-  /**
-   * Loads the model topology file and build the in memory graph of the model.
-   */
-  private async loadBinaryTopology(): Promise<ArrayBuffer> {
-    const response = await this.getFetchFunc()(this.path[0], this.requestInit);
-
-    if (!response.ok) {
-      throw new Error(`Request to ${this.path[0]} failed with error: ${
-          response.statusText}`);
-    }
-    return await response.arrayBuffer();
-  }
-
-  protected async loadBinaryModel(): Promise<ModelArtifacts> {
-    const graphPromise = this.loadBinaryTopology();
-    const manifestPromise =
-        await this.getFetchFunc()(this.path[1], this.requestInit);
-    if (!manifestPromise.ok) {
-      throw new Error(`Request to ${this.path[1]} failed with error: ${
-          manifestPromise.statusText}`);
-    }
-
-    const results = await Promise.all([graphPromise, manifestPromise]);
-    const [modelTopology, weightsManifestResponse] = results;
-
-    const weightsManifest =
-        await weightsManifestResponse.json() as WeightsManifestConfig;
-
-    let weightSpecs: WeightsManifestEntry[];
-    let weightData: ArrayBuffer;
-    if (weightsManifest != null) {
-      const results = await this.loadWeights(weightsManifest);
-      [weightSpecs, weightData] = results;
-    }
-
-    return {modelTopology, weightSpecs, weightData};
-  }
-
-  protected async loadJSONModel(): Promise<ModelArtifacts> {
     const modelConfigRequest =
-        await this.getFetchFunc()(this.path as string, this.requestInit);
+        await this.getFetchFunc()(this.path, this.requestInit);
 
     if (!modelConfigRequest.ok) {
-      throw new Error(`Request to ${this.path} failed with error: ${
-          modelConfigRequest.statusText}`);
+      throw new Error(
+          `Request to ${this.path} failed with status code ` +
+          `${modelConfigRequest.status}. Please verify this URL points to ` +
+          `the model JSON of the model to load.`);
     }
-    const modelConfig = await modelConfigRequest.json();
-    const modelTopology = modelConfig['modelTopology'];
-    const weightsManifest = modelConfig['weightsManifest'];
+    let modelConfig: ModelJSON;
+    try {
+      modelConfig = await modelConfigRequest.json();
+    } catch (e) {
+      let message = `Failed to parse model JSON of response from ${this.path}.`;
+      // TODO(nsthorat): Remove this after some time when we're comfortable that
+      // .pb files are mostly gone.
+      if (this.path.endsWith('.pb')) {
+        message += ' Your path contains a .pb file extension. ' +
+            'Support for .pb models have been removed in TensorFlow.js 1.0 ' +
+            'in favor of .json models. You can re-convert your Python ' +
+            'TensorFlow model using the TensorFlow.js 1.0 conversion scripts ' +
+            'or you can convert your.pb models with the \'pb2json\'' +
+            'NPM script in the tensorflow/tfjs-converter repository.';
+      } else {
+        message += ' Please make sure the server is serving valid ' +
+            'JSON for this request.';
+      }
+      throw new Error(message);
+    }
+    const modelTopology = modelConfig.modelTopology;
+    const weightsManifest = modelConfig.weightsManifest;
 
     // We do not allow both modelTopology and weightsManifest to be missing.
     if (modelTopology == null && weightsManifest == null) {
@@ -210,8 +198,6 @@ export class BrowserHTTPRequest implements IOHandler {
     let weightSpecs: WeightsManifestEntry[];
     let weightData: ArrayBuffer;
     if (weightsManifest != null) {
-      const weightsManifest =
-          modelConfig['weightsManifest'] as WeightsManifestConfig;
       const results = await this.loadWeights(weightsManifest);
       [weightSpecs, weightData] = results;
     }
@@ -236,8 +222,11 @@ export class BrowserHTTPRequest implements IOHandler {
         fetchURLs.push(pathPrefix + path + suffix);
       });
     });
-    const buffers = await loadWeightsAsArrayBuffer(
-        fetchURLs, this.requestInit, this.getFetchFunc(), this.onProgress);
+    const buffers = await loadWeightsAsArrayBuffer(fetchURLs, {
+      requestInit: this.requestInit,
+      fetchFunc: this.getFetchFunc(),
+      onProgress: this.onProgress
+    });
     return [weightSpecs, concatenateArrayBuffers(buffers)];
   }
 
@@ -278,7 +267,7 @@ export function isHTTPScheme(url: string): boolean {
 }
 
 export const httpRequestRouter: IORouter =
-    (url: string|string[], onProgress?: Function) => {
+    (url: string, onProgress?: OnProgressCallback) => {
       if (typeof fetch === 'undefined') {
         // browserHTTPRequest uses `fetch`, if one wants to use it in node.js
         // they have to setup a global fetch polyfill.
@@ -291,7 +280,7 @@ export const httpRequestRouter: IORouter =
           isHTTP = isHTTPScheme(url);
         }
         if (isHTTP) {
-          return browserHTTPRequest(url, null, null, null, onProgress);
+          return browserHTTPRequest(url, {onProgress});
         }
       }
       return null;
@@ -419,9 +408,7 @@ IORouterRegistry.registerLoadRouter(httpRequestRouter);
  *   main()
  * ```
  *
- * @param path A single URL path or an Array of URL  paths.
- *   Currently, only a single URL path is supported. Array input is reserved
- *   for future development.
+ * @param path A URL path to the model.
  *   Can be an absolute HTTP path (e.g.,
  *   'http://localhost:8000/model-upload)') or a relative path (e.g.,
  *   './model-upload').
@@ -434,17 +421,17 @@ IORouterRegistry.registerLoadRouter(httpRequestRouter);
  * topology (filename: 'model.json') and the weights of the model (filename:
  * 'model.weights.bin') will be appended to the body. If `requestInit` has a
  * `body`, an Error will be thrown.
- * @param weightPathPrefix Optional, this specifies the path prefix for weight
- *   files, by default this is calculated from the path param.
- * @param fetchFunc Optional, custom `fetch` function. E.g., in Node.js,
- *   the `fetch` from node-fetch can be used here.
- * @param onProgress Optional, progress callback function, fired periodically
- *   before the load is completed.
+ * @param loadOptions Optional configuration for the loading. It includes the
+ *   following fields:
+ *   - weightPathPrefix Optional, this specifies the path prefix for weight
+ *     files, by default this is calculated from the path param.
+ *   - fetchFunc Optional, custom `fetch` function. E.g., in Node.js,
+ *     the `fetch` from node-fetch can be used here.
+ *   - onProgress Optional, progress callback function, fired periodically
+ *     before the load is completed.
  * @returns An instance of `IOHandler`.
  */
 export function browserHTTPRequest(
-    path: string|string[], requestInit?: RequestInit, weightPathPrefix?: string,
-    fetchFunc?: Function, onProgress?: Function): IOHandler {
-  return new BrowserHTTPRequest(
-      path, requestInit, weightPathPrefix, fetchFunc, onProgress);
+    path: string, loadOptions?: LoadOptions): IOHandler {
+  return new BrowserHTTPRequest(path, loadOptions);
 }