Skip to content

Commit 52460d3

Browse files
authored
Revert breaking change in configure_optimizers return type (#20512)
1 parent c45c3c9 commit 52460d3

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

docs/source-pytorch/conf.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -464,8 +464,8 @@ def _load_py_module(name: str, location: str) -> ModuleType:
464464
("py:func", "lightning.pytorch.utilities.rank_zero.rank_zero_only"),
465465
("py:class", "lightning.pytorch.utilities.types.LRSchedulerConfig"),
466466
("py:class", "lightning.pytorch.utilities.types.LRSchedulerConfigType"),
467-
("py:class", "lightning.pytorch.utilities.types.OptimizerConfigType"),
468-
("py:class", "lightning.pytorch.utilities.types.OptimizerLRSchedulerConfigType"),
467+
("py:class", "lightning.pytorch.utilities.types.OptimizerConfig"),
468+
("py:class", "lightning.pytorch.utilities.types.OptimizerLRSchedulerConfig"),
469469
("py:class", "lightning_habana.pytorch.plugins.precision.HPUPrecisionPlugin"),
470470
("py:class", "lightning_habana.pytorch.strategies.HPUDDPStrategy"),
471471
("py:class", "lightning_habana.pytorch.strategies.HPUParallelStrategy"),

src/lightning/pytorch/utilities/types.py

+6-6
Original file line numberDiff line numberDiff line change
@@ -104,11 +104,11 @@ class LRSchedulerConfigType(TypedDict, total=False):
104104
strict: bool
105105

106106

107-
class OptimizerConfigType(TypedDict):
107+
class OptimizerConfig(TypedDict):
108108
optimizer: Optimizer
109109

110110

111-
class OptimizerLRSchedulerConfigType(TypedDict):
111+
class OptimizerLRSchedulerConfig(TypedDict):
112112
optimizer: Optimizer
113113
lr_scheduler: Union[LRSchedulerTypeUnion, LRSchedulerConfigType]
114114
monitor: NotRequired[str]
@@ -119,10 +119,10 @@ class OptimizerLRSchedulerConfigType(TypedDict):
119119
Optimizer,
120120
Sequence[Optimizer],
121121
tuple[Sequence[Optimizer], Sequence[Union[LRSchedulerTypeUnion, LRSchedulerConfig]]],
122-
OptimizerConfigType,
123-
OptimizerLRSchedulerConfigType,
124-
Sequence[OptimizerConfigType],
125-
Sequence[OptimizerLRSchedulerConfigType],
122+
OptimizerConfig,
123+
OptimizerLRSchedulerConfig,
124+
Sequence[OptimizerConfig],
125+
Sequence[OptimizerLRSchedulerConfig],
126126
]
127127
]
128128

0 commit comments

Comments
 (0)