fiftyone.utils.cvat.CVATVideoDatasetImporter

class documentation

class CVATVideoDatasetImporter(foud.LabeledVideoDatasetImporter, foud.ImportPathsMixin): (source)

Constructor: CVATVideoDatasetImporter(dataset_dir, data_path, labels_path, include_all_data, ...)

View In Hierarchy

Importer for CVAT video datasets stored on disk.

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

Parameters
dataset_dirthe dataset directory. If omitted, data_path and/or labels_path must be provided
data_path

an optional parameter that enables explicit control over the location of the media. Can be any of the following:

  • a folder name like "data" or "data/" specifying a subfolder of dataset_dir where the media files reside
  • an absolute directory path where the media files reside. In this case, the dataset_dir has no effect on the location of the data
  • a filename like "data.json" specifying the filename of the JSON data manifest file in dataset_dir
  • an absolute filepath specifying the location of the JSON data manifest. In this case, dataset_dir has no effect on the location of the data
  • a dict mapping filenames to absolute filepaths

If None, this parameter will default to whichever of data/ or data.json exists in the dataset directory

labels_path

an optional parameter that enables explicit control over the location of the labels. Can be any of the following:

  • a folder name like "labels" or "labels/" specifying the location of the labels in dataset_dir
  • an absolute folder path to the labels. In this case, dataset_dir has no effect on the location of the labels

If None, the parameter will default to labels/

include_all_datawhether to generate samples for all videos in the data directory (True) rather than only creating samples for videos with label entries (False)
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 data_path Undocumented
Instance Variable include_all_data Undocumented
Instance Variable labels_path 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 _cvat_task_labels Undocumented
Instance Variable _info Undocumented
Instance Variable _iter_uuids Undocumented
Instance Variable _labels_paths_map Undocumented
Instance Variable _num_samples Undocumented
Instance Variable _uuids Undocumented
Instance Variable _video_paths_map 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.

Inherited from ImportPathsMixin (via LabeledVideoDatasetImporter, DatasetImporter):

Static Method _load_data_map Helper function that parses either a data directory or a data manifest file into a UUID -> filepath map.
Static Method _parse_data_path Helper function that computes default values for the data_path parameter supported by many importers.
Static Method _parse_labels_path Helper function that computes default values for the labels_path parameter supported by many importers.
def __init__(self, dataset_dir=None, data_path=None, labels_path=None, include_all_data=False, 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__.

data_path: None = (source)

Undocumented

include_all_data: False = (source)

Undocumented

labels_path: None = (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
_cvat_task_labels = (source)

Undocumented

_info = (source)

Undocumented

_iter_uuids = (source)

Undocumented

_labels_paths_map = (source)

Undocumented

_num_samples = (source)

Undocumented

_uuids = (source)

Undocumented

_video_paths_map = (source)

Undocumented