save_byom() | Teradata Package for Python - save_byom() - Teradata Package for Python

The save_model() API allows a user to save externally trained models in Vantage in a specified table. This function allows users to save various models stored in different formats such as PMML, MOJO, and so on. If the specified model table exists in Vantage, model data is saved in that table. Otherwise, model table is created first based on the user parameters and then model data is saved.

Example Setup

• Import necessary modules.

  >>> import teradataml, os, datetime

  >>> # import save_byom from teradataml
  >>> from teradataml import save_byom

• Get the model file path to use in the examples.

  >>> model_file = os.path.join(os.path.dirname(teradataml.__file__), "data", "models", "iris_kmeans_model")

Example 1: Create a table with additional columns and column types specified

>>> save_byom("model1",
              model_file,
              "byom_models",
              additional_columns={"Description": "KMeans model",
                                  "UserId": "12345",
                                  "ProductionReady": False,
                                  "ModelEfficiency": 0.67412,
                                  "ModelSavedTime": datetime.datetime.now(),
                                  "ModelGeneratedDate":datetime.date.today(),
                                  "ModelGeneratedTime": datetime.time(hour=0,minute=5,second=45,microsecond=110)
                                  },
              additional_columns_types={"Description": VARCHAR(2000),
                                       "UserId": NUMBER(5),
                                       "ProductionReady": BYTEINT,
                                       "ModelEfficiency": NUMBER(11,10),
                                       "ModelSavedTime": TIMESTAMP,
                                       "ModelGeneratedDate": DATE,
                                       "ModelGeneratedTime": TIME}
              )
Created the table 'byom_models' as it does not exist.
Model is saved.

Example 2: Create a table with additional columns and column types not specified

This example creates a table "byom_model1" in the "test" database, with additional columns by not specifying the type of the columns. Once table is created, save the model in it.

>>> save_byom("model1",
              model_file,
              "byom_models1",
              additional_columns={"Description": "KMeans model",
                                  "UserId": "12346",
                                  "ProductionReady": False,
                                  "ModelEfficiency": 0.67412,
                                  "ModelSavedTime": datetime.datetime.now(),
                                  "ModelGeneratedDate":datetime.date.today(),
                                  "ModelGeneratedTime": datetime.time(hour=0,minute=5,second=45,microsecond=110)
                                  },
              schema_name="test"
              )
Created the table 'byom_models1' as it does not exist.
Model is saved.

Example 3: Save a model in an existing table

This example saves a model in the existing table "byom_models".

>>> save_byom("model2",
              model_file,
              "byom_models",
              additional_columns={"Description": "KMeans model duplicated"}
              )
Model is saved.

Example 4: Use the BYOM model catalog information set at session level by set_byom_catalog()

This example shows when save_byom() function is called without arguments table_name and schema_name, system uses the BYOM model catalog information set at session level by the set_byom_catalog() function.

• The model cataloging parameters are set using the set_byom_catalog() function.

  >>> set_byom_catalog(table_name='byom_models', schema_name='alice')
  
  The model cataloging parameters are set to table_name='byom_models' and schema_name='alice'

• The model is saved in the existing table specified by the arguments in set_byom_catalog() function.

  >>> save_byom('model3', model_file=model_file)
  Model is saved.

Example 5: Override session level parameters for BYOM model cataloging

This example shows that you can override the session level BYOM model catalog information set by the set_byom_catalog(), by passing the table as well as schema arguments explicitly.

• The model cataloging table name is set to 'byom_models' using the set_byom_catalog() function.

  >>> set_byom_catalog(table_name='byom_models', schema_name='alice')
  
  The model cataloging parameters are set to table_name='byom_models' and schema_name='alice'.

• The model is saved in a different table 'byom_licensed_models' which is specified by the table_name argument in this save_byom() function.

  >>> save_byom('licensed_model2', model_file=model_file, table_name='byom_licensed_models', additional_columns={"license_data": "A5sUL9KU_kP35Vq"})
  
  Created the model table 'byom_licensed_models' as it does not exist.
  Model is saved.