featurebyte.Feature.list_versions¶
list_versions(
*,
include_id: Optional[bool]=True,
feature_list_id: Optional[ObjectId]=None
) -> pd.DataFrameDescription¶
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(include_id=False)
name version dtype readiness online_enabled tables primary_tables entities primary_entities created_at is_default
0 CustomerLatestInvoiceTimestamp ... TIMESTAMP PRODUCTION_READY False [GROCERYINVOICE] [GROCERYINVOICE] [grocerycustomer] [grocerycustomer] ... True
1 InvoiceCount ... INT DRAFT False [GROCERYINVOICE, INVOICEITEMS] [INVOICEITEMS] [groceryinvoice] [groceryinvoice] ... True
2 ProductGroupLookup ... VARCHAR DRAFT False [GROCERYPRODUCT] [GROCERYPRODUCT] [groceryproduct] [groceryproduct] ... True
3 CustomerProductGroupTotalCost_7d ... OBJECT DRAFT False [GROCERYINVOICE, INVOICEITEMS, GROCERYPRODUCT] [INVOICEITEMS] [grocerycustomer] [grocerycustomer] ... True
4 CustomerProductGroupCounts_90d ... OBJECT DRAFT False [GROCERYINVOICE, INVOICEITEMS, GROCERYPRODUCT] [INVOICEITEMS] [grocerycustomer] [grocerycustomer] ... True
5 CustomerProductGroupCounts_7d ... OBJECT DRAFT False [GROCERYINVOICE, INVOICEITEMS, GROCERYPRODUCT] [INVOICEITEMS] [grocerycustomer] [grocerycustomer] ... True
6 InvoiceAmountAvg_60days ... FLOAT PRODUCTION_READY False [GROCERYINVOICE] [GROCERYINVOICE] [grocerycustomer] [grocerycustomer] ... True
7 InvoiceCount_60days ... FLOAT PRODUCTION_READY False [GROCERYINVOICE] [GROCERYINVOICE] [grocerycustomer] [grocerycustomer] ... True
>>> feature = catalog.get_feature("InvoiceCount_60days")
>>> feature.list_versions(include_id=False)
name version dtype readiness online_enabled tables primary_tables entities primary_entities created_at is_default
0 InvoiceCount_60days ... FLOAT PRODUCTION_READY False [GROCERYINVOICE] [GROCERYINVOICE] [grocerycustomer] [grocerycustomer] ... True