# composite_scheduler

Python API: `luxonis_train.schedulers.composite_scheduler`

这些调度器协同调度
[CompositeOptimizer](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/optimizers/composite_optimizer.md)
的成员调度器，以及一个用于更改基本学习率的辅助函数。

## 类

### CompositeLRScheduler

一个调度器，用于调度
[CompositeOptimizer](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/optimizers/composite_optimizer.md)
的成员调度器。

每个成员调度器都属于复合优化器的一个内部优化器，因此其 `base_lrs` 与该优化器的组匹配。Lightning 需要 `scheduler.optimizer` 是 `configure_optimizers` 返回的优化器。此类为 Lightning
提供了一个调度器，其 `optimizer` 是复合优化器。

构造函数不调用 `LRScheduler.__init__`。成员已经进行了初始步骤并修补了其优化器的 `step` 计数器。

> **示例**
> ```pycon
>>> from torch import nn
>>> from torch.optim import SGD
>>> from torch.optim.lr_scheduler import StepLR
>>> first = SGD(nn.Linear(2, 2).parameters(), lr=0.1)
>>> second = SGD(nn.Linear(2, 2).parameters(), lr=1.0)
>>> composite = CompositeOptimizer([first, second])
>>> scheduler = CompositeLRScheduler(
...     composite,
...     [StepLR(first, 1, gamma=0.5), StepLR(second, 1, gamma=0.1)],
... )
>>> composite.step()
>>> scheduler.step()
>>> [round(lr, 3) for lr in scheduler.get_last_lr()]
[0.05, 0.1]
```

#### 方法

##### init

```python
def __init__(composite: CompositeOptimizer, members: Sequence[LRScheduler]):
```

包装成员调度器。

调度器将 `last_epoch` 设置为 `0`。

参数

 * `composite` (`CompositeOptimizer`): Lightning 接收的优化器。调度器将其存储为 `optimizer`。
 * `members` (`Sequence[LRScheduler]`): 成员调度器。每个都属于 `composite` 的一个内部优化器。

##### get_last_lr

```python
def get_last_lr(self) -> list[float | Tensor]:
```

返回所有成员调度器的最后学习率。

返回

 * `list[float | Tensor]`: 成员的 `get_last_lr()` 值，按成员顺序连接。列表为每个成员优化器的每个组包含一个值。

##### load_state_dict

```python
def load_state_dict(state_dict: dict[str, Any]):
```

将状态加载到调度器及其成员中。

该方法恢复 `last_epoch` 并将 `"members"` 的每个条目加载到相同位置的成员中。

参数

 * `state_dict` (`dict[str, Any]`): [CompositeLRScheduler.state_dict](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/schedulers/composite_scheduler.md) 方法返回的状态。

引发

 * `ValueError`: 如果 `"version"` 不是 `1`。如果成员状态的数量与成员数量不同，也会引发此错误。

##### state_dict

```python
def state_dict(self) -> dict[str, Any]:
```

返回调度器及其成员的状态。

返回

 * `dict[str, Any]`: 一个包含以下键的字典。 * `"version"` 为 `1`。
    * `"last_epoch"` 包含 `last_epoch` 计数器。
    * `"members"` 包含每个成员的 `state_dict()`。

##### step

```python
def step(epoch: int | None = None):
```

每个成员调度器步进一次。

该方法将 `last_epoch` 加 `1`，然后按顺序调用每个成员的 `step()`。

参数

 * `epoch` (`int | None`): Lightning 可以传递的 epoch。该方法忽略它。

#### 属性

##### last_epoch

##### members

成员调度器，按构造函数的顺序排列。

##### optimizer

### CompositeReduceLROnPlateau

一个 `ReduceLROnPlateau`，用于调度 [CompositeOptimizer](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/optimizers/composite_optimizer.md) 的高原成员调度器。

该类为监控值的成员执行 [CompositeLRScheduler](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/schedulers/composite_scheduler.md) 的工作。每个成员都是复合优化器的一个内部优化器上的 `ReduceLROnPlateau`。Lightning 将监控值作为 [step](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/schedulers/composite_scheduler.md) 的第一个参数传递。

构造函数不调用 `ReduceLROnPlateau.__init__`。成员持有高原设置，例如 `mode` 和 `patience`。

#### 方法

##### init

```python
def __init__(composite: CompositeOptimizer, members: Sequence[ReduceLROnPlateau]):
```

包装成员调度器。

参数

 * `composite` (`CompositeOptimizer`): Lightning 接收的优化器。调度器将其存储为 `optimizer`。
 * `members` (`Sequence[ReduceLROnPlateau]`): 成员调度器。每个都属于 `composite` 的一个内部优化器。

##### load_state_dict

```python
def load_state_dict(state_dict: dict[str, Any]):
```

将状态加载到成员调度器中。

该方法将 `"members"` 的每个条目加载到相同位置的成员中。

参数

 * `state_dict` (`dict[str, Any]`): [CompositeReduceLROnPlateau.state_dict](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/schedulers/composite_scheduler.md) 方法返回的状态。

引发

 * `ValueError`: 如果 `"version"` 不是 `1`。如果成员状态的数量与成员数量不同，也会引发此错误。

##### state_dict

```python
def state_dict(self) -> dict[str, Any]:
```

返回成员调度器的状态。

返回

 * `dict[str, Any]`: 一个包含键 `"version"`（为 `1`）和 `"members"`（包含每个成员的 `state_dict()`）的字典。

##### step

```python
def step(metrics: Any, epoch: int | None = None):
```

将监控值传递给每个成员调度器。

每个成员自行决定是否降低其优化器的学习率。

参数

 * `metrics` (`Any`): 监控值，例如验证损失。
 * `epoch` (`int | None`): Lightning 可以传递的 epoch。该方法忽略它。

#### 属性

##### members

成员调度器，按构造函数的顺序排列。

##### optimizer

## 函数

### rebase_scheduler_lr

```python
def rebase_scheduler_lr(scheduler: LRScheduler | ReduceLROnPlateau, index: int, lr: float):
```

设置调度器中一个参数组的基本学习率。

该函数设置调度器的 `base_lrs[index]`。对于 `SequentialLR` 或 `ChainedScheduler`，它设置每个子调度器中的条目，以及子调度器的子调度器中的条目。没有 `base_lrs` 的调度器（例如 `ReduceLROnPlateau`）不会改变。该函数不会改变组的 `lr` 或 `initial_lr`。[TrainingPlanRuntime.set_group_base_lr](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/lightning/training_plan.md) 设置它们。

> **示例**
> ```pycon
>>> from torch import nn
>>> from torch.optim import SGD
>>> from torch.optim.lr_scheduler import StepLR
>>> optimizer = SGD(nn.Linear(2, 2).parameters(), lr=0.1)
>>> scheduler = StepLR(optimizer, step_size=1)
>>> rebase_scheduler_lr(scheduler, 0, 0.5)
>>> scheduler.base_lrs
[0.5]
>>> optimizer.param_groups[0]["lr"]
0.1
```

参数

 * `scheduler` (`LRScheduler | ReduceLROnPlateau`): 调度器。
 * `index` (`int`): 调度器优化器中参数组的索引。
 * `lr` (`float`): 新的基本学习率。
