Package org.tensorflow.metadata.v0

Class CommonStatistics

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, CommonStatisticsOrBuilder
    public final class CommonStatistics
extends com.google.protobuf.GeneratedMessageV3
implements CommonStatisticsOrBuilder
     Common statistics for all feature types. Statistics counting number of values
 (i.e., min_num_values, max_num_values, avg_num_values, and tot_num_values)
 include NaNs.
    Protobuf type tensorflow.metadata.v0.CommonStatistics
    See Also:
    Serialized Form

    • Field Detail

      • NUM_NON_MISSING_FIELD_NUMBER

        public static final int NUM_NON_MISSING_FIELD_NUMBER
        See Also:
        Constant Field Values

      • NUM_MISSING_FIELD_NUMBER

        public static final int NUM_MISSING_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MIN_NUM_VALUES_FIELD_NUMBER

        public static final int MIN_NUM_VALUES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MAX_NUM_VALUES_FIELD_NUMBER

        public static final int MAX_NUM_VALUES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • AVG_NUM_VALUES_FIELD_NUMBER

        public static final int AVG_NUM_VALUES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TOT_NUM_VALUES_FIELD_NUMBER

        public static final int TOT_NUM_VALUES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • NUM_VALUES_HISTOGRAM_FIELD_NUMBER

        public static final int NUM_VALUES_HISTOGRAM_FIELD_NUMBER
        See Also:
        Constant Field Values

      • WEIGHTED_COMMON_STATS_FIELD_NUMBER

        public static final int WEIGHTED_COMMON_STATS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FEATURE_LIST_LENGTH_HISTOGRAM_FIELD_NUMBER

        public static final int FEATURE_LIST_LENGTH_HISTOGRAM_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getNumNonMissing

        public long getNumNonMissing()
         The number of examples with at least one value for this feature.
        uint64 num_non_missing = 1;
        Specified by:
        getNumNonMissing in interface CommonStatisticsOrBuilder
        Returns:
        The numNonMissing.

      • getNumMissing

        public long getNumMissing()
         The number of examples with no values for this feature.
        uint64 num_missing = 2;
        Specified by:
        getNumMissing in interface CommonStatisticsOrBuilder
        Returns:
        The numMissing.

      • getMinNumValues

        public long getMinNumValues()
         The minimum number of values in a single example for this feature.
        uint64 min_num_values = 3;
        Specified by:
        getMinNumValues in interface CommonStatisticsOrBuilder
        Returns:
        The minNumValues.

      • getMaxNumValues

        public long getMaxNumValues()
         The maximum number of values in a single example for this feature.
        uint64 max_num_values = 4;
        Specified by:
        getMaxNumValues in interface CommonStatisticsOrBuilder
        Returns:
        The maxNumValues.

      • getAvgNumValues

        public float getAvgNumValues()
         The average number of values in a single example for this feature.
        float avg_num_values = 5;
        Specified by:
        getAvgNumValues in interface CommonStatisticsOrBuilder
        Returns:
        The avgNumValues.

      • getTotNumValues

        public long getTotNumValues()
         tot_num_values = avg_num_values * num_non_missing.
 This is calculated directly, so should have less numerical error.
        uint64 tot_num_values = 8;
        Specified by:
        getTotNumValues in interface CommonStatisticsOrBuilder
        Returns:
        The totNumValues.

      • hasNumValuesHistogram

        public boolean hasNumValuesHistogram()
         The quantiles histogram for the number of values in this feature.
        .tensorflow.metadata.v0.Histogram num_values_histogram = 6;
        Specified by:
        hasNumValuesHistogram in interface CommonStatisticsOrBuilder
        Returns:
        Whether the numValuesHistogram field is set.

      • getNumValuesHistogram

        public Histogram getNumValuesHistogram()
         The quantiles histogram for the number of values in this feature.
        .tensorflow.metadata.v0.Histogram num_values_histogram = 6;
        Specified by:
        getNumValuesHistogram in interface CommonStatisticsOrBuilder
        Returns:
        The numValuesHistogram.

      • hasWeightedCommonStats

        public boolean hasWeightedCommonStats()
        .tensorflow.metadata.v0.WeightedCommonStatistics weighted_common_stats = 7;
        Specified by:
        hasWeightedCommonStats in interface CommonStatisticsOrBuilder
        Returns:
        Whether the weightedCommonStats field is set.

      • hasFeatureListLengthHistogram

        public boolean hasFeatureListLengthHistogram()
         The histogram for the number of features in the feature list (only set if
 this feature is a non-context feature from a tf.SequenceExample).
 This is different from num_values_histogram, as num_values_histogram tracks
 the count of all values for a feature in an example, whereas this tracks
 the length of the feature list for this feature in an example (where each
 feature list can contain multiple values).
        .tensorflow.metadata.v0.Histogram feature_list_length_histogram = 9;
        Specified by:
        hasFeatureListLengthHistogram in interface CommonStatisticsOrBuilder
        Returns:
        Whether the featureListLengthHistogram field is set.

      • getFeatureListLengthHistogram

        public Histogram getFeatureListLengthHistogram()
         The histogram for the number of features in the feature list (only set if
 this feature is a non-context feature from a tf.SequenceExample).
 This is different from num_values_histogram, as num_values_histogram tracks
 the count of all values for a feature in an example, whereas this tracks
 the length of the feature list for this feature in an example (where each
 feature list can contain multiple values).
        .tensorflow.metadata.v0.Histogram feature_list_length_histogram = 9;
        Specified by:
        getFeatureListLengthHistogram in interface CommonStatisticsOrBuilder
        Returns:
        The featureListLengthHistogram.

      • getFeatureListLengthHistogramOrBuilder

        public HistogramOrBuilder getFeatureListLengthHistogramOrBuilder()
         The histogram for the number of features in the feature list (only set if
 this feature is a non-context feature from a tf.SequenceExample).
 This is different from num_values_histogram, as num_values_histogram tracks
 the count of all values for a feature in an example, whereas this tracks
 the length of the feature list for this feature in an example (where each
 feature list can contain multiple values).
        .tensorflow.metadata.v0.Histogram feature_list_length_histogram = 9;
        Specified by:
        getFeatureListLengthHistogramOrBuilder in interface CommonStatisticsOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static CommonStatistics parseFrom​(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CommonStatistics parseFrom​(ByteBuffer data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CommonStatistics parseFrom​(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CommonStatistics parseFrom​(com.google.protobuf.ByteString data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CommonStatistics parseFrom​(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CommonStatistics parseFrom​(byte[] data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CommonStatistics parseFrom​(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException
        Throws:
        IOException

      • newBuilderForType

        public CommonStatistics.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public CommonStatistics.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected CommonStatistics.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<CommonStatistics> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public CommonStatistics getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder