# tracker

Python API: `luxonis_train.utils.tracker`

用于 PyTorch Lightning 的实验跟踪器，支持 TensorBoard、Weights and Biases 和 MLFlow。

## 类

### LuxonisTrackerPL

基于 `luxonis_ml.tracker.LuxonisTracker` 构建的 Lightning 记录器。

该类将 Lightning 的 `Logger` 接口添加到 `luxonis_ml` 的跟踪器中。`Trainer` 可以通过它记录到 TensorBoard、Weights and Biases 和
MLFlow。[LuxonisModel](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/core/core.md)
为每次运行创建一个跟踪器。

#### 方法

##### init

```python
def __init__(*, _auto_finalize: bool = True, **kwargs):
```

初始化跟踪器和 Lightning 记录器。

参数

 * `_auto_finalize` (`bool`): `Trainer` 是否关闭运行。如果为 `True`，则实例将 `finalize` 替换为 `_finalize`。`Trainer` 在每次 `fit`、`validate`、`test` 或
   `predict` 调用结束时调用 `finalize("success")`。在发生异常时调用 `finalize("failed")`。如果为 `False`，则 Lightning 的 `finalize` 保持不变，调用者必须调用
   `_finalize`。[LuxonisModel.finalize_run](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/core/core.md)
   执行此操作。
 * `**kwargs`: `luxonis_ml.tracker.LuxonisTracker` 的关键字参数，例如 `project_name`、`run_name`、`save_directory` 和 `is_mlflow`。

#### 属性

##### finalize

## 函数

### get_tracker_init_params

```python
def get_tracker_init_params(cfg_tracker: Any) -> dict[str, Any]:
```

从跟踪器的配置构建跟踪器的关键字参数。

[TrackerConfig](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/config/config.md)
的 `model_dump` 省略了 `save_directory`，因此该函数将其添加回来。

> **示例**
> ```pycon
>>> from luxonis_train.config.config import TrackerConfig
>>> from luxonis_train.utils import get_tracker_init_params
>>> config = TrackerConfig(run_name="baseline")
>>> "save_directory" in config.model_dump()
False
>>> params = get_tracker_init_params(config)
>>> params["run_name"], str(params["save_directory"])
('baseline', 'output')
```

参数

 * `cfg_tracker` (`Any`): 跟踪器配置，一个 [TrackerConfig](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/config/config.md)。该函数调用其 `model_dump` 并读取其 `save_directory`。

返回

 * `dict[str, Any]`: `cfg_tracker` 的字段，包含 `save_directory`。[LuxonisModel](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/core/core.md) 将它们传递给 [LuxonisTrackerPL](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/utils/tracker.md)。
