Skip to content

featurebyte.Feature

class Feature(
*,
user_id: Union[PydanticObjectId, NoneType]=None,
name: Union[StrictStr, NoneType]=None,
created_at: Union[datetime, NoneType]=None,
updated_at: Union[datetime, NoneType]=None,
catalog_id: PydanticObjectId,
dtype: DBVarType,
graph: QueryGraph=None,
node_name: str,
tabular_source: TabularSource,
version: VersionIdentifier=None,
entity_ids: List[PydanticObjectId],
table_ids: List[PydanticObjectId]=None,
primary_table_ids: List[PydanticObjectId]=None,
feature_namespace_id: PydanticObjectId=None,
feature_list_ids: List[PydanticObjectId]=None,
feature_store: FeatureStoreModel
)

Description

A feature is input data that is used to train Machine Learning models and compute predictions. These features can sometimes be derived from attributes already present in the source tables. For instance, a customer churn model can use features obtained directly from a customer profile table, such as age, gender, income, and location.

However, in most cases, features are created by applying a series of row transformations, joins, filters, and aggregates. For instance, a customer churn model may utilize aggregate features that reflect the customer's account details over a given period, such as the entropy of product types purchased over the past 12 weeks, the count of canceled orders over the past 56 weeks, and the amount of money spent over the past 7 days.

Parameters

  • user_id: Union[PydanticObjectId, NoneType]

  • name: Union[StrictStr, NoneType]

  • created_at: Union[datetime, NoneType]

  • updated_at: Union[datetime, NoneType]

  • catalog_id: PydanticObjectId

  • dtype: DBVarType

  • graph: QueryGraph

  • node_name: str

  • tabular_source: TabularSource

  • version: VersionIdentifier

  • entity_ids: List[PydanticObjectId]

  • table_ids: List[PydanticObjectId]

  • primary_table_ids: List[PydanticObjectId]

  • feature_namespace_id: PydanticObjectId

  • feature_list_ids: List[PydanticObjectId]

  • feature_store: FeatureStoreModel