# tf.keras.layers.Hashing

<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/keras-team/keras/tree/v2.7.0/keras/layers/preprocessing/hashing.py#L27-L206) |

A preprocessing layer which hashes and bins categorical features.

Inherits From: [`Layer`](https://www.tensorflow.org/versions/r2.7/api_docs/python/tf/keras/layers/Layer), [`Module`](https://www.tensorflow.org/versions/r2.7/api_docs/python/tf/Module)

#### View aliases


**Main aliases**

[`tf.keras.layers.experimental.preprocessing.Hashing`](https://www.tensorflow.org/api_docs/python/tf/keras/layers/Hashing)
**Compat aliases for migration**

See
[Migration guide](https://www.tensorflow.org/guide/migrate) for
more details.

[`tf.compat.v1.keras.layers.Hashing`](https://www.tensorflow.org/api_docs/python/tf/keras/layers/Hashing), [`tf.compat.v1.keras.layers.experimental.preprocessing.Hashing`](https://www.tensorflow.org/api_docs/python/tf/keras/layers/Hashing)

<br />

    tf.keras.layers.Hashing(
        num_bins, mask_value=None, salt=None, **kwargs
    )

This layer transforms categorical inputs to hashed output. It element-wise
converts a ints or strings to ints in a fixed range. The stable hash
function uses `tensorflow::ops::Fingerprint` to produce the same output
consistently across all platforms.

This layer uses [FarmHash64](https://github.com/google/farmhash) by default,
which provides a consistent hashed output across different platforms and is
stable across invocations, regardless of device and context, by mixing the
input bits thoroughly.

If you want to obfuscate the hashed output, you can also pass a random `salt`
argument in the constructor. In that case, the layer will use the
[SipHash64](https://github.com/google/highwayhash) hash function, with
the `salt` value serving as additional input to the hash function.

For an overview and full list of preprocessing layers, see the preprocessing
[guide](https://www.tensorflow.org/guide/keras/preprocessing_layers).

**Example (FarmHash64)**

    layer = tf.keras.layers.Hashing(num_bins=3)
    inp = [['A'], ['B'], ['C'], ['D'], ['E']]
    layer(inp)
    <tf.Tensor: shape=(5, 1), dtype=int64, numpy=
      array([[1],
             [0],
             [1],
             [1],
             [2]])>

**Example (FarmHash64) with a mask value**

    layer = tf.keras.layers.Hashing(num_bins=3, mask_value='')
    inp = [['A'], ['B'], [''], ['C'], ['D']]
    layer(inp)
    <tf.Tensor: shape=(5, 1), dtype=int64, numpy=
      array([[1],
             [1],
             [0],
             [2],
             [2]])>

**Example (SipHash64)**

    layer = tf.keras.layers.Hashing(num_bins=3, salt=[133, 137])
    inp = [['A'], ['B'], ['C'], ['D'], ['E']]
    layer(inp)
    <tf.Tensor: shape=(5, 1), dtype=int64, numpy=
      array([[1],
             [2],
             [1],
             [0],
             [2]])>

**Example (Siphash64 with a single integer, same as `salt=[133, 133]`)**

    layer = tf.keras.layers.Hashing(num_bins=3, salt=133)
    inp = [['A'], ['B'], ['C'], ['D'], ['E']]
    layer(inp)
    <tf.Tensor: shape=(5, 1), dtype=int64, numpy=
      array([[0],
             [0],
             [2],
             [1],
             [0]])>

<br />

<br />

<br />

| ## Args ||
|---|---|
| `num_bins` | Number of hash bins. Note that this includes the `mask_value` bin, so the effective number of bins is `(num_bins - 1)` if `mask_value` is set. |
| `mask_value` | A value that represents masked inputs, which are mapped to index 0. Defaults to None, meaning no mask term will be added and the hashing will start at index 0. |
| `salt` | A single unsigned integer or None. If passed, the hash function used will be SipHash64, with these values used as an additional input (known as a "salt" in cryptography). These should be non-zero. Defaults to `None` (in that case, the FarmHash64 hash function is used). It also supports tuple/list of 2 unsigned integer numbers, see reference paper for details. |
| `**kwargs` | Keyword arguments to construct a layer. |

<br />

<br />

<br />

<br />

| ## Input shape ||
|---|---|
| A single or list of string, int32 or int64 `Tensor`, `SparseTensor` or `RaggedTensor` of shape `(batch_size, ...,)` ||

<br />

<br />

<br />

<br />

| ## Output shape ||
|---|---|
| An int64 `Tensor`, `SparseTensor` or `RaggedTensor` of shape `(batch_size, ...)`. If any input is `RaggedTensor` then output is `RaggedTensor`, otherwise if any input is `SparseTensor` then output is `SparseTensor`, otherwise the output is `Tensor`. ||

<br />

<br />

<br />

| ## Reference ||
|---|---|
| <br /> - [SipHash with salt](https://www.131002.net/siphash/siphash.pdf) ||

<br />