Documentation Home
HeatWave User Guide
Related Documentation Download this Manual
PDF (US Ltr) - 2.1Mb
PDF (A4) - 2.1Mb


HeatWave User Guide  /  ...  /  The Model Catalog Table

3.14.1.1 The Model Catalog Table

MySQL 8.1.0 deprecates several columns, and replaces them with additional model_metadata. model_metadata supports HeatWave AutoML and ONNX models.

The MODEL_CATALOG table has the following columns:

  • model_id

    A primary key, and a unique auto-incrementing numeric identifier for the model.

  • model_handle

    A name for the model. The model handle must be unique in the model catalog. The model handle is generated or set by the user when the ML_TRAIN routine is executed on a training dataset. The generated model_handle format is schemaName_tableName_userName_No, as in the following example: heatwaveml_bench.census_train_user1_1636729526.

    Note

    The format of the generated model handle is subject to change.

  • model_object

    A string in JSON format containing the serialized HeatWave AutoML model.

    As of MySQL 9.0.0, models are stored in the model_object_catalog table, and the model_object is set to NULL.

  • model_owner

    The user who initiated the ML_TRAIN query to create the model.

  • build_timestamp

    A timestamp indicating when the model was created (in UNIX epoch time). A model is created when the ML_TRAIN routine finishes executing.

    MySQL 8.1.0 deprecates build_timestamp, and replaces it with build_timestamp in model_metadata. A future release will remove it.

  • target_column_name

    The name of the column in the training table that was specified as the target column.

    MySQL 8.1.0 deprecates target_column_name, and replaces it with target_column_name in model_metadata. A future release will remove it.

  • train_table_name

    The name of the input table specified in the ML_TRAIN query.

    MySQL 8.1.0 deprecates train_table_name, and replaces it with train_table_name in model_metadata. A future release will remove it.

  • model_object_size

    The model object size, in bytes.

  • model_type

    The type of model (algorithm) selected by ML_TRAIN to build the model.

    MySQL 8.1.0 deprecates model_type, because it is the same as algorithm_name in model_metadata. A future release will remove it.

  • task

    The task type specified in the ML_TRAIN query.

    MySQL 8.1.0 deprecates task, and replaces it with task in model_metadata. A future release will remove it.

  • column_names

    The feature columns used to train the model.

    MySQL 8.1.0 deprecates column_names, and replaces it with column_names in model_metadata. A future release will remove it.

  • model_explanation

    The model explanation generated during training. See Section 3.14.7, “Model Explanations”.

    MySQL 8.1.0 deprecates model_explanation, and replaces it with model_explanation in model_metadata. A future release will remove it.

  • last_accessed

    The last time the model was accessed. HeatWave AutoML routines update this value to the current timestamp when accessing the model.

    MySQL 8.1.0 deprecates last_accessed, because it is no longer used. A future release will remove it.

  • model_metadata

    Metadata for the model. If an error occurs during training or you cancel the training operation, HeatWave AutoML records the error status in this column. See Section 3.14.1.3, “Model Metadata”

  • notes

    Use this column to record notes about the trained model. It also records any error messages that occur during model training.

    MySQL 8.1.0 deprecates notes, and replaces it with notes in model_metadata. A future release will remove it.