fiftyone.utils.data.exporters.VideoClassificationDirectoryTreeExporter

class documentation

class VideoClassificationDirectoryTreeExporter(LabeledVideoDatasetExporter): (source)

Constructor: VideoClassificationDirectoryTreeExporter(export_dir, export_media, rel_dir)

Exporter that writes a video classification directory tree to disk.

See :ref:`this page <VideoClassificationDirectoryTree-export>` for format details.

The filenames of the input images are maintained, unless a name conflict would occur, in which case an index of the form "-%d" % count is appended to the base filename.

Parameters
export_dir	the directory to write the export
export_media	controls how to export the raw media. The supported values are: `True` (default): 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
rel_dir	an optional relative directory to strip from each input filepath to generate a unique identifier for each video. When exporting media, this identifier is joined with `export_dir` to generate an output path for each exported video. 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`

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	`setup`	Performs any necessary setup before exporting the first sample in the dataset.
Instance Variable	`export_media`	Undocumented
Instance Variable	`rel_dir`	Undocumented
Property	`frame_labels_cls`	The `fiftyone.core.labels.Label` class(es) that can be exported by this exporter at the frame-level.
Property	`label_cls`	The `fiftyone.core.labels.Label` class(es) that can be exported at the sample-level.
Property	`requires_video_metadata`	Whether this exporter requires `fiftyone.core.metadata.VideoMetadata` instances for each sample being exported.
Instance Variable	`_class_counts`	Undocumented
Instance Variable	`_filename_counts`	Undocumented
Instance Variable	`_media_exporter`	Undocumented

Inherited from DatasetExporter (via LabeledVideoDatasetExporter):

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

def __init__(self, export_dir, export_media=None, rel_dir=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_sample(self, video_path, classification, _, metadata=None): (source) ¶

overrides fiftyone.utils.data.exporters.LabeledVideoDatasetExporter.export_sample

Exports the given sample to the dataset.

Parameters
video_path	the path to a video on disk
classification	Undocumented
_	Undocumented
metadata:`None`	a `fiftyone.core.metadata.VideoMetadata` instance for the sample. Only required when `requires_video_metadata` is `True`
label	an instance of `label_cls`, or a dictionary mapping field names to `fiftyone.core.labels.Label` instances, or `None` if the sample has no sample-level labels
frames	a dictionary mapping frame numbers to dictionaries that map field names to `fiftyone.core.labels.Label` instances, or `None` if the sample has no frame-level labels

def setup(self): (source) ¶

overrides fiftyone.utils.data.exporters.DatasetExporter.setup

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_media: None = (source) ¶

Undocumented

rel_dir: None = (source) ¶

Undocumented

@property
frame_labels_cls = (source) ¶

overrides fiftyone.utils.data.exporters.LabeledVideoDatasetExporter.frame_labels_cls

The fiftyone.core.labels.Label class(es) that can be exported by this exporter at the frame-level.

This can be any of the following:

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

@property
label_cls = (source) ¶

overrides fiftyone.utils.data.exporters.LabeledVideoDatasetExporter.label_cls

The fiftyone.core.labels.Label class(es) that can be exported at the sample-level.

This can be any of the following:

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

@property
requires_video_metadata = (source) ¶

overrides fiftyone.utils.data.exporters.LabeledVideoDatasetExporter.requires_video_metadata

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

_class_counts = (source) ¶

Undocumented

_filename_counts = (source) ¶

Undocumented

_media_exporter = (source) ¶

Undocumented