com.linkedin.feathr.common.tensor

Enum TensorCategory

java.lang.Object

java.lang.Enum<TensorCategory>

com.linkedin.feathr.common.tensor.TensorCategory

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TensorCategory>

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

Enum Constant Summary

Enum Constants

Enum Constant and 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 and Description
static TensorCategory	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TensorCategory[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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 Detail

values

public static TensorCategory[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TensorCategory c : TensorCategory.values())
    System.out.println(c);

Returns:

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

valueOf

public static TensorCategory valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null