Entity

Overview seeknal.entity

The Entity module encapsulates the business logic for managing entities within the Seeknal framework. It provides a class for defining entities, which are essential components in data processing and feature engineering.

Entity

Overview

The Entity class represents a data entity that can be defined and managed within the Seeknal framework.

Component	Description
Entity Name	The name of the entity, which is used to identify it within the framework.
Join Keys	A list of keys used for joining with other datasets..
PII Keys	A list of personally identifiable information (PII) keys.
Entity Description	A brief description of the entity, providing context and purpose.

TThe Entity class provides methods to create, update, and list entities, ensuring that all entity-related information is organized and accessible.

Entity Class

Attributes

• name (str): The name of the entity, which is converted to snake_case format.

• join_keys (Optional[List[str]]): A list of keys used for joining with other datasets.

• pii_keys (Optional[List[str]]): A list of personally identifiable information (PII) keys.

• description (Optional[str]): A brief description of the entity.

Methods

• __post_init__(): Converts the entity name to snake_case format upon initialization.

• get_or_create(self) -> Entity:

  • Retrieves an existing entity by name or creates a new one if it does not exist.

  • Updates the entity ID and associated details.

  • Returns the Entity object.

• list() -> None:

  • Lists all entities associated with the current project.

  • Displays entity names, join keys, PII keys, and descriptions in a tabular format.

• update(self, name=None, description=None, pii_keys=None) -> Entity:

  • Updates the entity details.

  • Raises an EntityNotFoundError if the entity does not exist.

  • Returns the updated Entity object.

• set_key_values(self, *args) -> Entity:

  • Sets the key values for the entity based on the provided arguments.

  • Returns the updated Entity object.