facet_feature_statistics_pb2.pyi
1 from google.protobuf.internal import containers as _containers 2 from google.protobuf.internal import enum_type_wrapper as _enum_type_wrapper 3 from google.protobuf import descriptor as _descriptor 4 from google.protobuf import message as _message 5 from typing import ClassVar as _ClassVar, Iterable as _Iterable, Mapping as _Mapping, Optional as _Optional, Union as _Union 6 7 DESCRIPTOR: _descriptor.FileDescriptor 8 9 class DatasetFeatureStatisticsList(_message.Message): 10 __slots__ = ("datasets",) 11 DATASETS_FIELD_NUMBER: _ClassVar[int] 12 datasets: _containers.RepeatedCompositeFieldContainer[DatasetFeatureStatistics] 13 def __init__(self, datasets: _Optional[_Iterable[_Union[DatasetFeatureStatistics, _Mapping]]] = ...) -> None: ... 14 15 class Path(_message.Message): 16 __slots__ = ("step",) 17 STEP_FIELD_NUMBER: _ClassVar[int] 18 step: _containers.RepeatedScalarFieldContainer[str] 19 def __init__(self, step: _Optional[_Iterable[str]] = ...) -> None: ... 20 21 class DatasetFeatureStatistics(_message.Message): 22 __slots__ = ("name", "num_examples", "weighted_num_examples", "features") 23 NAME_FIELD_NUMBER: _ClassVar[int] 24 NUM_EXAMPLES_FIELD_NUMBER: _ClassVar[int] 25 WEIGHTED_NUM_EXAMPLES_FIELD_NUMBER: _ClassVar[int] 26 FEATURES_FIELD_NUMBER: _ClassVar[int] 27 name: str 28 num_examples: int 29 weighted_num_examples: float 30 features: _containers.RepeatedCompositeFieldContainer[FeatureNameStatistics] 31 def __init__(self, name: _Optional[str] = ..., num_examples: _Optional[int] = ..., weighted_num_examples: _Optional[float] = ..., features: _Optional[_Iterable[_Union[FeatureNameStatistics, _Mapping]]] = ...) -> None: ... 32 33 class FeatureNameStatistics(_message.Message): 34 __slots__ = ("name", "path", "type", "num_stats", "string_stats", "bytes_stats", "struct_stats", "custom_stats") 35 class Type(int, metaclass=_enum_type_wrapper.EnumTypeWrapper): 36 __slots__ = () 37 INT: _ClassVar[FeatureNameStatistics.Type] 38 FLOAT: _ClassVar[FeatureNameStatistics.Type] 39 STRING: _ClassVar[FeatureNameStatistics.Type] 40 BYTES: _ClassVar[FeatureNameStatistics.Type] 41 STRUCT: _ClassVar[FeatureNameStatistics.Type] 42 INT: FeatureNameStatistics.Type 43 FLOAT: FeatureNameStatistics.Type 44 STRING: FeatureNameStatistics.Type 45 BYTES: FeatureNameStatistics.Type 46 STRUCT: FeatureNameStatistics.Type 47 NAME_FIELD_NUMBER: _ClassVar[int] 48 PATH_FIELD_NUMBER: _ClassVar[int] 49 TYPE_FIELD_NUMBER: _ClassVar[int] 50 NUM_STATS_FIELD_NUMBER: _ClassVar[int] 51 STRING_STATS_FIELD_NUMBER: _ClassVar[int] 52 BYTES_STATS_FIELD_NUMBER: _ClassVar[int] 53 STRUCT_STATS_FIELD_NUMBER: _ClassVar[int] 54 CUSTOM_STATS_FIELD_NUMBER: _ClassVar[int] 55 name: str 56 path: Path 57 type: FeatureNameStatistics.Type 58 num_stats: NumericStatistics 59 string_stats: StringStatistics 60 bytes_stats: BytesStatistics 61 struct_stats: StructStatistics 62 custom_stats: _containers.RepeatedCompositeFieldContainer[CustomStatistic] 63 def __init__(self, name: _Optional[str] = ..., path: _Optional[_Union[Path, _Mapping]] = ..., type: _Optional[_Union[FeatureNameStatistics.Type, str]] = ..., num_stats: _Optional[_Union[NumericStatistics, _Mapping]] = ..., string_stats: _Optional[_Union[StringStatistics, _Mapping]] = ..., bytes_stats: _Optional[_Union[BytesStatistics, _Mapping]] = ..., struct_stats: _Optional[_Union[StructStatistics, _Mapping]] = ..., custom_stats: _Optional[_Iterable[_Union[CustomStatistic, _Mapping]]] = ...) -> None: ... 64 65 class WeightedCommonStatistics(_message.Message): 66 __slots__ = ("num_non_missing", "num_missing", "avg_num_values", "tot_num_values") 67 NUM_NON_MISSING_FIELD_NUMBER: _ClassVar[int] 68 NUM_MISSING_FIELD_NUMBER: _ClassVar[int] 69 AVG_NUM_VALUES_FIELD_NUMBER: _ClassVar[int] 70 TOT_NUM_VALUES_FIELD_NUMBER: _ClassVar[int] 71 num_non_missing: float 72 num_missing: float 73 avg_num_values: float 74 tot_num_values: float 75 def __init__(self, num_non_missing: _Optional[float] = ..., num_missing: _Optional[float] = ..., avg_num_values: _Optional[float] = ..., tot_num_values: _Optional[float] = ...) -> None: ... 76 77 class CustomStatistic(_message.Message): 78 __slots__ = ("name", "num", "str", "histogram", "rank_histogram") 79 NAME_FIELD_NUMBER: _ClassVar[int] 80 NUM_FIELD_NUMBER: _ClassVar[int] 81 STR_FIELD_NUMBER: _ClassVar[int] 82 HISTOGRAM_FIELD_NUMBER: _ClassVar[int] 83 RANK_HISTOGRAM_FIELD_NUMBER: _ClassVar[int] 84 name: str 85 num: float 86 str: str 87 histogram: Histogram 88 rank_histogram: RankHistogram 89 def __init__(self, name: _Optional[str] = ..., num: _Optional[float] = ..., str: _Optional[str] = ..., histogram: _Optional[_Union[Histogram, _Mapping]] = ..., rank_histogram: _Optional[_Union[RankHistogram, _Mapping]] = ...) -> None: ... 90 91 class NumericStatistics(_message.Message): 92 __slots__ = ("common_stats", "mean", "std_dev", "num_zeros", "min", "median", "max", "histograms", "weighted_numeric_stats") 93 COMMON_STATS_FIELD_NUMBER: _ClassVar[int] 94 MEAN_FIELD_NUMBER: _ClassVar[int] 95 STD_DEV_FIELD_NUMBER: _ClassVar[int] 96 NUM_ZEROS_FIELD_NUMBER: _ClassVar[int] 97 MIN_FIELD_NUMBER: _ClassVar[int] 98 MEDIAN_FIELD_NUMBER: _ClassVar[int] 99 MAX_FIELD_NUMBER: _ClassVar[int] 100 HISTOGRAMS_FIELD_NUMBER: _ClassVar[int] 101 WEIGHTED_NUMERIC_STATS_FIELD_NUMBER: _ClassVar[int] 102 common_stats: CommonStatistics 103 mean: float 104 std_dev: float 105 num_zeros: int 106 min: float 107 median: float 108 max: float 109 histograms: _containers.RepeatedCompositeFieldContainer[Histogram] 110 weighted_numeric_stats: WeightedNumericStatistics 111 def __init__(self, common_stats: _Optional[_Union[CommonStatistics, _Mapping]] = ..., mean: _Optional[float] = ..., std_dev: _Optional[float] = ..., num_zeros: _Optional[int] = ..., min: _Optional[float] = ..., median: _Optional[float] = ..., max: _Optional[float] = ..., histograms: _Optional[_Iterable[_Union[Histogram, _Mapping]]] = ..., weighted_numeric_stats: _Optional[_Union[WeightedNumericStatistics, _Mapping]] = ...) -> None: ... 112 113 class StringStatistics(_message.Message): 114 __slots__ = ("common_stats", "unique", "top_values", "avg_length", "rank_histogram", "weighted_string_stats") 115 class FreqAndValue(_message.Message): 116 __slots__ = ("deprecated_freq", "value", "frequency") 117 DEPRECATED_FREQ_FIELD_NUMBER: _ClassVar[int] 118 VALUE_FIELD_NUMBER: _ClassVar[int] 119 FREQUENCY_FIELD_NUMBER: _ClassVar[int] 120 deprecated_freq: int 121 value: str 122 frequency: float 123 def __init__(self, deprecated_freq: _Optional[int] = ..., value: _Optional[str] = ..., frequency: _Optional[float] = ...) -> None: ... 124 COMMON_STATS_FIELD_NUMBER: _ClassVar[int] 125 UNIQUE_FIELD_NUMBER: _ClassVar[int] 126 TOP_VALUES_FIELD_NUMBER: _ClassVar[int] 127 AVG_LENGTH_FIELD_NUMBER: _ClassVar[int] 128 RANK_HISTOGRAM_FIELD_NUMBER: _ClassVar[int] 129 WEIGHTED_STRING_STATS_FIELD_NUMBER: _ClassVar[int] 130 common_stats: CommonStatistics 131 unique: int 132 top_values: _containers.RepeatedCompositeFieldContainer[StringStatistics.FreqAndValue] 133 avg_length: float 134 rank_histogram: RankHistogram 135 weighted_string_stats: WeightedStringStatistics 136 def __init__(self, common_stats: _Optional[_Union[CommonStatistics, _Mapping]] = ..., unique: _Optional[int] = ..., top_values: _Optional[_Iterable[_Union[StringStatistics.FreqAndValue, _Mapping]]] = ..., avg_length: _Optional[float] = ..., rank_histogram: _Optional[_Union[RankHistogram, _Mapping]] = ..., weighted_string_stats: _Optional[_Union[WeightedStringStatistics, _Mapping]] = ...) -> None: ... 137 138 class WeightedNumericStatistics(_message.Message): 139 __slots__ = ("mean", "std_dev", "median", "histograms") 140 MEAN_FIELD_NUMBER: _ClassVar[int] 141 STD_DEV_FIELD_NUMBER: _ClassVar[int] 142 MEDIAN_FIELD_NUMBER: _ClassVar[int] 143 HISTOGRAMS_FIELD_NUMBER: _ClassVar[int] 144 mean: float 145 std_dev: float 146 median: float 147 histograms: _containers.RepeatedCompositeFieldContainer[Histogram] 148 def __init__(self, mean: _Optional[float] = ..., std_dev: _Optional[float] = ..., median: _Optional[float] = ..., histograms: _Optional[_Iterable[_Union[Histogram, _Mapping]]] = ...) -> None: ... 149 150 class WeightedStringStatistics(_message.Message): 151 __slots__ = ("top_values", "rank_histogram") 152 TOP_VALUES_FIELD_NUMBER: _ClassVar[int] 153 RANK_HISTOGRAM_FIELD_NUMBER: _ClassVar[int] 154 top_values: _containers.RepeatedCompositeFieldContainer[StringStatistics.FreqAndValue] 155 rank_histogram: RankHistogram 156 def __init__(self, top_values: _Optional[_Iterable[_Union[StringStatistics.FreqAndValue, _Mapping]]] = ..., rank_histogram: _Optional[_Union[RankHistogram, _Mapping]] = ...) -> None: ... 157 158 class BytesStatistics(_message.Message): 159 __slots__ = ("common_stats", "unique", "avg_num_bytes", "min_num_bytes", "max_num_bytes") 160 COMMON_STATS_FIELD_NUMBER: _ClassVar[int] 161 UNIQUE_FIELD_NUMBER: _ClassVar[int] 162 AVG_NUM_BYTES_FIELD_NUMBER: _ClassVar[int] 163 MIN_NUM_BYTES_FIELD_NUMBER: _ClassVar[int] 164 MAX_NUM_BYTES_FIELD_NUMBER: _ClassVar[int] 165 common_stats: CommonStatistics 166 unique: int 167 avg_num_bytes: float 168 min_num_bytes: float 169 max_num_bytes: float 170 def __init__(self, common_stats: _Optional[_Union[CommonStatistics, _Mapping]] = ..., unique: _Optional[int] = ..., avg_num_bytes: _Optional[float] = ..., min_num_bytes: _Optional[float] = ..., max_num_bytes: _Optional[float] = ...) -> None: ... 171 172 class StructStatistics(_message.Message): 173 __slots__ = ("common_stats",) 174 COMMON_STATS_FIELD_NUMBER: _ClassVar[int] 175 common_stats: CommonStatistics 176 def __init__(self, common_stats: _Optional[_Union[CommonStatistics, _Mapping]] = ...) -> None: ... 177 178 class CommonStatistics(_message.Message): 179 __slots__ = ("num_non_missing", "num_missing", "min_num_values", "max_num_values", "avg_num_values", "tot_num_values", "num_values_histogram", "weighted_common_stats", "feature_list_length_histogram") 180 NUM_NON_MISSING_FIELD_NUMBER: _ClassVar[int] 181 NUM_MISSING_FIELD_NUMBER: _ClassVar[int] 182 MIN_NUM_VALUES_FIELD_NUMBER: _ClassVar[int] 183 MAX_NUM_VALUES_FIELD_NUMBER: _ClassVar[int] 184 AVG_NUM_VALUES_FIELD_NUMBER: _ClassVar[int] 185 TOT_NUM_VALUES_FIELD_NUMBER: _ClassVar[int] 186 NUM_VALUES_HISTOGRAM_FIELD_NUMBER: _ClassVar[int] 187 WEIGHTED_COMMON_STATS_FIELD_NUMBER: _ClassVar[int] 188 FEATURE_LIST_LENGTH_HISTOGRAM_FIELD_NUMBER: _ClassVar[int] 189 num_non_missing: int 190 num_missing: int 191 min_num_values: int 192 max_num_values: int 193 avg_num_values: float 194 tot_num_values: int 195 num_values_histogram: Histogram 196 weighted_common_stats: WeightedCommonStatistics 197 feature_list_length_histogram: Histogram 198 def __init__(self, num_non_missing: _Optional[int] = ..., num_missing: _Optional[int] = ..., min_num_values: _Optional[int] = ..., max_num_values: _Optional[int] = ..., avg_num_values: _Optional[float] = ..., tot_num_values: _Optional[int] = ..., num_values_histogram: _Optional[_Union[Histogram, _Mapping]] = ..., weighted_common_stats: _Optional[_Union[WeightedCommonStatistics, _Mapping]] = ..., feature_list_length_histogram: _Optional[_Union[Histogram, _Mapping]] = ...) -> None: ... 199 200 class Histogram(_message.Message): 201 __slots__ = ("num_nan", "num_undefined", "buckets", "type", "name") 202 class HistogramType(int, metaclass=_enum_type_wrapper.EnumTypeWrapper): 203 __slots__ = () 204 STANDARD: _ClassVar[Histogram.HistogramType] 205 QUANTILES: _ClassVar[Histogram.HistogramType] 206 STANDARD: Histogram.HistogramType 207 QUANTILES: Histogram.HistogramType 208 class Bucket(_message.Message): 209 __slots__ = ("low_value", "high_value", "deprecated_count", "sample_count") 210 LOW_VALUE_FIELD_NUMBER: _ClassVar[int] 211 HIGH_VALUE_FIELD_NUMBER: _ClassVar[int] 212 DEPRECATED_COUNT_FIELD_NUMBER: _ClassVar[int] 213 SAMPLE_COUNT_FIELD_NUMBER: _ClassVar[int] 214 low_value: float 215 high_value: float 216 deprecated_count: int 217 sample_count: float 218 def __init__(self, low_value: _Optional[float] = ..., high_value: _Optional[float] = ..., deprecated_count: _Optional[int] = ..., sample_count: _Optional[float] = ...) -> None: ... 219 NUM_NAN_FIELD_NUMBER: _ClassVar[int] 220 NUM_UNDEFINED_FIELD_NUMBER: _ClassVar[int] 221 BUCKETS_FIELD_NUMBER: _ClassVar[int] 222 TYPE_FIELD_NUMBER: _ClassVar[int] 223 NAME_FIELD_NUMBER: _ClassVar[int] 224 num_nan: int 225 num_undefined: int 226 buckets: _containers.RepeatedCompositeFieldContainer[Histogram.Bucket] 227 type: Histogram.HistogramType 228 name: str 229 def __init__(self, num_nan: _Optional[int] = ..., num_undefined: _Optional[int] = ..., buckets: _Optional[_Iterable[_Union[Histogram.Bucket, _Mapping]]] = ..., type: _Optional[_Union[Histogram.HistogramType, str]] = ..., name: _Optional[str] = ...) -> None: ... 230 231 class RankHistogram(_message.Message): 232 __slots__ = ("buckets", "name") 233 class Bucket(_message.Message): 234 __slots__ = ("low_rank", "high_rank", "deprecated_count", "label", "sample_count") 235 LOW_RANK_FIELD_NUMBER: _ClassVar[int] 236 HIGH_RANK_FIELD_NUMBER: _ClassVar[int] 237 DEPRECATED_COUNT_FIELD_NUMBER: _ClassVar[int] 238 LABEL_FIELD_NUMBER: _ClassVar[int] 239 SAMPLE_COUNT_FIELD_NUMBER: _ClassVar[int] 240 low_rank: int 241 high_rank: int 242 deprecated_count: int 243 label: str 244 sample_count: float 245 def __init__(self, low_rank: _Optional[int] = ..., high_rank: _Optional[int] = ..., deprecated_count: _Optional[int] = ..., label: _Optional[str] = ..., sample_count: _Optional[float] = ...) -> None: ... 246 BUCKETS_FIELD_NUMBER: _ClassVar[int] 247 NAME_FIELD_NUMBER: _ClassVar[int] 248 buckets: _containers.RepeatedCompositeFieldContainer[RankHistogram.Bucket] 249 name: str 250 def __init__(self, buckets: _Optional[_Iterable[_Union[RankHistogram.Bucket, _Mapping]]] = ..., name: _Optional[str] = ...) -> None: ...