fiftyone.utils.csv.CSVDatasetExporter

class documentation

class CSVDatasetExporter(foud.BatchDatasetExporter, foud.ExportPathsMixin): (source)

Constructor: CSVDatasetExporter(export_dir, data_path, labels_path, export_media, ...)

A flexible CSV exporter that represents slice(s) of field values of a dataset as columns of a CSV file.

See :ref:`this page <CSVDataset-export>` for exporting datasets of this type.

Parameters
export_dir	the directory to write the export. This has no effect if `data_path` and `labels_path` are absolute paths
data_path	an optional parameter that enables explicit control over the location of the exported media. Can be any of the following: a folder name like `"data"` or `"data/"` specifying a subfolder of `export_dir` in which to export the media an absolute directory path in which to export the media. In this case, the `export_dir` has no effect on the location of the data a JSON filename like `"data.json"` specifying the filename of the manifest file in `export_dir` generated when `export_media` is `"manifest"` an absolute filepath specifying the location to write the JSON manifest file when `export_media` is `"manifest"`. In this case, `export_dir` has no effect on the location of the data If None, the default value of this parameter will be chosen based on the value of the `export_media` parameter
labels_path	an optional parameter that enables explicit control over the location of the exported labels. Can be any of the following: a filename like `"labels.csv"` specifying the location in `export_dir` in which to export the labels an absolute filepath to which to export the labels. In this case, the `export_dir` has no effect on the location of the labels If None, the labels will be exported into `export_dir` using the default filename
export_media	controls how to export the raw media. The supported values are: `True`: copy all media files into the output directory `False`: don't export media `"move"`: move all media files into the output directory `"symlink"`: create symlinks to the media files in the output directory `"manifest"`: create a `data.json` in the output directory that maps UUIDs used in the labels files to the filepaths of the source media, rather than exporting the actual media If None, the default value of this parameter will be chosen based on the value of the `data_path` parameter
rel_dir	an optional relative directory to strip from each input filepath to generate a unique identifier for each media. When exporting media, this identifier is joined with `data_path` to generate an output path for each exported media. This argument allows for populating nested subdirectories that match the shape of the input paths. The path is converted to an absolute path (if necessary) via `fiftyone.core.storage.normalize_path`
abs_paths	whether to store absolute paths to the media in the exported labels
media_field	the name of the field containing the media to export for each sample
fields	an optional argument specifying the fields or `embedding.field.names` to include as columns in the exported CSV. Can be: a field or iterable of fields a dict mapping field names to column names By default, only the `media_field` is exported

Method	`__init__`	Undocumented
Method	`close`	Performs any necessary actions after the last sample has been exported.
Method	`export_samples`	Exports the given sample collection.
Method	`setup`	Performs any necessary setup before exporting the first sample in the dataset.
Instance Variable	`abs_paths`	Undocumented
Instance Variable	`data_path`	Undocumented
Instance Variable	`export_media`	Undocumented
Instance Variable	`fields`	Undocumented
Instance Variable	`labels_path`	Undocumented
Instance Variable	`media_field`	Undocumented
Instance Variable	`rel_dir`	Undocumented
Instance Variable	`_csv_writer`	Undocumented
Instance Variable	`_f`	Undocumented
Instance Variable	`_include_media`	Undocumented
Instance Variable	`_media_exporter`	Undocumented
Instance Variable	`_media_idx`	Undocumented
Instance Variable	`_needs_metadata`	Undocumented
Instance Variable	`_paths`	Undocumented

Inherited from BatchDatasetExporter:

Method export_sample Exports the given sample to the dataset.

Inherited from DatasetExporter (via BatchDatasetExporter):

Method	`__enter__`	Undocumented
Method	`__exit__`	Undocumented
Method	`log_collection`	Logs any relevant information about the `fiftyone.core.collections.SampleCollection` whose samples will be exported.

Inherited from ExportPathsMixin (via BatchDatasetExporter, DatasetExporter):

Static Method	`_parse_data_path`	Helper function that computes default values for the `data_path` and `export_media` parameters supported by many exporters.
Static Method	`_parse_labels_path`	Helper function that computes default values for the `labels_path` parameter supported by many exporters.

def __init__(self, export_dir=None, data_path=None, labels_path=None, export_media=None, rel_dir=None, abs_paths=False, media_field='filepath', fields=None): (source) ¶

overrides fiftyone.utils.data.exporters.DatasetExporter.__init__

Undocumented

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

overrides fiftyone.utils.data.exporters.DatasetExporter.close

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_samples(self, sample_collection, progress=None): (source) ¶

overrides fiftyone.utils.data.exporters.BatchDatasetExporter.export_samples

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