# LuxonisML API Reference

Python API: `luxonis_ml`

Source version: `v0.10.0-beta` (commit `cdfb00741162eb84ea9575881d412e420203e66f`)

MLOps utilities for training models for Luxonis devices.

LuxonisML provides helper functions and utilities used across the Luxonis MLOps stack.

The package is organized around a few main areas:

 * [luxonis_ml.data](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data.md):
   dataset creation, conversion, loading, augmentation, and export tools for computer vision workflows.
 * [luxonis_ml.ldf](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/ldf.md):
   the annotation schemas of the Luxonis Data Format. The `ldf` extra is a subset of the `data` extra.
 * [luxonis_ml.tracker](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/tracker.md):
   experiment tracking utilities for PyTorch Lightning and LuxonisTrain workflows.
 * [luxonis_ml.telemetry](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/telemetry.md):
   a lightweight telemetry layer with pluggable backends.
 * [luxonis_ml.nn_archive](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/nn_archive.md):
   NN Archive creation and inspection.
 * [luxonis_ml.utils](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/utils.md):
   shared configuration, filesystem, logging, graph, path, and registry helpers.

Each area installs through its own extra, such as `luxonis-ml[data]`. The `all` extra installs every module and every cloud
integration. The `data`, `ldf`, `tracker`, and `utils` modules raise `ImportError` when their extra is absent, and the message
names the extra to install.
[luxonis_ml.telemetry](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/telemetry.md)
is an exception: it imports without `posthog` and falls back to a no-op backend.

The package also installs a `luxonis_ml` command. It provides the `data`, `archive`, and `fs` sub-applications, and a
`checkhealth` command that reports whether the `ldf`, `data`, `utils`, and `nn_archive` modules import correctly.

The project is in beta, so APIs may change as the library evolves.

## Child Pages

 * [data](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data.md)
 * [enums](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/enums.md)
 * [ldf](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/ldf.md)
 * [nn_archive](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/nn_archive.md)
 * [telemetry](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/telemetry.md)
 * [tracker](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/tracker.md)
 * [utils](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/utils.md)
 * [CLI](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/__main__.md)
 * [guard_extras](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/guard_extras.md)
 * [typing](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/typing.md)

## Attributes

### semver

### version