UNPKG

@modelx/modelx

Version:

Construct AI & ML models with JSON using Typescript & Tensorflow

594 lines 138 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>&quot;src/model&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="_src_model_.html">&quot;src/model&quot;</a> </li> </ul> <h1>External module &quot;src/model&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>Enumerations</h3> <ul class="tsd-index-list"> <li class="tsd-kind-enum tsd-parent-kind-external-module"><a href="../enums/_src_model_.modelcategories.html" class="tsd-kind-icon">Model<wbr>Categories</a></li> <li class="tsd-kind-enum tsd-parent-kind-external-module"><a href="../enums/_src_model_.modeltypes.html" class="tsd-kind-icon">Model<wbr>Types</a></li> </ul> </section> <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/_src_model_.modelx.html" class="tsd-kind-icon">ModelX</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"><a href="../interfaces/_src_model_.getpredicitondata.html" class="tsd-kind-icon">Get<wbr>Prediciton<wbr>Data</a></li> <li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/_src_model_.modelcontext.html" class="tsd-kind-icon">Model<wbr>Context</a></li> <li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/_src_model_.sumpreviousrows.html" class="tsd-kind-icon">sum<wbr>Previous<wbr>Rows</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="_src_model_.html#classificationevaluation" class="tsd-kind-icon">Classification<wbr>Evaluation</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_src_model_.html#crossvalidationoptions" class="tsd-kind-icon">Cross<wbr>Validation<wbr>Options</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_src_model_.html#datafilterfunction" class="tsd-kind-icon">Data<wbr>Filter<wbr>Function</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_src_model_.html#evaluateclassificationmodel" class="tsd-kind-icon">Evaluate<wbr>Classification<wbr>Model</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_src_model_.html#evaluatemodeloptions" class="tsd-kind-icon">Evaluate<wbr>Model<wbr>Options</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_src_model_.html#evaluateregressionmodel" class="tsd-kind-icon">Evaluate<wbr>Regression<wbr>Model</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_src_model_.html#evaluationaccuracyoptions" class="tsd-kind-icon">Evaluation<wbr>Accuracy<wbr>Options</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_src_model_.html#forecasthelpernextvaluedata" class="tsd-kind-icon">Forecast<wbr>Helper<wbr>Next<wbr>Value<wbr>Data</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_src_model_.html#forecastpredictioninputnextvaluefunction" class="tsd-kind-icon">Forecast<wbr>Prediction<wbr>Input<wbr>Next<wbr>Value<wbr>Function</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_src_model_.html#forecastpredictionnextvaluestate" class="tsd-kind-icon">Forecast<wbr>Prediction<wbr>Next<wbr>Value<wbr>State</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_src_model_.html#generatedfunctiondefinitionslist" class="tsd-kind-icon">Generated<wbr>Function<wbr>Definitions<wbr>List</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_src_model_.html#generatedfunctiondefinitionsobject" class="tsd-kind-icon">Generated<wbr>Function<wbr>Definitions<wbr>Object</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_src_model_.html#generatedstatefulfunction" class="tsd-kind-icon">Generated<wbr>Stateful<wbr>Function</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_src_model_.html#generatedstatefulfunctionobject" class="tsd-kind-icon">Generated<wbr>Stateful<wbr>Function<wbr>Object</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_src_model_.html#generatedstatefulfunctionparams" class="tsd-kind-icon">Generated<wbr>Stateful<wbr>Function<wbr>Params</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_src_model_.html#generatedstatefulfunctionprops" class="tsd-kind-icon">Generated<wbr>Stateful<wbr>Function<wbr>Props</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_src_model_.html#generatedstatefulfunctionstate" class="tsd-kind-icon">Generated<wbr>Stateful<wbr>Function<wbr>State</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_src_model_.html#generatedstatefulfunctions" class="tsd-kind-icon">Generated<wbr>Stateful<wbr>Functions</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_src_model_.html#getdatasetproperties" class="tsd-kind-icon">Get<wbr>Data<wbr>Set<wbr>Properties</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_src_model_.html#modelconfiguration" class="tsd-kind-icon">Model<wbr>Configuration</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_src_model_.html#modeloptions" class="tsd-kind-icon">Model<wbr>Options</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_src_model_.html#modelstatus" class="tsd-kind-icon">Model<wbr>Status</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_src_model_.html#modeltrainningoptions" class="tsd-kind-icon">Model<wbr>Trainning<wbr>Options</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_src_model_.html#predictmodelconfig" class="tsd-kind-icon">Predict<wbr>Model<wbr>Config</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_src_model_.html#predictmodeloptions" class="tsd-kind-icon">Predict<wbr>Model<wbr>Options</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_src_model_.html#predictionoptions-2" class="tsd-kind-icon">Prediction<wbr>Options</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_src_model_.html#regressionevaluation" class="tsd-kind-icon">Regression<wbr>Evaluation</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_src_model_.html#sumpreviousrowcontext" class="tsd-kind-icon">Sum<wbr>Previous<wbr>Row<wbr>Context</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_src_model_.html#sumpreviousrowsoptions" class="tsd-kind-icon">Sum<wbr>Previous<wbr>Rows<wbr>Options</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_src_model_.html#timeseriesdimension" class="tsd-kind-icon">Timeseries<wbr>Dimension</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_src_model_.html#validatetimeseriesdataoptions" class="tsd-kind-icon">Validate<wbr>Timeseries<wbr>Data<wbr>Options</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_src_model_.html#retraintimeseriesmodel" class="tsd-kind-icon">retrain<wbr>Timeseries<wbr>Model</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Functions</h3> <ul class="tsd-index-list"> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_src_model_.html#getgeneratedstatefulfunction" class="tsd-kind-icon">get<wbr>Generated<wbr>Stateful<wbr>Function</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_src_model_.html#sumpreviousrows-2" class="tsd-kind-icon">sum<wbr>Previous<wbr>Rows</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Object literals</h3> <ul class="tsd-index-list"> <li class="tsd-kind-object-literal tsd-parent-kind-external-module"><a href="_src_model_.html#modelcategorymap" class="tsd-kind-icon">model<wbr>Category<wbr>Map</a></li> <li class="tsd-kind-object-literal tsd-parent-kind-external-module"><a href="_src_model_.html#modelmap" class="tsd-kind-icon">model<wbr>Map</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="classificationevaluation" class="tsd-anchor"></a> <h3>Classification<wbr>Evaluation</h3> <div class="tsd-signature tsd-kind-icon">Classification<wbr>Evaluation<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>accuracy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>actuals<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ModelXDataTypes.Vector</span><span class="tsd-signature-symbol">; </span>estimates<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ModelXDataTypes.Vector</span><span class="tsd-signature-symbol">; </span>labels<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>matrix<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ModelXDataTypes.Matrix</span><span class="tsd-signature-symbol"> }</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/repetere/modelx/blob/ba94d70/src/model.ts#L242">Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:242</a></li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>accuracy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>actuals<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ModelXDataTypes.Vector</span></h5> </li> <li class="tsd-parameter"> <h5>estimates<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ModelXDataTypes.Vector</span></h5> </li> <li class="tsd-parameter"> <h5>labels<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5> </li> <li class="tsd-parameter"> <h5>matrix<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ModelXDataTypes.Matrix</span></h5> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="crossvalidationoptions" class="tsd-anchor"></a> <h3>Cross<wbr>Validation<wbr>Options</h3> <div class="tsd-signature tsd-kind-icon">Cross<wbr>Validation<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>folds<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>parse_int_train_size<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>random_state<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>return_array<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>test_size<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>train_size<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 <a href="https://github.com/repetere/modelx/blob/ba94d70/src/model.ts#L145">Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:145</a></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> folds<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> parse_<wbr>int_<wbr>train_<wbr>size<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> random_<wbr>state<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> return_<wbr>array<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> test_<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> train_<wbr>size<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="datafilterfunction" class="tsd-anchor"></a> <h3>Data<wbr>Filter<wbr>Function</h3> <div class="tsd-signature tsd-kind-icon">Data<wbr>Filter<wbr>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>datum<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ModelXDataTypes.Datum</span>, datumIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/repetere/modelx/blob/ba94d70/src/model.ts#L291">Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:291</a></li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter-siganture"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>datum<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ModelXDataTypes.Datum</span>, datumIndex<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><span class="tsd-signature-type">boolean</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>datum: <span class="tsd-signature-type">ModelXDataTypes.Datum</span></h5> </li> <li> <h5>datumIndex: <span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> </ul> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="evaluateclassificationmodel" class="tsd-anchor"></a> <h3>Evaluate<wbr>Classification<wbr>Model</h3> <div class="tsd-signature tsd-kind-icon">Evaluate<wbr>Classification<wbr>Model<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/repetere/modelx/blob/ba94d70/src/model.ts#L266">Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:266</a></li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter-index-signature"> <h5><span class="tsd-signature-symbol">[</span>index: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><a href="_src_model_.html#classificationevaluation" class="tsd-signature-type">ClassificationEvaluation</a></h5> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="evaluatemodeloptions" class="tsd-anchor"></a> <h3>Evaluate<wbr>Model<wbr>Options</h3> <div class="tsd-signature tsd-kind-icon">Evaluate<wbr>Model<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>predictionOptions<span class="tsd-signature-symbol">?: </span><a href="_src_model_.html#predictionoptions-2" class="tsd-signature-type">PredictionOptions</a><span class="tsd-signature-symbol">; </span>retrain<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>x_indep_matrix_test<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ModelXDataTypes.Matrix</span><span class="tsd-signature-symbol">; </span>y_dep_matrix_test<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ModelXDataTypes.Matrix</span><span class="tsd-signature-symbol"> }</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/repetere/modelx/blob/ba94d70/src/model.ts#L226">Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:226</a></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> prediction<wbr>Options<span class="tsd-signature-symbol">?: </span><a href="_src_model_.html#predictionoptions-2" class="tsd-signature-type">PredictionOptions</a></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> retrain<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> x_<wbr>indep_<wbr>matrix_<wbr>test<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ModelXDataTypes.Matrix</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> y_<wbr>dep_<wbr>matrix_<wbr>test<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ModelXDataTypes.Matrix</span></h5> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="evaluateregressionmodel" class="tsd-anchor"></a> <h3>Evaluate<wbr>Regression<wbr>Model</h3> <div class="tsd-signature tsd-kind-icon">Evaluate<wbr>Regression<wbr>Model<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/repetere/modelx/blob/ba94d70/src/model.ts#L269">Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:269</a></li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter-index-signature"> <h5><span class="tsd-signature-symbol">[</span>index: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><a href="_src_model_.html#regressionevaluation" class="tsd-signature-type">RegressionEvaluation</a></h5> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="evaluationaccuracyoptions" class="tsd-anchor"></a> <h3>Evaluation<wbr>Accuracy<wbr>Options</h3> <div class="tsd-signature tsd-kind-icon">Evaluation<wbr>Accuracy<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>actualsDescaled<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ModelXDataTypes.Data</span><span class="tsd-signature-symbol">; </span>dependent_feature_label<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>estimatesDescaled<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ModelXDataTypes.Data</span><span class="tsd-signature-symbol"> }</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/repetere/modelx/blob/ba94d70/src/model.ts#L232">Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:232</a></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> actuals<wbr>Descaled<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ModelXDataTypes.Data</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> dependent_<wbr>feature_<wbr>label<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> estimates<wbr>Descaled<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ModelXDataTypes.Data</span></h5> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="forecasthelpernextvaluedata" class="tsd-anchor"></a> <h3>Forecast<wbr>Helper<wbr>Next<wbr>Value<wbr>Data</h3> <div class="tsd-signature tsd-kind-icon">Forecast<wbr>Helper<wbr>Next<wbr>Value<wbr>Data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>associated_data_entity<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>associated_data_location<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>associated_data_product<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">; </span>forecast_entity_id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>forecast_entity_name<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>forecast_entity_title<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>forecast_entity_type<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>origin_time_zone<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">ModelXDataTypes.Datum</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/repetere/modelx/blob/ba94d70/src/model.ts#L202">Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:202</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="forecastpredictioninputnextvaluefunction" class="tsd-anchor"></a> <h3>Forecast<wbr>Prediction<wbr>Input<wbr>Next<wbr>Value<wbr>Function</h3> <div class="tsd-signature tsd-kind-icon">Forecast<wbr>Prediction<wbr>Input<wbr>Next<wbr>Value<wbr>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><a href="_src_model_.html#forecastpredictionnextvaluestate" class="tsd-signature-type">ForecastPredictionNextValueState</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">ModelXDataTypes.Datum</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/repetere/modelx/blob/ba94d70/src/model.ts#L290">Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:290</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>returns a Datum used in next forecast prediction input</p> </div> </div> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter-siganture"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><a href="_src_model_.html#forecastpredictionnextvaluestate" class="tsd-signature-type">ForecastPredictionNextValueState</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ModelXDataTypes.Datum</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>state: <a href="_src_model_.html#forecastpredictionnextvaluestate" class="tsd-signature-type">ForecastPredictionNextValueState</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ModelXDataTypes.Datum</span></h4> </li> </ul> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="forecastpredictionnextvaluestate" class="tsd-anchor"></a> <h3>Forecast<wbr>Prediction<wbr>Next<wbr>Value<wbr>State</h3> <div class="tsd-signature tsd-kind-icon">Forecast<wbr>Prediction<wbr>Next<wbr>Value<wbr>State<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>DataSet<span class="tsd-signature-symbol">: </span><a href="../classes/_node_modules__modelx_data_src_dataset_.dataset.html" class="tsd-signature-type">DataSet</a><span class="tsd-signature-symbol">; </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ModelXDataTypes.Data</span><span class="tsd-signature-symbol">; </span>existingDatasetObjectIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>forecastDate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">; </span>forecastDates<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>forecastPredictionIndex<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>isOpen<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="../enums/_src_constants_.booleananswer.html" class="tsd-signature-type">BooleanAnswer</a><span class="tsd-signature-symbol">; </span>isOutlier<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="../enums/_src_constants_.booleananswer.html" class="tsd-signature-type">BooleanAnswer</a><span class="tsd-signature-symbol">; </span>lastDataRow<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ModelXDataTypes.Datum</span><span class="tsd-signature-symbol">; </span>parsedDate<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_src_constants_.parseddate.html" class="tsd-signature-type">ParsedDate</a><span class="tsd-signature-symbol">; </span>rawInputPredictionObject<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ModelXDataTypes.Datum</span><span class="tsd-signature-symbol">; </span>reverseTransform<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>sumPreviousRows<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_src_model_.sumpreviousrows.html" class="tsd-signature-type">sumPreviousRows</a><span class="tsd-signature-symbol">; </span>unscaledLastForecastedValue<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ModelXDataTypes.Datum</span><span class="tsd-signature-symbol"> }</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/repetere/modelx/blob/ba94d70/src/model.ts#L186">Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:186</a></li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>Data<wbr>Set<span class="tsd-signature-symbol">: </span><a href="../classes/_node_modules__modelx_data_src_dataset_.dataset.html" class="tsd-signature-type">DataSet</a></h5> </li> <li class="tsd-parameter"> <h5>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ModelXDataTypes.Data</span></h5> </li> <li class="tsd-parameter"> <h5>existing<wbr>Dataset<wbr>Object<wbr>Index<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> forecast<wbr>Date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Date</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> forecast<wbr>Dates<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">[]</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> forecast<wbr>Prediction<wbr>Index<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> is<wbr>Open<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="../enums/_src_constants_.booleananswer.html" class="tsd-signature-type">BooleanAnswer</a></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>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../enums/_src_constants_.booleananswer.html" class="tsd-signature-type">BooleanAnswer</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="../enums/_src_constants_.booleananswer.html" class="tsd-signature-type">BooleanAnswer</a></h4> </li> </ul> </li> </ul> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> is<wbr>Outlier<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="../enums/_src_constants_.booleananswer.html" class="tsd-signature-type">BooleanAnswer</a></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>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../enums/_src_constants_.booleananswer.html" class="tsd-signature-type">BooleanAnswer</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="../enums/_src_constants_.booleananswer.html" class="tsd-signature-type">BooleanAnswer</a></h4> </li> </ul> </li> </ul> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> last<wbr>Data<wbr>Row<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ModelXDataTypes.Datum</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> parsed<wbr>Date<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_src_constants_.parseddate.html" class="tsd-signature-type">ParsedDate</a></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> raw<wbr>Input<wbr>Prediction<wbr>Object<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ModelXDataTypes.Datum</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> reverse<wbr>Transform<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> sum<wbr>Previous<wbr>Rows<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_src_model_.sumpreviousrows.html" class="tsd-signature-type">sumPreviousRows</a></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> unscaled<wbr>Last<wbr>Forecasted<wbr>Value<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ModelXDataTypes.Datum</span></h5> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="generatedfunctiondefinitionslist" class="tsd-anchor"></a> <h3>Generated<wbr>Function<wbr>Definitions<wbr>List</h3> <div class="tsd-signature tsd-kind-icon">Generated<wbr>Function<wbr>Definitions<wbr>List<span class="tsd-signature-symbol">:</span> <a href="_src_model_.html#generatedstatefulfunctionobject" class="tsd-signature-type">GeneratedStatefulFunctionObject</a><span class="tsd-signature-symbol">[]</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/repetere/modelx/blob/ba94d70/src/model.ts#L156">Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:156</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="generatedfunctiondefinitionsobject" class="tsd-anchor"></a> <h3>Generated<wbr>Function<wbr>Definitions<wbr>Object</h3> <div class="tsd-signature tsd-kind-icon">Generated<wbr>Function<wbr>Definitions<wbr>Object<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/repetere/modelx/blob/ba94d70/src/model.ts#L153">Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:153</a></li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter-index-signature"> <h5><span class="tsd-signature-symbol">[</span>index: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><a href="_src_model_.html#generatedstatefulfunctionobject" class="tsd-signature-type">GeneratedStatefulFunctionObject</a></h5> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="generatedstatefulfunction" class="tsd-anchor"></a> <h3>Generated<wbr>Stateful<wbr>Function</h3> <div class="tsd-signature tsd-kind-icon">Generated<wbr>Stateful<wbr>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><a href="_src_model_.html#generatedstatefulfunctionstate" class="tsd-signature-type">GeneratedStatefulFunctionState</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/repetere/modelx/blob/ba94d70/src/model.ts#L173">Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:173</a></li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter-siganture"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><a href="_src_model_.html#generatedstatefulfunctionstate" class="tsd-signature-type">GeneratedStatefulFunctionState</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>state: <a href="_src_model_.html#generatedstatefulfunctionstate" class="tsd-signature-type">GeneratedStatefulFunctionState</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> </li> </ul> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="generatedstatefulfunctionobject" class="tsd-anchor"></a> <h3>Generated<wbr>Stateful<wbr>Function<wbr>Object</h3> <div class="tsd-signature tsd-kind-icon">Generated<wbr>Stateful<wbr>Function<wbr>Object<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>function_body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>variable_name<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 <a href="https://github.com/repetere/modelx/blob/ba94d70/src/model.ts#L162">Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:162</a></li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>function_<wbr>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5>variable_<wbr>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="generatedstatefulfunctionparams" class="tsd-anchor"></a> <h3>Generated<wbr>Stateful<wbr>Function<wbr>Params</h3> <div class="tsd-signature tsd-kind-icon">Generated<wbr>Stateful<wbr>Function<wbr>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>function_name_prefix<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>props<span class="tsd-signature-symbol">?: </span><a href="_src_model_.html#generatedstatefulfunctionprops" class="tsd-signature-type">GeneratedStatefulFunctionProps</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> &amp; </span><a href="_src_model_.html#generatedstatefulfunctionobject" class="tsd-signature-type">GeneratedStatefulFunctionObject</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/repetere/modelx/blob/ba94d70/src/model.ts#L169">Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:169</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="generatedstatefulfunctionprops" class="tsd-anchor"></a> <h3>Generated<wbr>Stateful<wbr>Function<wbr>Props</h3> <div class="tsd-signature tsd-kind-icon">Generated<wbr>Stateful<wbr>Function<wbr>Props<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>Luxon<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>ModelXData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/repetere/modelx/blob/ba94d70/src/model.ts#L158">Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:158</a></li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>Luxon<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></h5> </li> <li class="tsd-parameter"> <h5>ModelXData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></h5> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="generatedstatefulfunctionstate" class="tsd-anchor"></a> <h3>Generated<wbr>Stateful<wbr>Function<wbr>State</h3> <div class="tsd-signature tsd-kind-icon">Generated<wbr>Stateful<wbr>Function<wbr>State<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/repetere/modelx/blob/ba94d70/src/model.ts#L157">Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:157</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias