snowflake.ml.feature_store.Entity¶

class snowflake.ml.feature_store.Entity(name: str, join_keys: List[str], *, desc: str = '')¶

Bases: object

Entity encapsulates additional metadata for feature definition. Entity is typically used together with FeatureView to define join_keys and associate relevant FeatureViews. It can also be used for FeatureView search and lineage tracking.

Creates an Entity instance.

Parameters:

• name – name of the Entity.

• join_keys – join keys associated with a FeatureView, used for feature retrieval.

• desc – description of the Entity.

Example:

>>> fs = FeatureStore(...)
>>> e_1 = Entity(
...     name="my_entity",
...     join_keys=['col_1'],
...     desc='My first entity.'
... )
>>> fs.register_entity(e_1)
>>> fs.list_entities().show()
-----------------------------------------------------------
|"NAME"     |"JOIN_KEYS"  |"DESC"            |"OWNER"     |
-----------------------------------------------------------
|MY_ENTITY  |["COL_1"]    |My first entity.  |REGTEST_RL  |
-----------------------------------------------------------

Copy