class documentation

Interface for importing datasets of unlabeled video samples.

Typically, dataset importers should implement the parameters documented on this class, although this is not mandatory.

See :ref:`this page <writing-a-custom-dataset-importer>` for information about implementing/using dataset importers.

Parameters
dataset_dirthe dataset directory. This may be optional for some importers
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 __next__ Returns information about the next sample in the dataset.
Property has_video_metadata Whether this importer produces fiftyone.core.metadata.VideoMetadata instances for each video.

Inherited from DatasetImporter:

Method __enter__ Undocumented
Method __exit__ Undocumented
Method __init__ Undocumented
Method __iter__ Undocumented
Method __len__ The total number of samples that will be imported.
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 setup Performs any necessary setup before importing the first sample in the dataset.
Property has_dataset_info Whether this importer produces a dataset info dictionary.
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 __next__(self): (source)

Returns information about the next sample in the dataset.

Returns
an(video_path, video_metadata)
tuple
, where
Raises
StopIterationif there are no more samples to import