# needs_checkpoint

Python API: `luxonis_train.callbacks.needs_checkpoint`

作用于最佳检查点的回调的基类。

[NeedsCheckpoint.get_checkpoint](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/callbacks/needs_checkpoint.md)
返回具有最佳主要指标或最低验证损失的检查点的路径。当首选检查点不存在时，它会尝试另一个。当两者都不存在时，它返回 `None`，每个子类决定如何处理。

## 类

### NeedsCheckpoint

作用于最佳检查点的回调的基类。

[ArchiveOnTrainEnd](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/callbacks/archive_on_train_end.md)、[ConvertOnTrainEnd](https://docs.luxonis.com/zh/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/callbacks/convert_on_train_end.md)、[ExportOnTrainEnd](https://docs.luxonis.com/zh/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/callbacks/export_on_train_end.md)、[AIMETCallback](https://docs.luxonis.com/zh/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/callbacks/aimet_callback.md)
和
[TestOnTrainEnd](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/callbacks/test_on_train_end.md)
都继承自它。每个都在其 `on_train_end` 钩子中调用
[get_checkpoint](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/callbacks/needs_checkpoint.md)。[ArchiveOnTrainEnd](https://docs.luxonis.com/zh/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/callbacks/archive_on_train_end.md)
仅在没有更早的 ONNX 导出时调用它。此类不定义自己的钩子。

#### 方法

##### init

```python
def __init__(preferred_checkpoint: Literal['metric', 'loss'] = 'metric', **kwargs):
```

初始化回调。

参数

 * `preferred_checkpoint` (`Literal['metric', 'loss']`): 首先尝试的检查点。`"metric"` 选择最佳主要指标，`"loss"` 选择最低验证损失。构造函数不检查该值。除 `"loss"`
   之外的任何值都将作为 `"metric"` 处理。
 * `**kwargs`: `pl.Callback` 的关键字参数。该类不接受任何参数，因此任何键都会引发 `TypeError`。

##### get_checkpoint

```python
def get_checkpoint(pl_module: lxt.LuxonisLightningModule) -> str | None:
```

返回最佳检查点的路径。

该方法通过 `pl_module.core` 读取 `ModelCheckpoint` 回调的 `best_model_path`。它为 `"metric"` 调用
[LuxonisModel.get_best_metric_checkpoint_path](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/core/core.md)，为
`"loss"` 调用
[LuxonisModel.get_min_loss_checkpoint_path](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/core/core.md)。指标检查点仅在配置具有指标时存在。如果没有
`is_main_metric` 标志，配置会将第一个指标作为主要指标。路径在其回调保存检查点之前保持为空。

该方法首先尝试 `preferred_checkpoint`。当该路径为 `None` 或为空时，它会记录错误和信息消息，并尝试另一个检查点。当该路径也缺失时，它会记录第二个错误。

两个 getter 都只在 rank zero 上运行，并在所有其他 rank 上返回 `None`。在那里，该方法记录相同的三条消息并返回 `None`。

参数

 * `pl_module` (`lxt.LuxonisLightningModule`): 运行的模块。其
   [LuxonisModel](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/core/core.md)
   包含训练器及其回调。

返回

 * `str | None`: 检查点文件的路径，或者当两个检查点都不存在时为 `None`。
