ยป
API reference /
Optimizers /
Ftrl

`Ftrl`

class```
tf.keras.optimizers.Ftrl(
learning_rate=0.001,
learning_rate_power=-0.5,
initial_accumulator_value=0.1,
l1_regularization_strength=0.0,
l2_regularization_strength=0.0,
l2_shrinkage_regularization_strength=0.0,
beta=0.0,
weight_decay=None,
clipnorm=None,
clipvalue=None,
global_clipnorm=None,
use_ema=False,
ema_momentum=0.99,
ema_overwrite_frequency=None,
jit_compile=True,
name="Ftrl",
**kwargs
)
```

Optimizer that implements the FTRL algorithm.

"Follow The Regularized Leader" (FTRL) is an optimization algorithm developed at Google for click-through rate prediction in the early 2010s. It is most suitable for shallow models with large and sparse feature spaces. The algorithm is described by McMahan et al., 2013. The Keras version has support for both online L2 regularization (the L2 regularization described in the paper above) and shrinkage-type L2 regularization (which is the addition of an L2 penalty to the loss function).

Initialization:

```
n = 0
sigma = 0
z = 0
```

Update rule for one variable `w`

:

```
prev_n = n
n = n + g ** 2
sigma = (n ** -lr_power - prev_n ** -lr_power) / lr
z = z + g - sigma * w
if abs(z) < lambda_1:
w = 0
else:
w = (sgn(z) * lambda_1 - z) / ((beta + sqrt(n)) / alpha + lambda_2)
```

Notation:

`lr`

is the learning rate`g`

is the gradient for the variable`lambda_1`

is the L1 regularization strength`lambda_2`

is the L2 regularization strength`lr_power`

is the power to scale n.

Check the documentation for the `l2_shrinkage_regularization_strength`

parameter for more details when shrinkage is enabled, in which case gradient
is replaced with a gradient with shrinkage.

**Arguments**

**learning_rate**: A`Tensor`

, floating point value, a schedule that is a`tf.keras.optimizers.schedules.LearningRateSchedule`

, or a callable that takes no arguments and returns the actual value to use. The learning rate. Defaults to`0.001`

.**learning_rate_power**: A float value, must be less or equal to zero. Controls how the learning rate decreases during training. Use zero for a fixed learning rate.**initial_accumulator_value**: The starting value for accumulators. Only zero or positive values are allowed.**l1_regularization_strength**: A float value, must be greater than or equal to zero. Defaults to`0.0`

.**l2_regularization_strength**: A float value, must be greater than or equal to zero. Defaults to`0.0`

.**l2_shrinkage_regularization_strength**: A float value, must be greater than or equal to zero. This differs from L2 above in that the L2 above is a stabilization penalty, whereas this L2 shrinkage is a magnitude penalty. When input is sparse shrinkage will only happen on the active weights.**beta**: A float value, representing the beta value from the paper. Defaults to 0.0.**name**: String. The name to use for momentum accumulator weights created by the optimizer.**weight_decay**: Float, defaults to None. If set, weight decay is applied.**clipnorm**: Float. If set, the gradient of each weight is individually clipped so that its norm is no higher than this value.**clipvalue**: Float. If set, the gradient of each weight is clipped to be no higher than this value.**global_clipnorm**: Float. If set, the gradient of all weights is clipped so that their global norm is no higher than this value.**use_ema**: Boolean, defaults to False. If True, exponential moving average (EMA) is applied. EMA consists of computing an exponential moving average of the weights of the model (as the weight values change after each training batch), and periodically overwriting the weights with their moving average.**ema_momentum**: Float, defaults to 0.99. Only used if`use_ema=True`

. This is the momentum to use when computing the EMA of the model's weights:`new_average = ema_momentum * old_average + (1 - ema_momentum) * current_variable_value`

.**ema_overwrite_frequency**: Int or None, defaults to None. Only used if`use_ema=True`

. Every`ema_overwrite_frequency`

steps of iterations, we overwrite the model variable by its moving average. If None, the optimizer does not overwrite model variables in the middle of training, and you need to explicitly overwrite the variables at the end of training by calling`optimizer.finalize_variable_values()`

(which updates the model variables in-place). When using the built-in`fit()`

training loop, this happens automatically after the last epoch, and you don't need to do anything.**jit_compile**: Boolean, defaults to True. If True, the optimizer will use XLA compilation. If no GPU device is found, this flag will be ignored.**mesh**: optional`tf.experimental.dtensor.Mesh`

instance. When provided, the optimizer will be run in DTensor mode, e.g. state tracking variable will be a DVariable, and aggregation/reduction will happen in the global DTensor context.****kwargs**: keyword arguments only used for backward compatibility.