Class TensorScriptModelInterface

Base class for tensorscript models

interface: TensorScriptModelInterface
property: {Object} settings - tensorflow model hyperparameters
property: {Object} model - tensorflow model
property: {Object} tf - tensorflow / tensorflow-node / tensorflow-node-gpu
property: {Function} reshape - static reshape array function
property: {Function} getInputShape - static TensorScriptModelInterface

Hierarchy

TensorScriptModelInterface
- BaseNeuralNetwork
- TextEmbedding

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new TensorScriptModelInterface(options?: TensorScriptOptions, properties?: TensorScriptProperties): TensorScriptModelInterface

- Defined in Users/yawjosephetse/Developer/github/repetere/modelx/node_modules/@modelx/model/src/model_interface.ts:142
Parameters
- Default value options: TensorScriptOptions = {}
  
  tensorflow model hyperparameters
- Default value properties: TensorScriptProperties = {}
  
  extra instance properties
Returns TensorScriptModelInterface

Properties

compiled

compiled: boolean

getInputShape

getInputShape: (...args: any[]) => any

Type declaration

- (...args: any[]): any
- Parameters
  - Rest ...args: any[]
  Returns any

Optional getTimeseriesShape

getTimeseriesShape: (x_timeseries: NestedArray<any> | undefined) => Shape

Type declaration

- (x_timeseries: NestedArray<any> | undefined): Shape
- Parameters
  - x_timeseries: NestedArray<any> | undefined
  Returns Shape

Optional layers

layers: TensorScriptLayers | TensorScriptSavedLayers

model

model: any

reshape

reshape: (...args: any[]) => any

Type declaration

- (...args: any[]): any
- Parameters
  - Rest ...args: any[]
  Returns any

settings

settings: TensorScriptOptions

tf

tf: any

tokenizer

tokenizer: any

trained

trained: boolean

type

type: string

Optional xShape

xShape: number[]

Optional yShape

yShape: number[]

Methods

calculate

calculate(matrix: Matrix | Vector | InputTextArray): Calculation

- Defined in Users/yawjosephetse/Developer/github/repetere/modelx/node_modules/@modelx/model/src/model_interface.ts:308
Predicts new dependent variables

abstract

Parameters
- matrix: Matrix | Vector | InputTextArray
  
  new test independent variables
Returns Calculation

returns tensorflow prediction

exportConfiguration

exportConfiguration(): TensorScriptContext

- Defined in Users/yawjosephetse/Developer/github/repetere/modelx/node_modules/@modelx/model/src/model_interface.ts:267
Returns TensorScriptContext

importConfiguration

importConfiguration(configuration: TensorScriptContext): void

- Defined in Users/yawjosephetse/Developer/github/repetere/modelx/node_modules/@modelx/model/src/model_interface.ts:278
Parameters
- configuration: TensorScriptContext
Returns void

loadModel

loadModel(options: string): Promise<any>

- Defined in Users/yawjosephetse/Developer/github/repetere/modelx/node_modules/@modelx/model/src/model_interface.ts:317
Loads a saved tensoflow / keras model, this is an alias for

see

https://www.tensorflow.org/js/guide/save_load#loading_a_tfmodel

Parameters
- options: string
  
  tensorflow load model options
Returns Promise<any>

tensorflow model

predict

predict(input_matrix: Matrix | Vector | InputTextArray, options?: PredictionOptions): Promise<any>

- Defined in Users/yawjosephetse/Developer/github/repetere/modelx/node_modules/@modelx/model/src/model_interface.ts:343
Returns prediction values from tensorflow model

Parameters
- input_matrix: Matrix | Vector | InputTextArray
  
  new test independent variables
- Default value options: PredictionOptions = {}
Returns Promise<any>

predicted model values

saveModel

saveModel(options: string): Promise<any>

- Defined in Users/yawjosephetse/Developer/github/repetere/modelx/node_modules/@modelx/model/src/model_interface.ts:330
saves a tensorflow model, this is an alias for

see

https://www.tensorflow.org/js/guide/save_load#save_a_tfmodel

Parameters
- options: string
  
  tensorflow save model options
Returns Promise<any>

tensorflow model

train

train(x_matrix: Matrix, y_matrix: Matrix, layers?: TensorScriptLayers, x_test?: Matrix, y_test?: Matrix): Promise<LayersModel>

- Defined in Users/yawjosephetse/Developer/github/repetere/modelx/node_modules/@modelx/model/src/model_interface.ts:297
Asynchronously trains tensorflow model, must be implemented by tensorscript class

abstract

Parameters
- x_matrix: Matrix
  
  independent variables
- y_matrix: Matrix
  
  dependent variables
- Optional layers: TensorScriptLayers
- Optional x_test: Matrix
- Optional y_test: Matrix
Returns Promise<LayersModel>

returns trained tensorflow model

Static getInputShape

getInputShape(matrix?: any): Shape

- Defined in Users/yawjosephetse/Developer/github/repetere/modelx/node_modules/@modelx/model/src/model_interface.ts:248
Returns the shape of an input matrix

function

example

const input = [ [ 0, 1, ], [ 1, 0, ], ]; TensorScriptModelInterface.getInputShape(input) // => [2,2]

see

{https://stackoverflow.com/questions/10237615/get-size-of-dimensions-in-array}

Parameters
- Default value matrix: any = []
  
  input matrix
Returns Shape

returns the shape of a matrix (e.g. [2,2])

Static reshape

reshape(array: Vector, shape: Shape): Matrix | Vector

- Defined in Users/yawjosephetse/Developer/github/repetere/modelx/node_modules/@modelx/model/src/model_interface.ts:183
Reshapes an array

function

example

const array = [ 0, 1, 1, 0, ]; const shape = [2,2]; TensorScriptModelInterface.reshape(array,shape) // => [ [ 0, 1, ], [ 1, 0, ], ];

Parameters
- array: Vector
  
  input array
- shape: Shape
  
  shape array
Returns Matrix | Vector

returns a matrix with the defined shape