UNPKG

@modelx/modelx

Version:

Construct AI & ML models with JSON using Typescript & Tensorflow

435 lines 69.8 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>&quot;node_modules/@modelx/model/src/model_interface&quot; | @modelx/data</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="../index.html" class="title">@modelx/data</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> <input type="checkbox" id="tsd-filter-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../globals.html">Globals</a> </li> <li> <a href="_node_modules__modelx_model_src_model_interface_.html">&quot;node_modules/@modelx/model/src/model_interface&quot;</a> </li> </ul> <h1>External module &quot;node_modules/@modelx/model/src/model_interface&quot;</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Classes</h3> <ul class="tsd-index-list"> <li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/_node_modules__modelx_model_src_model_interface_.tensorscriptmodelinterface.html" class="tsd-kind-icon">Tensor<wbr>Script<wbr>Model<wbr>Interface</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Interfaces</h3> <ul class="tsd-index-list"> <li class="tsd-kind-interface tsd-parent-kind-external-module tsd-has-type-parameter"><a href="../interfaces/_node_modules__modelx_model_src_model_interface_.nestedarray.html" class="tsd-kind-icon">Nested<wbr>Array</a></li> <li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/_node_modules__modelx_model_src_model_interface_.tensorscriptcontext.html" class="tsd-kind-icon">Tensor<wbr>Script<wbr>Context</a></li> <li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/_node_modules__modelx_model_src_model_interface_.tensorscriptlstmmodelcontext.html" class="tsd-kind-icon">Tensor<wbr>ScriptLSTMModel<wbr>Context</a></li> <li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/_node_modules__modelx_model_src_model_interface_.tensorscriptmodelcontext.html" class="tsd-kind-icon">Tensor<wbr>Script<wbr>Model<wbr>Context</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Type aliases</h3> <ul class="tsd-index-list"> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_node_modules__modelx_model_src_model_interface_.html#calculation" class="tsd-kind-icon">Calculation</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_node_modules__modelx_model_src_model_interface_.html#denselayer" class="tsd-kind-icon">Dense<wbr>Layer</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-kind-icon">Epoch<wbr>Log</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_node_modules__modelx_model_src_model_interface_.html#inputtextarray" class="tsd-kind-icon">Input<wbr>Text<wbr>Array</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_node_modules__modelx_model_src_model_interface_.html#matrix" class="tsd-kind-icon">Matrix</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_node_modules__modelx_model_src_model_interface_.html#predictionoptions" class="tsd-kind-icon">Prediction<wbr>Options</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_node_modules__modelx_model_src_model_interface_.html#shape" class="tsd-kind-icon">Shape</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_node_modules__modelx_model_src_model_interface_.html#tensorscriptlayers" class="tsd-kind-icon">Tensor<wbr>Script<wbr>Layers</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_node_modules__modelx_model_src_model_interface_.html#tensorscriptoptions" class="tsd-kind-icon">Tensor<wbr>Script<wbr>Options</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_node_modules__modelx_model_src_model_interface_.html#tensorscriptproperties" class="tsd-kind-icon">Tensor<wbr>Script<wbr>Properties</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_node_modules__modelx_model_src_model_interface_.html#tensorscriptsavedlayers" class="tsd-kind-icon">Tensor<wbr>Script<wbr>Saved<wbr>Layers</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_node_modules__modelx_model_src_model_interface_.html#vector" class="tsd-kind-icon">Vector</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Type aliases</h2> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="calculation" class="tsd-anchor"></a> <h3>Calculation</h3> <div class="tsd-signature tsd-kind-icon">Calculation<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="_node_modules__modelx_model_src_model_interface_.html#vector" class="tsd-signature-type">Vector</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> }</span></div> <aside class="tsd-sources"> <ul> <li>Defined in Users/yawjosephetse/Developer/github/repetere/modelx/node_modules/@modelx/model/src/model_interface.ts:116</li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="_node_modules__modelx_model_src_model_interface_.html#vector" class="tsd-signature-type">Vector</a><span class="tsd-signature-symbol">&gt;</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-siganture"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-variable"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="_node_modules__modelx_model_src_model_interface_.html#vector" class="tsd-signature-type">Vector</a><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="_node_modules__modelx_model_src_model_interface_.html#vector" class="tsd-signature-type">Vector</a><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </li> </ul> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="denselayer" class="tsd-anchor"></a> <h3>Dense<wbr>Layer</h3> <div class="tsd-signature tsd-kind-icon">Dense<wbr>Layer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>activation<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>batchInputShape<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>inputDim<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>inputShape<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>kernelInitializer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>kernelRegularizer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>returnSequences<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>units<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div> <aside class="tsd-sources"> <ul> <li>Defined in Users/yawjosephetse/Developer/github/repetere/modelx/node_modules/@modelx/model/src/model_interface.ts:37</li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> activation<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> batch<wbr>Input<wbr>Shape<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> input<wbr>Dim<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> input<wbr>Shape<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> kernel<wbr>Initializer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> kernel<wbr>Regularizer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> return<wbr>Sequences<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5> </li> <li class="tsd-parameter"> <h5>units<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="epochlog" class="tsd-anchor"></a> <h3>Epoch<wbr>Log</h3> <div class="tsd-signature tsd-kind-icon">Epoch<wbr>Log<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>loss<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div> <aside class="tsd-sources"> <ul> <li>Defined in Users/yawjosephetse/Developer/github/repetere/modelx/node_modules/@modelx/model/src/model_interface.ts:55</li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>loss<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="inputtextarray" class="tsd-anchor"></a> <h3>Input<wbr>Text<wbr>Array</h3> <div class="tsd-signature tsd-kind-icon">Input<wbr>Text<wbr>Array<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_node_modules__modelx_model_src_model_interface_.nestedarray.html#array" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div> <aside class="tsd-sources"> <ul> <li>Defined in Users/yawjosephetse/Developer/github/repetere/modelx/node_modules/@modelx/model/src/model_interface.ts:107</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="matrix" class="tsd-anchor"></a> <h3>Matrix</h3> <div class="tsd-signature tsd-kind-icon">Matrix<span class="tsd-signature-symbol">:</span> <a href="_node_modules__modelx_model_src_model_interface_.html#vector" class="tsd-signature-type">Vector</a><span class="tsd-signature-symbol">[]</span></div> <aside class="tsd-sources"> <ul> <li>Defined in Users/yawjosephetse/Developer/github/repetere/modelx/node_modules/@modelx/model/src/model_interface.ts:111</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="predictionoptions" class="tsd-anchor"></a> <h3>Prediction<wbr>Options</h3> <div class="tsd-signature tsd-kind-icon">Prediction<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>json<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>probability<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>skip_matrix_check<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></div> <aside class="tsd-sources"> <ul> <li>Defined in Users/yawjosephetse/Developer/github/repetere/modelx/node_modules/@modelx/model/src/model_interface.ts:101</li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> json<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> probability<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> skip_<wbr>matrix_<wbr>check<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="shape" class="tsd-anchor"></a> <h3>Shape</h3> <div class="tsd-signature tsd-kind-icon">Shape<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_node_modules__modelx_model_src_model_interface_.nestedarray.html#array" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <ul> <li>Defined in Users/yawjosephetse/Developer/github/repetere/modelx/node_modules/@modelx/model/src/model_interface.ts:109</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="tensorscriptlayers" class="tsd-anchor"></a> <h3>Tensor<wbr>Script<wbr>Layers</h3> <div class="tsd-signature tsd-kind-icon">Tensor<wbr>Script<wbr>Layers<span class="tsd-signature-symbol">:</span> <a href="_node_modules__modelx_model_src_model_interface_.html#denselayer" class="tsd-signature-type">DenseLayer</a><span class="tsd-signature-symbol">[]</span></div> <aside class="tsd-sources"> <ul> <li>Defined in Users/yawjosephetse/Developer/github/repetere/modelx/node_modules/@modelx/model/src/model_interface.ts:48</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="tensorscriptoptions" class="tsd-anchor"></a> <h3>Tensor<wbr>Script<wbr>Options</h3> <div class="tsd-signature tsd-kind-icon">Tensor<wbr>Script<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>compile<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>loss<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>optimizer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>features<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>fit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>batchSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>callbacks<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>onBatchBegin<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>batch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, logs<span class="tsd-signature-symbol">: </span><a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-signature-type">EpochLog</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span>onBatchEnd<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>batch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, logs<span class="tsd-signature-symbol">: </span><a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-signature-type">EpochLog</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span>onEpochBegin<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>epoch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, logs<span class="tsd-signature-symbol">: </span><a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-signature-type">EpochLog</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span>onEpochEnd<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>epoch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, logs<span class="tsd-signature-symbol">: </span><a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-signature-type">EpochLog</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span>onTrainBegin<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>logs<span class="tsd-signature-symbol">: </span><a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-signature-type">EpochLog</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span>onTrainEnd<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>logs<span class="tsd-signature-symbol">: </span><a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-signature-type">EpochLog</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span>onYield<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>epoch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, batch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, logs<span class="tsd-signature-symbol">: </span><a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-signature-type">EpochLog</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>epochs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>shuffle<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>validationData<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">[</span><a href="_node_modules__modelx_model_src_model_interface_.html#matrix" class="tsd-signature-type">Matrix</a><span class="tsd-signature-symbol">, </span><a href="_node_modules__modelx_model_src_model_interface_.html#matrix" class="tsd-signature-type">Matrix</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span>validation_data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">[</span><a href="_node_modules__modelx_model_src_model_interface_.html#matrix" class="tsd-signature-type">Matrix</a><span class="tsd-signature-symbol">, </span><a href="_node_modules__modelx_model_src_model_interface_.html#matrix" class="tsd-signature-type">Matrix</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span>verbose<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>layerPreference<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>layers<span class="tsd-signature-symbol">?: </span><a href="_node_modules__modelx_model_src_model_interface_.html#tensorscriptlayers" class="tsd-signature-type">TensorScriptLayers</a><span class="tsd-signature-symbol"> | </span><a href="_node_modules__modelx_model_src_model_interface_.html#tensorscriptsavedlayers" class="tsd-signature-type">TensorScriptSavedLayers</a><span class="tsd-signature-symbol">; </span>learningRate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>lookback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>mulitpleTimeSteps<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>outputs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>stateful<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>timeSteps<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div> <aside class="tsd-sources"> <ul> <li>Defined in Users/yawjosephetse/Developer/github/repetere/modelx/node_modules/@modelx/model/src/model_interface.ts:58</li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> compile<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>loss<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>optimizer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> loss<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> optimizer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5> </li> </ul> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> features<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> fit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>batchSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>callbacks<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>onBatchBegin<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>batch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, logs<span class="tsd-signature-symbol">: </span><a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-signature-type">EpochLog</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span>onBatchEnd<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>batch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, logs<span class="tsd-signature-symbol">: </span><a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-signature-type">EpochLog</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span>onEpochBegin<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>epoch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, logs<span class="tsd-signature-symbol">: </span><a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-signature-type">EpochLog</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span>onEpochEnd<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>epoch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, logs<span class="tsd-signature-symbol">: </span><a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-signature-type">EpochLog</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span>onTrainBegin<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>logs<span class="tsd-signature-symbol">: </span><a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-signature-type">EpochLog</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span>onTrainEnd<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>logs<span class="tsd-signature-symbol">: </span><a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-signature-type">EpochLog</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span>onYield<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>epoch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, batch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, logs<span class="tsd-signature-symbol">: </span><a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-signature-type">EpochLog</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>epochs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>shuffle<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>validationData<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">[</span><a href="_node_modules__modelx_model_src_model_interface_.html#matrix" class="tsd-signature-type">Matrix</a><span class="tsd-signature-symbol">, </span><a href="_node_modules__modelx_model_src_model_interface_.html#matrix" class="tsd-signature-type">Matrix</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span>validation_data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">[</span><a href="_node_modules__modelx_model_src_model_interface_.html#matrix" class="tsd-signature-type">Matrix</a><span class="tsd-signature-symbol">, </span><a href="_node_modules__modelx_model_src_model_interface_.html#matrix" class="tsd-signature-type">Matrix</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span>verbose<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> batch<wbr>Size<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> callbacks<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>onBatchBegin<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>batch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, logs<span class="tsd-signature-symbol">: </span><a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-signature-type">EpochLog</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span>onBatchEnd<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>batch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, logs<span class="tsd-signature-symbol">: </span><a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-signature-type">EpochLog</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span>onEpochBegin<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>epoch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, logs<span class="tsd-signature-symbol">: </span><a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-signature-type">EpochLog</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span>onEpochEnd<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>epoch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, logs<span class="tsd-signature-symbol">: </span><a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-signature-type">EpochLog</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span>onTrainBegin<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>logs<span class="tsd-signature-symbol">: </span><a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-signature-type">EpochLog</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span>onTrainEnd<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>logs<span class="tsd-signature-symbol">: </span><a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-signature-type">EpochLog</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span>onYield<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>epoch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, batch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, logs<span class="tsd-signature-symbol">: </span><a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-signature-type">EpochLog</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> }</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr>Batch<wbr>Begin<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>batch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, logs<span class="tsd-signature-symbol">: </span><a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-signature-type">EpochLog</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-siganture"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-variable"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>batch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, logs<span class="tsd-signature-symbol">: </span><a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-signature-type">EpochLog</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>batch: <span class="tsd-signature-type">number</span></h5> </li> <li> <h5>logs: <a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-signature-type">EpochLog</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </li> </ul> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr>Batch<wbr>End<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>batch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, logs<span class="tsd-signature-symbol">: </span><a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-signature-type">EpochLog</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-siganture"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-variable"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>batch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, logs<span class="tsd-signature-symbol">: </span><a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-signature-type">EpochLog</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>batch: <span class="tsd-signature-type">number</span></h5> </li> <li> <h5>logs: <a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-signature-type">EpochLog</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </li> </ul> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr>Epoch<wbr>Begin<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>epoch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, logs<span class="tsd-signature-symbol">: </span><a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-signature-type">EpochLog</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-siganture"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-variable"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>epoch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, logs<span class="tsd-signature-symbol">: </span><a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-signature-type">EpochLog</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>epoch: <span class="tsd-signature-type">number</span></h5> </li> <li> <h5>logs: <a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-signature-type">EpochLog</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </li> </ul> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr>Epoch<wbr>End<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>epoch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, logs<span class="tsd-signature-symbol">: </span><a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-signature-type">EpochLog</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-siganture"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-variable"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>epoch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, logs<span class="tsd-signature-symbol">: </span><a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-signature-type">EpochLog</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>epoch: <span class="tsd-signature-type">number</span></h5> </li> <li> <h5>logs: <a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-signature-type">EpochLog</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </li> </ul> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr>Train<wbr>Begin<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>logs<span class="tsd-signature-symbol">: </span><a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-signature-type">EpochLog</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-siganture"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-variable"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>logs<span class="tsd-signature-symbol">: </span><a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-signature-type">EpochLog</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>logs: <a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-signature-type">EpochLog</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </li> </ul> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr>Train<wbr>End<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>logs<span class="tsd-signature-symbol">: </span><a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-signature-type">EpochLog</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-siganture"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-variable"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>logs<span class="tsd-signature-symbol">: </span><a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-signature-type">EpochLog</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>logs: <a href="_node_modules__modelx_model_src_model_interface_.html#epochlog" class="tsd-signature-type">EpochLog</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </li> </ul> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr>Yield<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>epoch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, batch<span