fiftyone.utils.data.exporters.UnlabeledImageDatasetExporter

class documentation

class UnlabeledImageDatasetExporter(DatasetExporter): (source)

Interface for exporting datasets of unlabeled 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	`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, metadata=None): (source) ¶

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

overridden in fiftyone.utils.data.exporters.ImageDirectoryExporter

Exports the given sample to the dataset.

Parameters
image_or_path	an image or the path to the image on disk
metadata:`None`	a `fiftyone.core.metadata.ImageMetadata` instance for the sample. Only required when `requires_image_metadata` is `True`

overridden in fiftyone.utils.data.exporters.ImageDirectoryExporter

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