PRODUCT vs PRODUCTGROUP Avg of item Quantity 28d

SDK code to create PRODUCT_vs_PRODUCTGROUP_Avg_of_item_Quantity_28d¶

Feature description:

Similarity between the product and all products of the product productgroup measured by the Ratio of the Avg of item Quantity over 28d for both entities.

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 = ['28d']

windows = ['28d']

Get view from table¶

See SDK reference for views

In [ ]:

# Get view from GROCERYPRODUCT dimension table.
groceryproduct_view = catalog.get_view("GROCERYPRODUCT")

# Get view from GROCERYPRODUCT dimension table. groceryproduct_view = catalog.get_view("GROCERYPRODUCT")

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")

In [ ]:

# Join GROCERYPRODUCT view to INVOICEITEMS view.
invoiceitems_view = invoiceitems_view.join(groceryproduct_view, rsuffix="")

# Join GROCERYPRODUCT view to INVOICEITEMS view. invoiceitems_view = invoiceitems_view.join(groceryproduct_view, rsuffix="")

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 Avg of Quantity for the product over time.
feature_group =\
invoiceitems_view_by_product.aggregate_over(
    "Quantity", method="avg",
    feature_names=[
        "PRODUCT_Avg_of_item_Quantity"
        + "_" + w for w in windows
    ],
    windows=windows
)
# Get PRODUCT_Avg_of_item_Quantity_28d object from feature group.
product_avg_of_item_quantity_28d =\
feature_group["PRODUCT_Avg_of_item_Quantity_28d"]

# Get Avg of Quantity for the product over time. feature_group =\ invoiceitems_view_by_product.aggregate_over( "Quantity", method="avg", feature_names=[ "PRODUCT_Avg_of_item_Quantity" + "_" + w for w in windows ], windows=windows ) # Get PRODUCT_Avg_of_item_Quantity_28d object from feature group. product_avg_of_item_quantity_28d =\ feature_group["PRODUCT_Avg_of_item_Quantity_28d"]

In [ ]:

# Group INVOICEITEMS view by productgroup entity (ProductGroup).
invoiceitems_view_by_productgroup =\
invoiceitems_view.groupby(['ProductGroup'])

# Group INVOICEITEMS view by productgroup entity (ProductGroup). invoiceitems_view_by_productgroup =\ invoiceitems_view.groupby(['ProductGroup'])

In [ ]:

# Get Avg of Quantity for the productgroup over time.
feature_group =\
invoiceitems_view_by_productgroup.aggregate_over(
    "Quantity", method="avg",
    feature_names=[
        "PRODUCTGROUP_Avg_of_item_Quantity"
        + "_" + w for w in windows
    ],
    windows=windows
)
# Get PRODUCTGROUP_Avg_of_item_Quantity_28d object from feature group.
productgroup_avg_of_item_quantity_28d =\
feature_group["PRODUCTGROUP_Avg_of_item_Quantity_28d"]

# Get Avg of Quantity for the productgroup over time. feature_group =\ invoiceitems_view_by_productgroup.aggregate_over( "Quantity", method="avg", feature_names=[ "PRODUCTGROUP_Avg_of_item_Quantity" + "_" + w for w in windows ], windows=windows ) # Get PRODUCTGROUP_Avg_of_item_Quantity_28d object from feature group. productgroup_avg_of_item_quantity_28d =\ feature_group["PRODUCTGROUP_Avg_of_item_Quantity_28d"]

Derive Similarity feature across entities¶

See list of feature transforms

In [ ]:

# Derive Similarity feature from Ratio of
# PRODUCT_Avg_of_item_Quantity_28d
# to PRODUCTGROUP_Avg_of_item_Quantity_28d
product_vs_productgroup_avg_of_item_quantity_28d = (
    product_avg_of_item_quantity_28d
    / productgroup_avg_of_item_quantity_28d
)
# Give a name to new feature
product_vs_productgroup_avg_of_item_quantity_28d.name = \
"PRODUCT_vs_PRODUCTGROUP_Avg_of_item_Quantity_28d"

# Derive Similarity feature from Ratio of # PRODUCT_Avg_of_item_Quantity_28d # to PRODUCTGROUP_Avg_of_item_Quantity_28d product_vs_productgroup_avg_of_item_quantity_28d = ( product_avg_of_item_quantity_28d / productgroup_avg_of_item_quantity_28d ) # Give a name to new feature product_vs_productgroup_avg_of_item_quantity_28d.name = \ "PRODUCT_vs_PRODUCTGROUP_Avg_of_item_Quantity_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_vs_productgroup_avg_of_item_quantity_28d.primary_entity

#Check the primary entity of the feature' product_vs_productgroup_avg_of_item_quantity_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_vs_PRODUCTGROUP_Avg_of_item_Quantity_28d
product_vs_productgroup_avg_of_item_quantity_28d.preview(
	preview_table
)

#Preview PRODUCT_vs_PRODUCTGROUP_Avg_of_item_Quantity_28d product_vs_productgroup_avg_of_item_quantity_28d.preview( preview_table )

Save feature¶

See SDK reference to save feature

In [ ]:

# Save feature
product_vs_productgroup_avg_of_item_quantity_28d.save()

# Save feature product_vs_productgroup_avg_of_item_quantity_28d.save()

Add description and see feature definition file¶

See SDK reference for the definition file of a feature

In [ ]:

# Add description
product_vs_productgroup_avg_of_item_quantity_28d.update_description(
	"Similarity between the product and all products of the product "
	"productgroup measured by the Ratio of the Avg of item Quantity over "
	"28d for both entities."
)
# See feature definition file
product_vs_productgroup_avg_of_item_quantity_28d.definition

# Add description product_vs_productgroup_avg_of_item_quantity_28d.update_description( "Similarity between the product and all products of the product " "productgroup measured by the Ratio of the Avg of item Quantity over " "28d for both entities." ) # See feature definition file product_vs_productgroup_avg_of_item_quantity_28d.definition