Package com.linkedin.feathr.common.tensor

Enum Class TensorCategory

java.lang.Object

java.lang.Enum<TensorCategory>

com.linkedin.feathr.common.tensor.TensorCategory

All Implemented Interfaces:

Serializable, Comparable<TensorCategory>, Constable

public enum TensorCategory
extends Enum<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).

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DENSE	Tensors of this category map the entire dimension space to values.
RAGGED	More general than DENSE, this category relaxes the constraint that shape of every dimension is constant within a single data instance.
SPARSE	Tensors of this category map some subset of the dimension space to values.

Method Summary

Modifier and Type	Method	Description
static TensorCategory	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TensorCategory[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SPARSE

public static final TensorCategory SPARSE

Tensors of this category map some subset of the dimension space to values.

DENSE

public static final TensorCategory DENSE

Tensors of this category map the entire dimension space to values. This includes scalar values (which are modeled as dense tensors with 0 dimensions).

RAGGED

public static final TensorCategory RAGGED

More general than DENSE, this category relaxes the constraint that shape of every dimension is constant within a single data instance.

Method Details

values

public static TensorCategory[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static TensorCategory valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null