Package org.tensorflow.metadata.v0

Class StringStatistics

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, StringStatisticsOrBuilder
    public final class StringStatistics
extends com.google.protobuf.GeneratedMessageV3
implements StringStatisticsOrBuilder
     Statistics for a string feature in a dataset.
    Protobuf type tensorflow.metadata.v0.StringStatistics
    See Also:
    Serialized Form

    • Field Detail

      • COMMON_STATS_FIELD_NUMBER

        public static final int COMMON_STATS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TOP_VALUES_FIELD_NUMBER

        public static final int TOP_VALUES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • AVG_LENGTH_FIELD_NUMBER

        public static final int AVG_LENGTH_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RANK_HISTOGRAM_FIELD_NUMBER

        public static final int RANK_HISTOGRAM_FIELD_NUMBER
        See Also:
        Constant Field Values

      • WEIGHTED_STRING_STATS_FIELD_NUMBER

        public static final int WEIGHTED_STRING_STATS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • VOCABULARY_FILE_FIELD_NUMBER

        public static final int VOCABULARY_FILE_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

      • hasCommonStats

        public boolean hasCommonStats()
        .tensorflow.metadata.v0.CommonStatistics common_stats = 1;
        Specified by:
        hasCommonStats in interface StringStatisticsOrBuilder
        Returns:
        Whether the commonStats field is set.

      • getUnique

        public long getUnique()
         The number of unique values
        uint64 unique = 2;
        Specified by:
        getUnique in interface StringStatisticsOrBuilder
        Returns:
        The unique.

      • getTopValuesCount

        public int getTopValuesCount()
         A sorted list of the most-frequent values and their frequencies, with
 the most-frequent being first.
        repeated .tensorflow.metadata.v0.StringStatistics.FreqAndValue top_values = 3;
        Specified by:
        getTopValuesCount in interface StringStatisticsOrBuilder

      • getAvgLength

        public float getAvgLength()
         The average length of the values
        float avg_length = 4;
        Specified by:
        getAvgLength in interface StringStatisticsOrBuilder
        Returns:
        The avgLength.

      • hasRankHistogram

        public boolean hasRankHistogram()
         The rank histogram for the values of the feature.
 The rank is used to measure of how commonly the value is found in the
 dataset. The most common value would have a rank of 1, with the second-most
 common value having a rank of 2, and so on.
        .tensorflow.metadata.v0.RankHistogram rank_histogram = 5;
        Specified by:
        hasRankHistogram in interface StringStatisticsOrBuilder
        Returns:
        Whether the rankHistogram field is set.

      • getRankHistogram

        public RankHistogram getRankHistogram()
         The rank histogram for the values of the feature.
 The rank is used to measure of how commonly the value is found in the
 dataset. The most common value would have a rank of 1, with the second-most
 common value having a rank of 2, and so on.
        .tensorflow.metadata.v0.RankHistogram rank_histogram = 5;
        Specified by:
        getRankHistogram in interface StringStatisticsOrBuilder
        Returns:
        The rankHistogram.

      • getRankHistogramOrBuilder

        public RankHistogramOrBuilder getRankHistogramOrBuilder()
         The rank histogram for the values of the feature.
 The rank is used to measure of how commonly the value is found in the
 dataset. The most common value would have a rank of 1, with the second-most
 common value having a rank of 2, and so on.
        .tensorflow.metadata.v0.RankHistogram rank_histogram = 5;
        Specified by:
        getRankHistogramOrBuilder in interface StringStatisticsOrBuilder

      • hasWeightedStringStats

        public boolean hasWeightedStringStats()
         Weighted statistics for the feature, if the values have weights.
        .tensorflow.metadata.v0.WeightedStringStatistics weighted_string_stats = 6;
        Specified by:
        hasWeightedStringStats in interface StringStatisticsOrBuilder
        Returns:
        Whether the weightedStringStats field is set.

      • getVocabularyFile

        public String getVocabularyFile()
         A vocabulary file, used for vocabularies too large to store in the proto
 itself.  Note that the file may be relative to some context-dependent
 directory.  E.g. in TFX the feature statistics will live in a PPP and
 vocabulary file names will be relative to this PPP.
        string vocabulary_file = 7;
        Specified by:
        getVocabularyFile in interface StringStatisticsOrBuilder
        Returns:
        The vocabularyFile.

      • getVocabularyFileBytes

        public com.google.protobuf.ByteString getVocabularyFileBytes()
         A vocabulary file, used for vocabularies too large to store in the proto
 itself.  Note that the file may be relative to some context-dependent
 directory.  E.g. in TFX the feature statistics will live in a PPP and
 vocabulary file names will be relative to this PPP.
        string vocabulary_file = 7;
        Specified by:
        getVocabularyFileBytes in interface StringStatisticsOrBuilder
        Returns:
        The bytes for vocabularyFile.

      • 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 StringStatistics parseFrom​(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<StringStatistics> 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 StringStatistics getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder