myco.optimizers

Routines and default settings for a series of model optimizers.

get_from_config(config)

Return an optimizer initialized with parameters from a myco model config.

Source code in myco/optimizers.py

def get_from_config(config: dict) -> tf.keras.optimizers.Optimizer:
    """Return an optimizer initialized with parameters from a myco model config."""
    # handle passing the full config object or just the "optimizer" config
    if "optimizer" in config:
        config = config["optimizer"].copy()

    name = config.pop("name")
    optimizer = get_optimizer(name)
    return optimizer(**config)

get_names()

Return a list of valid model architecture names

Source code in myco/optimizers.py

def get_names():
    """Return a list of valid model architecture names"""
    return list(SUPPORTED.keys())

get_optimizer(name)

Return an optimizer class that can be initialized with parameter values

Parameters:

Name	Type	Description	Default
name	str	the optimizer. Get available options from get_optimizer_names().	required

Returns:

Type	Description
tf.keras.optimizers.Optimizer	A callable optimizer object.

Example

adam = get_optimizer('adam') opt = adam(learning_rate=0.01)

Source code in myco/optimizers.py

def get_optimizer(name: str) -> tf.keras.optimizers.Optimizer:
    """Return an optimizer class that can be initialized with parameter values

    Args:
        name: the optimizer. Get available options from get_optimizer_names().

    Returns:
        A callable optimizer object.

    Example:
        adam = get_optimizer('adam')
        opt = adam(learning_rate=0.01)
    """
    assert name in get_names(), f"Invalid optimizer: {name}"
    return SUPPORTED[name]