Teradata Package for Python Function Reference | 17.10 - set_byom_catalog - Teradata Package for Python - Look here for syntax, methods and examples for the functions included in the Teradata Package for Python.

Teradata® Package for Python Function Reference

Product
Teradata Package for Python
Release Number
17.10
Published
April 2022
Language
English (United States)
Last Update
2022-08-19
lifecycle
previous
Product Category
Teradata Vantage
teradataml.catalog.byom.set_byom_catalog = set_byom_catalog(table_name, schema_name=None)
DESCRIPTION:
    Function to set the BYOM model catalog information to be used by
    BYOM model cataloging APIs such as:
        * delete_byom
        * list_byom
        * retrieve_byom
        * save_byom
        * set_license
 
PARAMETERS:
    table_name:
        Required Argument.
        Specifies the name of the table to be used for BYOM model cataloging.
        This table will be used for saving, retrieving BYOM model information
        by BYOM model cataloging APIs.
        Types: str.
 
    schema_name:
        Optional Argument.
        Specifies the name of the schema/database in which the table specified in
        "table_name" is looked up. If not specified, then table is looked
        up in current schema/database.
        Types: str
 
RETURNS:
    None
 
RAISES:
    TeradataMlException
 
EXAMPLES:
    >>> from teradataml import set_byom_catalog
 
    # Example 1 - Set global parameters table_name = 'model_table_name' and schema_name = 'model_schema_name';
    >>> set_byom_catalog(table_name='model_table_name', schema_name='model_schema_name')
    The model cataloging parameters are set to table_name='model_table_name' and schema_name='model_schema_name'