LuxonisML API Documentation Modules Classes Names
Clear Help

For more information on the search, visit the help page.

Class Hierarchy

  • abc.ABC
    • luxonis_ml.data.augmentations.AugmentationEngine - No class docstring; 1/1 property, 2/2 methods documented
      • luxonis_ml.data.augmentations.AlbumentationsEngine - Augmentation engine backed by Albumentations.
    • luxonis_ml.data.augmentations.BatchTransform - Base class for transforms that combine multiple samples.
      • luxonis_ml.data.augmentations.custom.MixUp - Batch-based augmentation that blends two images together.
      • luxonis_ml.data.augmentations.custom.Mosaic4 - Batch-based augmentation that creates a mosaic of four images.
    • luxonis_ml.data.datasets.Annotation - Base class for an annotation.
      • luxonis_ml.data.datasets.ArrayAnnotation - Custom annotation backed by an array file.
      • luxonis_ml.data.datasets.BBoxAnnotation - Bounding box annotation.
      • luxonis_ml.data.datasets.ClassificationAnnotation - Dummy wrapper annotation for classification tasks.
      • luxonis_ml.data.datasets.KeypointAnnotation - Keypoint annotation.
      • luxonis_ml.data.datasets.SegmentationAnnotation - Run-length encoded segmentation mask.
        • luxonis_ml.data.datasets.InstanceSegmentationAnnotation - Instance segmentation annotation.
    • luxonis_ml.data.datasets.BaseDataset - Base class for datasets in the Luxonis MLOps ecosystem.
      • luxonis_ml.data.datasets.LuxonisDataset - Luxonis Dataset Format (LDF) dataset handle.
    • luxonis_ml.data.exporters.BaseExporter - Base class for dataset exporters.
      • luxonis_ml.data.exporters.ClassificationDirectoryExporter - Undocumented
      • luxonis_ml.data.exporters.CocoExporter - Exporter for COCO dataset format.
      • luxonis_ml.data.exporters.CreateMLExporter - Undocumented
      • luxonis_ml.data.exporters.DarknetExporter - Export object detection data in Darknet format.
      • luxonis_ml.data.exporters.FiftyOneClassificationExporter - Export FiftyOne classification data.
      • luxonis_ml.data.exporters.NativeExporter - Exporter for LDF format.
      • luxonis_ml.data.exporters.SegmentationMaskDirectoryExporter - Export semantic segmentation masks in directory format.
      • luxonis_ml.data.exporters.TensorflowCSVExporter - Undocumented
      • luxonis_ml.data.exporters.UltralyticsNDJSONExporter - Export datasets in Ultralytics NDJSON format.
      • luxonis_ml.data.exporters.VOCExporter - No class docstring; 0/1 instance variable, 0/6 method, 1/3 static method documented
      • luxonis_ml.data.exporters.YoloV4Exporter - Export object detection data in YOLOv4 format.
      • luxonis_ml.data.exporters.YoloV6Exporter - Export object detection data in YOLOv6 format.
      • luxonis_ml.data.exporters.YoloV8Exporter - Export bounding-box annotations in YOLOv8 format.
      • luxonis_ml.data.exporters.YoloV8InstanceSegmentationExporter - Export instance-segmentation annotations in YOLOv8 format.
      • luxonis_ml.data.exporters.YoloV8KeypointsExporter - Export keypoint annotations in YOLOv8 pose format.
    • luxonis_ml.data.loaders.BaseLoader - Base abstract loader class.
      • luxonis_ml.data.loaders.LuxonisLoader - Indexed loader for LuxonisDataset samples.
    • luxonis_ml.data.parsers.BaseParser - Base class for dataset-format parsers.
      • luxonis_ml.data.parsers.ClassificationDirectoryParser - Parse a directory with classification annotations into LDF.
      • luxonis_ml.data.parsers.COCOParser - Parse a directory with COCO annotations into LDF.
      • luxonis_ml.data.parsers.CreateMLParser - Parse a directory with CreateML annotations into LDF.
      • luxonis_ml.data.parsers.DarknetParser - Parse a directory with Darknet annotations into LDF.
      • luxonis_ml.data.parsers.FiftyOneClassificationParser - Parse FiftyOne image classification data into LDF.
      • luxonis_ml.data.parsers.NativeParser - No class docstring; 1/1 constant, 1/2 method, 0/1 static method documented
      • luxonis_ml.data.parsers.SegmentationMaskDirectoryParser - Parse a directory with segmentation mask annotations into LDF.
      • luxonis_ml.data.parsers.SOLOParser - Parse a directory with SOLO annotations into LDF.
      • luxonis_ml.data.parsers.TensorflowCSVParser - Parse a directory with TensorFlow CSV annotations into LDF.
      • luxonis_ml.data.parsers.UltralyticsNDJSONParser - Parse Ultralytics NDJSON datasets into LDF.
      • luxonis_ml.data.parsers.VOCParser - Parse a directory with VOC annotations into LDF.
      • luxonis_ml.data.parsers.YoloV4Parser - Parse a directory with YOLOv4 annotations into LDF.
      • luxonis_ml.data.parsers.YoloV6Parser - Parse YOLOv6 annotations into LDF.
      • luxonis_ml.data.parsers.YOLOv8Parser - Parse YOLOv8 and Ultralytics annotations into LDF.
    • luxonis_ml.nn_archive.config_building_blocks.base_models.Head - Parser head definition for model outputs.
    • luxonis_ml.telemetry.backends.TelemetryBackend - Base class for telemetry backends.
      • luxonis_ml.telemetry.backends.NoopBackend - Backend that discards all telemetry events.
      • luxonis_ml.telemetry.backends.PostHogBackend - PostHog backend using the official python package.
      • luxonis_ml.telemetry.backends.StdoutBackend - Backend that logs telemetry to stdout.
  • abc.ABCMeta
    • luxonis_ml.utils.AutoRegisterMeta - Metaclass for automatically registering modules.
  • albumentations.Compose
    • luxonis_ml.data.augmentations.BatchCompose - Compose batch-aware Albumentations transforms.
  • albumentations.DualTransform
    • luxonis_ml.data.augmentations.BatchTransform - Base class for transforms that combine multiple samples.
      • luxonis_ml.data.augmentations.custom.MixUp - Batch-based augmentation that blends two images together.
      • luxonis_ml.data.augmentations.custom.Mosaic4 - Batch-based augmentation that creates a mosaic of four images.
    • luxonis_ml.data.augmentations.custom.HorizontalSymmetricKeypointsFlip - Flip images and symmetric keypoints horizontally.
    • luxonis_ml.data.augmentations.custom.LetterboxResize - Augmentation that resizes an image with padding to maintain the aspect ratio.
    • luxonis_ml.data.augmentations.custom.TransposeSymmetricKeypoints - Transpose images and symmetric keypoints.
    • luxonis_ml.data.augmentations.custom.VerticalSymmetricKeypointsFlip - Flip images and symmetric keypoints vertically.
  • collections.abc.Mapping
    • luxonis_ml.data.utils.visualizations.ColorMap - A mapping that assigns distinct RGB colors to hashable labels.
  • enum.Enum
    • luxonis_ml.data.BucketStorage - Underlying object storage for a bucket.
    • luxonis_ml.data.BucketType - Whether bucket storage is internal to Luxonis.
    • luxonis_ml.data.datasets.UpdateMode - Dataset media update mode.
    • luxonis_ml.data.ImageType - Image type for image media.
    • luxonis_ml.data.MediaType - Individual file type.
    • luxonis_ml.data.parsers.luxonis_parser.ParserType - Recognized parser entry-point type.
    • luxonis_ml.data.parsers.ParserIssue - Parser issue categories reported during best-effort parsing.
    • luxonis_ml.data.parsers.yolov8_parser.Format - YOLOv8 directory layout variant.
    • luxonis_ml.data.utils.COCOFormat - Supported COCO directory layouts.
    • luxonis_ml.enums.DatasetType - Dataset import/export format identifiers.
    • luxonis_ml.nn_archive.config_building_blocks.enums.DataType - Data types supported by NN Archive input and output streams.
    • luxonis_ml.nn_archive.config_building_blocks.enums.InputType - Input categories supported by NN Archive model inputs.
    • luxonis_ml.utils.filesystem.FSType - Filesystem backend type.
  • luxonis_ml.data.exporters.exporter_utils.ExporterSpec - Exporter class and constructor arguments.
  • luxonis_ml.data.exporters.PreparedLDF - Lightweight container for LDF data ready for export.
  • luxonis_ml.data.LDFEquivalence - Helpers for comparing datasets in Luxonis Data Format.
  • luxonis_ml.data.parsers.ParserIssueMessage - Structured message describing a skipped parser item.
  • luxonis_ml.data.utils.AugmentationsCollector - Collect augmentation names that were applied to a sample.
  • luxonis_ml.data.utils.ParquetFileManager - Manage append-style writes across partitioned parquet files.
  • luxonis_ml.data.utils.remote_file_downloader.RequestsRemoteFileAPIClient - Undocumented
  • luxonis_ml.data.utils.RemoteFileDownloader - Download remote files with optional image validation.
  • luxonis_ml.nn_archive.ArchiveGenerator - Build NN Archive files from configuration and model executables.
  • luxonis_ml.telemetry.events.TelemetryEvent - Represents a single telemetry event.
  • luxonis_ml.telemetry.singleton.TelemetryKey - Undocumented
  • luxonis_ml.telemetry.Telemetry - Telemetry client for emitting events via pluggable backends.
  • luxonis_ml.telemetry.TelemetryConfig - Configuration for telemetry collection.
  • luxonis_ml.telemetry.TelemetryDefaults - Optional product-level defaults for telemetry configuration.
  • luxonis_ml.tracker.LuxonisTracker - Logger wrapper for TensorBoard, WandB, and MLflow.
  • luxonis_ml.typing.BaseModelExtraForbid
    • luxonis_ml.data.datasets.Annotation - Base class for an annotation.
      • luxonis_ml.data.datasets.ArrayAnnotation - Custom annotation backed by an array file.
      • luxonis_ml.data.datasets.BBoxAnnotation - Bounding box annotation.
      • luxonis_ml.data.datasets.ClassificationAnnotation - Dummy wrapper annotation for classification tasks.
      • luxonis_ml.data.datasets.KeypointAnnotation - Keypoint annotation.
      • luxonis_ml.data.datasets.SegmentationAnnotation - Run-length encoded segmentation mask.
        • luxonis_ml.data.datasets.InstanceSegmentationAnnotation - Instance segmentation annotation.
    • luxonis_ml.data.datasets.DatasetRecord - Dataset record containing file paths and an optional annotation.
    • luxonis_ml.data.datasets.Detection - Detection record containing annotations and metadata for one object.
    • luxonis_ml.data.datasets.LuxonisComponent - Media component within a source.
    • luxonis_ml.data.datasets.LuxonisSource - Source definition for a dataset.
    • luxonis_ml.data.datasets.Metadata - Stored metadata for a Luxonis Data Format dataset.
    • luxonis_ml.nn_archive.Config - Configuration schema for an NN Archive.
    • luxonis_ml.nn_archive.config_building_blocks.base_models.Input - Model input stream definition.
    • luxonis_ml.nn_archive.config_building_blocks.base_models.Output - Model output stream definition.
    • luxonis_ml.nn_archive.config_building_blocks.base_models.PreprocessingBlock - Preprocessing operations applied to model input data.
    • luxonis_ml.nn_archive.Model - Configuration for one model stage in an NN Archive.
  • luxonis_ml.utils.environ._EnvironProxy - Undocumented
  • luxonis_ml.utils.LuxonisFileSystem - An abstraction over remote and local sources.
  • mlflow.tracking.request_header.abstract_request_header_provider.RequestHeaderProvider
    • luxonis_ml.tracker.LuxonisRequestHeaderProvider - Undocumented
  • pydantic.BaseModel
    • luxonis_ml.nn_archive.config_building_blocks.base_models.Head - Parser head definition for model outputs.
    • luxonis_ml.nn_archive.config_building_blocks.base_models.HeadMetadata - Base parser metadata.
      • luxonis_ml.nn_archive.config_building_blocks.base_models.head_metadata.HeadClassificationMetadata - Metadata for a classification head.
      • luxonis_ml.nn_archive.config_building_blocks.base_models.head_metadata.HeadObjectDetectionMetadata - Metadata for an object detection head.
        • luxonis_ml.nn_archive.config_building_blocks.base_models.head_metadata.HeadObjectDetectionSSDMetadata - Metadata for an SSD object detection head.
        • luxonis_ml.nn_archive.config_building_blocks.base_models.head_metadata.HeadYOLOMetadata - Metadata for a YOLO head.
      • luxonis_ml.nn_archive.config_building_blocks.base_models.head_metadata.HeadSegmentationMetadata - Metadata for a segmentation head.
    • luxonis_ml.nn_archive.config_building_blocks.base_models.Metadata - Model metadata stored in an NN Archive.
    • luxonis_ml.utils.BaseModelExtraForbid - Base model with extra fields forbidden.
      • luxonis_ml.typing.ConfigItem - Configuration schema for dynamic object instantiation. Typically used to instantiate objects stored in registries.
        • luxonis_ml.data.augmentations.albumentations_engine.AlbumentationConfigItem - Configuration item for AlbumentationsEngine.
      • luxonis_ml.utils.LuxonisConfig - Class for storing configuration.
  • pydantic_settings.BaseSettings
    • luxonis_ml.utils.environ.Environ - Environment-backed configuration for Luxonis ML.
  • str
    • luxonis_ml.data.datasets.Category - Category label for metadata values.
    • luxonis_ml.data.parsers.yolov8_parser.Format - YOLOv8 directory layout variant.
    • luxonis_ml.data.utils.COCOFormat - Supported COCO directory layouts.
    • luxonis_ml.enums.DatasetType - Dataset import/export format identifiers.
  • tuple[np.ndarray | dict[str, 'np.ndarray'], Labels] if TYPE_CHECKING else object
    • luxonis_ml.typing.LoaderOutput - No class docstring; 1/1 property, 0/3 class variable, 0/2 method documented
  • typing.Generic
    • luxonis_ml.data.parsers.LuxonisParser - Detect a dataset format and dispatch to the matching parser.
    • luxonis_ml.utils.Registry - A registry to store and retrieve modules.
  • typing.Protocol
    • luxonis_ml.data.utils.augmentations_collector.AugmentationsLike - Protocol for augmentation engines inspected by the collector.
    • luxonis_ml.data.utils.remote_file_downloader.RemoteFileAPIClient - Undocumented
    • luxonis_ml.telemetry.cli.shared._TelemetryCallable - Undocumented
    • luxonis_ml.utils.filesystem.PutFile - Protocol for the put_file plugins.
  • typing.TypedDict
    • luxonis_ml.data.utils.ParquetRecord - Single annotation row written to parquet.
  • typing_extensions.TypedDict
    • luxonis_ml.data.datasets.metadata.Skeletons - Keypoint skeleton metadata.
    • luxonis_ml.data.datasets.migration.LDF_1_0_0_MetadataDict - Metadata dictionary used by LDF 1.0.0.

API Documentation for LuxonisML, generated by pydoctor 25.10.1 at 2026-07-14 08:19:23.