PRODUCT vs PRODUCTGROUP item TotalCost across invoice Weekdays 28d

SDK code to create PRODUCT_vs_PRODUCTGROUP_item_TotalCost_across_invoice_Weekdays_28d¶

Feature description:

Similarity between the product and all products of the product productgroup measured by the Cosine Similarity between the Distribution representing the cumulative TotalCost of item, categorized by their respective invoice's Weekday, 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="")

Extract Date parts¶

See SDK reference for view columns

See list of datetime transforms

In [ ]:

# Extract day_of_week date part from Timestamp column for INVOICEITEMS view.
invoiceitems_view["Weekday of invoice"] = invoiceitems_view["Timestamp"].dt.day_of_week

# Extract day_of_week date part from Timestamp column for INVOICEITEMS view. invoiceitems_view["Weekday of invoice"] = invoiceitems_view["Timestamp"].dt.day_of_week

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) across different Weekday of
# invoices.
invoiceitems_view_by_product_across_weekday_of_invoice =\
invoiceitems_view.groupby(
    ['GroceryProductGuid'], category="Weekday of invoice"
)

# Group INVOICEITEMS view by product entity (GroceryProductGuid) across different Weekday of # invoices. invoiceitems_view_by_product_across_weekday_of_invoice =\ invoiceitems_view.groupby( ['GroceryProductGuid'], category="Weekday of invoice" )

In [ ]:

# Distribution representing the cumulative TotalCost of item, categorized by their respective
# invoice's Weekday, for the product over time.
feature_group =\
invoiceitems_view_by_product_across_weekday_of_invoice.aggregate_over(
    "TotalCost", method=fb.AggFunc.SUM,
    feature_names=[
        "PRODUCT_item_TotalCost_across_invoice_Weekdays"
        + "_" + w for w in windows
    ],
    windows=windows
)
# Get PRODUCT_item_TotalCost_across_invoice_Weekdays_28d object from feature group.
product_item_totalcost_across_invoice_weekdays_28d =\
feature_group["PRODUCT_item_TotalCost_across_invoice_Weekdays_28d"]

# Distribution representing the cumulative TotalCost of item, categorized by their respective # invoice's Weekday, for the product over time. feature_group =\ invoiceitems_view_by_product_across_weekday_of_invoice.aggregate_over( "TotalCost", method=fb.AggFunc.SUM, feature_names=[ "PRODUCT_item_TotalCost_across_invoice_Weekdays" + "_" + w for w in windows ], windows=windows ) # Get PRODUCT_item_TotalCost_across_invoice_Weekdays_28d object from feature group. product_item_totalcost_across_invoice_weekdays_28d =\ feature_group["PRODUCT_item_TotalCost_across_invoice_Weekdays_28d"]

In [ ]:

# Group INVOICEITEMS view by productgroup entity (ProductGroup) across different Weekday of
# invoices.
invoiceitems_view_by_productgroup_across_weekday_of_invoice =\
invoiceitems_view.groupby(
    ['ProductGroup'], category="Weekday of invoice"
)

# Group INVOICEITEMS view by productgroup entity (ProductGroup) across different Weekday of # invoices. invoiceitems_view_by_productgroup_across_weekday_of_invoice =\ invoiceitems_view.groupby( ['ProductGroup'], category="Weekday of invoice" )

In [ ]:

# Distribution representing the cumulative TotalCost of item, categorized by their respective
# invoice's Weekday, for the productgroup over time.
feature_group =\
invoiceitems_view_by_productgroup_across_weekday_of_invoice.aggregate_over(
    "TotalCost", method=fb.AggFunc.SUM,
    feature_names=[
        "PRODUCTGROUP_item_TotalCost_across_invoice_Weekdays"
        + "_" + w for w in windows
    ],
    windows=windows
)
# Get PRODUCTGROUP_item_TotalCost_across_invoice_Weekdays_28d object from feature group.
productgroup_item_totalcost_across_invoice_weekdays_28d =\
feature_group["PRODUCTGROUP_item_TotalCost_across_invoice_Weekdays_28d"]

# Distribution representing the cumulative TotalCost of item, categorized by their respective # invoice's Weekday, for the productgroup over time. feature_group =\ invoiceitems_view_by_productgroup_across_weekday_of_invoice.aggregate_over( "TotalCost", method=fb.AggFunc.SUM, feature_names=[ "PRODUCTGROUP_item_TotalCost_across_invoice_Weekdays" + "_" + w for w in windows ], windows=windows ) # Get PRODUCTGROUP_item_TotalCost_across_invoice_Weekdays_28d object from feature group. productgroup_item_totalcost_across_invoice_weekdays_28d =\ feature_group["PRODUCTGROUP_item_TotalCost_across_invoice_Weekdays_28d"]

Derive Similarity feature across entities¶

See list of feature transforms

In [ ]:

# Derive Similarity feature from cosine similarity between
# PRODUCT_item_TotalCost_across_invoice_Weekdays_28d
# and PRODUCTGROUP_item_TotalCost_across_invoice_Weekdays_28d
product_vs_productgroup_item_totalcost_across_invoice_weekdays_28d =\
product_item_totalcost_across_invoice_weekdays_28d.cd.cosine_similarity(
        productgroup_item_totalcost_across_invoice_weekdays_28d
    )
# Give a name to new feature
product_vs_productgroup_item_totalcost_across_invoice_weekdays_28d.name = \
"PRODUCT_vs_PRODUCTGROUP_item_TotalCost_across_invoice_Weekdays_28d"

# Derive Similarity feature from cosine similarity between # PRODUCT_item_TotalCost_across_invoice_Weekdays_28d # and PRODUCTGROUP_item_TotalCost_across_invoice_Weekdays_28d product_vs_productgroup_item_totalcost_across_invoice_weekdays_28d =\ product_item_totalcost_across_invoice_weekdays_28d.cd.cosine_similarity( productgroup_item_totalcost_across_invoice_weekdays_28d ) # Give a name to new feature product_vs_productgroup_item_totalcost_across_invoice_weekdays_28d.name = \ "PRODUCT_vs_PRODUCTGROUP_item_TotalCost_across_invoice_Weekdays_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_item_totalcost_across_invoice_weekdays_28d.primary_entity

#Check the primary entity of the feature' product_vs_productgroup_item_totalcost_across_invoice_weekdays_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_item_TotalCost_across_invoice_Weekdays_28d
product_vs_productgroup_item_totalcost_across_invoice_weekdays_28d.preview(
	preview_table
)

#Preview PRODUCT_vs_PRODUCTGROUP_item_TotalCost_across_invoice_Weekdays_28d product_vs_productgroup_item_totalcost_across_invoice_weekdays_28d.preview( preview_table )

Save feature¶

See SDK reference to save feature

In [ ]:

# Save feature
product_vs_productgroup_item_totalcost_across_invoice_weekdays_28d.save()

# Save feature product_vs_productgroup_item_totalcost_across_invoice_weekdays_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_item_totalcost_across_invoice_weekdays_28d.update_description(
	"Similarity between the product and all products of the product "
	"productgroup measured by the Cosine Similarity between the "
	"Distribution representing the cumulative TotalCost of item, "
	"categorized by their respective invoice's Weekday, over 28d for both "
	"entities."
)
# See feature definition file
product_vs_productgroup_item_totalcost_across_invoice_weekdays_28d.definition

# Add description product_vs_productgroup_item_totalcost_across_invoice_weekdays_28d.update_description( "Similarity between the product and all products of the product " "productgroup measured by the Cosine Similarity between the " "Distribution representing the cumulative TotalCost of item, " "categorized by their respective invoice's Weekday, over 28d for both " "entities." ) # See feature definition file product_vs_productgroup_item_totalcost_across_invoice_weekdays_28d.definition