watchful.enrich module

This script is run on the Python command line to execute data enrichment. If a custom enricher is used, then the enrich_dataset() function is used.

watchful.enrich.enrich_dataset(custom_enricher_cls: Type[Enricher], args: List[str] | None = None) → None

This is the function to use for performing custom data enrichment. Custom data enrichment variables, functions and mdoels can be defined in custom_enricher_cls and are used to perform the data enrichment.

Parameters:

• custom_enricher_cls (Enricher) – A custom enricher class that inherited Enricher and implemented its abstract methods.

• args (List[str]) – A list containing optional input arguments as defined in main().

watchful.enrich.main(args: List[str] | None = None, custom_enricher: Enricher | None = None) → None

This is the utility function for performing data enrichment without a custom enricher; it is generally not called directly but invoked via the Python command line by the user. To perform data enrichment with a custom enricher, use enrich_dataset() instead.

This function contains the logic and pipelining for the data enrichment.

Parameters:

args (List[str]) – A list containing optional input arguments as defined in the parser arguments below.