featurebyte.Catalog.list_feature_lists

list_feature_lists(

include_id: Union[bool, NoneType]=True,

primary_entity: Union[str, List[str], NoneType]=None,

entity: Union[str, NoneType]=None,

table: Union[str, NoneType]=None

) -> DataFrame

Description

Returns a DataFrame that contains various attributes of the registered feature lists. These attributes include the names of the feature lists, the number of features in each list, their status, whether they have been deployed in production, the percentage of production ready features of their default version, the tables used by the features, their related entities, and creation dates.

The resulting DataFrame can be filtered based on the primary entity of the feature lists or the tables utilized by the feature lists.

Parameters

• include_id: Union[bool, NoneType]
  default: True
  Whether to include id in the list.
  
  
• primary_entity: Union[str, List[str], NoneType]
  Name of entity used to filter results. If multiple entities are provided, the filtered results will contain feature lists that are associated with all the entities.
  
  
• entity: Union[str, NoneType]
  Name of entity used to filter results.
  
  
• table: Union[str, NoneType]
  Name of table used to filter results.
  
  

Returns

• DataFrame
  Table of feature lists.
  
  

Examples

>>> feature_lists = catalog.list_feature_lists()