# tff.learning.optimizers.build_sgdm

<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/federated/blob/v0.87.0 Version 2.0, January 2004 Licensed under the Apache License, Version 2.0 (the) |

Returns a [`tff.learning.optimizers.Optimizer`](https://www.tensorflow.org/federated/api_docs/python/tff/learning/optimizers/Optimizer) for momentum SGD.

    tff.learning.optimizers.build_sgdm(
        learning_rate: optimizer.Float = 0.01,
        momentum: Optional[optimizer.Float] = None
    ) -> https://www.tensorflow.org/federated/api_docs/python/tff/learning/optimizers/Optimizer

### Used in the notebooks

| Used in the tutorials |
|---|
| - [Federated Reconstruction for Matrix Factorization](https://www.tensorflow.org/federated/tutorials/federated_reconstruction_for_matrix_factorization) - [Federated Learning for Image Classification](https://www.tensorflow.org/federated/tutorials/federated_learning_for_image_classification) - [Composing Learning Algorithms](https://www.tensorflow.org/federated/tutorials/composing_learning_algorithms) - [Differential Privacy in TFF](https://www.tensorflow.org/federated/tutorials/federated_learning_with_differential_privacy) - [TFF simulations with accelerators](https://www.tensorflow.org/federated/tutorials/simulations_with_accelerators) |

This class supports the simple gradient descent and its variant with momentum.

If momentum is not used, the update rule given learning rate `lr`, weights `w`
and gradients `g` is:

    w = w - lr * g

If momentum `m` (a float between `0.0` and `1.0`) is used, the update rule is

    v = m * v + g
    w = w - lr * v

where `v` is the velocity from previous steps of the optimizer.

<br />

<br />

<br />

| ## Args ||
|---|---|
| `learning_rate` | A positive float for learning rate, default to 0.01. |
| `momentum` | An optional float between 0.0 and 1.0. If `None`, no momentum is used. |

<br />