«

fiftyone.utils.voc.VOCDetectionDatasetImporter

class documentation

class VOCDetectionDatasetImporter(foud.LabeledImageDatasetImporter, foud.ImportPathsMixin): (source)

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

View In Hierarchy

Importer for VOC detection datasets stored on disk.

See :ref:`this page <VOCDetectionDataset-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 images in the data directory (True) rather than only creating samples for images with label entries (False)
extra_attrs

whether to load extra annotation attributes onto the imported labels. Supported values are:

  • True: load all extra attributes found
  • False: do not load extra attributes
  • a name or list of names of specific attributes to load
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 setup Performs any necessary setup before importing the first sample in the dataset.
Instance Variable data_path Undocumented
Instance Variable extra_attrs Undocumented
Instance Variable include_all_data Undocumented
Instance Variable labels_path Undocumented
Property has_dataset_info Whether this importer produces a dataset info dictionary.
Property has_image_metadata Whether this importer produces fiftyone.core.metadata.ImageMetadata instances for each image.
Property label_cls The fiftyone.core.labels.Label class(es) returned by this importer.
Instance Variable _image_paths_map Undocumented
Instance Variable _iter_uuids Undocumented
Instance Variable _labels_paths_map Undocumented
Instance Variable _num_samples Undocumented
Instance Variable _uuids Undocumented

Inherited from DatasetImporter (via LabeledImageDatasetImporter):

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 ImportPathsMixin (via LabeledImageDatasetImporter, 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, extra_attrs=True, 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.LabeledImageDatasetImporter.__next__

Returns information about the next sample in the dataset.

Returns
an(image_path, image_metadata, label)
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__.

data_path: None = (source)

Undocumented

extra_attrs: True = (source)

Undocumented

include_all_data: False = (source)

Undocumented

labels_path: None = (source)

Undocumented

@property
has_dataset_info = (source)
overrides fiftyone.utils.data.importers.DatasetImporter.has_dataset_info

Whether this importer produces a dataset info dictionary.

@property
has_image_metadata = (source)
overrides fiftyone.utils.data.importers.LabeledImageDatasetImporter.has_image_metadata

Whether this importer produces fiftyone.core.metadata.ImageMetadata instances for each image.

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

The fiftyone.core.labels.Label class(es) returned by this importer.

This can be any of the following:

  • a fiftyone.core.labels.Label class. In this case, the importer is guaranteed to return labels of this type
  • a list or tuple of fiftyone.core.labels.Label classes. In this case, the importer can produce a single label field of any of these types
  • a dict mapping keys to fiftyone.core.labels.Label classes. In this case, the importer will return 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 labels that it may return
_image_paths_map = (source)

Undocumented

_iter_uuids = (source)

Undocumented

_labels_paths_map = (source)

Undocumented

_num_samples = (source)

Undocumented

_uuids = (source)

Undocumented