CUSTOMER Consistency of Sum of invoice Amount 14d vs 28d

SDK code to create CUSTOMER_Consistency_of_Sum_of_invoice_Amount_14d_vs_28d¶

Feature description:

Consistency of the customer measured by the Ratio of the Sum of invoice Amount 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 GROCERYINVOICE event table.
groceryinvoice_view = catalog.get_view("GROCERYINVOICE")

# Get view from GROCERYINVOICE event table. groceryinvoice_view = catalog.get_view("GROCERYINVOICE")

Do window aggregation from GROCERYINVOICE¶

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 GROCERYINVOICE view by customer entity (GroceryCustomerGuid).
groceryinvoice_view_by_customer =\
groceryinvoice_view.groupby(['GroceryCustomerGuid'])

# Group GROCERYINVOICE view by customer entity (GroceryCustomerGuid). groceryinvoice_view_by_customer =\ groceryinvoice_view.groupby(['GroceryCustomerGuid'])

In [ ]:

# Get Sum of Amount for the customer over time.
feature_group =\
groceryinvoice_view_by_customer.aggregate_over(
    "Amount", method="sum",
    feature_names=[
        "CUSTOMER_Sum_of_invoice_Amount"
        + "_" + w for w in windows
    ],
    fill_value=0,
    windows=windows
)
# Get CUSTOMER_Sum_of_invoice_Amount_14d object from feature group.
customer_sum_of_invoice_amount_14d =\
feature_group["CUSTOMER_Sum_of_invoice_Amount_14d"]
# Get CUSTOMER_Sum_of_invoice_Amount_28d object from feature group.
customer_sum_of_invoice_amount_28d =\
feature_group["CUSTOMER_Sum_of_invoice_Amount_28d"]

# Get Sum of Amount for the customer over time. feature_group =\ groceryinvoice_view_by_customer.aggregate_over( "Amount", method="sum", feature_names=[ "CUSTOMER_Sum_of_invoice_Amount" + "_" + w for w in windows ], fill_value=0, windows=windows ) # Get CUSTOMER_Sum_of_invoice_Amount_14d object from feature group. customer_sum_of_invoice_amount_14d =\ feature_group["CUSTOMER_Sum_of_invoice_Amount_14d"] # Get CUSTOMER_Sum_of_invoice_Amount_28d object from feature group. customer_sum_of_invoice_amount_28d =\ feature_group["CUSTOMER_Sum_of_invoice_Amount_28d"]

In [ ]:

# Derive Consistency feature from Ratio of
# CUSTOMER_Sum_of_invoice_Amount_14d
# to CUSTOMER_Sum_of_invoice_Amount_28d
customer_consistency_of_sum_of_invoice_amount_14d_vs_28d = (
    customer_sum_of_invoice_amount_14d
     / customer_sum_of_invoice_amount_28d
)
# Give a name to new feature
customer_consistency_of_sum_of_invoice_amount_14d_vs_28d.name = \
"CUSTOMER_Consistency_of_Sum_of_invoice_Amount_14d_vs_28d"

# Derive Consistency feature from Ratio of # CUSTOMER_Sum_of_invoice_Amount_14d # to CUSTOMER_Sum_of_invoice_Amount_28d customer_consistency_of_sum_of_invoice_amount_14d_vs_28d = ( customer_sum_of_invoice_amount_14d / customer_sum_of_invoice_amount_28d ) # Give a name to new feature customer_consistency_of_sum_of_invoice_amount_14d_vs_28d.name = \ "CUSTOMER_Consistency_of_Sum_of_invoice_Amount_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'
customer_consistency_of_sum_of_invoice_amount_14d_vs_28d.primary_entity

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

#Preview CUSTOMER_Consistency_of_Sum_of_invoice_Amount_14d_vs_28d customer_consistency_of_sum_of_invoice_amount_14d_vs_28d.preview( preview_table )

Save feature¶

See SDK reference to save feature

In [ ]:

# Save feature
customer_consistency_of_sum_of_invoice_amount_14d_vs_28d.save()

# Save feature customer_consistency_of_sum_of_invoice_amount_14d_vs_28d.save()

Add description and see feature definition file¶

See SDK reference for the definition file of a feature

In [ ]:

# Add description
customer_consistency_of_sum_of_invoice_amount_14d_vs_28d.update_description(
	"Consistency of the customer measured by the Ratio of the Sum of "
	"invoice Amount for both the 14d and 28d periods"
)
# See feature definition file
customer_consistency_of_sum_of_invoice_amount_14d_vs_28d.definition

# Add description customer_consistency_of_sum_of_invoice_amount_14d_vs_28d.update_description( "Consistency of the customer measured by the Ratio of the Sum of " "invoice Amount for both the 14d and 28d periods" ) # See feature definition file customer_consistency_of_sum_of_invoice_amount_14d_vs_28d.definition