@modelx/modelx

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>"src/features" | @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_features_.html">"src/features"</a> </li> </ul> <h1>External module "src/features"</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_features_.autofeaturetypes.html" class="tsd-kind-icon">Auto<wbr>Feature<wbr>Types</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_features_.html#autofeature" class="tsd-kind-icon">Auto<wbr>Feature</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_src_features_.html#autofeatureautoassignmentoptions" class="tsd-kind-icon">Auto<wbr>Feature<wbr>Auto<wbr>Assignment<wbr>Options</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_src_features_.html#uniquedateoptions" class="tsd-kind-icon">Unique<wbr>Date<wbr>Options</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_features_.html#autoassignfeaturecolumns" class="tsd-kind-icon">auto<wbr>Assign<wbr>Feature<wbr>Columns</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_src_features_.html#getautofeatures" class="tsd-kind-icon">get<wbr>Auto<wbr>Features</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_src_features_.html#getencodedfeatures" class="tsd-kind-icon">get<wbr>Encoded<wbr>Features</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_src_features_.html#getenddate" class="tsd-kind-icon">get<wbr>End<wbr>Date</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_src_features_.html#getuniquedays" class="tsd-kind-icon">get<wbr>Unique<wbr>Days</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_src_features_.html#getuniquehours" class="tsd-kind-icon">get<wbr>Unique<wbr>Hours</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_src_features_.html#getuniqueminutes" class="tsd-kind-icon">get<wbr>Unique<wbr>Minutes</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_src_features_.html#getuniquemonths" class="tsd-kind-icon">get<wbr>Unique<wbr>Months</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_src_features_.html#getuniqueseconds" class="tsd-kind-icon">get<wbr>Unique<wbr>Seconds</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_src_features_.html#getuniqueweeks" class="tsd-kind-icon">get<wbr>Unique<wbr>Weeks</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_src_features_.html#getuniqueyears" class="tsd-kind-icon">get<wbr>Unique<wbr>Years</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_features_.html#dimensiondates" class="tsd-kind-icon">dimension<wbr>Dates</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="autofeature" class="tsd-anchor"></a> <h3>Auto<wbr>Feature</h3> <div class="tsd-signature tsd-kind-icon">Auto<wbr>Feature<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>feature_field_name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>feature_field_type<span class="tsd-signature-symbol">: </span><a href="../enums/_src_features_.autofeaturetypes.html" class="tsd-signature-type">AutoFeatureTypes</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/features.ts#L314">Users/yawjosephetse/Developer/github/repetere/modelx/src/features.ts:314</a></li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>feature_<wbr>field_<wbr>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5>feature_<wbr>field_<wbr>type<span class="tsd-signature-symbol">: </span><a href="../enums/_src_features_.autofeaturetypes.html" class="tsd-signature-type">AutoFeatureTypes</a></h5> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="autofeatureautoassignmentoptions" class="tsd-anchor"></a> <h3>Auto<wbr>Feature<wbr>Auto<wbr>Assignment<wbr>Options</h3> <div class="tsd-signature tsd-kind-icon">Auto<wbr>Feature<wbr>Auto<wbr>Assignment<wbr>Options<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><span class="tsd-signature-symbol">; </span>dependent_variables<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><a href="_src_features_.html#autofeature" class="tsd-signature-type">AutoFeature</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>independent_variables<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>input_independent_features<span class="tsd-signature-symbol">?: </span><a href="_src_features_.html#autofeature" class="tsd-signature-type">AutoFeature</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>output_dependent_features<span class="tsd-signature-symbol">?: </span><a href="_src_features_.html#autofeature" class="tsd-signature-type">AutoFeature</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>preprocessing_feature_column_options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ModelXDataTypes.DataSetTransform</span><span class="tsd-signature-symbol">; </span>training_feature_column_options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ModelXDataTypes.DataSetTransform</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/features.ts#L318">Users/yawjosephetse/Developer/github/repetere/modelx/src/features.ts:318</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> datum<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> dependent_<wbr>variables<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><span class="tsd-flag ts-flagOptional">Optional</span> features<span class="tsd-signature-symbol">?: </span><a href="_src_features_.html#autofeature" class="tsd-signature-type">AutoFeature</a><span class="tsd-signature-symbol">[]</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> independent_<wbr>variables<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><span class="tsd-flag ts-flagOptional">Optional</span> input_<wbr>independent_<wbr>features<span class="tsd-signature-symbol">?: </span><a href="_src_features_.html#autofeature" class="tsd-signature-type">AutoFeature</a><span class="tsd-signature-symbol">[]</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> output_<wbr>dependent_<wbr>features<span class="tsd-signature-symbol">?: </span><a href="_src_features_.html#autofeature" class="tsd-signature-type">AutoFeature</a><span class="tsd-signature-symbol">[]</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> preprocessing_<wbr>feature_<wbr>column_<wbr>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ModelXDataTypes.DataSetTransform</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> training_<wbr>feature_<wbr>column_<wbr>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ModelXDataTypes.DataSetTransform</span></h5> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="uniquedateoptions" class="tsd-anchor"></a> <h3>Unique<wbr>Date<wbr>Options</h3> <div class="tsd-signature tsd-kind-icon">Unique<wbr>Date<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>end<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>start<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>time_zone<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>weekday<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><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/features.ts#L6">Users/yawjosephetse/Developer/github/repetere/modelx/src/features.ts:6</a></li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>end<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5>start<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5>time_<wbr>zone<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> weekday<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5> </li> </ul> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Functions</h2> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="autoassignfeaturecolumns" class="tsd-anchor"></a> <h3>auto<wbr>Assign<wbr>Feature<wbr>Columns</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">auto<wbr>Assign<wbr>Feature<wbr>Columns<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>datum<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">; </span>dependent_variables<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>independent_variables<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>input_independent_features<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>feature_field_name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>feature_field_type<span class="tsd-signature-symbol">: </span><a href="../enums/_src_features_.autofeaturetypes.html" class="tsd-signature-type">AutoFeatureTypes</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>output_dependent_features<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>feature_field_name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>feature_field_type<span class="tsd-signature-symbol">: </span><a href="../enums/_src_features_.autofeaturetypes.html" class="tsd-signature-type">AutoFeatureTypes</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>preprocessing_feature_column_options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">; </span>training_feature_column_options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>preprocessing_feature_column_options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">; </span>training_feature_column_options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">; </span>x_raw_independent_features<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>y_raw_dependent_labels<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></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/repetere/modelx/blob/ba94d70/src/features.ts#L343">Users/yawjosephetse/Developer/github/repetere/modelx/src/features.ts:343</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>datum<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">; </span>dependent_variables<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>independent_variables<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>input_independent_features<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>feature_field_name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>feature_field_type<span class="tsd-signature-symbol">: </span><a href="../enums/_src_features_.autofeaturetypes.html" class="tsd-signature-type">AutoFeatureTypes</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>output_dependent_features<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>feature_field_name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>feature_field_type<span class="tsd-signature-symbol">: </span><a href="../enums/_src_features_.autofeaturetypes.html" class="tsd-signature-type">AutoFeatureTypes</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>preprocessing_feature_column_options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">; </span>training_feature_column_options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> }</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>datum<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span></h5> <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><span class="tsd-signature-type">any</span></h5> </li> </ul> </li> <li class="tsd-parameter"> <h5>dependent_<wbr>variables<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>independent_<wbr>variables<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>input_<wbr>independent_<wbr>features<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>feature_field_name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>feature_field_type<span class="tsd-signature-symbol">: </span><a href="../enums/_src_features_.autofeaturetypes.html" class="tsd-signature-type">AutoFeatureTypes</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h5> </li> <li class="tsd-parameter"> <h5>output_<wbr>dependent_<wbr>features<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>feature_field_name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>feature_field_type<span class="tsd-signature-symbol">: </span><a href="../enums/_src_features_.autofeaturetypes.html" class="tsd-signature-type">AutoFeatureTypes</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h5> </li> <li class="tsd-parameter"> <h5>preprocessing_<wbr>feature_<wbr>column_<wbr>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span></h5> <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><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">any</span></h5> </li> </ul> </li> <li class="tsd-parameter"> <h5>training_<wbr>feature_<wbr>column_<wbr>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span></h5> <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><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">any</span></h5> </li> </ul> </li> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>preprocessing_feature_column_options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">; </span>training_feature_column_options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">; </span>x_raw_independent_features<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>y_raw_dependent_labels<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></h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>preprocessing_<wbr>feature_<wbr>column_<wbr>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span></h5> <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><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">any</span></h5> </li> </ul> </li> <li class="tsd-parameter"> <h5>training_<wbr>feature_<wbr>column_<wbr>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span></h5> <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><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">any</span></h5> </li> </ul> </li> <li class="tsd-parameter"> <h5>x_<wbr>raw_<wbr>independent_<wbr>features<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5> </li> <li class="tsd-parameter"> <h5>y_<wbr>raw_<wbr>dependent_<wbr>labels<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5> </li> </ul> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="getautofeatures" class="tsd-anchor"></a> <h3>get<wbr>Auto<wbr>Features</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">get<wbr>Auto<wbr>Features<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>datum<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">; </span>variables<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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_src_features_.html#autofeature" class="tsd-signature-type">AutoFeature</a><span class="tsd-signature-symbol">[]</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/repetere/modelx/blob/ba94d70/src/features.ts#L329">Users/yawjosephetse/Developer/github/repetere/modelx/src/features.ts:329</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>datum<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">; </span>variables<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></h5> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>datum<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span></h5> <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><span class="tsd-signature-type">any</span></h5> </li> </ul> </li> <li class="tsd-parameter"> <h5>variables<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5> </li> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_src_features_.html#autofeature" class="tsd-signature-type">AutoFeature</a><span class="tsd-signature-symbol">[]</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="getencodedfeatures" class="tsd-anchor"></a> <h3>get<wbr>Encoded<wbr>Features</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">get<wbr>Encoded<wbr>Features<span class="tsd-signature-symbol">(</span>__namedParameters<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>features<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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/repetere/modelx/blob/ba94d70/src/features.ts#L291">Users/yawjosephetse/Developer/github/repetere/modelx/src/features.ts:291</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>__namedParameters: <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>features<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></h5> <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>features<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5> </li> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="getenddate" class="tsd-anchor"></a> <h3>get<wbr>End<wbr>Date</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">get<wbr>End<wbr>Date<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>dimension<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>start_date<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">; </span>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">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/repetere/modelx/blob/ba94d70/src/features.ts#L245">Users/yawjosephetse/Developer/github/repetere/modelx/src/features.ts:245</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Returns an end date from a start date by dimension</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><p>getEndDate({ start: '2018-01-01', dimension: 'monthly', time_zone: 'America/Los_Angeles', }) => 2018-02-01T00:08:00.000Z getEndDate({ start: '2018-01-01', dimension: 'weekly', time_zone: 'America/Los_Angeles', }) => 2018-01-08T00:08:00.000Z getEndDate({ start: '2018-01-01', dimension: 'daily', time_zone: 'America/Los_Angeles', }) => 2018-01-02T00:08:00.000Z getEndDate({ start: '2018-01-01', dimension: 'hourly', time_zone: 'America/Los_Angeles', }) => 2018-01-01T00:09:00.000Z</p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>options: <span class="tsd-signature-symbol">{ </span>dimension<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>start_date<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">; </span>time_zone<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>dimension<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>monthly, weekly, daily, hourly</p> </div> </li> <li class="tsd-parameter"> <h5>start_<wbr>date<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span></h5> <div class="tsd-comment tsd-typography"> <p>start of date</p> </div> </li> <li class="tsd-parameter"> <h5>time_<wbr>zone<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>valid IANA time_zone e.g. America/Los_Angeles</p> </div> </li> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4> <p>JavaScript end date</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="getuniquedays" class="tsd-anchor"></a> <h3>get<wbr>Unique<wbr>Days</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">get<wbr>Unique<wbr>Days<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>end<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>start<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>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">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">[]</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/repetere/modelx/blob/ba94d70/src/features.ts#L134">Users/yawjosephetse/Developer/github/repetere/modelx/src/features.ts:134</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Returns an array of JavaScript Dates by Days within a range of ISO dates</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><p>getUniqueMonths({ start: '2018-01-01', end: '2018-01-31', weekday:'monday', time_zone: 'America/Los_Angeles', }) => [ 2018-01-01T08:00:00.000Z, 2018-01-02T08:00:00.000Z, ... 2018-01-29T08:00:00.000Z, 2018-01-30T08:00:00.000Z, 2018-01-31T08:00:00.000Z ]]</p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>end<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>start<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>time_zone<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>end<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5>start<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5>time_<wbr>zone<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">[]</span></h4> <p>Array of JavaScript Dates</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="getuniquehours" class="tsd-anchor"></a> <h3>get<wbr>Unique<wbr>Hours</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">get<wbr>Unique<wbr>Hours<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>end<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>start<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>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">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">[]</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/repetere/modelx/blob/ba94d70/src/features.ts#L164">Users/yawjosephetse/Developer/github/repetere/modelx/src/features.ts:164</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Returns an array of JavaScript Dates by Hours within a range of ISO dates</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><p>getUniqueHours({ start: '2018-01-01', end: '2018-01-31', weekday:'monday', time_zone: 'America/Los_Angeles', }) => [ 2018-01-01T00:08:00.000Z, 2018-01-01T01:09:00.000Z, ... 2018-01-01T21:00:00.000Z, 2018-01-01T22:00:00.000Z, 2018-01-01T23:00:00.000Z ]]</p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>end<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>start<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>time_zone<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>end<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5>start<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5>time_<wbr>zone<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">[]</span></h4> <p>Array of JavaScript Dates</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="getuniqueminutes" class="tsd-anchor"></a> <h3>get<wbr>Unique<wbr>Minutes</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">get<wbr>Unique<wbr>Minutes<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>end<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>start<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>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">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">[]</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/repetere/modelx/blob/ba94d70/src/features.ts#L192">Users/yawjosephetse/Developer/github/repetere/modelx/src/features.ts:192</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Returns an array of JavaScript Dates by Hours within a range of ISO dates</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><p>getUniqueHours({ start: '2018-01-01', end: '2018-01-31', weekday:'monday', time_zone: 'America/Los_Angeles', }) => [ 2018-01-01T00:08:00.000Z, 2018-01-01T01:09:00.000Z, ... 2018-01-01T21:00:00.000Z, 2018-01-01T22:00:00.000Z, 2018-01-01T23:00:00.000Z ]]</p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>end<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>start<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>time_zone<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>end<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5>start<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5>time_<wbr>zone<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">[]</span></h4> <p>Array of JavaScript Dates</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="getuniquemonths" class="tsd-anchor"></a> <h3>get<wbr>Unique<wbr>Months</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">get<wbr>Unique<wbr>Months<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>end<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>start<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>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">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">[]</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/repetere/modelx/blob/ba94d70/src/features.ts#L50">Users/yawjosephetse/Developer/github/repetere/modelx/src/features.ts:50</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Returns an array of JavaScript Dates by Month within a range of ISO dates</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><p>getUniqueMonths({ start: '2018-01-01', end: '2018-03-01', time_zone: 'America/Los_Angeles', }) => [ 2018-01-01T08:00:00.000Z, 2018-02-01T08:00:00.000Z, 2018-03-01T08:00:00.000Z ]</p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>end<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>start<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>time_zone<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>end<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5>start<span