org.tensorflow.metadata.v0.StringStatisticsOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of scio-tensorflow_2.12 Show documentation
Scio add-on for TensorFlow
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: tensorflow_metadata/proto/v0/statistics.proto

// Protobuf Java Version: 3.25.4
package org.tensorflow.metadata.v0;

public interface StringStatisticsOrBuilder extends
    // @@protoc_insertion_point(interface_extends:tensorflow.metadata.v0.StringStatistics)
    com.google.protobuf.MessageOrBuilder {

  /**
   * .tensorflow.metadata.v0.CommonStatistics common_stats = 1;
   * @return Whether the commonStats field is set.
   */
  boolean hasCommonStats();
  /**
   * .tensorflow.metadata.v0.CommonStatistics common_stats = 1;
   * @return The commonStats.
   */
  org.tensorflow.metadata.v0.CommonStatistics getCommonStats();
  /**
   * .tensorflow.metadata.v0.CommonStatistics common_stats = 1;
   */
  org.tensorflow.metadata.v0.CommonStatisticsOrBuilder getCommonStatsOrBuilder();

  /**
   *    * The number of unique values
   * 
   *
   * uint64 unique = 2;
   * @return The unique.
   */
  long getUnique();

  /**
   *    * 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;
   */
  java.util.List 
      getTopValuesList();
  /**
   *    * 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;
   */
  org.tensorflow.metadata.v0.StringStatistics.FreqAndValue getTopValues(int index);
  /**
   *    * 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;
   */
  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;
   */
  java.util.List 
      getTopValuesOrBuilderList();
  /**
   *    * 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;
   */
  org.tensorflow.metadata.v0.StringStatistics.FreqAndValueOrBuilder getTopValuesOrBuilder(
      int index);

  /**
   *    * The average length of the values
   * 
   *
   * float avg_length = 4;
   * @return The avgLength.
   */
  float getAvgLength();

  /**
   *    * 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;
   * @return Whether the rankHistogram field is set.
   */
  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;
   * @return The rankHistogram.
   */
  org.tensorflow.metadata.v0.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;
   */
  org.tensorflow.metadata.v0.RankHistogramOrBuilder getRankHistogramOrBuilder();

  /**
   *    * Weighted statistics for the feature, if the values have weights.
   * 
   *
   * .tensorflow.metadata.v0.WeightedStringStatistics weighted_string_stats = 6;
   * @return Whether the weightedStringStats field is set.
   */
  boolean hasWeightedStringStats();
  /**
   *    * Weighted statistics for the feature, if the values have weights.
   * 
   *
   * .tensorflow.metadata.v0.WeightedStringStatistics weighted_string_stats = 6;
   * @return The weightedStringStats.
   */
  org.tensorflow.metadata.v0.WeightedStringStatistics getWeightedStringStats();
  /**
   *    * Weighted statistics for the feature, if the values have weights.
   * 
   *
   * .tensorflow.metadata.v0.WeightedStringStatistics weighted_string_stats = 6;
   */
  org.tensorflow.metadata.v0.WeightedStringStatisticsOrBuilder getWeightedStringStatsOrBuilder();

  /**
   *    * 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;
   * @return The vocabularyFile.
   */
  java.lang.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;
   * @return The bytes for vocabularyFile.
   */
  com.google.protobuf.ByteString
      getVocabularyFileBytes();

  /**
   *    * Counts the number of invalid utf8 strings present in leaf arrays for this
   * feature. Validation is only performed for byte- or string-like features (
   * those having type BYTES or STRING).
   * 
   *
   * uint64 invalid_utf8_count = 8;
   * @return The invalidUtf8Count.
   */
  long getInvalidUtf8Count();
}