<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/models/blob/v2.20.0/official/modeling/optimization/optimizer_factory.py#L76-L100) |

Register customize optimizer cls.

#### View aliases


**Main aliases**

[`tfm.optimization.optimizer_factory.register_optimizer_cls`](https://www.tensorflow.org/api_docs/python/tfm/optimization/register_optimizer_cls)

<br />

    tfm.optimization.register_optimizer_cls(
        key: str,
        optimizer_config_cls: Union[tf_keras.optimizers.Optimizer, tf_keras.optimizers.legacy.Optimizer,
            tf_keras.optimizers.experimental.Optimizer],
        use_legacy_optimizer: bool = True
    )

The user will still need to subclass data classes in
configs.optimization_config to be used with OptimizerFactory.

<br />

<br />

<br />

| ## Args ||
|---|---|
| `key` | A string to that the optimizer_config_cls is registered with. |
| `optimizer_config_cls` | A class which inherits tf_keras.optimizers.Optimizer. |
| `use_legacy_optimizer` | A boolean that indicates if using legacy optimizers. |

<br />