fiftyone.utils.data.exporters.DatasetExporter

class documentation

class DatasetExporter(object): (source)

Known subclasses: fiftyone.utils.data.exporters.BatchDatasetExporter, fiftyone.utils.data.exporters.GenericSampleDatasetExporter, fiftyone.utils.data.exporters.GroupDatasetExporter, fiftyone.utils.data.exporters.LabeledImageDatasetExporter, fiftyone.utils.data.exporters.LabeledVideoDatasetExporter, fiftyone.utils.data.exporters.UnlabeledImageDatasetExporter, fiftyone.utils.data.exporters.UnlabeledMediaDatasetExporter, fiftyone.utils.data.exporters.UnlabeledVideoDatasetExporter

Constructor: DatasetExporter(export_dir)

View In Hierarchy

Base interface for exporting datasets.

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	`__enter__`	Undocumented
Method	`__exit__`	Undocumented
Method	`__init__`	Undocumented
Method	`close`	Performs any necessary actions after the last sample has been exported.
Method	`export_sample`	Exports the given sample to the dataset.
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.
Instance Variable	`export_dir`	Undocumented

def __enter__(self): (source) ¶

Undocumented

def __exit__(self, *args): (source) ¶

Undocumented

def __init__(self, export_dir=None): (source) ¶

overridden in fiftyone.utils.bdd.BDDDatasetExporter, fiftyone.utils.coco.COCODetectionDatasetExporter, fiftyone.utils.csv.CSVDatasetExporter, fiftyone.utils.cvat.CVATImageDatasetExporter, fiftyone.utils.cvat.CVATVideoDatasetExporter, fiftyone.utils.data.exporters.FiftyOneDatasetExporter, fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter, fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter, fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter, fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter, fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter, fiftyone.utils.data.exporters.ImageClassificationDirectoryTreeExporter, fiftyone.utils.data.exporters.ImageDirectoryExporter, fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter, fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter, fiftyone.utils.data.exporters.MediaDirectoryExporter, fiftyone.utils.data.exporters.VideoClassificationDirectoryTreeExporter, fiftyone.utils.data.exporters.VideoDirectoryExporter, fiftyone.utils.geojson.GeoJSONDatasetExporter, fiftyone.utils.kitti.KITTIDetectionDatasetExporter, fiftyone.utils.tf.TFRecordsDatasetExporter, fiftyone.utils.voc.VOCDetectionDatasetExporter, fiftyone.utils.yolo.YOLOv4DatasetExporter, fiftyone.utils.yolo.YOLOv5DatasetExporter

Undocumented

def close(self, *args): (source) ¶

overridden in fiftyone.utils.bdd.BDDDatasetExporter, fiftyone.utils.coco.COCODetectionDatasetExporter, fiftyone.utils.csv.CSVDatasetExporter, fiftyone.utils.cvat.CVATImageDatasetExporter, fiftyone.utils.cvat.CVATVideoDatasetExporter, fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter, fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter, fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter, fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter, fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter, fiftyone.utils.data.exporters.ImageClassificationDirectoryTreeExporter, fiftyone.utils.data.exporters.ImageDirectoryExporter, fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter, fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter, fiftyone.utils.data.exporters.MediaDirectoryExporter, fiftyone.utils.data.exporters.VideoClassificationDirectoryTreeExporter, fiftyone.utils.data.exporters.VideoDirectoryExporter, fiftyone.utils.geojson.GeoJSONDatasetExporter, fiftyone.utils.kitti.KITTIDetectionDatasetExporter, fiftyone.utils.tf.TFRecordsDatasetExporter, fiftyone.utils.voc.VOCDetectionDatasetExporter, fiftyone.utils.yolo.YOLOv4DatasetExporter, fiftyone.utils.yolo.YOLOv5DatasetExporter

Performs any necessary actions after the last sample has been exported.

This method is called when the exporter's context manager interface is exited, DatasetExporter.__exit__.

Parameters
*args	the arguments to `DatasetExporter.__exit__`

def export_sample(self, *args, **kwargs): (source) ¶

overridden in fiftyone.utils.data.exporters.BatchDatasetExporter, fiftyone.utils.data.exporters.GenericSampleDatasetExporter, fiftyone.utils.data.exporters.GroupDatasetExporter, fiftyone.utils.data.exporters.LabeledImageDatasetExporter, fiftyone.utils.data.exporters.LabeledVideoDatasetExporter, fiftyone.utils.data.exporters.UnlabeledImageDatasetExporter, fiftyone.utils.data.exporters.UnlabeledMediaDatasetExporter, fiftyone.utils.data.exporters.UnlabeledVideoDatasetExporter

Exports the given sample to the dataset.

Parameters
*args	subclass-specific positional arguments
**kwargs	subclass-specific keyword arguments

def log_collection(self, sample_collection): (source) ¶

overridden in fiftyone.utils.coco.COCODetectionDatasetExporter, fiftyone.utils.cvat.CVATImageDatasetExporter, fiftyone.utils.cvat.CVATVideoDatasetExporter, fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter, fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter, fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter, fiftyone.utils.geojson.GeoJSONDatasetExporter

Logs any relevant information about the fiftyone.core.collections.SampleCollection whose samples will be exported.

Subclasses can optionally implement this method if their export format can record information such as the fiftyone.core.collections.SampleCollection.info of the collection being exported.

By convention, this method must be optional; i.e., if it is not called before the first call to export_sample, then the exporter must make do without any information about the fiftyone.core.collections.SampleCollection (which may not be available, for example, if the samples being exported are not stored in a collection).

Parameters
sample_collection	the `fiftyone.core.collections.SampleCollection` whose samples will be exported

def setup(self): (source) ¶

Performs any necessary setup before exporting the first sample in the dataset.

This method is called when the exporter's context manager interface is entered, DatasetExporter.__enter__.

export_dir: None = (source) ¶

Undocumented