# NN Archive CLI

Python API: `luxonis_ml.nn_archive.__main__`

## Functions

### 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.

Parameters

 * `path` (`Annotated[Path, Parameter(validator=validators.Path(exists=True))]`): Path to the NN Archive.
 * `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.

### 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.

Parameters

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

## Attributes

### app