mirror of
https://github.com/nerfstudio-project/nerfstudio.git
synced 2026-11-21 23:25:39 +08:00
Update docstrings and add missing types
This commit is contained in:
1 parent
b725d5dafa
commit
f77d1fc110
7 files changed
+184
-136
No files matched your search
@@ -31,11 +31,11 @@ def setup_optimizers(config: DictConfig, param_groups: Dict[str, List[Parameter]
|
||||
"""Helper to set up the optimizers
|
||||
|
||||
Args:
|
||||
config (DictConfig): _description_
|
||||
param_groups (Dict[str, List[Parameter]]): _description_
|
||||
config: The optimizer configuration object.
|
||||
param_groups: A dictionary of parameter groups to optimize.
|
||||
|
||||
Returns:
|
||||
Optimizers: _description_
|
||||
The optimizers object.
|
||||
"""
|
||||
return Optimizers(config, param_groups)
|
||||
|
||||
@@ -45,6 +45,14 @@ class ExponentialDecaySchedule(LambdaLR):
|
||||
See https://github.com/google-research/google-research/blob/
|
||||
fd2cea8cdd86b3ed2c640cbe5561707639e682f3/jaxnerf/nerf/utils.py#L360
|
||||
for details.
|
||||
|
||||
Args:
|
||||
optimizer: The optimizer to update.
|
||||
lr_init: The initial learning rate.
|
||||
lr_final: The final learning rate.
|
||||
max_steps: The maximum number of steps.
|
||||
lr_delay_steps: The number of steps to delay the learning rate. Default is 0.
|
||||
lr_delay_mult: The multiplier for the learning rate after the delay. Default is 1.0.
|
||||
"""
|
||||
|
||||
def __init__(self, optimizer, lr_init, lr_final, max_steps, lr_delay_steps=0, lr_delay_mult=1.0) -> None:
|
||||
@@ -66,15 +74,14 @@ class ExponentialDecaySchedule(LambdaLR):
|
||||
|
||||
|
||||
class Optimizers:
|
||||
"""_summary_"""
|
||||
"""A set of optimizers.
|
||||
|
||||
Args:
|
||||
config: The optimizer configuration object.
|
||||
param_groups: A dictionary of parameter groups to optimize.
|
||||
"""
|
||||
|
||||
def __init__(self, config: DictConfig, param_groups: Dict[str, List[Parameter]]):
|
||||
"""_summary_
|
||||
|
||||
Args:
|
||||
config (DictConfig): _description_
|
||||
param_dict (Dict[str, List[Parameter]]): _description_
|
||||
"""
|
||||
self.config = config
|
||||
self.optimizers = {}
|
||||
self.schedulers = {}
|
||||
@@ -87,35 +94,39 @@ class Optimizers:
|
||||
)
|
||||
|
||||
def optimizer_step(self, param_group_name: str) -> None:
|
||||
"""fetch and step corresponding optimizer
|
||||
"""Fetch and step corresponding optimizer.
|
||||
|
||||
Args:
|
||||
param_group_name (str): name of optimizer to step forward
|
||||
param_group_name: name of optimizer to step forward
|
||||
"""
|
||||
self.optimizers[param_group_name].step()
|
||||
|
||||
def scheduler_step(self, param_group_name: str) -> None:
|
||||
"""fetch and step corresponding scheduler
|
||||
"""Fetch and step corresponding scheduler.
|
||||
|
||||
Args:
|
||||
param_group_name (str): name of scheduler to step forward
|
||||
param_group_name: name of scheduler to step forward
|
||||
"""
|
||||
if self.config.param_group_name.scheduler:
|
||||
self.schedulers[param_group_name].step()
|
||||
|
||||
def zero_grad_all(self):
|
||||
"""zero the gradients for all optimizer parameters"""
|
||||
def zero_grad_all(self) -> None:
|
||||
"""Zero the gradients for all optimizer parameters."""
|
||||
for _, optimizer in self.optimizers.items():
|
||||
optimizer.zero_grad()
|
||||
|
||||
def optimizer_step_all(self):
|
||||
def optimizer_step_all(self) -> None:
|
||||
"""Run step for all optimizers."""
|
||||
for _, optimizer in self.optimizers.items():
|
||||
# note that they key is the parameter name
|
||||
optimizer.step()
|
||||
|
||||
def scheduler_step_all(self, step):
|
||||
"""Run step for all schedulers."""
|
||||
def scheduler_step_all(self, step: int) -> None:
|
||||
"""Run step for all schedulers.
|
||||
|
||||
Args:
|
||||
step: the current step
|
||||
"""
|
||||
for param_group_name, scheduler in self.schedulers.items():
|
||||
scheduler.step()
|
||||
# TODO(ethan): clean this up. why is there indexing into a list?
|
||||
@@ -123,6 +134,10 @@ class Optimizers:
|
||||
writer.put_scalar(name=f"learning_rate/{param_group_name}", scalar=lr, step=step)
|
||||
|
||||
def load_optimizers(self, loaded_state: Dict[str, Any]) -> None:
|
||||
"""Helper to load the optimizer state from previous checkpoint"""
|
||||
"""Helper to load the optimizer state from previous checkpoint
|
||||
|
||||
Args:
|
||||
loaded_state: the state from the previous checkpoint
|
||||
"""
|
||||
for k, v in loaded_state["optimizers"].items():
|
||||
self.optimizers[k].load_state_dict(v)
|
||||
Reference in new issue
Block a user