fiftyone.utils.data.exporters.BatchDatasetExporter

class documentation

class BatchDatasetExporter(DatasetExporter): (source)

Base interface for exporters that export entire fiftyone.core.collections.SampleCollection instances in a single batch.

This interface allows for greater efficiency for export formats that handle aggregating over the samples themselves.

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.
Method	`export_samples`	Exports the given sample collection.

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, *args, **kwargs): (source) ¶

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

Exports the given sample to the dataset.

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

def export_samples(self, sample_collection, progress=None): (source) ¶

overridden in fiftyone.utils.csv.CSVDatasetExporter, fiftyone.utils.data.exporters.FiftyOneDatasetExporter

Exports the given sample collection.

Parameters
sample_collection	a `fiftyone.core.collections.SampleCollection`
progress:`None`	whether to render a progress bar (True/False), use the default value `fiftyone.config.show_progress_bars` (None), or a progress callback function to invoke instead