# parsing_neural_network

Python API: `depthai_nodes.node.parsing_neural_network`

## 类

### ParsingNeuralNetwork

使用每个 NN Archive 头的原生解析器构建推理。

`build()` 接受 NN Archive、模型描述或 Model Zoo slug。解析器输出保留其原生消息类型。当需要 Python 解析器实现时，请使用 `HostParsingNeuralNetwork`。

#### 方法

##### init

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

初始化包装器并创建内部神经网络节点。

##### build

```python
def build(input: dai.Node.Output | dai.node.Camera, nnSource: dai.NNModelDescription | dai.NNArchive | str, fps: float | None = None) -> ParsingNeuralNetwork:
```

构建神经网络节点并为每个头创建解析器节点。

参数

 * `input` (`dai.Node.Output | dai.node.Camera`): 上游输出或将帧馈送到神经网络节点的相机。
 * `nnSource` (`dai.NNModelDescription | dai.NNArchive | str`): dai.NNModelDescription、dai.NNArchive 或 HubAI 模型 slug。
 * `fps` (`float | None`): 神经网络节点的可选运行时 FPS 限制。

返回

 * `ParsingNeuralNetwork`: 配置好的节点实例。

抛出

 * `ValueError`: 如果 `nnSource` 不是存档、模型描述或 Model Zoo slug，或者其解析器配置无效。

##### cleanup

```python
def cleanup(self):
```

清理 ParsingNeuralNetwork 节点并从管道中删除 ParsingNeuralNetwork 创建的所有节点。

必须在从管道中删除节点之前调用。

##### getNumInferenceThreads

```python
def getNumInferenceThreads(self) -> int:
```

返回配置的推理线程数。

##### getOutput

```python
def getOutput(head: int) -> dai.Node.Output:
```

选择单个模型头输出。

参数

 * `head` (`int`): 存档中基于零的头索引。

返回

 * `dai.Node.Output`: 所选头的解析器输出。

抛出

 * `KeyError`: 如果头不可用。

##### getParser

```python
def getParser(*args, **kwargs) -> BaseParser | dai.DeviceNode:
```

返回请求的模型头的解析器。

参数

 * `*args`: 头索引、解析器类型或解析器类型和头索引。
 * `parserType`: 用于运行时类型检查的可选预期解析器类型。
 * `index`: 模型头索引。默认为 0。
 * `**kwargs`: 可选的 `parserType` 和 `index` 关键字参数。

返回

 * `BaseParser | dai.DeviceNode`: 与请求的头匹配的解析器节点。

抛出

 * `KeyError`: 如果模型头索引不可用。
 * `TypeError`: 如果解析器与请求的解析器类型不匹配。

##### run

```python
def run(self):
```

从 ThreadedHostNode 继承的方法。

方法随管道的启动而运行。

##### setBackend

```python
def setBackend(setBackend: str):
```

将配置转发到底层原生 NeuralNetwork 节点。

> **注意**
> 后端和平台验证由 DepthAI 执行。此转发方法不会重建解析器节点。

参数

 * `setBackend` (`str`): DepthAI 接受的后端标识符。

##### setBackendProperties

```python
def setBackendProperties(setBackendProperties: dict[str, str]):
```

将配置转发到底层原生 NeuralNetwork 节点。

> **注意**
> 后端和平台验证由 DepthAI 执行。此转发方法不会重建解析器节点。

参数

 * `setBackendProperties` (`dict[str, str]`): 特定于后端的字符串属性。

##### setBlob

```python
def setBlob(blob: Path | dai.OpenVINO.Blob):
```

将配置转发到底层原生 NeuralNetwork 节点。

> **注意**
> 后端和平台验证由 DepthAI 执行。此转发方法不会重建解析器节点。

参数

 * `blob` (`Path | dai.OpenVINO.Blob`): DepthAI 接受的 OpenVINO blob 或路径。

##### setBlobPath

```python
def setBlobPath(path: Path):
```

将配置转发到底层原生 NeuralNetwork 节点。

> **注意**
> 后端和平台验证由 DepthAI 执行。此转发方法不会重建解析器节点。

参数

 * `path` (`Path`): 本地 OpenVINO blob 路径。

##### setFromModelZoo

```python
def setFromModelZoo(description: dai.NNModelDescription, useCached: bool):
```

将模型加载到原生网络中，而无需重建解析器。

参数

 * `description` (`dai.NNModelDescription`): 传递给 DepthAI 的 Model Zoo 描述。
 * `useCached` (`bool`): DepthAI 是否可以重用缓存模型。

##### setModelPath

```python
def setModelPath(modelPath: Path):
```

将配置转发到底层原生 NeuralNetwork 节点。

> **注意**
> 后端和平台验证由 DepthAI 执行。此转发方法不会重建解析器节点。

参数

 * `modelPath` (`Path`): 原生节点接受的本地模型路径。

##### setNNArchive

```python
def setNNArchive(nnArchive: dai.NNArchive, numShaves: int | None = None):
```

设置活动模型存档并重建解析器节点。

参数

 * `nnArchive` (`dai.NNArchive`): 包含模型和解析器配置的神经网络存档。
 * `numShaves` (`int | None`): 分配给神经网络节点的可选 shave 数量。

##### setNumInferenceThreads

```python
def setNumInferenceThreads(numThreads: int):
```

将配置转发到底层原生 NeuralNetwork 节点。

> **注意**
> 后端和平台验证由 DepthAI 执行。此转发方法不会重建解析器节点。

参数

 * `numThreads` (`int`): 请求的并行推理线程数。

##### setNumNCEPerInferenceThread

```python
def setNumNCEPerInferenceThread(numNCEPerThread: int):
```

将配置转发到底层原生 NeuralNetwork 节点。

> **注意**
> 后端和平台验证由 DepthAI 执行。此转发方法不会重建解析器节点。

参数

 * `numNCEPerThread` (`int`): 每个推理线程分配的神经计算引擎数量。

##### setNumPoolFrames

```python
def setNumPoolFrames(numFrames: int):
```

将配置转发到底层原生 NeuralNetwork 节点。

> **注意**
> 后端和平台验证由 DepthAI 执行。此转发方法不会重建解析器节点。

参数

 * `numFrames` (`int`): 网络输出池中的帧数。

##### setNumShavesPerInferenceThread

```python
def setNumShavesPerInferenceThread(numShavesPerInferenceThread: int):
```

将配置转发到底层原生 NeuralNetwork 节点。

> **注意**
> 后端和平台验证由 DepthAI 执行。此转发方法不会重建解析器节点。

参数

 * `numShavesPerInferenceThread` (`int`): 每个推理线程分配的 SHAVE 核心数量。

#### 属性

##### input

返回主神经网络输入。

##### inputs

返回神经网络输入映射。

##### out

当模型只有一个头时，返回单个解析器输出。

##### outputs

神经网络输出，其有效负载为 dai.MessageGroup，其中包含所有模型头的输出，并且可以作为以 str(模型头索引) 为键的字典进行访问。

仅当至少有两个模型头时才能使用。否则，必须使用 out 属性。

##### passthrough

返回底层 NN 节点的主直通流。

##### passthroughs

返回底层 NN 节点的直通输出映射。

## 属性

### TParser
