Placeholder

class getml.data.Placeholder(name)[source]

Abstract representation of tables and their relations.

This classes provides an abstract representation of the DataFrame. However, it does not contain any actual data.

Examples:

population_placeholder = getml.data.Placeholder("POPULATION")
peripheral_placeholder = getml.data.Placeholder("PERIPHERAL")

With your Placeholder in place you can use the join() method to construct the data model (required for the Pipeline).

population_placeholder.join(peripheral_placeholder,
                            join_key="join_key",
                            time_stamp="time_stamp"
)
Args:
name (str):

The name used for this placeholder. This name will appear in the generated SQL code.

Raises:
TypeError:

If any of the input arguments is of wrong type.

Methods

join(other[, join_key, time_stamp, …])

Establish a relation between two Placeholder s.

set_relations([allow_lagged_targets, …])

Set all relational instance variables not exposed in the constructor.