luxonis_ml.data.exporters.BaseExporter

class documentation

class BaseExporter(ABC):

Constructor: BaseExporter(dataset_identifier, output_path, max_partition_size_gb)

View In Hierarchy

Base class for dataset exporters.

Method	`__init__`	Undocumented
Method	`export`	Convert the prepared dataset into the exporter's format.
Method	`supported_ann_types`	Return task types supported by this exporter.
Instance Variable	`current_size`	Current partition size in bytes.
Instance Variable	`dataset_identifier`	Name or identifier used for exported paths.
Instance Variable	`image_indices`	Per-image export indices used by concrete exporters.
Instance Variable	`max_partition_size`	Optional maximum partition size in bytes.
Instance Variable	`max_partition_size_gb`	Optional maximum partition size in GiB.
Instance Variable	`output_path`	Directory where the export is written.
Instance Variable	`part`	Current partition index, or `None` when partitioning is disabled.
Method	`_dump_annotations`	Undocumented
Method	`_get_data_path`	Return the folder path to store data files for this split.

def __init__(self, dataset_identifier: str, output_path: Path, max_partition_size_gb: float | None): ¶

overridden in luxonis_ml.data.exporters.CocoExporter, luxonis_ml.data.exporters.CreateMLExporter, luxonis_ml.data.exporters.DarknetExporter, luxonis_ml.data.exporters.FiftyOneClassificationExporter, luxonis_ml.data.exporters.SegmentationMaskDirectoryExporter, luxonis_ml.data.exporters.TensorflowCSVExporter, luxonis_ml.data.exporters.UltralyticsNDJSONExporter, luxonis_ml.data.exporters.YoloV4Exporter, luxonis_ml.data.exporters.YoloV6Exporter, luxonis_ml.data.exporters.YoloV8Exporter, luxonis_ml.data.exporters.YoloV8InstanceSegmentationExporter, luxonis_ml.data.exporters.YoloV8KeypointsExporter

Undocumented

@abstractmethod

def export(self, prepared_ldf: PreparedLDF): ¶

overridden in luxonis_ml.data.exporters.ClassificationDirectoryExporter, luxonis_ml.data.exporters.CocoExporter, luxonis_ml.data.exporters.CreateMLExporter, luxonis_ml.data.exporters.DarknetExporter, luxonis_ml.data.exporters.FiftyOneClassificationExporter, luxonis_ml.data.exporters.NativeExporter, luxonis_ml.data.exporters.SegmentationMaskDirectoryExporter, luxonis_ml.data.exporters.TensorflowCSVExporter, luxonis_ml.data.exporters.UltralyticsNDJSONExporter, luxonis_ml.data.exporters.VOCExporter, luxonis_ml.data.exporters.YoloV4Exporter, luxonis_ml.data.exporters.YoloV6Exporter, luxonis_ml.data.exporters.YoloV8Exporter, luxonis_ml.data.exporters.YoloV8InstanceSegmentationExporter, luxonis_ml.data.exporters.YoloV8KeypointsExporter

Convert the prepared dataset into the exporter's format.

Parameters
prepared_ldf:`PreparedLDF`	Dataset data prepared for export.

Raises
`NotImplementedError`	Always raised by the abstract base implementation.

@abstractmethod

def supported_ann_types(self) -> list[str]: ¶

Return task types supported by this exporter.

Returns
`list[str]`	Supported annotation task types.

Raises
`NotImplementedError`	Always raised by the abstract base implementation.

current_size: int = ¶

overridden in luxonis_ml.data.exporters.CocoExporter, luxonis_ml.data.exporters.CreateMLExporter, luxonis_ml.data.exporters.DarknetExporter, luxonis_ml.data.exporters.NativeExporter, luxonis_ml.data.exporters.TensorflowCSVExporter, luxonis_ml.data.exporters.UltralyticsNDJSONExporter, luxonis_ml.data.exporters.VOCExporter, luxonis_ml.data.exporters.YoloV4Exporter, luxonis_ml.data.exporters.YoloV6Exporter, luxonis_ml.data.exporters.YoloV8Exporter, luxonis_ml.data.exporters.YoloV8InstanceSegmentationExporter, luxonis_ml.data.exporters.YoloV8KeypointsExporter

Current partition size in bytes.

dataset_identifier = ¶

Name or identifier used for exported paths.

image_indices: dict = ¶

Per-image export indices used by concrete exporters.

max_partition_size = ¶

Optional maximum partition size in bytes.

max_partition_size_gb = ¶

Optional maximum partition size in GiB.

output_path = ¶

Directory where the export is written.

part = ¶

Current partition index, or None when partitioning is disabled.

@abstractmethod

def _dump_annotations(self, annotations: dict, output_path: Path, part: int | None = None): ¶

Undocumented

@abstractmethod

def _get_data_path(self, output_path: Path, split: str) -> Path: ¶

Return the folder path to store data files for this split.