ModelX | @modelx/data

Hierarchy

ModelX

Implements

ModelContext

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ModelX(configuration: ModelConfiguration, options?: ModelOptions): ModelX

- Defined in Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:405
Parameters
- configuration: ModelConfiguration
- Default value options: ModelOptions = {}
Returns ModelX

Properties

DataSet

DataSet: DataSet

Model

Model: TensorScriptModelInterface | LSTMTimeSeries

Optional auto_assign_features

auto_assign_features: boolean

config

config: ModelConfiguration

cross_validation_options

cross_validation_options: CrossValidationOptions

debug

debug: boolean

Optional dependent_variables

dependent_variables: string[]

Optional dimension

dimension: Dimensions

emptyObject

emptyObject: ModelXDataTypes.Datum

Optional entity

entity: Entity

forecastDates

forecastDates: Date[]

Optional independent_variables

independent_variables: string[]

Optional input_independent_features

input_independent_features: AutoFeature[]

max_evaluation_outputs

max_evaluation_outputs: number

mockEncodedData

mockEncodedData: ModelXDataTypes.Data

original_data_test

original_data_test: ModelXDataTypes.Data

original_data_train

original_data_train: ModelXDataTypes.Data

Optional output_dependent_features

output_dependent_features: AutoFeature[]

Optional prediction_inputs

prediction_inputs: ModelXDataTypes.Data

Optional prediction_inputs_next_value_function

prediction_inputs_next_value_function: ForecastPredictionInputNextValueFunction

prediction_inputs_next_value_functions

prediction_inputs_next_value_functions: GeneratedFunctionDefinitionsList

Optional prediction_options

prediction_options: PredictModelConfig

prediction_timeseries_date_feature

prediction_timeseries_date_feature: string

Optional prediction_timeseries_date_format

prediction_timeseries_date_format: string

prediction_timeseries_dimension_feature

prediction_timeseries_dimension_feature: string

Optional prediction_timeseries_end_date

prediction_timeseries_end_date: Date | string

Optional prediction_timeseries_start_date

prediction_timeseries_start_date: Date | string

prediction_timeseries_time_zone

prediction_timeseries_time_zone: string

preprocessing_feature_column_options

preprocessing_feature_column_options: ModelXDataTypes.DataSetTransform

removedFilterdtrainingData

removedFilterdtrainingData: ModelXDataTypes.Data

Optional retrain_forecast_model_with_predictions

retrain_forecast_model_with_predictions: boolean

status

status: ModelStatus

testDataSet

testDataSet: DataSet

trainDataSet

trainDataSet: DataSet

trainingData

trainingData: ModelXDataTypes.Data

Optional training_data_filter_function

training_data_filter_function: DataFilterFunction

Optional training_data_filter_function_body

training_data_filter_function_body: string

training_feature_column_options

training_feature_column_options: ModelXDataTypes.DataSetTransform

Optional training_model_loss

training_model_loss: number

training_options

training_options: ModelXModelTypes.TensorScriptOptions

training_progress_callback

training_progress_callback: TrainingProgressCallback

Optional training_size_values

training_size_values: number

use_empty_objects

use_empty_objects: boolean

use_mock_encoded_data

use_mock_encoded_data: boolean

use_preprocessing_on_trainning_data

use_preprocessing_on_trainning_data: boolean

validate_training_data

validate_training_data: boolean

x_indep_matrix_test

x_indep_matrix_test: ModelXDataTypes.Matrix

x_indep_matrix_train

x_indep_matrix_train: ModelXDataTypes.Matrix

x_independent_features

x_independent_features: string[]

x_raw_independent_features

x_raw_independent_features: string[]

y_dep_matrix_test

y_dep_matrix_test: ModelXDataTypes.Matrix

y_dep_matrix_train

y_dep_matrix_train: ModelXDataTypes.Matrix

y_dependent_labels

y_dependent_labels: string[]

y_raw_dependent_labels

y_raw_dependent_labels: string[]

Methods

addMockData

addMockData(__namedParameters?: { use_mock_dates: boolean }): void

- Defined in Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:611
Parameters
- Default value __namedParameters: { use_mock_dates: boolean } = {}
  - use_mock_dates: boolean
Returns void

checkTrainingStatus

checkTrainingStatus(options?: { retrain?: boolean }): Promise<boolean>

- Defined in Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:693
Parameters
- Default value options: { retrain?: boolean } = {}
  - Optional retrain?: boolean
Returns Promise<boolean>

evaluateClassificationAccuracy

evaluateClassificationAccuracy(options?: EvaluationAccuracyOptions): { accuracy: any; actuals: any; estimates: any; labels: any; matrix: any }

- Defined in Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:1407
Parameters
- Default value options: EvaluationAccuracyOptions = {}
Returns { accuracy: any; actuals: any; estimates: any; labels: any; matrix: any }
- accuracy: any
- actuals: any
- estimates: any
- labels: any
- matrix: any

evaluateModel

evaluateModel(options?: EvaluateModelOptions): Promise<EvaluateClassificationModel | EvaluateRegressionModel>

- Defined in Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:1462
Parameters
- Default value options: EvaluateModelOptions = {}
Returns Promise<EvaluateClassificationModel | EvaluateRegressionModel>

evaluateRegressionAccuracy

evaluateRegressionAccuracy(options?: EvaluationAccuracyOptions): RegressionEvaluation

- Defined in Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:1421
Parameters
- Default value options: EvaluationAccuracyOptions = {}
Returns RegressionEvaluation

getCrosstrainingData

getCrosstrainingData(): { test: any; train: any }

- Defined in Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:621
Returns { test: any; train: any }
- test: any
- train: any

getDataSetProperties

getDataSetProperties(options?: GetDataSetProperties): Promise<void>

- Defined in Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:700
Parameters
- Default value options: GetDataSetProperties = {}
Returns Promise<void>

getForecastDates

getForecastDates(options?: {}): Date[]

- Defined in Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:594
Parameters
- Default value options: {} = {}
Returns Date[]

getPredictionData

getPredictionData(options?: { getPredictionInputPromise?: GetPredicitonData }): Promise<{}[]>

- Defined in Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:921
Parameters
- Default value options: { getPredictionInputPromise?: GetPredicitonData } = {}
  - Optional getPredictionInputPromise?: GetPredicitonData
Returns Promise<{}[]>

getTimeseriesDimension

getTimeseriesDimension(options?: { DataSetData?: ModelXDataTypes.Datum; dimension?: Dimensions }): TimeseriesDimension

- Defined in Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:537
Attempts to automatically figure out the time dimension of each date feature (hourly, daily, etc) and the format of the date property (e.g. JS Date Object, or ISO String, etc) from the dataset data

Parameters
- Default value options: { DataSetData?: ModelXDataTypes.Datum; dimension?: Dimensions } = {}
  - Optional DataSetData?: ModelXDataTypes.Datum
  - Optional dimension?: Dimensions
Returns TimeseriesDimension

getTrainingData

getTrainingData(options?: { getDataPromise?: GetPredicitonData; retrain?: boolean; trainingData?: ModelXDataTypes.Data }): Promise<void>

- Defined in Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:682
Parameters
- Default value options: { getDataPromise?: GetPredicitonData; retrain?: boolean; trainingData?: ModelXDataTypes.Data } = {}
  - Optional getDataPromise?: GetPredicitonData
  - Optional retrain?: boolean
  - Optional trainingData?: ModelXDataTypes.Data
Returns Promise<void>

predictModel

predictModel(options?: PredictModelOptions): Promise<any>

- Defined in Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:1149
Parameters
- Default value options: PredictModelOptions = {}
Returns Promise<any>

removeMockData

removeMockData(__namedParameters?: { use_mock_dates: boolean }): void

- Defined in Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:616
Parameters
- Default value __namedParameters: { use_mock_dates: boolean } = {}
  - use_mock_dates: boolean
Returns void

retrainTimeseriesModel

retrainTimeseriesModel(options?: retrainTimeseriesModel): Promise<this>

- Defined in Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:1260
Parameters
- Default value options: retrainTimeseriesModel = {}
Returns Promise<this>

timeseriesForecast

timeseriesForecast(options?: ValidateTimeseriesDataOptions): Promise<any[]>

- Defined in Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:1289
Parameters
- Default value options: ValidateTimeseriesDataOptions = {}
Returns Promise<any[]>

trainModel

trainModel(options?: ModelTrainningOptions): Promise<this>

- Defined in Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:931
Parameters
- Default value options: ModelTrainningOptions = {}
Returns Promise<this>

validateTimeseriesData

validateTimeseriesData(options?: ValidateTimeseriesDataOptions): Promise<{ datasetDates: any; dimension: Dimensions; forecastDateFirstDataSetDateIndex: any; forecastDates: Date[]; lastOriginalForecastDate: Date; raw_prediction_inputs: {}[] }>

- Defined in Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:826
Parameters
- Default value options: ValidateTimeseriesDataOptions = {}
Returns Promise<{ datasetDates: any; dimension: Dimensions; forecastDateFirstDataSetDateIndex: any; forecastDates: Date[]; lastOriginalForecastDate: Date; raw_prediction_inputs: {}[] }>

validateTrainingData

validateTrainingData(__namedParameters?: { cross_validate_training_data: boolean; inputMatrix: number[][] }): boolean

- Defined in Users/yawjosephetse/Developer/github/repetere/modelx/src/model.ts:656
Parameters
- Default value __namedParameters: { cross_validate_training_data: boolean; inputMatrix: number[][] } = {inputMatrix:undefined,}
  - cross_validate_training_data: boolean
  - inputMatrix: number[][]
Returns boolean

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: ModelConfiguration

Default value options: ModelOptions = {}

Returns ModelX

Properties

DataSet

Model

Optional auto_assign_features

config

cross_validation_options

debug

Optional dependent_variables

Optional dimension

emptyObject

Optional entity

forecastDates

Optional independent_variables

Optional input_independent_features

max_evaluation_outputs

mockEncodedData

original_data_test

original_data_train

Optional output_dependent_features

Optional prediction_inputs

Optional prediction_inputs_next_value_function

prediction_inputs_next_value_functions

Optional prediction_options

prediction_timeseries_date_feature

Optional prediction_timeseries_date_format

prediction_timeseries_dimension_feature

Optional prediction_timeseries_end_date

Optional prediction_timeseries_start_date

prediction_timeseries_time_zone

preprocessing_feature_column_options

removedFilterdtrainingData

Optional retrain_forecast_model_with_predictions

status

testDataSet

trainDataSet

trainingData

Optional training_data_filter_function

Optional training_data_filter_function_body

training_feature_column_options

Optional training_model_loss

training_options

training_progress_callback

Optional training_size_values

use_empty_objects

use_mock_encoded_data

use_preprocessing_on_trainning_data

validate_training_data

x_indep_matrix_test

x_indep_matrix_train

x_independent_features

x_raw_independent_features

y_dep_matrix_test

y_dep_matrix_train

y_dependent_labels

y_raw_dependent_labels

Methods

addMockData

Parameters

Default value __namedParameters: { use_mock_dates: boolean } = {}

use_mock_dates: boolean

Returns void

checkTrainingStatus

Parameters

Default value options: { retrain?: boolean } = {}

Optional retrain?: boolean

Returns Promise<boolean>

evaluateClassificationAccuracy

Parameters