# metadata_logger

Python API: `luxonis_train.callbacks.metadata_logger`

将选定的配置值记录为超参数，并将其保存到 `metadata.yaml`。

## 类

### MetadataLogger

回调，将选定的配置值记录为超参数。

当训练开始时，回调从配置中读取 `hyperparams` 的每个键。它使用模型的记录器记录这些值，并将它们保存到模型保存目录中的 `metadata.yaml`。

回调位于 `CALLBACKS` 注册表中，因此配置可以添加它：

```yaml
trainer:
  callbacks:
    - name: MetadataLogger
      params:
        hyperparams: ["trainer.epochs", "trainer.batch_size"]
```

#### 方法

##### init

```python
def __init__(hyperparams: list[str]):
```

初始化回调。

参数

 * `hyperparams` (`list[str]`): 要记录的配置键。键的级别用点分隔，例如 `"trainer.epochs"`。列表的级别是整数索引，例如 `"model.nodes.0.name"`。

##### on_fit_start

```python
def on_fit_start(_: pl.Trainer, pl_module: lxt.LuxonisLightningModule):
```

记录并保存选定的配置值。

Lightning 在训练开始时调用此钩子。钩子使用 `cfg.get` 读取 `hyperparams` 的每个键。配置中不存在的键将返回 `None`。如果列表的级别不是整数，`cfg.get` 会引发 `ValueError`。钩子将键值字典传递给
`pl_module.logger` 的 `log_hyperparams`。然后，它使用 `yaml.safe_dump` 将字典写入 `pl_module.save_dir` 中的 `metadata.yaml`，并替换现有文件。如果值不是纯 YAML
类型（例如嵌套配置部分），`yaml.safe_dump` 会引发 `yaml.representer.RepresenterError`。

参数

 * `_` (`pl.Trainer`): 训练器。未使用。
 * `pl_module` (`lxt.LuxonisLightningModule`): 模型。它提供配置、记录器和保存目录。
