@modelx/modelx

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>ModelContext | @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="../modules/_src_model_.html">"src/model"</a> </li> <li> <a href="_src_model_.modelcontext.html">ModelContext</a> </li> </ul> <h1>Interface ModelContext</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">ModelContext</span> </li> </ul> </section> <section class="tsd-panel"> <h3>Implemented by</h3> <ul class="tsd-hierarchy"> <li><a href="../classes/_src_model_.modelx.html" class="tsd-signature-type">ModelX</a></li> </ul> </section> <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>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_src_model_.modelcontext.html#dataset" class="tsd-kind-icon">Data<wbr>Set</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_src_model_.modelcontext.html#config" class="tsd-kind-icon">config</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_src_model_.modelcontext.html#dimension" class="tsd-kind-icon">dimension</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_src_model_.modelcontext.html#entity" class="tsd-kind-icon">entity</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_src_model_.modelcontext.html#prediction_inputs_next_value_functions" class="tsd-kind-icon">prediction_<wbr>inputs_<wbr>next_<wbr>value_<wbr>functions</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_src_model_.modelcontext.html#status" class="tsd-kind-icon">status</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_src_model_.modelcontext.html#trainingdata" class="tsd-kind-icon">training<wbr>Data</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_src_model_.modelcontext.html#training_data_filter_function_body" class="tsd-kind-icon">training_<wbr>data_<wbr>filter_<wbr>function_<wbr>body</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="dataset" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> Data<wbr>Set</h3> <div class="tsd-signature tsd-kind-icon">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></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/repetere/modelx/blob/ba94d70/src/model.ts#L110">Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:110</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="config" class="tsd-anchor"></a> <h3>config</h3> <div class="tsd-signature tsd-kind-icon">config<span class="tsd-signature-symbol">:</span> <a href="../modules/_src_model_.html#modelconfiguration" class="tsd-signature-type">ModelConfiguration</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/repetere/modelx/blob/ba94d70/src/model.ts#L103">Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:103</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="dimension" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> dimension</h3> <div class="tsd-signature tsd-kind-icon">dimension<span class="tsd-signature-symbol">:</span> <a href="../enums/_src_constants_.dimensions.html" class="tsd-signature-type">Dimensions</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/repetere/modelx/blob/ba94d70/src/model.ts#L108">Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:108</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="entity" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> entity</h3> <div class="tsd-signature tsd-kind-icon">entity<span class="tsd-signature-symbol">:</span> <a href="../modules/_src_constants_.html#entity" class="tsd-signature-type">Entity</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/repetere/modelx/blob/ba94d70/src/model.ts#L109">Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:109</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="prediction_inputs_next_value_functions" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> prediction_<wbr>inputs_<wbr>next_<wbr>value_<wbr>functions</h3> <div class="tsd-signature tsd-kind-icon">prediction_<wbr>inputs_<wbr>next_<wbr>value_<wbr>functions<span class="tsd-signature-symbol">:</span> <a href="../modules/_src_model_.html#generatedfunctiondefinitionslist" class="tsd-signature-type">GeneratedFunctionDefinitionsList</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/repetere/modelx/blob/ba94d70/src/model.ts#L106">Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:106</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="status" class="tsd-anchor"></a> <h3>status</h3> <div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <a href="../modules/_src_model_.html#modelstatus" class="tsd-signature-type">ModelStatus</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/repetere/modelx/blob/ba94d70/src/model.ts#L104">Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:104</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="trainingdata" class="tsd-anchor"></a> <h3>training<wbr>Data</h3> <div class="tsd-signature tsd-kind-icon">training<wbr>Data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ModelXDataTypes.Data</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/repetere/modelx/blob/ba94d70/src/model.ts#L105">Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:105</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="training_data_filter_function_body" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> training_<wbr>data_<wbr>filter_<wbr>function_<wbr>body</h3> <div class="tsd-signature tsd-kind-icon">training_<wbr>data_<wbr>filter_<wbr>function_<wbr>body<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/repetere/modelx/blob/ba94d70/src/model.ts#L107">Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:107</a></li> </ul> </aside> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../globals.html"><em>Globals</em></a> </li> <li class="current tsd-kind-external-module"> <a href="../modules/_src_model_.html">"src/model"</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> <ul class="current"> <li class="current tsd-kind-interface tsd-parent-kind-external-module"> <a href="_src_model_.modelcontext.html" class="tsd-kind-icon">Model<wbr>Context</a> <ul> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_src_model_.modelcontext.html#dataset" class="tsd-kind-icon">Data<wbr>Set</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_src_model_.modelcontext.html#config" class="tsd-kind-icon">config</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_src_model_.modelcontext.html#dimension" class="tsd-kind-icon">dimension</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_src_model_.modelcontext.html#entity" class="tsd-kind-icon">entity</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_src_model_.modelcontext.html#prediction_inputs_next_value_functions" class="tsd-kind-icon">prediction_<wbr>inputs_<wbr>next_<wbr>value_<wbr>functions</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_src_model_.modelcontext.html#status" class="tsd-kind-icon">status</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_src_model_.modelcontext.html#trainingdata" class="tsd-kind-icon">training<wbr>Data</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_src_model_.modelcontext.html#training_data_filter_function_body" class="tsd-kind-icon">training_<wbr>data_<wbr>filter_<wbr>function_<wbr>body</a> </li> </ul> </li> </ul> <ul class="after-current"> </ul> </nav> </div> </div> </div> <footer> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li> <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li> <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li> <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li> <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> <li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li> <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li> <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li> <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li> </ul> </div> </div> </footer> <div class="overlay"></div> <script src="../assets/js/main.js"></script> <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> </body> </html>