ITEM Quantity Z Score to PRODUCTGROUP item Quantity 14d

SDK code to create ITEM_Quantity_Z_Score_to_PRODUCTGROUP_item_Quantity_14d¶

Feature description:

Z-Score of the item Quantity in relation to the distribution of item Quantity among all items with the same productgroup as that item over a 14d period.

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']

windows = ['14d']

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

Create Lookup feature¶

See SDK reference for features

See SDK reference to declare a lookup feature

In [ ]:

# Create lookup feature from Quantity column for item entity.
item_quantity =\
invoiceitems_view["Quantity"].as_feature("ITEM_Quantity")

# Create lookup feature from Quantity column for item entity. item_quantity =\ invoiceitems_view["Quantity"].as_feature("ITEM_Quantity")

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 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_14d object from feature group.
productgroup_avg_of_item_quantity_14d =\
feature_group["PRODUCTGROUP_Avg_of_item_Quantity_14d"]

# 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_14d object from feature group. productgroup_avg_of_item_quantity_14d =\ feature_group["PRODUCTGROUP_Avg_of_item_Quantity_14d"]

In [ ]:

# Get Std of Quantity for the productgroup over time.
feature_group =\
invoiceitems_view_by_productgroup.aggregate_over(
    "Quantity", method="std",
    feature_names=[
        "PRODUCTGROUP_Std_of_item_Quantity"
        + "_" + w for w in windows
    ],
    windows=windows
)
# Get PRODUCTGROUP_Std_of_item_Quantity_14d object from feature group.
productgroup_std_of_item_quantity_14d =\
feature_group["PRODUCTGROUP_Std_of_item_Quantity_14d"]

# Get Std of Quantity for the productgroup over time. feature_group =\ invoiceitems_view_by_productgroup.aggregate_over( "Quantity", method="std", feature_names=[ "PRODUCTGROUP_Std_of_item_Quantity" + "_" + w for w in windows ], windows=windows ) # Get PRODUCTGROUP_Std_of_item_Quantity_14d object from feature group. productgroup_std_of_item_quantity_14d =\ feature_group["PRODUCTGROUP_Std_of_item_Quantity_14d"]

Compare lookup with aggregation¶

See list of feature transforms

In [ ]:

# Get the Z-Score of the item Quantity in relation to the distribution of item Quantity among all
# items with the same productgroup as that item over a 14d period.
item_quantity_z_score_to_productgroup_item_quantity_14d = (
    item_quantity
    - productgroup_avg_of_item_quantity_14d
) / productgroup_std_of_item_quantity_14d
# Give a name to new feature
item_quantity_z_score_to_productgroup_item_quantity_14d.name = \
"ITEM_Quantity_Z_Score_to_PRODUCTGROUP_item_Quantity_14d"

# Get the Z-Score of the item Quantity in relation to the distribution of item Quantity among all # items with the same productgroup as that item over a 14d period. item_quantity_z_score_to_productgroup_item_quantity_14d = ( item_quantity - productgroup_avg_of_item_quantity_14d ) / productgroup_std_of_item_quantity_14d # Give a name to new feature item_quantity_z_score_to_productgroup_item_quantity_14d.name = \ "ITEM_Quantity_Z_Score_to_PRODUCTGROUP_item_Quantity_14d"

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'
item_quantity_z_score_to_productgroup_item_quantity_14d.primary_entity

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

#Preview ITEM_Quantity_Z_Score_to_PRODUCTGROUP_item_Quantity_14d item_quantity_z_score_to_productgroup_item_quantity_14d.preview( preview_table )

Save feature¶

See SDK reference to save feature

In [ ]:

# Save feature
item_quantity_z_score_to_productgroup_item_quantity_14d.save()

# Save feature item_quantity_z_score_to_productgroup_item_quantity_14d.save()

Add description and see feature definition file¶

See SDK reference for the definition file of a feature

In [ ]:

# Add description
item_quantity_z_score_to_productgroup_item_quantity_14d.update_description(
	"Z-Score of the item Quantity in relation to the distribution of item "
	"Quantity among all items with the same productgroup as that item over "
	"a 14d period."
)
# See feature definition file
item_quantity_z_score_to_productgroup_item_quantity_14d.definition

# Add description item_quantity_z_score_to_productgroup_item_quantity_14d.update_description( "Z-Score of the item Quantity in relation to the distribution of item " "Quantity among all items with the same productgroup as that item over " "a 14d period." ) # See feature definition file item_quantity_z_score_to_productgroup_item_quantity_14d.definition