abacusai.point_in_time_group

Classes

PointInTimeGroup

A point in time group containing point in time features

Module Contents

class abacusai.point_in_time_group.PointInTimeGroup(client, groupName=None, windowKey=None, aggregationKeys=None, lookbackWindow=None, lookbackWindowLag=None, lookbackCount=None, lookbackUntilPosition=None, historyTableName=None, historyWindowKey=None, historyAggregationKeys=None, features={})

Bases: abacusai.return_class.AbstractApiClass

A point in time group containing point in time features

Parameters:
  • client (ApiClient) – An authenticated API Client instance

  • groupName (str) – The name of the point in time group

  • windowKey (str) – Name of feature which contains the timestamp value for the point in time feature

  • aggregationKeys (list) – List of keys to use for join the historical table and performing the window aggregation.

  • lookbackWindow (float) – Number of seconds in the past from the current time for start of the window.

  • lookbackWindowLag (float) – Optional lag to offset the closest point for the window. If it is positive, we delay the start of window. If it is negative, we are looking at the “future” rows in the history table.

  • lookbackCount (int) – If window is specified in terms of count, the start position of the window (0 is the current row)

  • lookbackUntilPosition (int) – Optional lag to offset the closest point for the window. If it is positive, we delay the start of window by that many rows. If it is negative, we are looking at those many “future” rows in the history table.

  • historyTableName (str) – The table to use for aggregating, if not provided, the source table will be used

  • historyWindowKey (str) – Name of feature to use for ordering the rows on the history table. If not provided, the windowKey from the source table will be used

  • historyAggregationKeys (list) – List of keys to use for join the historical table and performing the window aggregation. If not provided, the aggregationKeys from the source table will be used. Must be the same length and order as the source table’s aggregationKeys

  • features (PointInTimeGroupFeature) – List of features in the Point in Time group

group_name
window_key
aggregation_keys
lookback_window
lookback_window_lag
lookback_count
lookback_until_position
history_table_name
history_window_key
history_aggregation_keys
features
deprecated_keys
__repr__()
to_dict()

Get a dict representation of the parameters in this class

Returns:

The dict value representation of the class parameters

Return type:

dict