com.linkedin.feathr.common

Class FeatureTypeConfig

java.lang.Object

com.linkedin.feathr.common.FeatureTypeConfig

All Implemented Interfaces:

java.io.Serializable

public class FeatureTypeConfig
extends java.lang.Object
implements java.io.Serializable

This class encapsulates the type definition for a feature. This implementation supports Feathr's high level semantic type system (e.g. NUMERIC, BOOLEAN, VECTOR) and the new Tensor type system which includes additional metadata such as category, dimensions, shape, value type and etc. When the feature type annotation from the feature definition is processed, the following scenarios are expected: 1. No type annotated --> (FeatureType=UNSPECIFIED, TensorType=null) 2. High level semantic NON-TENSOR feature types --> (FeatureType=, TensorType=) 3. Parameterized Tensor type annotated --> (FeatureTypes = TENSOR, TensorType = )

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static FeatureTypeConfig	CATEGORICAL_SET_TYPE_CONFIG
static FeatureTypeConfig	CATEGORICAL_TYPE_CONFIG
static FeatureTypeConfig	DENSE_VECTOR_TYPE_CONFIG
static FeatureTypeConfig	NUMERIC_TYPE_CONFIG
static FeatureTypeConfig	TERM_VECTOR_TYPE_CONFIG
static FeatureTypeConfig	UNDEFINED_TYPE_CONFIG

Constructor Summary

Constructors

Constructor and Description
FeatureTypeConfig()
FeatureTypeConfig(FeatureTypes featureType) Constructs a new instance with the legacy FeatureTypes.
FeatureTypeConfig(FeatureTypes featureType, TensorType tensorType, java.lang.String documentation) Package private constructor where both the legacy type and tensor types are passed in.
FeatureTypeConfig(TensorType tensorType) Constructs a new instance with the new TensorType.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.String	getDocumentation()
FeatureTypes	getFeatureType()
TensorType	getTensorType()
int	hashCode()
boolean	hasTensorType()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

UNDEFINED_TYPE_CONFIG

public static final FeatureTypeConfig UNDEFINED_TYPE_CONFIG

NUMERIC_TYPE_CONFIG

public static final FeatureTypeConfig NUMERIC_TYPE_CONFIG

DENSE_VECTOR_TYPE_CONFIG

public static final FeatureTypeConfig DENSE_VECTOR_TYPE_CONFIG

TERM_VECTOR_TYPE_CONFIG

public static final FeatureTypeConfig TERM_VECTOR_TYPE_CONFIG

CATEGORICAL_TYPE_CONFIG

public static final FeatureTypeConfig CATEGORICAL_TYPE_CONFIG

CATEGORICAL_SET_TYPE_CONFIG

public static final FeatureTypeConfig CATEGORICAL_SET_TYPE_CONFIG

Constructor Detail

FeatureTypeConfig

public FeatureTypeConfig()

FeatureTypeConfig

public FeatureTypeConfig(FeatureTypes featureType)

Constructs a new instance with the legacy FeatureTypes. The corresponding TensorType will be populated

FeatureTypeConfig

public FeatureTypeConfig(@Nonnull
                         TensorType tensorType)

Constructs a new instance with the new TensorType. The corresponding the legacy FeatureTypes will be populated as FeatureTypes.TENSOR

FeatureTypeConfig

public FeatureTypeConfig(@Nonnull
                         FeatureTypes featureType,
                         @Nonnull
                         TensorType tensorType,
                         java.lang.String documentation)

Package private constructor where both the legacy type and tensor types are passed in. This constructor is reserved for internal use only and does not provide any of consistency checking between legacy types and TensorType from the other pubic constructors

Method Detail

getDocumentation

public java.lang.String getDocumentation()

hasTensorType

public boolean hasTensorType()

getFeatureType

public FeatureTypes getFeatureType()

getTensorType

public TensorType getTensorType()

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object