That is for rows we have grad for, we update var, accum and linear as follows:
Args
var
A mutable Tensor. Must be one of the following types: float32, float64, int32, uint8, int16, int8, complex64, int64, qint8, quint8, qint32, bfloat16, qint16, quint16, uint16, complex128, half, uint32, uint64.
Should be from a Variable().
accum
A mutable Tensor. Must have the same type as var.
Should be from a Variable().
linear
A mutable Tensor. Must have the same type as var.
Should be from a Variable().
grad
A Tensor. Must have the same type as var. The gradient.
indices
A Tensor. Must be one of the following types: int32, int64.
A vector of indices into the first dimension of var and accum.
lr
A Tensor. Must have the same type as var.
Scaling factor. Must be a scalar.
l1
A Tensor. Must have the same type as var.
L1 regularization. Must be a scalar.
l2
A Tensor. Must have the same type as var.
L2 regularization. Must be a scalar.
lr_power
A Tensor. Must have the same type as var.
Scaling factor. Must be a scalar.
use_locking
An optional bool. Defaults to False.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-04-26 UTC."],[],[],null,["# tf.raw_ops.SparseApplyFtrl\n\nUpdate relevant entries in '\\*var' according to the Ftrl-proximal scheme.\n\n#### View aliases\n\n\n**Compat aliases for migration**\n\nSee\n[Migration guide](https://www.tensorflow.org/guide/migrate) for\nmore details.\n\n[`tf.compat.v1.raw_ops.SparseApplyFtrl`](https://www.tensorflow.org/api_docs/python/tf/raw_ops/SparseApplyFtrl)\n\n\u003cbr /\u003e\n\n tf.raw_ops.SparseApplyFtrl(\n var,\n accum,\n linear,\n grad,\n indices,\n lr,\n l1,\n l2,\n lr_power,\n use_locking=False,\n multiply_linear_by_lr=False,\n name=None\n )\n\nThat is for rows we have grad for, we update var, accum and linear as follows:\n\n\\\\\\[accum_new = accum + grad \\* grad\\\\\\]\n\n\\\\\\[linear += grad + (accum_{new}\\^{-lr_{power} } - accum\\^{-lr_{power} } / lr \\* var\\\\\\]\n\n\\\\\\[quadratic = 1.0 / (accum_{new}\\^{lr_{power} } \\* lr) + 2 \\* l2\\\\\\]\n\n\\\\\\[var = (sign(linear) \\* l1 - linear) / quadratic\\\\ if\\\\ \\|linear\\| \\\u003e l1\\\\ else\\\\ 0.0\\\\\\]\n\n\\\\\\[accum = accum_{new}\\\\\\]\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Args ---- ||\n|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `var` | A mutable `Tensor`. Must be one of the following types: `float32`, `float64`, `int32`, `uint8`, `int16`, `int8`, `complex64`, `int64`, `qint8`, `quint8`, `qint32`, `bfloat16`, `qint16`, `quint16`, `uint16`, `complex128`, `half`, `uint32`, `uint64`. Should be from a Variable(). |\n| `accum` | A mutable `Tensor`. Must have the same type as `var`. Should be from a Variable(). |\n| `linear` | A mutable `Tensor`. Must have the same type as `var`. Should be from a Variable(). |\n| `grad` | A `Tensor`. Must have the same type as `var`. The gradient. |\n| `indices` | A `Tensor`. Must be one of the following types: `int32`, `int64`. A vector of indices into the first dimension of var and accum. |\n| `lr` | A `Tensor`. Must have the same type as `var`. Scaling factor. Must be a scalar. |\n| `l1` | A `Tensor`. Must have the same type as `var`. L1 regularization. Must be a scalar. |\n| `l2` | A `Tensor`. Must have the same type as `var`. L2 regularization. Must be a scalar. |\n| `lr_power` | A `Tensor`. Must have the same type as `var`. Scaling factor. Must be a scalar. |\n| `use_locking` | An optional `bool`. Defaults to `False`. 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. |\n| `multiply_linear_by_lr` | An optional `bool`. Defaults to `False`. |\n| `name` | A name for the operation (optional). |\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Returns ------- ||\n|---|---|\n| A mutable `Tensor`. Has the same type as `var`. ||\n\n\u003cbr /\u003e"]]
