OneHot

Returns a one-hot tensor.

The locations represented by indices in `indices` take value `on_value`, while all other locations take value `off_value`.

If the input `indices` is rank `N`, the output will have rank `N+1`, The new axis is created at dimension `axis` (default: the new axis is appended at the end).

If `indices` is a scalar the output shape will be a vector of length `depth`.

If `indices` is a vector of length `features`, the output shape will be:

features x depth if axis == -1
   depth x features if axis == 0
 

If `indices` is a matrix (batch) with shape `[batch, features]`, the output shape will be:

batch x features x depth if axis == -1
   batch x depth x features if axis == 1
   depth x batch x features if axis == 0
 

Examples =========

Suppose that

indices = [0, 2, -1, 1]
   depth = 3
   on_value = 5.0
   off_value = 0.0
   axis = -1
 

Then output is `[4 x 3]`:

output =
   [5.0 0.0 0.0]  // one_hot(0)
   [0.0 0.0 5.0]  // one_hot(2)
   [0.0 0.0 0.0]  // one_hot(-1)
   [0.0 5.0 0.0]  // one_hot(1)
 

Suppose that

indices = [0, 2, -1, 1]
   depth = 3
   on_value = 0.0
   off_value = 3.0
   axis = 0
 

Then output is `[3 x 4]`:

output =
   [0.0 3.0 3.0 3.0]
   [3.0 3.0 3.0 0.0]
   [3.0 3.0 3.0 3.0]
   [3.0 0.0 3.0 3.0]
 //  ^                one_hot(0)
 //      ^            one_hot(2)
 //          ^        one_hot(-1)
 //              ^    one_hot(1)
 

Suppose that

indices = [[0, 2], [1, -1]]
   depth = 3
   on_value = 1.0
   off_value = 0.0
   axis = -1
 

Then output is `[2 x 2 x 3]`:

output =
   [
     [1.0, 0.0, 0.0]  // one_hot(0)
     [0.0, 0.0, 1.0]  // one_hot(2)
   ][
     [0.0, 1.0, 0.0]  // one_hot(1)
     [0.0, 0.0, 0.0]  // one_hot(-1)
   ]
 

Nested Classes

class

OneHot.Options

Optional attributes for OneHot

Constants

String

OP_NAME

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

Public Methods

Output<U>	asOutput() Returns the symbolic handle of the tensor.
static OneHot.Options	axis(Long axis)
static <U extends TType> OneHot<U>	create(Scope scope, Operand<? extends TNumber> indices, Operand<TInt32> depth, Operand<U> onValue, Operand<U> offValue, Options... options) Factory method to create a class wrapping a new OneHot operation.
Output<U>	output() The one-hot tensor.

Inherited Methods

From class 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()

From class java.lang.Object

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()

From interface 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.

From interface org.tensorflow.Operand

abstract Output<U extends TType>	asOutput() Returns the symbolic handle of the tensor.
abstract U extends TType	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<U extends TType>	type() Returns the tensor type of this operand

From interface 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.