Skip to content

added docstring for compute and apply gradients #2926

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 17, 2020
Merged

added docstring for compute and apply gradients #2926

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
80a1596
added docstring for compute and apply gradients
dhirensr Mar 18, 2020
18e21b3
Merge branch 'master' into T2897
pyu10055 Jul 17, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions tfjs-core/src/optimizers/optimizer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ export abstract class Optimizer extends Serializable {
* respect to. If specified, only the trainable variables in varList will have
* gradients computed with respect to. Defaults to all trainable variables.
*/
/** @doc {heading: 'Training', subheading: 'Optimizers'} */
computeGradients(f: () => Scalar, varList?: Variable[]):
{value: Scalar, grads: NamedTensorMap} {
return variableGrads(f, varList);
Expand All @@ -113,6 +114,7 @@ export abstract class Optimizer extends Serializable {
*
* @param variableGradients A mapping of variable name to its gradient value.
*/
/** @doc {heading: 'Training', subheading: 'Optimizers'} */
abstract applyGradients(variableGradients: NamedTensorMap|
NamedTensor[]): void;

Expand Down