com.linkedin.feathr.core.config.producer.anchors

Class TimeWindowFeatureConfig

java.lang.Object

com.linkedin.feathr.core.config.producer.anchors.FeatureConfig

com.linkedin.feathr.core.config.producer.anchors.TimeWindowFeatureConfig

All Implemented Interfaces:

ConfigObj, java.io.Serializable

public final class TimeWindowFeatureConfig
extends FeatureConfig

This represents 2 types of configs:- 1. a time-window (sliding window) feature offline config.

 
   <feature name>: {
    def: <column name>
    aggregation: <aggregation type>
    window: <length of window time>
    filter: <string>
    groupBy: <column name>
    limit: <int>
    decay: <string>
    weight: <string>
    embeddingSize: <int>
  }
 
 

2. a nearline feature config : { def/def.mvel: // the field on which the aggregation will be computed OR an MVEL expression (use def.mvel) aggregation: //aggregation types: SUM, COUNT, MAX, AVG windowParameters: { type: //The window type: SlidingWindow (MVP), FixedWindow (MVP), SessionWindow size: length of window time slidingInterval: // (Optional) Used only by sliding windowin nearline features. Specifies the interval of sliding window starts } groupBy: // (Optional) comma separated columns/fields on which the data will be ‘grouped by’ before aggregation filter/filter.mvel: // (Optional) An expression for filtering the fact data before aggregation. For mvel expression, use filter.mvel). } Details can be referenced in the FeatureDefConfigSchema In the offline world, it is always a sliding window and window in offline is equivalent to size in nearline. So, we convert the offline config to the nearline config, with the only difference being window used in offline, windowParameters used in nearline.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.linkedin.feathr.core.config.producer.anchors.FeatureConfig

AGGREGATION, DECAY, DEF, DEF_MVEL, DEF_SQL_EXPR, DEFAULT, EMBEDDING_SIZE, FILTER, FILTER_MVEL, GROUPBY, LIMIT, PARAMETERS, SIZE, SLIDING_INTERVAL, TYPE, WEIGHT, WINDOW, WINDOW_PARAMETERS

Constructor Summary

Constructors

Constructor and Description
TimeWindowFeatureConfig(java.lang.String columnExpr, ExprType columnExprType, TimeWindowAggregationType aggregation, WindowParametersConfig windowParameters, java.lang.String filter, ExprType filterExprType, java.lang.String groupBy, java.lang.Integer limit, java.lang.String decay, java.lang.String weight) Deprecated. please use the constructor with all parameters
TimeWindowFeatureConfig(java.lang.String columnExpr, TimeWindowAggregationType aggregation, WindowParametersConfig windowParameters, java.lang.String filter, java.lang.String groupBy, java.lang.Integer limit, java.lang.String decay, java.lang.String weight) Deprecated. please use the constructor with all parameters
TimeWindowFeatureConfig(TypedExpr typedColumnExpr, TimeWindowAggregationType aggregation, WindowParametersConfig windowParameters, TypedExpr typedFilter, java.lang.String groupBy, java.lang.Integer limit, java.lang.String decay, java.lang.String weight, java.lang.Integer embeddingSize) Constructor with all parameters
TimeWindowFeatureConfig(TypedExpr typedColumnExpr, TimeWindowAggregationType aggregation, WindowParametersConfig windowParameters, TypedExpr typedFilter, java.lang.String groupBy, java.lang.Integer limit, java.lang.String decay, java.lang.String weight, java.lang.Integer embeddingSize, FeatureTypeConfig featureTypeConfig, java.lang.String defaultValue) Constructor with all parameters

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
TimeWindowAggregationType	getAggregation()
java.lang.String	getColumnExpr()
ExprType	getColumnExprType()
java.util.Optional<java.lang.String>	getDecay()
java.util.Optional<java.lang.String>	getDefaultValue()
java.util.Optional<java.lang.Integer>	getEmbeddingSize()
java.util.Optional<FeatureTypeConfig>	getFeatureTypeConfig()
java.util.Optional<java.lang.String>	getFilter()
java.util.Optional<ExprType>	getFilterExprType()
java.util.Optional<java.lang.String>	getGroupBy()
java.util.Optional<java.lang.Integer>	getLimit()
TypedExpr	getTypedColumnExpr()
java.util.Optional<TypedExpr>	getTypedFilter()
java.util.Optional<java.lang.String>	getWeight()
java.time.Duration	getWindow()
WindowParametersConfig	getWindowParameters()
int	hashCode()
java.lang.String	toString()

Methods inherited from class com.linkedin.feathr.core.config.producer.anchors.FeatureConfig

getParameters

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TimeWindowFeatureConfig

public TimeWindowFeatureConfig(TypedExpr typedColumnExpr,
                               TimeWindowAggregationType aggregation,
                               WindowParametersConfig windowParameters,
                               TypedExpr typedFilter,
                               java.lang.String groupBy,
                               java.lang.Integer limit,
                               java.lang.String decay,
                               java.lang.String weight,
                               java.lang.Integer embeddingSize,
                               FeatureTypeConfig featureTypeConfig,
                               java.lang.String defaultValue)

Constructor with all parameters

Parameters:

typedColumnExpr - The column/field on which the aggregation will be computed, with the expr type

aggregation - Aggregation type as specified in [[TimeWindowAggregationType]]

windowParameters - windowParameters as specified in [[WindowParametersConfig]]

typedFilter - Spark SQL / MVEL expression for filtering the fact data before aggregation, with expr type

groupBy - column/field on which the data will be grouped by before aggregation

limit - positive integer to limit the number of records for each group

decay - not supported currently

weight - not supported currently

embeddingSize - embedding size

featureTypeConfig - featureTypeConfig for this faeture

TimeWindowFeatureConfig

public TimeWindowFeatureConfig(TypedExpr typedColumnExpr,
                               TimeWindowAggregationType aggregation,
                               WindowParametersConfig windowParameters,
                               TypedExpr typedFilter,
                               java.lang.String groupBy,
                               java.lang.Integer limit,
                               java.lang.String decay,
                               java.lang.String weight,
                               java.lang.Integer embeddingSize)

Constructor with all parameters

Parameters:

typedColumnExpr - The column/field on which the aggregation will be computed, with the expr type

aggregation - Aggregation type as specified in [[TimeWindowAggregationType]]

windowParameters - windowParameters as specified in [[WindowParametersConfig]]

typedFilter - Spark SQL / MVEL expression for filtering the fact data before aggregation, with expr type

groupBy - column/field on which the data will be grouped by before aggregation

limit - positive integer to limit the number of records for each group

decay - not supported currently

weight - not supported currently

embeddingSize - embedding size

TimeWindowFeatureConfig

public TimeWindowFeatureConfig(java.lang.String columnExpr,
                               ExprType columnExprType,
                               TimeWindowAggregationType aggregation,
                               WindowParametersConfig windowParameters,
                               java.lang.String filter,
                               ExprType filterExprType,
                               java.lang.String groupBy,
                               java.lang.Integer limit,
                               java.lang.String decay,
                               java.lang.String weight)

Deprecated. please use the constructor with all parameters

Parameters:

columnExpr - The column/field on which the aggregation will be computed

columnExprType - The column/field expr type

aggregation - Aggregation type as specified in [[TimeWindowAggregationType]]

windowParameters - windowParameters as specified in [[WindowParametersConfig]]

filter - Spark SQL / MVEL expression for filtering the fact data before aggregation

filterExprType - the filter expression type

groupBy - column/field on which the data will be grouped by before aggregation

limit - positive integer to limit the number of records for each group

decay - not supported currently

weight - not supported currently

TimeWindowFeatureConfig

@Deprecated
public TimeWindowFeatureConfig(java.lang.String columnExpr,
                                           TimeWindowAggregationType aggregation,
                                           WindowParametersConfig windowParameters,
                                           java.lang.String filter,
                                           java.lang.String groupBy,
                                           java.lang.Integer limit,
                                           java.lang.String decay,
                                           java.lang.String weight)

Deprecated. please use the constructor with all parameters

Constructor

Parameters:

columnExpr - The column/field on which the aggregation will be computed

aggregation - Aggregation type as specified in [[TimeWindowAggregationType]]

windowParameters - windowParameters as specified in [[WindowParametersConfig]]

filter - Spark SQL expression for filtering the fact data before aggregation

groupBy - column/field on which the data will be grouped by before aggregation

limit - positive integer to limit the number of records for each group

decay - not supported currently

weight - not supported currently

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getColumnExpr

public java.lang.String getColumnExpr()

getAggregation

public TimeWindowAggregationType getAggregation()

getWindow

public java.time.Duration getWindow()

getWindowParameters

public WindowParametersConfig getWindowParameters()

getFilter

public java.util.Optional<java.lang.String> getFilter()

getGroupBy

public java.util.Optional<java.lang.String> getGroupBy()

getLimit

public java.util.Optional<java.lang.Integer> getLimit()

getDecay

public java.util.Optional<java.lang.String> getDecay()

getWeight

public java.util.Optional<java.lang.String> getWeight()

getColumnExprType

public ExprType getColumnExprType()

getFilterExprType

public java.util.Optional<ExprType> getFilterExprType()

getTypedColumnExpr

public TypedExpr getTypedColumnExpr()

getTypedFilter

public java.util.Optional<TypedExpr> getTypedFilter()

getEmbeddingSize

public java.util.Optional<java.lang.Integer> getEmbeddingSize()

getDefaultValue

public java.util.Optional<java.lang.String> getDefaultValue()

Specified by:

getDefaultValue in class FeatureConfig

getFeatureTypeConfig

public java.util.Optional<FeatureTypeConfig> getFeatureTypeConfig()

Specified by:

getFeatureTypeConfig in class FeatureConfig

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object