tft.bucketize( x, num_buckets, epsilon=None, weights=None, elementwise=False, always_return_num_quantiles=False, name=None )
Returns a bucketized column, with a bucket index assigned to each input.
x: A numeric input
SparseTensorwhose values should be mapped to buckets. For a
SparseTensoronly non-missing values will be included in the quantiles computation, and the result of
bucketizewill be a
SparseTensorwith non-missing values mapped to buckets.
num_buckets: Values in the input
xare divided into approximately equal-sized buckets, where the number of buckets is num_buckets. This is a hint. The actual number of buckets computed can be less or more than the requested number. Use the generated metadata to find the computed number of buckets.
epsilon: (Optional) Error tolerance, typically a small fraction close to zero. If a value is not specified by the caller, a suitable value is computed based on experimental results. For
num_bucketsless than 100, the value of 0.01 is chosen to handle a dataset of up to ~1 trillion input data values. If
num_bucketsis larger, then epsilon is set to (1/
num_buckets) to enforce a stricter error tolerance, because more buckets will result in smaller range for each bucket, and so we want the boundaries to be less fuzzy. See analyzers.quantiles() for details.
weights: (Optional) Weights tensor for the quantiles. Tensor must have the same shape as x.
elementwise: (Optional) If true, bucketize each element of the tensor independently.
always_return_num_quantiles: (Optional) A bool that determines whether the exact num_buckets should be returned (defaults to False for now, but will be changed to True in an imminent update).
name: (Optional) A name for this operation.
Tensor of the same shape as
x, with each element in the
returned tensor representing the bucketized value. Bucketized value is
in the range [0, actual_num_buckets). Sometimes the actual number of buckets
can be different than num_buckets hint, for example in case the number of
distinct values is smaller than num_buckets, or in cases where the
input values are not uniformly distributed.
ValueError: If value of num_buckets is not > 1.