INVOICE item TotalCost across product ProductGroups

SDK code to create INVOICE_item_TotalCost_across_product_ProductGroups¶

Feature description:

Distribution representing the cumulative TotalCost of item, categorized by their respective product's ProductGroup, for the invoice.The result is presented as a dictionary where the ProductGroup serves as the key and its corresponding sum of TotalCost forms the value.

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

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

Join views¶

See SDK reference for views

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

Do aggregation by invoice in INVOICEITEMS¶

See SDK reference for features

See SDK reference to groupby a view

See SDK reference to do aggregation by invoice

See list of aggregation operations

See SDK reference to add an aggregation by invoice to the event view

In [ ]:

# Group INVOICEITEMS view by invoice entity (GroceryInvoiceGuid) across different ProductGroups.
invoiceitems_view_by_invoice_across_productgroup =\
invoiceitems_view.groupby(
    "GroceryInvoiceGuid", category="ProductGroup"
)

# Group INVOICEITEMS view by invoice entity (GroceryInvoiceGuid) across different ProductGroups. invoiceitems_view_by_invoice_across_productgroup =\ invoiceitems_view.groupby( "GroceryInvoiceGuid", category="ProductGroup" )

In [ ]:

# Distribution representing the cumulative TotalCost of item,  categorized by their respective
# product's ProductGroup,  for the invoice.
invoice_item_totalcost_across_product_productgroups =\
invoiceitems_view_by_invoice_across_productgroup.aggregate(
    "TotalCost", method=fb.AggFunc.SUM,
    feature_name="INVOICE_item_TotalCost_across_product_ProductGroups"
)

# Distribution representing the cumulative TotalCost of item, categorized by their respective # product's ProductGroup, for the invoice. invoice_item_totalcost_across_product_productgroups =\ invoiceitems_view_by_invoice_across_productgroup.aggregate( "TotalCost", method=fb.AggFunc.SUM, feature_name="INVOICE_item_TotalCost_across_product_ProductGroups" )

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_item_totalcost_across_product_productgroups.primary_entity

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

#Preview INVOICE_item_TotalCost_across_product_ProductGroups invoice_item_totalcost_across_product_productgroups.preview( preview_table )

Save feature¶

See SDK reference to save feature

In [ ]:

# Save feature
invoice_item_totalcost_across_product_productgroups.save()

# Save feature invoice_item_totalcost_across_product_productgroups.save()

Add description and see feature definition file¶

See SDK reference for the definition file of a feature

In [ ]:

# Add description
invoice_item_totalcost_across_product_productgroups.update_description(
	"Distribution representing the cumulative TotalCost of item,  "
	"categorized by their respective product's ProductGroup,  for the "
	"invoice.The result is presented as a dictionary where the ProductGroup"
	" serves as the key and its corresponding sum of TotalCost forms the "
	"value."
)
# See feature definition file
invoice_item_totalcost_across_product_productgroups.definition

# Add description invoice_item_totalcost_across_product_productgroups.update_description( "Distribution representing the cumulative TotalCost of item, " "categorized by their respective product's ProductGroup, for the " "invoice.The result is presented as a dictionary where the ProductGroup" " serves as the key and its corresponding sum of TotalCost forms the " "value." ) # See feature definition file invoice_item_totalcost_across_product_productgroups.definition