felixbenning / tensorflow-optimizer

My Custom Tensorflow Optimizer

This is a template mockup for for a custom tensorflow optimizer see Plugin-able Optimizers #49895. Replace this with a short description of your Optimizer.

Template Usage

• Replace all occurances of my-optimizer with your pip package name
• Replace all occurances of MyOptimizer with the class name of your optimizer
• Replace all occurances of my_optimizer with the name of your implementation file (or package) and rename the implementation template.
• Write your Optimizer
• fix the **hyperparemeters in this README.
• Delete this Section from the README and modify the remaining sections

Installation

pip install my-optimizer

Usage

import tensorflow as tf
from tensorflow.optimizers import MyOptimizer

inputs = tf.keras.layers.Input(shape=(3,))
outputs = tf.keras.layers.Dense(2)(inputs)
model = tf.keras.models.Model(inputs=inputs, outputs=outputs)
model.compile(
   optimizer=MyOptimizer(**hyperparameters), 
   loss="mse", 
   metrics=["mae"]
)

Details

Mathematical Details of the Optimizer.

How to Cite

Bibtex / DOI / etc.