package.experimental.train.optimizer.registry.OptimizerRegistry Class Reference

Static Public Member Functions
Optimizer	create_optimizer (str name)
optimizer_type	map_optimizer_to_enum (Optimizer optimizer_instance)

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

Detailed Description

Registry for creating optimizers by name.

Definition at line 8 of file registry.py.

Member Function Documentation

create_optimizer()

Optimizer package.experimental.train.optimizer.registry.OptimizerRegistry.create_optimizer ( str  name )

static

Create an optimizer instance by name.

Args:
    name (str): Name of the optimizer.

Returns:
    Optimizer: Optimizer instance.

Definition at line 15 of file registry.py.

    def create_optimizer(name: str) -> Optimizer:
        """
        Create an optimizer instance by name.
 
        Args:
            name (str): Name of the optimizer.
 
        Returns:
            Optimizer: 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_type package.experimental.train.optimizer.registry.OptimizerRegistry.map_optimizer_to_enum ( Optimizer  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 31 of file registry.py.

    def map_optimizer_to_enum(optimizer_instance: Optimizer) -> optimizer_type:
        """
        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: Dict[Type[Optimizer], optimizer_type] = {
            SGD: optimizer_type.SGD,
            Adam: optimizer_type.ADAM
        }
        for cls, enum_val in optimizer_to_enum.items():
            if isinstance(optimizer_instance, cls):
                return enum_val
        raise TypeError(
            f"Unsupported optimizer type: {type(optimizer_instance).__name__}. "
            f"Supported types are: {list(optimizer_to_enum.keys())}.")

Field Documentation

_optimizers

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

staticprotected

Definition at line 12 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