Enum TensorDebugMode

  • All Implemented Interfaces:
    com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, java.io.Serializable, java.lang.Comparable<TensorDebugMode>

    public enum TensorDebugMode
    extends java.lang.Enum<TensorDebugMode>
    implements com.google.protobuf.ProtocolMessageEnum
     Available modes for extracting debugging information from a Tensor.
     TODO(cais): Document the detailed column names and semantics in a separate
     markdown file once the implementation settles.
     
    Protobuf enum org.platanios.tensorflow.proto.TensorDebugMode
    • Enum Constant Detail

      • UNSPECIFIED

        public static final TensorDebugMode UNSPECIFIED
        UNSPECIFIED = 0;
      • NO_TENSOR

        public static final TensorDebugMode NO_TENSOR
         Only records what tensors are computed, eagerly or in graphs.
         No information regarding the value of the tensor is available.
         
        NO_TENSOR = 1;
      • CURT_HEALTH

        public static final TensorDebugMode CURT_HEALTH
         A minimalist health summary for float-type tensors.
         Contains information only about the presence/absence of pathological
         values including Infinity and NaN.
         Applicable only to float dtypes.
         
        CURT_HEALTH = 2;
      • CONCISE_HEALTH

        public static final TensorDebugMode CONCISE_HEALTH
         A concise health summary for float-type tensors.
         Contains more information that CURT_HEALTH.
         Infinity and NaN are treated differently.
         Applicable only to float and integer dtypes.
         
        CONCISE_HEALTH = 3;
      • FULL_HEALTH

        public static final TensorDebugMode FULL_HEALTH
         A detailed health summary.
         Contains further detailed information than `CONCISE_HEALTH`.
         Information about device, dtype and shape are included.
         Counts for various types of values (Infinity, NaN, negative, zero,
         positive) are included.
         Applicable to float, integer and boolean dtypes.
         
        FULL_HEALTH = 4;
      • SHAPE

        public static final TensorDebugMode SHAPE
         Provides full runtime shape information, up to a maximum rank, beyond
         which the dimension sizes are truncated.
         
        SHAPE = 5;
      • FULL_NUMERICS

        public static final TensorDebugMode FULL_NUMERICS
         Full numeric summary.
         Including device, dtype, shape, counts of various types of values
         (Infinity, NaN, negative, zero, positive), and summary statistics
         (minimum, maximum, mean and variance).
         Applicable to float, integer and boolean dtypes.
         
        FULL_NUMERICS = 6;
      • FULL_TENSOR

        public static final TensorDebugMode FULL_TENSOR
         Full tensor value.
         
        FULL_TENSOR = 7;
      • REDUCE_INF_NAN_THREE_SLOTS

        public static final TensorDebugMode REDUCE_INF_NAN_THREE_SLOTS
         Reduce the elements of a tensor to a rank-1 tensor of shape [3], in which
         - the 1st element is -inf if any element of the tensor is -inf,
           or zero otherwise.
         - the 2nd element is +inf if any element of the tensor is +inf,
           or zero otherwise.
         - the 3rd element is nan if any element of the tensor is nan, or zero
           otherwise.
         
        REDUCE_INF_NAN_THREE_SLOTS = 8;
    • Field Detail

      • UNSPECIFIED_VALUE

        public static final int UNSPECIFIED_VALUE
        UNSPECIFIED = 0;
        See Also:
        Constant Field Values
      • NO_TENSOR_VALUE

        public static final int NO_TENSOR_VALUE
         Only records what tensors are computed, eagerly or in graphs.
         No information regarding the value of the tensor is available.
         
        NO_TENSOR = 1;
        See Also:
        Constant Field Values
      • CURT_HEALTH_VALUE

        public static final int CURT_HEALTH_VALUE
         A minimalist health summary for float-type tensors.
         Contains information only about the presence/absence of pathological
         values including Infinity and NaN.
         Applicable only to float dtypes.
         
        CURT_HEALTH = 2;
        See Also:
        Constant Field Values
      • CONCISE_HEALTH_VALUE

        public static final int CONCISE_HEALTH_VALUE
         A concise health summary for float-type tensors.
         Contains more information that CURT_HEALTH.
         Infinity and NaN are treated differently.
         Applicable only to float and integer dtypes.
         
        CONCISE_HEALTH = 3;
        See Also:
        Constant Field Values
      • FULL_HEALTH_VALUE

        public static final int FULL_HEALTH_VALUE
         A detailed health summary.
         Contains further detailed information than `CONCISE_HEALTH`.
         Information about device, dtype and shape are included.
         Counts for various types of values (Infinity, NaN, negative, zero,
         positive) are included.
         Applicable to float, integer and boolean dtypes.
         
        FULL_HEALTH = 4;
        See Also:
        Constant Field Values
      • SHAPE_VALUE

        public static final int SHAPE_VALUE
         Provides full runtime shape information, up to a maximum rank, beyond
         which the dimension sizes are truncated.
         
        SHAPE = 5;
        See Also:
        Constant Field Values
      • FULL_NUMERICS_VALUE

        public static final int FULL_NUMERICS_VALUE
         Full numeric summary.
         Including device, dtype, shape, counts of various types of values
         (Infinity, NaN, negative, zero, positive), and summary statistics
         (minimum, maximum, mean and variance).
         Applicable to float, integer and boolean dtypes.
         
        FULL_NUMERICS = 6;
        See Also:
        Constant Field Values
      • FULL_TENSOR_VALUE

        public static final int FULL_TENSOR_VALUE
         Full tensor value.
         
        FULL_TENSOR = 7;
        See Also:
        Constant Field Values
      • REDUCE_INF_NAN_THREE_SLOTS_VALUE

        public static final int REDUCE_INF_NAN_THREE_SLOTS_VALUE
         Reduce the elements of a tensor to a rank-1 tensor of shape [3], in which
         - the 1st element is -inf if any element of the tensor is -inf,
           or zero otherwise.
         - the 2nd element is +inf if any element of the tensor is +inf,
           or zero otherwise.
         - the 3rd element is nan if any element of the tensor is nan, or zero
           otherwise.
         
        REDUCE_INF_NAN_THREE_SLOTS = 8;
        See Also:
        Constant Field Values
    • Method Detail

      • values

        public static TensorDebugMode[] 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 (TensorDebugMode c : TensorDebugMode.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static TensorDebugMode 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
      • getNumber

        public final int getNumber()
        Specified by:
        getNumber in interface com.google.protobuf.Internal.EnumLite
        Specified by:
        getNumber in interface com.google.protobuf.ProtocolMessageEnum
      • valueOf

        @Deprecated
        public static TensorDebugMode valueOf​(int value)
        Deprecated.
        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:
        value - 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
      • forNumber

        public static TensorDebugMode forNumber​(int value)
        Parameters:
        value - The numeric wire value of the corresponding enum entry.
        Returns:
        The enum associated with the given numeric wire value.
      • internalGetValueMap

        public static com.google.protobuf.Internal.EnumLiteMap<TensorDebugMode> internalGetValueMap()
      • getValueDescriptor

        public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
        Specified by:
        getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum
      • getDescriptorForType

        public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum
      • getDescriptor

        public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()
      • valueOf

        public static TensorDebugMode valueOf​(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
        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:
        desc - 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