mirror of https://github.com/tensorflow/addons.git
README.md
Addons - Optimizers
Components
https://www.tensorflow.org/addons/api_docs/python/tfa/optimizers
Contribution Guidelines
Standard API
In order to conform with the current API standard, all optimizers must:
- Inherit from either
keras.optimizer_v2.OptimizerV2or its subclasses. - Register as a keras global object so it can be serialized properly:
@tf.keras.utils.register_keras_serializable(package='Addons')
Testing Requirements
- To run your
tf.functionsin eager mode and graph mode in the tests, you can use the@pytest.mark.usefixtures("maybe_run_functions_eagerly")decorator. This will run the tests twice, once normally, and once withtf.config.run_functions_eagerly(True).
Documentation Requirements
- Update the CODEOWNERS file