INVOICE Amount Z Score to CUSTOMER invoice Amount 14d
SDK code to create INVOICE_Amount_Z_Score_to_CUSTOMER_invoice_Amount_14d¶
Feature description:
Z-Score of the invoice Amount in relation to the distribution of invoice Amount among all invoices with the same customer as that invoice over a 14d period.
In [ ]:
Copied!
import featurebyte as fb
fb.use_profile("tutorial")
import featurebyte as fb
fb.use_profile("tutorial")
Activate catalog¶
In [ ]:
Copied!
catalog = fb.Catalog.activate("Grocery Dataset Tutorial")
catalog = fb.Catalog.activate("Grocery Dataset Tutorial")
Set windows for aggregation¶
In [ ]:
Copied!
windows = ['14d']
windows = ['14d']
Get view from table¶
In [ ]:
Copied!
# Get view from GROCERYINVOICE event table.
groceryinvoice_view = catalog.get_view("GROCERYINVOICE")
# Get view from GROCERYINVOICE event table.
groceryinvoice_view = catalog.get_view("GROCERYINVOICE")
In [ ]:
Copied!
# Create lookup feature from Amount column for invoice entity.
invoice_amount =\
groceryinvoice_view["Amount"].as_feature("INVOICE_Amount")
# Create lookup feature from Amount column for invoice entity.
invoice_amount =\
groceryinvoice_view["Amount"].as_feature("INVOICE_Amount")
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
In [ ]:
Copied!
# 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 [ ]:
Copied!
# Get Avg of Amount for the customer over time.
feature_group =\
groceryinvoice_view_by_customer.aggregate_over(
"Amount", method="avg",
feature_names=[
"CUSTOMER_Avg_of_invoice_Amount"
+ "_" + w for w in windows
],
windows=windows
)
# Get CUSTOMER_Avg_of_invoice_Amount_14d object from feature group.
customer_avg_of_invoice_amount_14d =\
feature_group["CUSTOMER_Avg_of_invoice_Amount_14d"]
# Get Avg of Amount for the customer over time.
feature_group =\
groceryinvoice_view_by_customer.aggregate_over(
"Amount", method="avg",
feature_names=[
"CUSTOMER_Avg_of_invoice_Amount"
+ "_" + w for w in windows
],
windows=windows
)
# Get CUSTOMER_Avg_of_invoice_Amount_14d object from feature group.
customer_avg_of_invoice_amount_14d =\
feature_group["CUSTOMER_Avg_of_invoice_Amount_14d"]
In [ ]:
Copied!
# Get Std of Amount for the customer over time.
feature_group =\
groceryinvoice_view_by_customer.aggregate_over(
"Amount", method="std",
feature_names=[
"CUSTOMER_Std_of_invoice_Amount"
+ "_" + w for w in windows
],
windows=windows
)
# Get CUSTOMER_Std_of_invoice_Amount_14d object from feature group.
customer_std_of_invoice_amount_14d =\
feature_group["CUSTOMER_Std_of_invoice_Amount_14d"]
# Get Std of Amount for the customer over time.
feature_group =\
groceryinvoice_view_by_customer.aggregate_over(
"Amount", method="std",
feature_names=[
"CUSTOMER_Std_of_invoice_Amount"
+ "_" + w for w in windows
],
windows=windows
)
# Get CUSTOMER_Std_of_invoice_Amount_14d object from feature group.
customer_std_of_invoice_amount_14d =\
feature_group["CUSTOMER_Std_of_invoice_Amount_14d"]
Compare lookup with aggregation¶
In [ ]:
Copied!
# Get the Z-Score of the invoice Amount in relation to the distribution of invoice Amount among all
# invoices with the same customer as that invoice over a 14d period.
invoice_amount_z_score_to_customer_invoice_amount_14d = (
invoice_amount
- customer_avg_of_invoice_amount_14d
) / customer_std_of_invoice_amount_14d
# Give a name to new feature
invoice_amount_z_score_to_customer_invoice_amount_14d.name = \
"INVOICE_Amount_Z_Score_to_CUSTOMER_invoice_Amount_14d"
# Get the Z-Score of the invoice Amount in relation to the distribution of invoice Amount among all
# invoices with the same customer as that invoice over a 14d period.
invoice_amount_z_score_to_customer_invoice_amount_14d = (
invoice_amount
- customer_avg_of_invoice_amount_14d
) / customer_std_of_invoice_amount_14d
# Give a name to new feature
invoice_amount_z_score_to_customer_invoice_amount_14d.name = \
"INVOICE_Amount_Z_Score_to_CUSTOMER_invoice_Amount_14d"
Preview feature¶
Read on the feature primary entity concept
Read on the serving entity concept
In [ ]:
Copied!
#Check the primary entity of the feature'
invoice_amount_z_score_to_customer_invoice_amount_14d.primary_entity
#Check the primary entity of the feature'
invoice_amount_z_score_to_customer_invoice_amount_14d.primary_entity
In [ ]:
Copied!
#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 [ ]:
Copied!
#Preview INVOICE_Amount_Z_Score_to_CUSTOMER_invoice_Amount_14d
invoice_amount_z_score_to_customer_invoice_amount_14d.preview(
preview_table
)
#Preview INVOICE_Amount_Z_Score_to_CUSTOMER_invoice_Amount_14d
invoice_amount_z_score_to_customer_invoice_amount_14d.preview(
preview_table
)
Save feature¶
In [ ]:
Copied!
# Save feature
invoice_amount_z_score_to_customer_invoice_amount_14d.save()
# Save feature
invoice_amount_z_score_to_customer_invoice_amount_14d.save()
Add description and see feature definition file¶
In [ ]:
Copied!
# Add description
invoice_amount_z_score_to_customer_invoice_amount_14d.update_description(
"Z-Score of the invoice Amount in relation to the distribution of "
"invoice Amount among all invoices with the same customer as that "
"invoice over a 14d period."
)
# See feature definition file
invoice_amount_z_score_to_customer_invoice_amount_14d.definition
# Add description
invoice_amount_z_score_to_customer_invoice_amount_14d.update_description(
"Z-Score of the invoice Amount in relation to the distribution of "
"invoice Amount among all invoices with the same customer as that "
"invoice over a 14d period."
)
# See feature definition file
invoice_amount_z_score_to_customer_invoice_amount_14d.definition