optimizer.registry.OptimizerRegistry Class Reference

Static Public Member Functions
	create_optimizer (name)
	map_optimizer_to_enum (optimizer_instance)

Static Protected Attributes
dict	_optimizers = {"adam": Adam, "sgd": SGD}

Detailed Description

Registry for creating optimizers by name.

Definition at line 6 of file registry.py.

Member Function Documentation

create_optimizer()

optimizer.registry.OptimizerRegistry.create_optimizer (   name )

static

Create an optimizer instance by name.
Args:
    name (str): Name of the optimizer.
Returns:
    BaseOptimizer: Optimizer instance.

Definition at line 13 of file registry.py.

    def create_optimizer(name):
        """
        Create an optimizer instance by name.
        Args:
            name (str): Name of the optimizer.
        Returns:
            BaseOptimizer: Optimizer instance.
        """
        if name not in OptimizerRegistry._optimizers:
            raise ValueError(
                f"Unknown Optimizer: {name}. Custom optimizer is not supported yet")
        return OptimizerRegistry._optimizers[name]()
 

map_optimizer_to_enum()

optimizer.registry.OptimizerRegistry.map_optimizer_to_enum (   optimizer_instance )

static

Maps an optimizer instance to the appropriate enum value.
Args:
    optimizer_instance (Optimizer): An instance of an optimizer.
Returns:
    optimizer_type: Corresponding enum value for the optimizer.
Raises:
    TypeError: If the optimizer_instance is not a recognized optimizer type.

Definition at line 27 of file registry.py.

    def map_optimizer_to_enum(optimizer_instance):
        """
        Maps an optimizer instance to the appropriate enum value.
        Args:
            optimizer_instance (Optimizer): An instance of an optimizer.
        Returns:
            optimizer_type: Corresponding enum value for the optimizer.
        Raises:
            TypeError: If the optimizer_instance is not a recognized optimizer type.
        """
        # Optimizer to Enum mapping
        optimizer_to_enum = {SGD: optimizer_type.SGD, Adam: optimizer_type.ADAM}
        for optimizer_class, enum_value in optimizer_to_enum.items():
            if isinstance(optimizer_instance, optimizer_class):
                return enum_value
        raise TypeError(
            f"Unsupported optimizer type: {type(optimizer_instance).__name__}. "
            f"Supported types are: {list(optimizer_to_enum.keys())}.")

Field Documentation

_optimizers

dict optimizer.registry.OptimizerRegistry._optimizers = {"adam": Adam, "sgd": SGD}

staticprotected

Definition at line 10 of file registry.py.

---

The documentation for this class was generated from the following file:

• runtime/onert/api/python/package/experimental/train/optimizer/registry.py