class Materialization

A handle to a server-side materialization job, which enriches a Timeline (or set of Timelines) by running it (them) through a given Topology.

Objects are not constructed directly. Materializations are returned by methods of the Client class.

Attributes

branch: str property readonly

Topology branch used for materialization.

event_types: List[str] property readonly

Materialized event types

hash: str property readonly

Unique hash identifying the job.

path: str property readonly

S3 bucket path where results are stored.

timelines: List[str] property readonly

Timelines materialized by the job.

Methods

get_errors(self, event_type, features=[])

Return event-level materialization errors for specified event type. Waits if job is still processing.

Parameters:

Name	Type	Description	Default
event_type	str	Name of event type to fetch.	required
features	List[str]	Feature names to fetch. By default, fetch all.	[]

Returns:

Type	Description
pd.DataFrame	Event-level errors

get_events(self, event_type, features=[])

Return enriched events of specified type. Waits if job is still processing.

Parameters:

Name	Type	Description	Default
event_type	str	Name of event type to fetch.	required
features	List[str]	Feature names to fetch. By default, fetch all.	[]

Returns:

Type	Description
pd.DataFrame	Enriched events

progress(self)

Current progress of subjobs: X of Y jobs completed.

status(self)

Current status of the job. One of {'processing', 'materialized', 'error'}

wait(self)

Wait until materialization completes. In a Notebook, a progress bar is displayed.

Returns:

Type	Description
str	Materialization status