Teradata Package for Python Function Reference on VantageCloud Lake - load_filter - 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 on VantageCloud Lake

Deployment
VantageCloud
Edition
Lake
Product
Teradata Package for Python
Release Number
20.00.00.11
Published
August 2026
ft:locale
en-US
ft:lastEdition
2026-08-13
dita:id
TeradataPython_FxRef_Lake_2000
Product Category
Teradata Vantage
teradataml.store.feature_store.models.FilterManager.load_filter = load_filter(self, df, filter_id='filter_id')
DESCRIPTION:
    Loads the filter definitions from teradataml DataFrame into the filter manager.
 
PARAMETERS:
    df:
        Required Argument.
        Specifies the DataFrame containing filter definitions. 
        Each row represents one filter scenario.
        Types: teradataml DataFrame
        
    filter_id:
        Optional Argument.
        Specifies the name of the column that stores filter identifiers in the filter artifact.
        Default Value: 'filter_id'
        Types: str
        
RETURNS:
    bool: True if filters are loaded successfully.
    
RAISES:
    TeradataMLException
    
EXAMPLES:
    >>> load_example_data('dataframe', 'admissions_train')
    >>> df = DataFrame("admissions_train")
 
    # Create a FeatureStore.
    >>> from teradataml import FeatureStore, FilterManager
    >>> fs = FeatureStore(repo='vfs_v1', data_domain='sales')
    Repo vfs_v1 does not exist. Run FeatureStore.setup() to create the repo and setup FeatureStore.
    >>> fs.setup()
 
    # Example 1: Create a FilterManager for managing filters related to statistics features
    #            in the repository 'vfs_v1' with name 'stats_filter_manager' and load filter 
    #            definitions into it.
    # Create an instance of FilterManager
    >>> fm = FilterManager(repo='vfs_v1', name='stats_filter_manager')
    >>> fm
    Filter Manager 'stats_filter_manager' does not exist. Run FilterManager.load_filter() to create it.
    FilterManager(repo=vfs_v1, name=stats_filter_manager, filters=None)
 
    # Load filter definitions for statistics features into the filter manager using a DataFrame.
    >>> fm.load_filter(df=df.groupby('stats').count()[['stats']])
    True
 
    >>> fm
    FilterManager(repo=vfs_v1, name=stats_filter_manager, filters=3)