# archive_utils

Python API: `luxonis_train.core.utils.archive_utils`

导出模型及其头部的 NN 存档条目。

[LuxonisModel.archive](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/core/core.md)
使用这些函数构建存档配置的 `inputs`、`outputs` 和
`heads`。[LuxonisModel.export](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/core/core.md)
还读取 `modelconverter` 配置的输入和输出，该配置写入 ONNX 文件旁边。

## 类

### ArchiveMetadataDict

模型的一个输入或输出的形状和数据类型。

#### 属性

##### dtype

张量的数据类型，可以是 `int8`、`int32`、`uint8`、`float32` 和 `float16` 之一。

##### shape

张量的维度。模型文件中没有固定大小的维度为 `0`。

## 函数

### get_head_configs

```python
def get_head_configs(lightning_module: LuxonisLightningModule, outputs: list[dict]) -> list[dict]:
```

构建 NN 存档配置的 `heads` 条目。

该函数按构建顺序访问 `lightning_module` 的节点。它跳过不是
[BaseHead](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/base_head.md)
的节点，以及设置了 `remove_on_export` 的头部。对于每个其他头部，它从
[BaseHead.get_head_config](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/base_head.md)
开始，并添加两个键：

 * `"name"`：节点的名称。当较早的头部已经使用了该名称时，该函数会附加 `_<n>`，其中 `<n>` 是到目前为止已使用的名称数量。
 * `"outputs"`：头部的
   [BaseNode.export_output_names](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/base_node.md)。当它们为
   `None` 或为空时，该函数会选择 `outputs` 中属于节点名称的名称。

参数

 * `lightning_module` (`LuxonisLightningModule`)：存档描述其头部的模块。
 * `outputs` (`list[dict]`)：NN 存档配置的输出，每个都有一个 `"name"` 键。

返回

 * `list[dict]`：每个导出头部的配置字典，包含键 `"parser"`、`"metadata"`、`"name"` 和 `"outputs"`。

### get_inputs

```python
def get_inputs(path: Path) -> dict[str, ArchiveMetadataDict]:
```

读取导出模型文件的输入。

该函数仅支持 ONNX 文件。它读取模型的 `graph.input` 的每个条目。

参数

 * `path` (`Path`)：模型文件，后缀为 `.onnx`。

返回

 * `dict[str, ArchiveMetadataDict]`：每个输入的形状和数据类型，以输入名称为键，按图顺序排列。

引发

 * `NotImplementedError`：当 `path` 的后缀不是 `.onnx` 时。
 * `ValueError`：当文件无法作为 ONNX 模型加载，或者输入具有不支持的数据类型时。

### get_outputs

```python
def get_outputs(path: Path) -> dict[str, ArchiveMetadataDict]:
```

读取导出模型文件的输出。

该函数仅支持 ONNX 文件。它读取模型的 `graph.output` 的每个条目。

参数

 * `path` (`Path`)：模型文件，后缀为 `.onnx`。

返回

 * `dict[str, ArchiveMetadataDict]`：每个输出的形状和数据类型，以输出名称为键，按图顺序排列。

引发

 * `NotImplementedError`：当 `path` 的后缀不是 `.onnx` 时。
 * `ValueError`：当文件无法作为 ONNX 模型加载，或者输出具有不支持的数据类型时。
