Fingerprint

public final class Fingerprint

Generates fingerprint values.

Generates fingerprint values of `data`.

Fingerprint op considers the first dimension of `data` as the batch dimension, and `output[i]` contains the fingerprint value generated from contents in `data[i, ...]` for all `i`.

Fingerprint op writes fingerprint values as byte arrays. For example, the default method `farmhash64` generates a 64-bit fingerprint value at a time. This 8-byte value is written out as an `uint8` array of size 8, in little-endian order.

For example, suppose that `data` has data type `DT_INT32` and shape (2, 3, 4), and that the fingerprint method is `farmhash64`. In this case, the output shape is (2, 8), where 2 is the batch dimension size of `data`, and 8 is the size of each fingerprint value in bytes. `output[0, :]` is generated from 12 integers in `data[0, :, :]` and similarly `output[1, :]` is generated from other 12 integers in `data[1, :, :]`.

Note that this op fingerprints the raw underlying buffer, and it does not fingerprint Tensor's metadata such as data type and/or shape. For example, the fingerprint values are invariant under reshapes and bitcasts as long as the batch dimension remain the same: 

Fingerprint(data) == Fingerprint(Reshape(data, ...))
 Fingerprint(data) == Fingerprint(Bitcast(data, ...))
For string data, one should expect `Fingerprint(data) != Fingerprint(ReduceJoin(data))` in general.

Constants

String OP_NAME The name of this op, as known by TensorFlow core engine

Public Methods

Output<TUint8>
asOutput()
Returns the symbolic handle of the tensor.
static Fingerprint
create(Scope scope, Operand<? extends TType> data, Operand<TString> method)
Factory method to create a class wrapping a new Fingerprint operation.
Output<TUint8>
fingerprint()
A two-dimensional `Tensor` of type tf.uint8.

Inherited Methods

org.tensorflow.op.RawOp
final boolean
equals(Object obj)
final int
hashCode()
Operation
op()
Return this unit of computation as a single Operation.
final String
toString()
boolean
equals(Object arg0)
final Class<?>
getClass()
int
hashCode()
final void
notify()
final void
notifyAll()
String
toString()
final void
wait(long arg0, int arg1)
final void
wait(long arg0)
final void
wait()
org.tensorflow.op.Op
abstract ExecutionEnvironment
env()
Return the execution environment this op was created in.
abstract Operation
op()
Return this unit of computation as a single Operation.
org.tensorflow.Operand
abstract Output<TUint8>
asOutput()
Returns the symbolic handle of the tensor.
abstract TUint8
asTensor()
Returns the tensor at this operand.
abstract Shape
shape()
Returns the (possibly partially known) shape of the tensor referred to by the Output of this operand.
abstract Class<TUint8>
type()
Returns the tensor type of this operand
org.tensorflow.ndarray.Shaped
abstract int
rank()
abstract Shape
shape()
abstract long
size()
Computes and returns the total size of this container, in number of values.

Constants

public static final String OP_NAME

The name of this op, as known by TensorFlow core engine

Constant Value: "Fingerprint"

Public Methods

public Output<TUint8> asOutput ()

Returns the symbolic handle of the tensor.

Inputs to TensorFlow operations are outputs of another TensorFlow operation. This method is used to obtain a symbolic handle that represents the computation of the input.

public static Fingerprint create (Scope scope, Operand<? extends TType> data, Operand<TString> method)

Factory method to create a class wrapping a new Fingerprint operation.

Parameters
scope current scope
data Must have rank 1 or higher.
method Fingerprint method used by this op. Currently available method is `farmhash::fingerprint64`.
Returns
  • a new instance of Fingerprint

public Output<TUint8> fingerprint ()

A two-dimensional `Tensor` of type tf.uint8. The first dimension equals to `data`'s first dimension, and the second dimension size depends on the fingerprint algorithm.