fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter

class documentation

class VideoClassificationDirectoryTreeImporter(LabeledVideoDatasetImporter): (source)

Constructor: VideoClassificationDirectoryTreeImporter(dataset_dir, compute_metadata, classes, unlabeled, ...)

View In Hierarchy

Importer for a viideo classification directory tree stored on disk.

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

Parameters
dataset_dirthe dataset directory
compute_metadatawhether to produce fiftyone.core.metadata.VideoMetadata instances for each video when importing
classesan optional string or list of strings specifying a subset of classes to load
unlabeledthe name of the subdirectory containing unlabeled images
shufflewhether to randomly shuffle the order in which the samples are imported
seeda random seed to use when shuffling
max_samplesa maximum number of samples to import. By default, all samples are imported
Method __init__ Undocumented
Method __iter__ Undocumented
Method __len__ The total number of samples that will be imported.
Method __next__ Returns information about the next sample in the dataset.
Method get_dataset_info Returns the dataset info for the dataset.
Method setup Performs any necessary setup before importing the first sample in the dataset.
Instance Variable classes Undocumented
Instance Variable compute_metadata Undocumented
Instance Variable unlabeled Undocumented
Property frame_labels_cls The fiftyone.core.labels.Label class(es) returned by this importer within the frame labels that it produces.
Property has_dataset_info Whether this importer produces a dataset info dictionary.
Property has_video_metadata Whether this importer produces fiftyone.core.metadata.VideoMetadata instances for each video.
Property label_cls The fiftyone.core.labels.Label class(es) returned by this importer within the sample-level labels that it produces.
Static Method _get_classes Undocumented
Static Method _get_num_samples Undocumented
Instance Variable _classes Undocumented
Instance Variable _iter_samples Undocumented
Instance Variable _num_samples Undocumented
Instance Variable _samples Undocumented

Inherited from DatasetImporter (via LabeledVideoDatasetImporter):

Method __enter__ Undocumented
Method __exit__ Undocumented
Method close Performs any necessary actions after the last sample has been imported.
Method _preprocess_list Internal utility that preprocesses the given list---which is presumed to be a list defining the samples that should be imported---by applying the values of the shuffle, seed, and max_samples parameters of the importer.
def __init__(self, dataset_dir, compute_metadata=False, classes=None, unlabeled='_unlabeled', shuffle=False, seed=None, max_samples=None): (source)
overrides fiftyone.utils.data.importers.DatasetImporter.__init__

Undocumented

def __iter__(self): (source)
overrides fiftyone.utils.data.importers.DatasetImporter.__iter__

Undocumented

def __len__(self): (source)
overrides fiftyone.utils.data.importers.DatasetImporter.__len__

The total number of samples that will be imported.

Raises
TypeErrorif the total number is not known
def __next__(self): (source)
overrides fiftyone.utils.data.importers.LabeledVideoDatasetImporter.__next__

Returns information about the next sample in the dataset.

Returns
an(video_path, video_metadata, labels, frames)
tuple
, where
Raises
StopIterationif there are no more samples to import
def get_dataset_info(self): (source)
overrides fiftyone.utils.data.importers.DatasetImporter.get_dataset_info

Returns the dataset info for the dataset.

By convention, this method should be called after all samples in the dataset have been imported.

Returns
a dict of dataset info
def setup(self): (source)
overrides fiftyone.utils.data.importers.DatasetImporter.setup

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

This method is called when the importer's context manager interface is entered, DatasetImporter.__enter__.

classes: None = (source)

Undocumented

compute_metadata: False = (source)

Undocumented

unlabeled: "_unlabeled" = (source)

Undocumented

@property
frame_labels_cls = (source)
overrides fiftyone.utils.data.importers.LabeledVideoDatasetImporter.frame_labels_cls

The fiftyone.core.labels.Label class(es) returned by this importer within the frame labels that it produces.

This can be any of the following:

  • a fiftyone.core.labels.Label class. In this case, the importer is guaranteed to return frame labels of this type
  • a list or tuple of fiftyone.core.labels.Label classes. In this case, the importer can produce a single frame label field of any of these types
  • a dict mapping keys to fiftyone.core.labels.Label classes. In this case, the importer will return frame label dictionaries with keys and value-types specified by this dictionary. Not all keys need be present in each frame
  • None. In this case, the importer makes no guarantees about the frame labels that it may return
@property
has_dataset_info = (source)
overrides fiftyone.utils.data.importers.DatasetImporter.has_dataset_info

Whether this importer produces a dataset info dictionary.

@property
has_video_metadata = (source)
overrides fiftyone.utils.data.importers.LabeledVideoDatasetImporter.has_video_metadata

Whether this importer produces fiftyone.core.metadata.VideoMetadata instances for each video.

@property
label_cls = (source)
overrides fiftyone.utils.data.importers.LabeledVideoDatasetImporter.label_cls

The fiftyone.core.labels.Label class(es) returned by this importer within the sample-level labels that it produces.

This can be any of the following:

  • a fiftyone.core.labels.Label class. In this case, the importer is guaranteed to return sample-level labels of this type
  • a list or tuple of fiftyone.core.labels.Label classes. In this case, the importer can produce 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 importer will return sample-level label dictionaries with keys and value-types specified by this dictionary. Not all keys need be present in the imported labels
  • None. In this case, the importer makes no guarantees about the sample-level labels that it may return
@staticmethod
def _get_classes(dataset_dir): (source)

Undocumented

@staticmethod
def _get_num_samples(dataset_dir): (source)

Undocumented

_classes = (source)

Undocumented

_iter_samples = (source)

Undocumented

_num_samples = (source)

Undocumented

_samples = (source)

Undocumented