# nn_archive

Python API: `luxonis_ml.nn_archive`

Public entry point for Luxonis NN Archive creation and inspection.

The luxonis_ml.nn_archive package collects the schema models and helper functions used to create NN Archive tar files. An archive
stores `config.json` alongside compiled model executables so model metadata, input/output definitions, tensor layouts, and
parser-head configuration can travel with the executable artifact.

> **Example**
> Build a validated archive with the package-level imports.

```python
from luxonis_ml.nn_archive import ArchiveGenerator

generator = ArchiveGenerator(
    archive_name="model",
    save_path="artifacts",
    cfg_dict=config,
    executables_paths=["model.blob"],
)
archive_path = generator.make_archive()
```

> **See Also**
> [luxonis_ml.nn_archive.config_building_blocks](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/nn_archive/config_building_blocks.md) for the input, output, metadata, and parser-head schemas used by [Model](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/nn_archive/model.md).

## Child Pages

 * [config_building_blocks](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/nn_archive/config_building_blocks.md)
 * [NN Archive
   CLI](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/nn_archive/__main__.md)
 * [archive_generator](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/nn_archive/archive_generator.md)
 * [config](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/nn_archive/config.md)
 * [model](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/nn_archive/model.md)
 * [utils](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/nn_archive/utils.md)
