Update documentation around accepted image formats

Author: Kevin Scott

README.md

@@ -131,7 +131,7 @@ mlClassifier.addData(images, labels, 'train');
 
 #### Parameters
 
-* **images** (`Tensor3D[]`) - an array of 3D tensors. Images can be any sizes, but will be cropped and sized down to match the pretrained model.
+* **images** (`Array<tf.Tensor3D | ImageData | HTMLImageElement | string>`) - an array of 3D tensors, ImageData (output from a canvas `toPixels`, a native browser `Image`, or a string representing the image `src`. Images can be any sizes, but will be cropped and sized down to match the pretrained model.
 * **labels** (`string[]`) - an array of strings, matching the images passed above.
 * **dataType** (`string`) *Optional* - an enum specifying which data type the images match. Data types can be `train` for data used in `model.train()`, and `eval`, for data used in `model.evaluate()`. If no argument is supplied, `dataType` will default to `train`.
 

src/index.ts

@@ -2,7 +2,9 @@ import * as tf from '@tensorflow/tfjs';
 import cropAndResizeImage from './cropAndResizeImage';
 import getClasses from './getClasses';
 import train from './train';
-import translateImages from './translateImages';
+import translateImages, {
+  IImageData,
+} from './translateImages';
 import loadPretrainedModel, {
   PRETRAINED_MODELS_KEYS,
 } from './loadPretrainedModel';
@@ -126,7 +128,7 @@ class MLClassifier {
 
   public getModel = () => this.model;
 
-  public addData = async (origImages: Array<tf.Tensor3D | HTMLImageElement>, origLabels: string[], dataType: string = 'train') => {
+  public addData = async (origImages: Array<tf.Tensor3D | IImageData | HTMLImageElement | string>, origLabels: string[], dataType: string = 'train') => {
     this.callbackFn('onAddData', 'start', origImages, origLabels, dataType);
     if (!origImages) {
       throw new Error('You must supply images');

src/translateImages.ts

@@ -38,7 +38,7 @@ const imageDataToTensor = async ({
   return tf.tensor3d(Array.from(data), [width, height, 4]);
 };
 
-interface IImageData {
+export interface IImageData {
   data: Uint8ClampedArray;
   width: number;
   height: number;