fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor

class documentation

class LabeledVideoDatasetIngestor(LabeledVideoDatasetImporter, VideoIngestor): (source)

Constructor: LabeledVideoDatasetIngestor(dataset_dir, samples, sample_parser, max_samples)

View In Hierarchy

Dataset importer that ingests labeled videos into the provided dataset_dir during import.

The source videos and labels are parsed from the provided samples using the provided fiftyone.utils.data.parsers.LabeledVideoSampleParser.

The source videos are directly copied from their source locations into dataset_dir, maintaining the original filenames, unless a name conflict would occur, in which case an index of the form "-%d" % count is appended to the base filename.

Parameters
dataset_dirthe directory where input videos will be ingested into
samplesan iterable of samples that can be parsed by sample_parser
sample_parseran fiftyone.utils.data.parsers.LabeledVideoSampleParser to use to parse the samples
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 setup Performs any necessary setup before importing the first sample in the dataset.
Instance Variable sample_parser Undocumented
Instance Variable samples 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.
Instance Variable _iter_samples Undocumented
Instance Variable _num_imported Undocumented
Instance Variable _num_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 get_dataset_info Returns the dataset info for the dataset.
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.

Inherited from VideoIngestor (via LabeledVideoDatasetImporter, DatasetImporter):

Method _ingest_video Undocumented
Method _setup Undocumented
Instance Variable _filename_maker Undocumented
def __init__(self, dataset_dir, samples, sample_parser, 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 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__.

sample_parser = (source)

Undocumented

samples = (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
_iter_samples = (source)

Undocumented

_num_imported: int = (source)

Undocumented

_num_samples = (source)

Undocumented