INVOICE Amount to CUSTOMER invoice Amount ratio 14d

SDK code to create INVOICE_Amount_to_CUSTOMER_invoice_Amount_ratio_14d¶

Feature description:

Ratio of invoice Amount to the total sum of invoice Amount among all invoices with the same customer as that invoice over the 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 GROCERYINVOICE event table.
groceryinvoice_view = catalog.get_view("GROCERYINVOICE")

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

Create Lookup feature¶

See SDK reference for features

See SDK reference to declare a lookup feature

In [ ]:

# 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

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

Compare lookup with aggregation¶

See list of feature transforms

In [ ]:

# Get the Ratio of invoice Amount to the total sum of invoice Amount among all invoices with the
# same customer as that invoice over the 14d period.
invoice_amount_to_customer_invoice_amount_ratio_14d = (
    invoice_amount
    / customer_sum_of_invoice_amount_14d
)
# Give a name to new feature
invoice_amount_to_customer_invoice_amount_ratio_14d.name = \
"INVOICE_Amount_to_CUSTOMER_invoice_Amount_ratio_14d"

# Get the Ratio of invoice Amount to the total sum of invoice Amount among all invoices with the # same customer as that invoice over the 14d period. invoice_amount_to_customer_invoice_amount_ratio_14d = ( invoice_amount / customer_sum_of_invoice_amount_14d ) # Give a name to new feature invoice_amount_to_customer_invoice_amount_ratio_14d.name = \ "INVOICE_Amount_to_CUSTOMER_invoice_Amount_ratio_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'
invoice_amount_to_customer_invoice_amount_ratio_14d.primary_entity

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

#Preview INVOICE_Amount_to_CUSTOMER_invoice_Amount_ratio_14d invoice_amount_to_customer_invoice_amount_ratio_14d.preview( preview_table )

Save feature¶

See SDK reference to save feature

In [ ]:

# Save feature
invoice_amount_to_customer_invoice_amount_ratio_14d.save()

# Save feature invoice_amount_to_customer_invoice_amount_ratio_14d.save()

Add description and see feature definition file¶

See SDK reference for the definition file of a feature

In [ ]:

# Add description
invoice_amount_to_customer_invoice_amount_ratio_14d.update_description(
	"Ratio of invoice Amount to the total sum of invoice Amount among all "
	"invoices with the same customer as that invoice over the 14d period."
)
# See feature definition file
invoice_amount_to_customer_invoice_amount_ratio_14d.definition

# Add description invoice_amount_to_customer_invoice_amount_ratio_14d.update_description( "Ratio of invoice Amount to the total sum of invoice Amount among all " "invoices with the same customer as that invoice over the 14d period." ) # See feature definition file invoice_amount_to_customer_invoice_amount_ratio_14d.definition