Hashing

String hashing ops take a string input tensor and map each element to an integer.

tf.string_to_hash_bucket_fast(input, num_buckets, name=None)

Converts each string in the input Tensor to its hash mod by a number of buckets.

The hash function is deterministic on the content of the string within the process and will never change. However, it is not suitable for cryptography. This function may be used when CPU time is scarce and inputs are trusted or unimportant. There is a risk of adversaries constructing inputs that all hash to the same bucket. To prevent this problem, use a strong hash function with tf.string_to_hash_bucket_strong.

Args:
  • input: A Tensor of type string. The strings to assign a hash bucket.
  • num_buckets: An int that is >= 1. The number of buckets.
  • name: A name for the operation (optional).
Returns:

A Tensor of type int64. A Tensor of the same shape as the input string_tensor.


tf.string_to_hash_bucket_strong(input, num_buckets, key, name=None)

Converts each string in the input Tensor to its hash mod by a number of buckets.

The hash function is deterministic on the content of the string within the process. The hash function is a keyed hash function, where attribute key defines the key of the hash function. key is an array of 2 elements.

A strong hash is important when inputs may be malicious, e.g. URLs with additional components. Adversaries could try to make their inputs hash to the same bucket for a denial-of-service attack or to skew the results. A strong hash prevents this by making it dificult, if not infeasible, to compute inputs that hash to the same bucket. This comes at a cost of roughly 4x higher compute time than tf.string_to_hash_bucket_fast.

Args:
  • input: A Tensor of type string. The strings to assign a hash bucket.
  • num_buckets: An int that is >= 1. The number of buckets.
  • key: A list of ints. The key for the keyed hash function passed as a list of two uint64 elements.
  • name: A name for the operation (optional).
Returns:

A Tensor of type int64. A Tensor of the same shape as the input string_tensor.


tf.string_to_hash_bucket(string_tensor, num_buckets, name=None)

Converts each string in the input Tensor to its hash mod by a number of buckets.

The hash function is deterministic on the content of the string within the process.

Note that the hash function may change from time to time. This functionality will be deprecated and it's recommended to use tf.string_to_hash_bucket_fast() or tf.string_to_hash_bucket_strong().

Args:
  • string_tensor: A Tensor of type string.
  • num_buckets: An int that is >= 1. The number of buckets.
  • name: A name for the operation (optional).
Returns:

A Tensor of type int64. A Tensor of the same shape as the input string_tensor.