# model

Python API: `luxonis_train.config.predefined_models.ocr_recognition.v1.model`

OCR 文本识别模型。

## 类

### OCRRecognitionModel

在裁剪图像上进行文本识别，基于 [PPOCRv4](https://github.com/PaddlePaddle/PaddleOCR)。

数据集需要在 `text` 元数据字段中包含每张图像的文本：

```python
for path, label in zip(image_paths, labels):
    if label:
        yield {
            "file": path,
            "annotation": {"metadata": {"text": label}},
        }
```

将 `alphabet` 设置为要识别的字符，可以是列表或命名字母表之一，并将 `max_text_len` 设置为预期的最长字符串。

 * `吞吐量：`： 48x320 时的每秒帧数。 * `light`：RVC2 上 50，RVC4 上 300

> **示例**
> 配置的 `model` 部分：

```yaml
model:
  predefined_model:
    name: OCRRecognitionModel
    params:
      variant: light
```

 * `组件：`： *
   节点：[PPLCNetV3](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/backbones/pplcnet_v3/pplcnet_v3.md)
   ->
   [SVTRNeck](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/necks/svtr_neck/svtr_neck.md)
   ->
   [OCRCTCHead](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/ocr_ctc_head.md)
    * 损失：[CTCLoss](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/losses/ctc_loss.md)
    * 指标：[OCRAccuracy](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/ocr_accuracy.md)
    * 可视化工具：[OCRVisualizer](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/visualizers/ocr_visualizer.md)
    * 主要指标：[OCRAccuracy](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/ocr_accuracy.md)
    * 变体：`light`

#### 方法

##### init

```python
def __init__(alphabet: list[str] | AlphabetName = 'english', max_text_len: int = 40, ignore_unknown: bool = True, **kwargs):
```

使用其默认组件初始化模型。

> **示例**
> ```pycon
>>> model = OCRRecognitionModel(
...     alphabet=["a", "b"], max_text_len=8
... )
>>> backbone, _, head = model.nodes
>>> backbone.params
{'max_text_len': 8}
>>> head.params
{'alphabet': ['a', 'b'], 'ignore_unknown': True}
```

参数

 * `alphabet` (`list[str] | AlphabetName`)： 头部预测的字符。名称选择预定义字母表并记录信息消息： * `"english"`：`a` 到 `z` 和 `A` 到 `Z`；
    * `"english_lowercase"`：`a` 到 `z`；
    * `"numeric"`：`0` 到 `9`；
    * `"alphanumeric"`：`"english"` 和 `"numeric"`；
    * `"alphanumeric_lowercase"`：`"english_lowercase"` 和 `"numeric"`；
    * `"punctuation"`：空格和 ASCII 标点符号；
    * `"ascii"`：可打印的 ASCII 字符，代码 `32` 到 `126`。 模型直接传递列表。当 `head_params` 包含 `alphabet` 时，它不读取该值。
 * `max_text_len` (`int`)：骨干网络输出的序列步数，也是模型可以预测的最长文本。
 * `ignore_unknown` (`bool`)：头部是否丢弃不在字母表中的标签字符。如果为 `False`，头部将其映射到额外的 `"<UNK>"` 类。
 * `**kwargs`：[SimplePredefinedModel.init](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/config/predefined_models/base_predefined_model.md) 的关键字参数。

引发

 * `ValueError`：当 `alphabet` 是一个未命名预定义字母表的字符串，并且 `head_params` 不包含 `alphabet` 时。

##### get_variants

```python
def get_variants() -> tuple[str, dict[str, Params]]:
```

获取默认变体名称和可用变体。

该模型有一个变体，`light`。它将 `backbone_variant` 设置为 `"rec-light"`，即 [PPLCNetV3](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/backbones/pplcnet_v3/pplcnet_v3.md) 的识别变体。该变体未设置 `weights`，因此没有节点加载检查点。

> **示例**
> ```pycon
>>> OCRRecognitionModel.get_variants()
('light', {'light': {'backbone_variant': 'rec-light'}})
```

返回

 * `tuple[str, dict[str, Params]]`：`"light"` 和包含其构造函数参数的单个变体。

## 属性

### AlphabetName
