# ocr_accuracy

Python API: `luxonis_train.attached_modules.metrics.ocr_accuracy`

OCR 预测的精确匹配准确率。

该指标还给出了恰好有一个和恰好有两个错误字符的文本的比例。

## 类

### OCRAccuracy

OCR 文本中零、一或两个错误字符的比例。

 * `输入:`: * `predictions` (`Tensor`): [B, T, C] logits
    * `target` (`Tensor`): [B, S] 字符代码，`0` 填充
 * `输出:`: * `Tensor`: 标量，精确匹配的比例
    * `rank_0`, `rank_1`, `rank_2` (`Tensor`): 标量，恰好有 `0`、`1` 或 `2` 个错误字符的文本的比例
 * `公式:`: 该指标贪婪地解码每个预测。它在每一步选择具有最高 logit 的类，并将每个相同类的运行合并为一个类。然后它删除 `blank_class` 并用 `0` 填充结果到 T 个位置。节点的 `encoder` 将目标字符转换为类索引。该指标用
   `blank_class` 填充较短的目标，并将较长的目标裁剪到 T 个位置。它逐位比较两个序列。具有 e ≤ 2 个不同位置的文本计入 `rank_e`。具有更多不同位置的文本不计入任何 rank。

> **参考**
> * 来源：本项目。
 * 许可证：Apache-2.0（本项目）

> **注意事项**
> * 比较不是编辑距离。缺失的字符会使其后的字符移位，每个移位的位置都算作错误。
 * 位置 T 之后的字符不计入。
 * [OCRCTCHead](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/ocr_ctc_head.md)
   的编码器使用类 `0` 作为空白和填充。使用另一个 `blank_class`，解码会保留头的空白。指标添加到目标的每个位置也算作错误。

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

```yaml
- name: OCRCTCHead
  inputs: [SVTRNeck]
  metrics:
    - name: OCRAccuracy
```

 * `兼容:`: *
   由以下使用：[OCRRecognitionModel](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/config/predefined_models/ocr_recognition/v1/model.md)
    * 节点：[OCRCTCHead](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/ocr_ctc_head.md)

#### 方法

##### init

```python
def __init__(blank_class: int = 0, **kwargs):
```

初始化指标。

节点必须是
[OCRCTCHead](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/ocr_ctc_head.md)。否则
[BaseAttachedModule](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/base_attached_module.md)
会引发
[IncompatibleError](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/utils/exceptions.md)。

参数

 * `blank_class` (`int`): CTC 空白的类索引。解码会从预测中删除它，指标会用它填充目标。保持 `0`，即
   [OCRCTCHead](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/ocr_ctc_head.md)
   编码器的空白。
 * `**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) -> tuple[Tensor, dict[str, Tensor]]:
```

将计数除以文本数量。

> **示例**
> 字母表 `["a", "b"]` 给出空白、`"a"` 和 `"b"` 类。第一个文本解码为 `"ab"`。第二个文本解码为 `"aa"`，其中有一个错误字符：

```pycon
>>> import torch
>>> import torch.nn.functional as F
>>> from torch import Size
>>> from luxonis_train.nodes import OCRCTCHead
>>> head = OCRCTCHead(
...     alphabet=["a", "b"],
...     input_shapes=[{"features": [Size([1, 8, 1, 4])]}],
... )
>>> metric = OCRAccuracy(node=head)
>>> classes = torch.tensor([[1, 1, 2, 0], [1, 0, 1, 0]])
>>> text = torch.tensor([[97, 98], [97, 98]])
>>> metric.update(F.one_hot(classes, 3).float(), text)
>>> accuracy, ranks = metric.compute()
>>> accuracy.item(), ranks["rank_1"].item()
(0.5, 0.5)
```

返回

 * `tuple[Tensor, dict[str, Tensor]]`: 精确匹配的比例，以及一个包含键 `"rank_0"`、`"rank_1"` 和 `"rank_2"` 的字典。`"rank_k"` 是恰好有 `k`
   个错误字符的文本的比例。所有值都是标量。当自上次 `reset` 以来没有运行
   [update](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/ocr_accuracy.md)
   时，它们是 `NaN`。

##### update

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

解码一个批次并将其计数添加到状态。

该方法将恰好有 `0`、`1` 和 `2` 个错误字符的文本数量添加到 `rank_0`、`rank_1` 和 `rank_2`。它将批次大小添加到 `total`。类文档字符串描述了解码和比较。

参数

 * `predictions` (`Tensor`): 形状为 `[B, T, C]` 的 logits，是节点的主要输出。
 * `target` (`Tensor`): 文本的字符代码，形状为 `[B, S]`，用 `0` 填充。它是任务的 `metadata/text` 标签。

#### 属性

##### node

##### rank_0

##### rank_1

##### rank_2

##### supported_tasks

##### total
