PRODUCT Consistency of Sum of item Quantity 14d vs 28d

SDK code to create PRODUCT_Consistency_of_Sum_of_item_Quantity_14d_vs_28d¶

Feature description:

Consistency of the product measured by the Ratio of the Sum of item Quantity for both the 14d and 28d periods

In [ ]:

import featurebyte as fb
fb.use_profile("tutorial")

import featurebyte as fb fb.use_profile("tutorial")

Activate catalog¶

See SDK reference for catalogs

In [ ]:

catalog = fb.Catalog.activate("Grocery Dataset Tutorial")

catalog = fb.Catalog.activate("Grocery Dataset Tutorial")

Set windows for aggregation¶

In [ ]:

windows = ['14d', '28d']

windows = ['14d', '28d']

Get view from table¶

See SDK reference for views

In [ ]:

# Get view from INVOICEITEMS item table.
invoiceitems_view = catalog.get_view("INVOICEITEMS")

# Get view from INVOICEITEMS item table. invoiceitems_view = catalog.get_view("INVOICEITEMS")

Do window aggregation from INVOICEITEMS¶

See SDK reference for features

See SDK reference to groupby a view

See SDK reference to do aggregation over time

See SDK reference for feature group

See list of aggregation operations

In [ ]:

# Group INVOICEITEMS view by product entity (GroceryProductGuid).
invoiceitems_view_by_product =\
invoiceitems_view.groupby(['GroceryProductGuid'])

# Group INVOICEITEMS view by product entity (GroceryProductGuid). invoiceitems_view_by_product =\ invoiceitems_view.groupby(['GroceryProductGuid'])

In [ ]:

# Get Sum of Quantity for the product over time.
feature_group =\
invoiceitems_view_by_product.aggregate_over(
    "Quantity", method="sum",
    feature_names=[
        "PRODUCT_Sum_of_item_Quantity"
        + "_" + w for w in windows
    ],
    windows=windows
)
# Get PRODUCT_Sum_of_item_Quantity_14d object from feature group.
product_sum_of_item_quantity_14d =\
feature_group["PRODUCT_Sum_of_item_Quantity_14d"]
# Get PRODUCT_Sum_of_item_Quantity_28d object from feature group.
product_sum_of_item_quantity_28d =\
feature_group["PRODUCT_Sum_of_item_Quantity_28d"]

# Get Sum of Quantity for the product over time. feature_group =\ invoiceitems_view_by_product.aggregate_over( "Quantity", method="sum", feature_names=[ "PRODUCT_Sum_of_item_Quantity" + "_" + w for w in windows ], windows=windows ) # Get PRODUCT_Sum_of_item_Quantity_14d object from feature group. product_sum_of_item_quantity_14d =\ feature_group["PRODUCT_Sum_of_item_Quantity_14d"] # Get PRODUCT_Sum_of_item_Quantity_28d object from feature group. product_sum_of_item_quantity_28d =\ feature_group["PRODUCT_Sum_of_item_Quantity_28d"]

In [ ]:

# Derive Consistency feature from Ratio of
# PRODUCT_Sum_of_item_Quantity_14d
# to PRODUCT_Sum_of_item_Quantity_28d
product_consistency_of_sum_of_item_quantity_14d_vs_28d = (
    product_sum_of_item_quantity_14d
     / product_sum_of_item_quantity_28d
)
# Give a name to new feature
product_consistency_of_sum_of_item_quantity_14d_vs_28d.name = \
"PRODUCT_Consistency_of_Sum_of_item_Quantity_14d_vs_28d"

# Derive Consistency feature from Ratio of # PRODUCT_Sum_of_item_Quantity_14d # to PRODUCT_Sum_of_item_Quantity_28d product_consistency_of_sum_of_item_quantity_14d_vs_28d = ( product_sum_of_item_quantity_14d / product_sum_of_item_quantity_28d ) # Give a name to new feature product_consistency_of_sum_of_item_quantity_14d_vs_28d.name = \ "PRODUCT_Consistency_of_Sum_of_item_Quantity_14d_vs_28d"

Preview feature¶

Read on the feature primary entity concept

Read on the serving entity concept

See SDK reference for observation table

See SDK reference to preview feature

In [ ]:

#Check the primary entity of the feature'
product_consistency_of_sum_of_item_quantity_14d_vs_28d.primary_entity

#Check the primary entity of the feature' product_consistency_of_sum_of_item_quantity_14d_vs_28d.primary_entity

In [ ]:

#Get observation table: 'Preview Table with 10 items'
preview_table = catalog.get_observation_table(
	"Preview Table with 10 items"
)

#Get observation table: 'Preview Table with 10 items' preview_table = catalog.get_observation_table( "Preview Table with 10 items" )

In [ ]:

#Preview PRODUCT_Consistency_of_Sum_of_item_Quantity_14d_vs_28d
product_consistency_of_sum_of_item_quantity_14d_vs_28d.preview(
	preview_table
)

#Preview PRODUCT_Consistency_of_Sum_of_item_Quantity_14d_vs_28d product_consistency_of_sum_of_item_quantity_14d_vs_28d.preview( preview_table )

Save feature¶

See SDK reference to save feature

In [ ]:

# Save feature
product_consistency_of_sum_of_item_quantity_14d_vs_28d.save()

# Save feature product_consistency_of_sum_of_item_quantity_14d_vs_28d.save()

Add description and see feature definition file¶

See SDK reference for the definition file of a feature

In [ ]:

# Add description
product_consistency_of_sum_of_item_quantity_14d_vs_28d.update_description(
	"Consistency of the product measured by the Ratio of the Sum of item "
	"Quantity for both the 14d and 28d periods"
)
# See feature definition file
product_consistency_of_sum_of_item_quantity_14d_vs_28d.definition

# Add description product_consistency_of_sum_of_item_quantity_14d_vs_28d.update_description( "Consistency of the product measured by the Ratio of the Sum of item " "Quantity for both the 14d and 28d periods" ) # See feature definition file product_consistency_of_sum_of_item_quantity_14d_vs_28d.definition