# NN Archive CLI

Python API: `luxonis_ml.nn_archive.__main__`

## Functions

| Name | Description |
| --- | --- |
|
[`extract`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/nn_archive/__main__.md)
| Extract an NN Archive. |
|
[`inspect`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/nn_archive/__main__.md)
| Print NN Archive configuration. |

### function `extract`

```python
def extract(
    path: Annotated[Path, Parameter(validator=validators.Path(exists=True))],
    destination: Annotated[Path | None, Parameter(name='--dest', alias='-d')] = None,
)
```

Extract an NN Archive.

Extracts the NN Archive to the destination path. By default, the Archive is extracted to the current working directory.

Args

| Name | Type | Description | Default |
| --- | --- | --- | --- |
| `path` | `Annotated[Path, Parameter(validator=validators.Path(exists=True))]` | Path to the NN Archive. | required |
| `destination` | `Annotated[Path | None, Parameter(name='--dest', alias='-d')]` | Path where to extract the Archive. If not
provided, the Archive is extracted to the current working directory. | `None` |

### function `inspect`

```python
def inspect(
    path: Annotated[Path, Parameter(validator=validators.Path(exists=True))],
    *,
    inputs: Annotated[bool, Parameter(alias='-i', negative=())] = False,
    metadata: Annotated[bool, Parameter(alias='-m', negative=())] = False,
    outputs: Annotated[bool, Parameter(alias='-o', negative=())] = False,
    heads: Annotated[bool, Parameter(alias='-h', negative=())] = False,
    buildinfo: Annotated[bool, Parameter(alias='-b', negative=())] = False,
)
```

Print NN Archive configuration.

If no options are provided, all info is printed.

Args

| Name | Type | Description | Default |
| --- | --- | --- | --- |
| `path` | `Annotated[Path, Parameter(validator=validators.Path(exists=True))]` | Path to the NN Archive. | required |
| `inputs` | `Annotated[bool, Parameter(alias='-i', negative=())]` | Print inputs info. | `False` |
| `metadata` | `Annotated[bool, Parameter(alias='-m', negative=())]` | Print metadata. | `False` |
| `outputs` | `Annotated[bool, Parameter(alias='-o', negative=())]` | Print outputs info. | `False` |
| `heads` | `Annotated[bool, Parameter(alias='-h', negative=())]` | Print heads info. | `False` |
| `buildinfo` | `Annotated[bool, Parameter(alias='-b', negative=())]` | Print build info if available. | `False` |

## Module Attributes

| Name | Description |
| --- | --- |
|
[`app`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/nn_archive/__main__.md)
| |

### variable `app`

```python
app = App(help='NN Archive utilities.', help_flags='--help')
```
