PRODUCT Variability of customer State based on item TotalCost 28d

SDK code to create PRODUCT_Variability_of_customer_State_based_on_item_TotalCost_28d¶

Feature description:

The feature evaluates the distribution of a product's item's TotalCost across various customer's State categories over a 28d period using entropy. Higher entropy signifies a more uniform distribution of item's TotalCost across categories, while lower entropy suggests a concentration within specific customer's State categories.

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 INVOICEITEMS item table.
invoiceitems_view = catalog.get_view("INVOICEITEMS")

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

In [ ]:

# Get view from GROCERYCUSTOMER scd table.
grocerycustomer_view = catalog.get_view("GROCERYCUSTOMER")

# Get view from GROCERYCUSTOMER scd table. grocerycustomer_view = catalog.get_view("GROCERYCUSTOMER")

Join views¶

See SDK reference for views

In [ ]:

# Join GROCERYCUSTOMER view to INVOICEITEMS view.
invoiceitems_view = invoiceitems_view.join(grocerycustomer_view, rsuffix="")

# Join GROCERYCUSTOMER view to INVOICEITEMS view. invoiceitems_view = invoiceitems_view.join(grocerycustomer_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) across different States.
invoiceitems_view_by_product_across_state =\
invoiceitems_view.groupby(
    ['GroceryProductGuid'], category="State"
)

# Group INVOICEITEMS view by product entity (GroceryProductGuid) across different States. invoiceitems_view_by_product_across_state =\ invoiceitems_view.groupby( ['GroceryProductGuid'], category="State" )

In [ ]:

# Distribution representing the cumulative TotalCost of item, categorized by their respective
# customer's State, for the product over time.
feature_group =\
invoiceitems_view_by_product_across_state.aggregate_over(
    "TotalCost", method=fb.AggFunc.SUM,
    feature_names=[
        "PRODUCT_item_TotalCost_across_customer_States"
        + "_" + w for w in windows
    ],
    windows=windows
)
# Get PRODUCT_item_TotalCost_across_customer_States_28d object from feature group.
product_item_totalcost_across_customer_states_28d =\
feature_group["PRODUCT_item_TotalCost_across_customer_States_28d"]

# Distribution representing the cumulative TotalCost of item, categorized by their respective # customer's State, for the product over time. feature_group =\ invoiceitems_view_by_product_across_state.aggregate_over( "TotalCost", method=fb.AggFunc.SUM, feature_names=[ "PRODUCT_item_TotalCost_across_customer_States" + "_" + w for w in windows ], windows=windows ) # Get PRODUCT_item_TotalCost_across_customer_States_28d object from feature group. product_item_totalcost_across_customer_states_28d =\ feature_group["PRODUCT_item_TotalCost_across_customer_States_28d"]

Derive feature from aggregation across categories¶

See list of feature transforms

In [ ]:

# Get Variability of customer State based on item TotalCost from
# PRODUCT_item_TotalCost_across_customer_States_28d
product_variability_of_customer_state_based_on_item_totalcost_28d =\
product_item_totalcost_across_customer_states_28d.cd.entropy()
# Give a name to new feature
product_variability_of_customer_state_based_on_item_totalcost_28d.name = \
"PRODUCT_Variability_of_customer_State_based_on_item_TotalCost_28d"

# Get Variability of customer State based on item TotalCost from # PRODUCT_item_TotalCost_across_customer_States_28d product_variability_of_customer_state_based_on_item_totalcost_28d =\ product_item_totalcost_across_customer_states_28d.cd.entropy() # Give a name to new feature product_variability_of_customer_state_based_on_item_totalcost_28d.name = \ "PRODUCT_Variability_of_customer_State_based_on_item_TotalCost_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_variability_of_customer_state_based_on_item_totalcost_28d.primary_entity

#Check the primary entity of the feature' product_variability_of_customer_state_based_on_item_totalcost_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_Variability_of_customer_State_based_on_item_TotalCost_28d
product_variability_of_customer_state_based_on_item_totalcost_28d.preview(
	preview_table
)

#Preview PRODUCT_Variability_of_customer_State_based_on_item_TotalCost_28d product_variability_of_customer_state_based_on_item_totalcost_28d.preview( preview_table )

Save feature¶

See SDK reference to save feature

In [ ]:

# Save feature
product_variability_of_customer_state_based_on_item_totalcost_28d.save()

# Save feature product_variability_of_customer_state_based_on_item_totalcost_28d.save()

Add description and see feature definition file¶

See SDK reference for the definition file of a feature

In [ ]:

# Add description
product_variability_of_customer_state_based_on_item_totalcost_28d.update_description(
	"The feature evaluates the distribution of a product's item's TotalCost"
	" across various customer's State categories over a 28d period using "
	"entropy. Higher entropy signifies a more uniform distribution of "
	"item's TotalCost across categories, while lower entropy suggests a "
	"concentration within specific customer's State categories."
)
# See feature definition file
product_variability_of_customer_state_based_on_item_totalcost_28d.definition

# Add description product_variability_of_customer_state_based_on_item_totalcost_28d.update_description( "The feature evaluates the distribution of a product's item's TotalCost" " across various customer's State categories over a 28d period using " "entropy. Higher entropy signifies a more uniform distribution of " "item's TotalCost across categories, while lower entropy suggests a " "concentration within specific customer's State categories." ) # See feature definition file product_variability_of_customer_state_based_on_item_totalcost_28d.definition