# recognition_confusion_matrix

Python API: `luxonis_train.attached_modules.metrics.confusion_matrix.recognition_confusion_matrix`

用于分类和分割的混淆矩阵。

## 类

### RecognitionConfusionMatrix

用于分类和语义分割的混淆矩阵。

 * `输入:`: * `predictions` (`Tensor`): `[B, n_classes, ...]` logits
    * `targets` (`Tensor`): 相同形状，one-hot
 * `输出:`: * `mcc` (`Tensor`): 矩阵的标量 MCC，参见
   [compute_mcc](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/confusion_matrix/utils.md)
    * `confusion_matrix` (`Tensor`): [nclasses, nclasses] 计数，或 [2, 2]（对于一个类），行是目标
 * `公式:`: 对于多于一个类，每个样本或每个像素的预测类是最高 logit 的索引。目标类是最高目标值的索引。对于相等的值，最低索引获胜，因此仅包含零的目标计为类 `0`。`torchmetrics`
   `MulticlassConfusionMatrix` 计算目标类和预测类的每一对。 对于一个类，`torchmetrics` `BinaryConfusionMatrix` 比较每个预测值与相同位置的目标值。当批次的浮点预测超出 `[0, 1]`
   时，它会对该批次的所有预测应用 sigmoid。高于 `0.5` 的预测为正。矩阵为 `[[TN, FP], [FN, TP]]`，包含真负例 (TN)、假正例 (FP)、假负例 (FN) 和真正例 (TP) 的计数。

> **参考**
> * 来源：封装 [torchmetrics](https://github.com/Lightning-AI/torchmetrics) (Apache-2.0)。
 * 许可证：Apache-2.0（本项目）

> **注意事项**
> 该指标需要一个节点，因为它从节点读取 `n_classes`。[reset](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/confusion_matrix/recognition_confusion_matrix.md) 清除封装的矩阵，但 [compute](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/confusion_matrix/recognition_confusion_matrix.md) 的缓存结果会一直保留，直到下一次 [update](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/confusion_matrix/recognition_confusion_matrix.md)。

> **示例**
> 附加到 `model.nodes` 中的 `ClassificationHead`：

```yaml
- name: ClassificationHead
  inputs: [ResNet]
  metrics:
    - name: RecognitionConfusionMatrix
```

 * `兼容:`: * 节点: *
   [BiSeNetHead](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/bisenet_head.md)
       * [ClassificationHead](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/classification_head.md)
       * [DDRNetSegmentationHead](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/ddrnet_segmentation_head.md)
       * [SegmentationHead](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/segmentation_head.md)
       * [TransformerClassificationHead](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/transformer_classification_head.md)
       * [TransformerSegmentationHead](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/transformer_segmentation_head.md)

#### 方法

##### init

```python
def __init__(**kwargs):
```

初始化指标和封装的矩阵。

`metric` 属性保存封装的矩阵。当节点只有一个类时，它是一个 `BinaryConfusionMatrix`。否则，它是一个具有 `n_classes` 类的 `MulticlassConfusionMatrix`。

参数

 * `**kwargs`: 转发给
   [BaseMetric](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/base_metric.md)
   的关键字参数，例如 `node`。

##### compute

```python
def compute(self) -> dict[str, Tensor]:
```

返回自上次重置以来的 MCC 和矩阵。

> **示例**
> 批次有三个样本和两个类。第三个样本的目标类是 `1`，但模型预测类是 `0`。`SimpleNamespace` 代表节点。

```pycon
>>> import torch
>>> from types import SimpleNamespace
>>> node = SimpleNamespace(task=None, n_classes=2)
>>> metric = RecognitionConfusionMatrix(node=node)
>>> logits = torch.tensor([[2.0, 0.0], [0.0, 1.0], [3.0, 1.0]])
>>> targets = torch.tensor([[1, 0], [0, 1], [0, 1]])
>>> metric.update(logits, targets)
>>> result = metric.compute()
>>> result["confusion_matrix"].tolist()
[[1, 0], [1, 1]]
>>> result["mcc"].item()
0.5
```

返回

 * `dict[str, Tensor]`: 一个包含两个键的字典。 * `"mcc"` 保存矩阵的标量 MCC，参见
   [compute_mcc](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/confusion_matrix/utils.md)。
    * `"confusion_matrix"` 保存 `int64` 计数。行是目标类，列是预测类。形状是 `[n_classes, n_classes]`，或者对于一个类是 `[2, 2]`。

##### reset

```python
def reset(self):
```

重置封装的 `torchmetrics` 矩阵。

该方法不会在此指标上调用 `torchmetrics` 的 `Metric.reset`。上次
[compute](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/confusion_matrix/recognition_confusion_matrix.md)
的缓存结果会保留，并且
[compute](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/confusion_matrix/recognition_confusion_matrix.md)
会返回它，直到下一次
[update](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/confusion_matrix/recognition_confusion_matrix.md)。在
[InstanceSegmentationConfusionMatrix](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/confusion_matrix/instance_segmentation_confusion_matrix.md)
中，框矩阵也保留其计数。

> **示例**
> 重置后，[compute](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/confusion_matrix/recognition_confusion_matrix.md) 返回第一个批次的缓存结果。下一次 [update](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/confusion_matrix/recognition_confusion_matrix.md) 清除缓存，新结果仅包含第二个批次。

```pycon
>>> import torch
>>> from types import SimpleNamespace
>>> node = SimpleNamespace(task=None, n_classes=2)
>>> metric = RecognitionConfusionMatrix(node=node)
>>> class_0 = torch.tensor([[1.0, 0.0]])
>>> class_1 = torch.tensor([[0.0, 1.0]])
>>> metric.update(class_0, class_0)
>>> metric.compute()["confusion_matrix"].tolist()
[[1, 0], [0, 0]]
>>> metric.reset()
>>> metric.compute()["confusion_matrix"].tolist()
[[1, 0], [0, 0]]
>>> metric.update(class_1, class_1)
>>> metric.compute()["confusion_matrix"].tolist()
[[0, 0], [0, 1]]
```

##### update

```python
def update(predictions: Tensor, targets: Tensor):
```

将一个批次的预测和目标添加到矩阵中。

对于多于一个类，该方法对两个张量的维度 `1` 进行 `argmax`。对于一个类，它将两个张量不变地传递。类文档字符串描述了封装矩阵如何计数它们。

参数

 * `predictions` (`Tensor`): 节点的主要输出，对于分类是形状为 `[B, n_classes]` 的 logits，对于分割是形状为 `[B, n_classes, H, W]` 的 logits。
 * `targets` (`Tensor`): 相同形状的 one-hot 标签，任务的 `classification` 或 `segmentation` 标签。对于一个类，值必须是 `0` 或 `1`。其他值会导致 `torchmetrics` 引发
   `RuntimeError`。

#### 属性

##### metric

##### supported_tasks
