# archive_generator

Python API: `luxonis_ml.nn_archive.archive_generator`

## 类

### ArchiveGenerator

根据配置和模型可执行文件构建 NN 归档文件。

生成的归档是一个压缩的 tar 文件，其中包含 `config.json` 和提供的可执行文件。

#### 方法

##### init

```python
def __init__(archive_name: str, save_path: PathType, cfg_dict: dict, executables_paths: list[PathType], compression: Literal['xz', 'gz', 'bz2'] = 'xz'):
```

为 NN 归档创建一个生成器。

参数

 * `archive_name` (`str`): 期望的归档文件名。如果缺少，将添加 `.tar` 和压缩后缀。
 * `save_path` (`PathType`): 归档文件应写入的目录。
 * `cfg_dict` (`dict`): 用于构建 `config.json` 的归档配置。
 * `executables_paths` (`list[PathType]`): 要包含的模型可执行文件的路径。
 * `compression` (`Literal['xz', 'gz', 'bz2']`): tar 归档的压缩算法。

引发

 * `ValueError`: 如果 `compression` 不是 `"xz"`、`"gz"` 或 `"bz2"` 之一。

##### make_archive

```python
def make_archive(self) -> Path:
```

生成 NN 归档文件。

返回

 * `Path`: 生成的归档文件的路径。

#### 属性

##### archive_name

归档文件名，包括 `.tar` 和压缩后缀。

##### cfg

已验证的归档配置。

##### compression

用于 tar 归档的压缩算法。

##### executables_paths

归档中包含的可执行文件的路径。

##### save_path

归档文件写入的目录。
