grilly.optim.base

Base Optimizer class (PyTorch-like)

Similar to torch.optim.Optimizer

Classes

Any(*args, **kwargs)	Special type indicating an unconstrained type.
Iterator()
Optimizer(params, defaults)	Base class for all optimizers.

class grilly.optim.base.Optimizer(params, defaults)

Bases: object

Base class for all optimizers.

Similar to torch.optim.Optimizer, but works with numpy arrays and GPU-accelerated operations via Vulkan shaders.

Initialize optimizer.

Parameters

• params (Iterator[numpy.ndarray]) – Iterator of parameter arrays to optimize

• defaults (dict[str, Any]) – Dictionary of default hyperparameter values

__init__(params, defaults)

Initialize optimizer.

Parameters

• params (Iterator[numpy.ndarray]) – Iterator of parameter arrays to optimize

• defaults (dict[str, Any]) – Dictionary of default hyperparameter values

Dependencies: numpy.

Variables: params (collections.abc.Iterator[numpy.ndarray], required); defaults (dict[str, typing.Any], required).

Usage Example

import numpy as np
from grilly.optim.base import Optimizer

instance = Optimizer(...)
result = instance.__init__(params=np.zeros(1, dtype=np.float32), defaults='example')

zero_grad()

Clear gradients for all parameters.

Note: In this implementation, gradients are expected to be stored in a separate structure (e.g., in the model’s backward pass). This method is provided for API compatibility.

Dependencies: None detected from callable globals.

Variables: This callable does not take explicit input variables.

Usage Example

from grilly.optim.base import Optimizer

instance = Optimizer(...)
result = instance.zero_grad()

step(closure=None)

Perform a single optimization step.

Parameters

closure – Optional closure that reevaluates the model and returns loss

Must be implemented by subclasses.

Dependencies: None detected from callable globals.

Variables: closure (Any, optional, default None).

Usage Example

from grilly.optim.base import Optimizer

instance = Optimizer(...)
result = instance.step(closure=None)

state_dict()

Return the state of the optimizer as a dict.

Returns

Dictionary containing optimizer state

Return type

dict[str, Any]

Dependencies: None detected from callable globals.

Variables: This callable does not take explicit input variables.

Usage Example

from grilly.optim.base import Optimizer

instance = Optimizer(...)
result = instance.state_dict()

load_state_dict(state_dict)

Load optimizer state from state_dict.

Parameters

state_dict (dict[str, Any]) – Dictionary containing optimizer state

Dependencies: None detected from callable globals.

Variables: state_dict (dict[str, typing.Any], required).

Usage Example

from grilly.optim.base import Optimizer

instance = Optimizer(...)
result = instance.load_state_dict(state_dict='example')