fiftyone.utils.data.exporters.LabeledImageDatasetExporter

class documentation

class LabeledImageDatasetExporter(DatasetExporter): (source)

Constructor: LabeledImageDatasetExporter(export_dir)

View In Hierarchy

Interface for exporting datasets of labeled image samples.

See :ref:`this page <writing-a-custom-dataset-exporter>` for information about implementing/using dataset exporters.

Parameters
export_dir	the directory to write the export. This may be optional for some exporters

Method	`export_sample`	Exports the given sample to the dataset.
Property	`label_cls`	The `fiftyone.core.labels.Label` class(es) exported by this exporter.
Property	`requires_image_metadata`	Whether this exporter requires `fiftyone.core.metadata.ImageMetadata` instances for each sample being exported.

Inherited from DatasetExporter:

Method	`__enter__`	Undocumented
Method	`__exit__`	Undocumented
Method	`__init__`	Undocumented
Method	`close`	Performs any necessary actions after the last sample has been exported.
Method	`log_collection`	Logs any relevant information about the `fiftyone.core.collections.SampleCollection` whose samples will be exported.
Method	`setup`	Performs any necessary setup before exporting the first sample in the dataset.

def export_sample(self, image_or_path, label, metadata=None): (source) ¶

overrides fiftyone.utils.data.exporters.DatasetExporter.export_sample

overridden in fiftyone.utils.bdd.BDDDatasetExporter, fiftyone.utils.coco.COCODetectionDatasetExporter, fiftyone.utils.cvat.CVATImageDatasetExporter, fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter, fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter, fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter, fiftyone.utils.data.exporters.ImageClassificationDirectoryTreeExporter, fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter, fiftyone.utils.kitti.KITTIDetectionDatasetExporter, fiftyone.utils.tf.TFRecordsDatasetExporter, fiftyone.utils.voc.VOCDetectionDatasetExporter, fiftyone.utils.yolo.YOLOv4DatasetExporter, fiftyone.utils.yolo.YOLOv5DatasetExporter

Exports the given sample to the dataset.

Parameters
image_or_path	an image or the path to the image on disk
label	an instance of `label_cls`, or a dictionary mapping field names to `fiftyone.core.labels.Label` instances, or `None` if the sample is unlabeled
metadata:`None`	a `fiftyone.core.metadata.ImageMetadata` instance for the sample. Only required when `requires_image_metadata` is `True`

@property
label_cls = (source) ¶

overridden in fiftyone.utils.bdd.BDDDatasetExporter, fiftyone.utils.coco.COCODetectionDatasetExporter, fiftyone.utils.cvat.CVATImageDatasetExporter, fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter, fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter, fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter, fiftyone.utils.data.exporters.ImageClassificationDirectoryTreeExporter, fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter, fiftyone.utils.kitti.KITTIDetectionDatasetExporter, fiftyone.utils.tf.TFImageClassificationDatasetExporter, fiftyone.utils.tf.TFObjectDetectionDatasetExporter, fiftyone.utils.voc.VOCDetectionDatasetExporter, fiftyone.utils.yolo.YOLOv4DatasetExporter, fiftyone.utils.yolo.YOLOv5DatasetExporter

The fiftyone.core.labels.Label class(es) exported by this exporter.

This can be any of the following:

a fiftyone.core.labels.Label class. In this case, the exporter directly exports labels of this type
a list or tuple of fiftyone.core.labels.Label classes. In this case, the exporter can export a single label field of any of these types
a dict mapping keys to fiftyone.core.labels.Label classes. In this case, the exporter can handle label dictionaries with value-types specified by this dictionary. Not all keys need be present in the exported label dicts
None. In this case, the exporter makes no guarantees about the labels that it can export

@property
requires_image_metadata = (source) ¶

Whether this exporter requires fiftyone.core.metadata.ImageMetadata instances for each sample being exported.