# coding=utf-8
# Copyright 2019 The Tensor2Tensor Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""gin-configurable optimizers and learning rate functions."""

from __future__ import absolute_import
from __future__ import division
from __future__ import print_function

import gin

from jax.experimental import optimizers as opt


def opt_configure(*args, **kwargs):
  kwargs["module"] = "trax.optimizers"
  return gin.external_configurable(*args, **kwargs)

# Optimizers
sgd = opt_configure(opt.sgd)
adam = opt_configure(opt.adam)
momentum = opt_configure(opt.momentum)
rmsprop = opt_configure(opt.rmsprop)

# Learning rates
constant = opt_configure(opt.constant)
exponential_decay = opt_configure(opt.exponential_decay)
inverse_time_decay = opt_configure(opt.inverse_time_decay)
piecewise_constant = opt_configure(opt.piecewise_constant)
