com.linkedin.feathr.common.tensor

Class TensorType

java.lang.Object

com.linkedin.feathr.common.tensor.TensorType

All Implemented Interfaces:

java.io.Serializable

public final class TensorType
extends java.lang.Object
implements java.io.Serializable

Type definition for a TypedTensor, defines the value type, dimension types and dimension names.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static TensorType	EMPTY

Constructor Summary

Constructors

Constructor and Description
TensorType(TensorCategory tensorCategory, ValueType valueType, java.util.List<DimensionType> dimensionTypes)
TensorType(TensorCategory tensorCategory, ValueType valueType, java.util.List<DimensionType> dimensionTypes, java.util.List<java.lang.String> dimensionNames)
TensorType(ValueType valueType, java.util.List<DimensionType> dimensionTypes) Create a SPARSE tensor type with default local names for dimensions.
TensorType(ValueType valueType, java.util.List<DimensionType> dimensionTypes, java.util.List<java.lang.String> dimensionNames) Create a SPARSE tensor type.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
Representable[]	getColumnTypes() WARNING: this returns primitive representations, not DimensionType/ValueType.
int	getDenseSize()
java.util.List<java.lang.String>	getDimensionNames()
java.util.List<DimensionType>	getDimensionTypes()
int[]	getShape()
TensorCategory	getTensorCategory()
ValueType	getValueType()
int	hashCode()
void	setDimensions(WriteableTuple target, java.lang.Object[] dimensions)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final TensorType EMPTY

Constructor Detail

TensorType

public TensorType(ValueType valueType,
                  java.util.List<DimensionType> dimensionTypes)

Create a SPARSE tensor type with default local names for dimensions.

Parameters:

valueType - the type of the value contained in the tensor.

dimensionTypes - a sequence of types for all dimensions of the tensor (can be empty). Dimension names will default to names taken from dimensionTypes.

TensorType

public TensorType(ValueType valueType,
                  java.util.List<DimensionType> dimensionTypes,
                  java.util.List<java.lang.String> dimensionNames)

Create a SPARSE tensor type.

Parameters:

valueType - the type of the value contained in the tensor.

dimensionTypes - a sequence of types for all dimensions of the tensor (can be empty).

dimensionNames - are local to the TensorType, allowing to differentiate between multiple instances of the same dimension type, for example, x used for both viewer and viewee. If null, defaults to names taken from dimensionTypes.

TensorType

public TensorType(TensorCategory tensorCategory,
                  ValueType valueType,
                  java.util.List<DimensionType> dimensionTypes,
                  java.util.List<java.lang.String> dimensionNames)

Parameters:

tensorCategory - the category of the tensor type, such as dense, sparse, etc. NOTE: at the moment this is stored as is, and no additional validation is guaranteed (such as choosing the right tensor builder based on the tensor category).

valueType - the type of the value contained in the tensor.

dimensionTypes - a sequence of types for all dimensions of the tensor (can be empty).

dimensionNames - are local to the TensorType, allowing to differentiate between multiple instances of the same dimension type, for example, x used for both viewer and viewee. If null, defaults to names taken from dimensionTypes.

TensorType

public TensorType(TensorCategory tensorCategory,
                  ValueType valueType,
                  java.util.List<DimensionType> dimensionTypes)

Parameters:

tensorCategory - the category of the tensor type, such as dense, sparse, etc. NOTE: at the moment this is stored as is, and no additional validation is guaranteed (such as choosing the right tensor builder based on the tensor category).

valueType - the type of the value contained in the tensor.

dimensionTypes - a sequence of types for all dimensions of the tensor (can be empty).

Method Detail

getTensorCategory

public TensorCategory getTensorCategory()

Returns:

the category of this tensor. NOTE: only use in context of the FDS until adopted elsewhere. This defaults to SPARSE if not specified in constructor.

getValueType

public ValueType getValueType()

getDimensionTypes

public java.util.List<DimensionType> getDimensionTypes()

getDimensionNames

public java.util.List<java.lang.String> getDimensionNames()

getColumnTypes

public Representable[] getColumnTypes()

WARNING: this returns primitive representations, not DimensionType/ValueType.

Returns:

Dimension types followed by a value type.

setDimensions

public void setDimensions(WriteableTuple target,
                          java.lang.Object[] dimensions)

getShape

public int[] getShape()

getDenseSize

public int getDenseSize()

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