Skip to content

featurebyte.Feature.list_versions

list_versions(
*,
include_id: Optional[bool]=True,
feature_list_id: Optional[ObjectId]=None
) -> pd.DataFrame

Description

Returns a DataFrame that presents a summary of the feature versions belonging to the namespace of the Feature object. The DataFrame contains multiple attributes of the feature versions, such as their version names, readiness states, online availability, and creation dates.

Parameters

  • include_id: Optional[bool]
    default: True
    Whether to include id in the list.

  • feature_list_id: Optional[ObjectId]
    Feature list ID used to filter results and only include versions that are used in the specified feature list.

Returns

  • pd.DataFrame
    Table of features

Examples

List saved Feature versions

>>> Feature.list_versions()
    name        version  dtype readiness  online_enabled             table    entities              created_at
0  new_feat2  V230323  FLOAT     DRAFT           False      [sf_event_table]  [customer] 2023-03-23 07:16:21.244
1  new_feat1  V230323  FLOAT     DRAFT           False      [sf_event_table]  [customer] 2023-03-23 07:16:21.166
2     sum_1d  V230323  FLOAT     DRAFT           False      [sf_event_table]  [customer] 2023-03-23 07:16:21.009
List Feature versions with the same name

>>> feature = catalog.get_feature("InvoiceCount_60days")
>>> feature.list_versions()
        name  version  dtype readiness  online_enabled             table    entities              created_at
    0  sum_1d  V230323  FLOAT     DRAFT           False  [sf_event_table]  [customer] 2023-03-23 06:19:35.838