Class ApplyFtrl<T extends TType>

java.lang.Object

org.tensorflow.op.RawOp

org.tensorflow.op.train.ApplyFtrl<T>

All Implemented Interfaces:

Shaped, Op, Operand<T>

@Operator(group="train")
public final class ApplyFtrl<T extends TType>
extends RawOp
implements Operand<T>

Update '*var' according to the Ftrl-proximal scheme. grad_with_shrinkage = grad + 2 * l2_shrinkage * var accum_new = accum + grad * grad linear += grad_with_shrinkage - (accum_new^(-lr_power) - accum^(-lr_power)) / lr * var quadratic = 1.0 / (accum_new^(lr_power) * lr) + 2 * l2 var = (sign(linear) * l1 - linear) / quadratic if |linear| > l1 else 0.0 accum = accum_new

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ApplyFtrl.Inputs<T extends TType>
static class	ApplyFtrl.Options	Optional attributes for ApplyFtrl

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OP_NAME	The name of this op, as known by TensorFlow core engine

Fields inherited from class RawOp

operation

Modifier and Type	Field	Description
protected final Operation	operation

Constructor Summary

Constructors

Constructor	Description
ApplyFtrl(Operation operation)

Method Summary

Modifier and Type	Method	Description
Output<T>	asOutput()	Returns the symbolic handle of the tensor.
static <T extends TType> ApplyFtrl<T>	create(Scope scope, Operand<T> var, Operand<T> accum, Operand<T> linear, Operand<T> grad, Operand<T> lr, Operand<T> l1, Operand<T> l2, Operand<T> l2Shrinkage, Operand<T> lrPower, ApplyFtrl.Options... options)	Factory method to create a class wrapping a new ApplyFtrlV2 operation.
static ApplyFtrl.Options	multiplyLinearByLr(Boolean multiplyLinearByLr)	Sets the multiplyLinearByLr option.
Output<T>	out()	Gets out.
static ApplyFtrl.Options	useLocking(Boolean useLocking)	Sets the useLocking option.

Methods inherited from class RawOp

equals, hashCode, op, toString

Modifier and Type	Method	Description
final boolean	equals(Object obj)
final int	hashCode()
Operation	op()	Return this unit of computation as a single Operation.
final String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Op

env

Modifier and Type	Method	Description
default ExecutionEnvironment	env()	Return the execution environment this op was created in.

Methods inherited from interface Operand

asTensor, shape, type

Modifier and Type	Method	Description
default T	asTensor()	Returns the tensor at this operand.
default Shape	shape()	Returns the (possibly partially known) shape of the tensor referred to by the Output of this operand.
default Class<T>	type()	Returns the tensor type of this operand

Methods inherited from interface Shaped

rank, size

Modifier and Type	Method	Description
default int	rank()
default long	size()	Computes and returns the total size of this container, in number of values.

Field Details

OP_NAME

public static final String OP_NAME

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

See Also:

• Constant Field Values

Constructor Details

ApplyFtrl

public ApplyFtrl(Operation operation)

Method Details

create

@Endpoint(describeByClass=true)
public static <T extends TType> ApplyFtrl<T> create(Scope scope,
 Operand<T> var,
 Operand<T> accum,
 Operand<T> linear,
 Operand<T> grad,
 Operand<T> lr,
 Operand<T> l1,
 Operand<T> l2,
 Operand<T> l2Shrinkage,
 Operand<T> lrPower,
 ApplyFtrl.Options... options)

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

Type Parameters:

T - data type for ApplyFtrlV2 output and operands

Parameters:

scope - current scope

var - Should be from a Variable().

accum - Should be from a Variable().

linear - Should be from a Variable().

grad - The gradient.

lr - Scaling factor. Must be a scalar.

l1 - L1 regularization. Must be a scalar.

l2 - L2 shrinkage regularization. Must be a scalar.

l2Shrinkage - The l2Shrinkage value

lrPower - Scaling factor. Must be a scalar.

options - carries optional attribute values

Returns:

a new instance of ApplyFtrl

useLocking

public static ApplyFtrl.Options useLocking(Boolean useLocking)

Sets the useLocking option.

Parameters:

useLocking - If True, updating of the var and accum tensors will be protected by a lock; otherwise the behavior is undefined, but may exhibit less contention.

Returns:

this Options instance.

multiplyLinearByLr

public static ApplyFtrl.Options multiplyLinearByLr(Boolean multiplyLinearByLr)

Sets the multiplyLinearByLr option.

Parameters:

multiplyLinearByLr - the multiplyLinearByLr option

Returns:

this Options instance.

out

public Output<T> out()

Gets out. Same as "var".

Returns:

out.

asOutput

public Output<T> asOutput()

Description copied from interface: Operand

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.

Specified by:

asOutput in interface Operand<T extends TType>

See Also:

• OperationBuilder.addInput(Output)