Input Contracts

The user needs to provide the below environment variables as an input to the Data Science Job run for the managed container,

  • CONFIG_LOCATION (Required)

  • TEST_CONFIG_LOCATION (Optional)

  • RUNTIME_PARAMETER (Required)

    • ACTION_TYPE (Required)

    • DATE_RANGE (Optional)

    Action Type

    Override Date Range

    Test Config Location

    Run time Configuration in ML Job Run

    BASELINE_RUN

    No

    No

    		 
    CONFIG_LOCATION : "<HTTP_LOCATION_OF_OCI_STORAGE_APPLICATION_CONFIG_FILE_PATH>"
RUNTIME_PARAMETER : {"ACTION_TYPE":"RUN_BASELINE"}

    BASELINE_RUN

    Yes

    Yes

    		 
    CONFIG_LOCATION : "<HTTP_LOCATION_OF_OCI_STORAGE_APPLICATION_CONFIG_FILE_PATH>"
TEST_CONFIG_LOCATION : "<HTTP_LOCATION_OF_OCI_STORAGE_TEST_CONFIG_FILE_PATH>"
RUNTIME_PARAMETER : {
                      "ACTION_TYPE":"RUN_BASELINE" ,
                      "DATE_RANGE:": {
                                      "start": "2024-04-03",
                                      "end": "2024-04-03"
                                      }
                      }

    PREDICTION_RUN

    No

    No

    		 
    CONFIG_LOCATION : "<HTTP_LOCATION_OF_OCI_STORAGE_APPLICATION_CONFIG_FILE_PATH>"
RUNTIME_PARAMETER : {"ACTION_TYPE":"RUN_PREDICTION"}

    PREDICTION_RUN

    Yes

    Yes

    		 
    CONFIG_LOCATION : "<HTTP_LOCATION_OF_OCI_STORAGE_APPLICATION_CONFIG_FILE_PATH>"
TEST_CONFIG_LOCATION : "<HTTP_LOCATION_OF_OCI_STORAGE_TEST_CONFIG_FILE_PATH>"
RUNTIME_PARAMETER : {
                      "ACTION_TYPE":"RUN_PREDICTION" ,
                      "DATE_RANGE:": {
                                      "start": "2024-04-03",
                                      "end": "2024-04-03"
                                      }
                      }

    RUN_CONFIG_VALIDATION

    No

    No

    		 
    CONFIG_LOCATION : "<HTTP_LOCATION_OF_OCI_STORAGE_APPLICATION_CONFIG_FILE_PATH>"
RUNTIME_PARAMETER : {"ACTION_TYPE":"RUN_CONFIG_VALIDATION"}

    RUN_CONFIG_VALIDATION

    Yes

    Yes

    		 
    CONFIG_LOCATION : "<HTTP_LOCATION_OF_OCI_STORAGE_APPLICATION_CONFIG_FILE_PATH>"
TEST_CONFIG_LOCATION : "<HTTP_LOCATION_OF_OCI_STORAGE_TEST_CONFIG_FILE_PATH>"
RUNTIME_PARAMETER : {
                      "ACTION_TYPE":"RUN_CONFIG_VALIDATION",
                      "DATE_RANGE:": {
                                      "start": "2024-04-03",
                                                                              "end": "2024-04-03"
                                      }
                      }

Example

Partition Data

CONFIG LOCATION

This is the HTTP location of oci storage application config, which is a mandatory parameter to kick start a run.

The configuration needed to run baseline/prediction run is authored using a Application Configuration JSON file. User needs to upload the JSON file to OCI Object Storage bucket.

The location of the bucket object needs to be provided in CONFIG_LOCATION environment variable.

See also

How to configure ML Monitoring Application config file

TEST CONFIG LOCATION

This is the HTTP location of oci storage test config, which is a optional parameter for a run.

The configuration needed to configure test authored using a Test Configuration JSON file. User needs to upload the JSON file to OCI Object Storage bucket.

The location of the bucket object needs to be provided in TEST_CONFIG_LOCATION environment variable.

See also

How to configure ML Monitoring Test config file

RUNTIME PARAMETER

Action Types

In order to run the ML Monitoring Application, the user needs to define one Action Type corresponding to each run.

Currently, there are 3 Action Types supported in the ML Monitoring Application:

  1. RUN_CONFIG_VALIDATION

  2. RUN_BASELINE

  3. RUN_PREDICTION

DATE RANGE

The DATE_RANGE parameter will override the start and end filters of the ObjectStorageFileSearchDataSource and SaveMetricOutputAsJsonPostProcessor present in the application configuration.

"CONFIG_LOCATION": "<HTTP_LOCATION_OF_OCI_STORAGE_APPLICATION_CONFIG_FILE_PATH>"
"RUNTIME_PARAMETER": "{"ACTION_TYPE":"RUN_BASELINE", "DATE_RANGE":{"start":"2023-06-28", "end":"2023-06-29"}}"

For more information please refer here: DATE_RANGE

See also

RUN_BASELINE with DATE RANGE PARAMETER