check¶
-
Pipeline.
check
(population_table: Union[getml.data.data_frame.DataFrame, getml.data.view.View, getml.data.subset.Subset], peripheral_tables: Optional[Union[Dict[str, Union[getml.data.data_frame.DataFrame, getml.data.view.View]], Sequence[Union[getml.data.data_frame.DataFrame, getml.data.view.View]]]] = None) → None[source]¶ Checks the validity of the data model.
- Args:
- population_table (
DataFrame
,View
orSubset
): Main table containing the target variable(s) and corresponding to the
population
Placeholder
instance variable.- peripheral_tables (List[
DataFrame
orView
], dict,DataFrame
orView
, optional): Additional tables corresponding to the
peripheral
Placeholder
instance variable. If passed as a list, the order needs to match the order of the corresponding placeholders passed toperipheral
.If you pass a
Subset
to population_table, the peripheral tables from that subset will be used. If you use aContainer
,StarSchema
orTimeSeries
, that means you are passing aSubset
.
- population_table (