Teradata Package for Python Function Reference on VantageCloud Lake - prune_filters - 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.prune_filters = prune_filters(self, filter_id)
DESCRIPTION:
    Removes all filters with IDs lower than filter_id and reassigns
    sequential IDs starting from 1 to the remaining filters.
 
PARAMETERS:
    filter_id:
        Required Argument.
        Specifies the filter ID used as a threshold to prune filters.
        Notes:
            * The remaining filters with filter_id >= specified filter_id will be retained 
              and reassigned new filter_ids starting from 1.
            * The 'filter_id' must exist in the filter artifact's table.
        Types: int
 
RETURNS:
    bool: True if the filters are deleted 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, load filter definitions, and prune filters with filter_id < 2.
    # Create an instance of FilterManager and load filter definitions.
    >>> fm = FilterManager(repo='vfs_v1', name='stats_filter_manager')
    Filter Manager 'stats_filter_manager' does not exist. Run FilterManager.load_filter() to create it.
    >>> fm.load_filter(df=df.groupby('stats').count()[['stats']])
    True
    >>> fm.list_filters()
                  stats
    filter_id          
    3            Novice
    2          Beginner
    1          Advanced
 
    # Prune filters with filter_id < 2, keeping only filters with filter_id >= 2.
    >>> fm.prune_filters(2)
    True
    >>> fm.list_filters()
                  stats
    filter_id          
    2            Novice
    1          Beginner