Stay organized with collections
Save and categorize content based on your preferences.
tensorflow::ops::ResourceSparseApplyFtrlV2
#include <training_ops.h>
Update relevant entries in '*var' according to the Ftrl-proximal scheme.
Summary
That is for rows we have grad for, we update var, accum and linear as follows: grad_with_shrinkage = grad + 2 * l2_shrinkage * var accum_new = accum + grad_with_shrinkage * grad_with_shrinkage 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
Args:
- scope: A Scope object
- var: Should be from a Variable().
- accum: Should be from a Variable().
- linear: Should be from a Variable().
- grad: The gradient.
- indices: A vector of indices into the first dimension of var and accum.
- lr: Scaling factor. Must be a scalar.
- l1: L1 regularization. Must be a scalar.
- l2: L2 shrinkage regularization. Must be a scalar.
- lr_power: Scaling factor. Must be a scalar.
Optional attributes (see Attrs):
- use_locking: 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:
Constructors and Destructors
|
ResourceSparseApplyFtrlV2(const ::tensorflow::Scope & scope, ::tensorflow::Input var, ::tensorflow::Input accum, ::tensorflow::Input linear, ::tensorflow::Input grad, ::tensorflow::Input indices, ::tensorflow::Input lr, ::tensorflow::Input l1, ::tensorflow::Input l2, ::tensorflow::Input l2_shrinkage, ::tensorflow::Input lr_power)
|
ResourceSparseApplyFtrlV2(const ::tensorflow::Scope & scope, ::tensorflow::Input var, ::tensorflow::Input accum, ::tensorflow::Input linear, ::tensorflow::Input grad, ::tensorflow::Input indices, ::tensorflow::Input lr, ::tensorflow::Input l1, ::tensorflow::Input l2, ::tensorflow::Input l2_shrinkage, ::tensorflow::Input lr_power, const ResourceSparseApplyFtrlV2::Attrs & attrs)
|
Public attributes
Public functions
ResourceSparseApplyFtrlV2
ResourceSparseApplyFtrlV2(
const ::tensorflow::Scope & scope,
::tensorflow::Input var,
::tensorflow::Input accum,
::tensorflow::Input linear,
::tensorflow::Input grad,
::tensorflow::Input indices,
::tensorflow::Input lr,
::tensorflow::Input l1,
::tensorflow::Input l2,
::tensorflow::Input l2_shrinkage,
::tensorflow::Input lr_power
)
ResourceSparseApplyFtrlV2
ResourceSparseApplyFtrlV2(
const ::tensorflow::Scope & scope,
::tensorflow::Input var,
::tensorflow::Input accum,
::tensorflow::Input linear,
::tensorflow::Input grad,
::tensorflow::Input indices,
::tensorflow::Input lr,
::tensorflow::Input l1,
::tensorflow::Input l2,
::tensorflow::Input l2_shrinkage,
::tensorflow::Input lr_power,
const ResourceSparseApplyFtrlV2::Attrs & attrs
)
operator::tensorflow::Operation
operator::tensorflow::Operation() const
Public static functions
MultiplyLinearByLr
Attrs MultiplyLinearByLr(
bool x
)
UseLocking
Attrs UseLocking(
bool x
)
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates. Some content is licensed under the numpy license.
Last updated 2023-10-06 UTC.
[null,null,["Last updated 2023-10-06 UTC."],[],[],null,["# tensorflow::ops::ResourceSparseApplyFtrlV2 Class Reference\n\ntensorflow::ops::ResourceSparseApplyFtrlV2\n==========================================\n\n`#include \u003ctraining_ops.h\u003e`\n\nUpdate relevant entries in '\\*var' according to the Ftrl-proximal scheme.\n\nSummary\n-------\n\nThat is for rows we have grad for, we update var, accum and linear as follows: grad_with_shrinkage = grad + 2 \\* l2_shrinkage \\* var accum_new = accum + grad_with_shrinkage \\* grad_with_shrinkage 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\\| \\\u003e l1 else 0.0 accum = accum_new\n\nArgs:\n\n- scope: A [Scope](/versions/r2.14/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope) object\n- var: Should be from a Variable().\n- accum: Should be from a Variable().\n- linear: Should be from a Variable().\n- grad: The gradient.\n- indices: A vector of indices into the first dimension of var and accum.\n- lr: Scaling factor. Must be a scalar.\n- l1: L1 regularization. Must be a scalar.\n- l2: L2 shrinkage regularization. Must be a scalar.\n- lr_power: Scaling factor. Must be a scalar.\n\n\u003cbr /\u003e\n\nOptional attributes (see [Attrs](/versions/r2.14/api_docs/cc/struct/tensorflow/ops/resource-sparse-apply-ftrl-v2/attrs#structtensorflow_1_1ops_1_1_resource_sparse_apply_ftrl_v2_1_1_attrs)):\n\n- use_locking: 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\n\u003cbr /\u003e\n\nReturns:\n\n- the created [Operation](/versions/r2.14/api_docs/cc/class/tensorflow/operation#classtensorflow_1_1_operation)\n\n\u003cbr /\u003e\n\n| ### Constructors and Destructors ||\n|---|---|\n| [ResourceSparseApplyFtrlV2](#classtensorflow_1_1ops_1_1_resource_sparse_apply_ftrl_v2_1a77306a45450ada78aafa759f7b197723)`(const ::`[tensorflow::Scope](/versions/r2.14/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope)` & scope, ::`[tensorflow::Input](/versions/r2.14/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input)` var, ::`[tensorflow::Input](/versions/r2.14/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input)` accum, ::`[tensorflow::Input](/versions/r2.14/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input)` linear, ::`[tensorflow::Input](/versions/r2.14/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input)` grad, ::`[tensorflow::Input](/versions/r2.14/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input)` indices, ::`[tensorflow::Input](/versions/r2.14/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input)` lr, ::`[tensorflow::Input](/versions/r2.14/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input)` l1, ::`[tensorflow::Input](/versions/r2.14/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input)` l2, ::`[tensorflow::Input](/versions/r2.14/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input)` l2_shrinkage, ::`[tensorflow::Input](/versions/r2.14/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input)` lr_power)` ||\n| [ResourceSparseApplyFtrlV2](#classtensorflow_1_1ops_1_1_resource_sparse_apply_ftrl_v2_1a76e64a98f17ed91ba2513c27b045eb40)`(const ::`[tensorflow::Scope](/versions/r2.14/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope)` & scope, ::`[tensorflow::Input](/versions/r2.14/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input)` var, ::`[tensorflow::Input](/versions/r2.14/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input)` accum, ::`[tensorflow::Input](/versions/r2.14/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input)` linear, ::`[tensorflow::Input](/versions/r2.14/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input)` grad, ::`[tensorflow::Input](/versions/r2.14/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input)` indices, ::`[tensorflow::Input](/versions/r2.14/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input)` lr, ::`[tensorflow::Input](/versions/r2.14/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input)` l1, ::`[tensorflow::Input](/versions/r2.14/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input)` l2, ::`[tensorflow::Input](/versions/r2.14/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input)` l2_shrinkage, ::`[tensorflow::Input](/versions/r2.14/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input)` lr_power, const `[ResourceSparseApplyFtrlV2::Attrs](/versions/r2.14/api_docs/cc/struct/tensorflow/ops/resource-sparse-apply-ftrl-v2/attrs#structtensorflow_1_1ops_1_1_resource_sparse_apply_ftrl_v2_1_1_attrs)` & attrs)` ||\n\n| ### Public attributes ||\n|-----------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------|\n| [operation](#classtensorflow_1_1ops_1_1_resource_sparse_apply_ftrl_v2_1a392e0892ef99d41bc86397a57df9a98f) | [Operation](/versions/r2.14/api_docs/cc/class/tensorflow/operation#classtensorflow_1_1_operation) |\n\n| ### Public functions ||\n|--------------------------------------------------------------------------------------------------------------------------------------------|---|\n| [operator::tensorflow::Operation](#classtensorflow_1_1ops_1_1_resource_sparse_apply_ftrl_v2_1afba48dacb7460dfeb6303226504eec7e)`() const ` | |\n\n| ### Public static functions ||\n|------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [MultiplyLinearByLr](#classtensorflow_1_1ops_1_1_resource_sparse_apply_ftrl_v2_1a6538eb563c2ac53a5b55762289706098)`(bool x)` | [Attrs](/versions/r2.14/api_docs/cc/struct/tensorflow/ops/resource-sparse-apply-ftrl-v2/attrs#structtensorflow_1_1ops_1_1_resource_sparse_apply_ftrl_v2_1_1_attrs) |\n| [UseLocking](#classtensorflow_1_1ops_1_1_resource_sparse_apply_ftrl_v2_1a5a50996a22963c9d267ae9f2b76fa63c)`(bool x)` | [Attrs](/versions/r2.14/api_docs/cc/struct/tensorflow/ops/resource-sparse-apply-ftrl-v2/attrs#structtensorflow_1_1ops_1_1_resource_sparse_apply_ftrl_v2_1_1_attrs) |\n\n| ### Structs ||\n|--------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [tensorflow::ops::ResourceSparseApplyFtrlV2::Attrs](/versions/r2.14/api_docs/cc/struct/tensorflow/ops/resource-sparse-apply-ftrl-v2/attrs) | Optional attribute setters for [ResourceSparseApplyFtrlV2](/versions/r2.14/api_docs/cc/class/tensorflow/ops/resource-sparse-apply-ftrl-v2#classtensorflow_1_1ops_1_1_resource_sparse_apply_ftrl_v2). |\n\nPublic attributes\n-----------------\n\n### operation\n\n```text\nOperation operation\n``` \n\nPublic functions\n----------------\n\n### ResourceSparseApplyFtrlV2\n\n```gdscript\n ResourceSparseApplyFtrlV2(\n const ::tensorflow::Scope & scope,\n ::tensorflow::Input var,\n ::tensorflow::Input accum,\n ::tensorflow::Input linear,\n ::tensorflow::Input grad,\n ::tensorflow::Input indices,\n ::tensorflow::Input lr,\n ::tensorflow::Input l1,\n ::tensorflow::Input l2,\n ::tensorflow::Input l2_shrinkage,\n ::tensorflow::Input lr_power\n)\n``` \n\n### ResourceSparseApplyFtrlV2\n\n```gdscript\n ResourceSparseApplyFtrlV2(\n const ::tensorflow::Scope & scope,\n ::tensorflow::Input var,\n ::tensorflow::Input accum,\n ::tensorflow::Input linear,\n ::tensorflow::Input grad,\n ::tensorflow::Input indices,\n ::tensorflow::Input lr,\n ::tensorflow::Input l1,\n ::tensorflow::Input l2,\n ::tensorflow::Input l2_shrinkage,\n ::tensorflow::Input lr_power,\n const ResourceSparseApplyFtrlV2::Attrs & attrs\n)\n``` \n\n### operator::tensorflow::Operation\n\n```gdscript\n operator::tensorflow::Operation() const \n``` \n\nPublic static functions\n-----------------------\n\n### MultiplyLinearByLr\n\n```text\nAttrs MultiplyLinearByLr(\n bool x\n)\n``` \n\n### UseLocking\n\n```text\nAttrs UseLocking(\n bool x\n)\n```"]]
