fiftyone.utils.openimages.OpenImagesDatasetImporter

class documentation

class OpenImagesDatasetImporter(foud.LabeledImageDatasetImporter): (source)

Known subclasses: fiftyone.utils.openimages.OpenImagesV6DatasetImporter, fiftyone.utils.openimages.OpenImagesV7DatasetImporter

Constructor: OpenImagesDatasetImporter(dataset_dir, label_types, classes, attrs, ...)

View In Hierarchy

Base class for importing datasets in Open Images format.

See fiftyone.types.OpenImagesDataset for format details.

Parameters
dataset_dir	the dataset directory
label_types	a label type or list of label types to load. The supported values are `("detections", "classifications", "points", "relationships", "segmentations")`. "points" are only supported for open-images-v7. By default, all supported label types for version are loaded
classes	a string or list of strings specifying required classes to load. If provided, only samples containing at least one instance of a specified class will be loaded
attrs	a string or list of strings specifying required relationship attributes to load. Only applicable when `label_types` includes "relationships". If provided, only samples containing at least one instance of a specified attribute will be loaded
image_ids	an optional list of specific image IDs to load. Can be provided in any of the following formats: a list of `<image-id>` strings a list of `<split>/<image-id>` strings the path to a text (newline-separated), JSON, or CSV file containing the list of image IDs to load in either of the first two formats
include_id	whether to load the Open Images ID for each sample along with the labels
only_matching	whether to only load labels that match the `classes` or `attrs` requirements that you provide (True), or to load all labels for samples that match the requirements (False)
load_hierarchy	whether to load the classes hierarchy and add it to the dataset's `info` dictionary
shuffle	whether to randomly shuffle the order in which the samples are imported
seed	a random seed to use when shuffling
max_samples	a maximum number of samples to load. If `label_types`, `classes`, and/or `attrs` are also specified, first priority will be given to samples that contain all of the specified label types, classes, and/or attributes, followed by samples that contain at least one of the specified labels types or classes. The actual number of samples loaded may be less than this maximum value if the dataset does not contain sufficient samples matching your requirements. By default, all matching samples are loaded

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	`attrs`	Undocumented
Instance Variable	`classes`	Undocumented
Instance Variable	`image_ids`	Undocumented
Instance Variable	`label_types`	Undocumented
Instance Variable	`load_hierarchy`	Undocumented
Instance Variable	`only_matching`	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	`_attrs_map`	Undocumented
Instance Variable	`_classes_map`	Undocumented
Instance Variable	`_cls_data`	Undocumented
Instance Variable	`_det_data`	Undocumented
Instance Variable	`_images_map`	Undocumented
Instance Variable	`_info`	Undocumented
Instance Variable	`_iter_uuids`	Undocumented
Instance Variable	`_pnt_data`	Undocumented
Instance Variable	`_point_classes_map`	Undocumented
Instance Variable	`_rel_data`	Undocumented
Instance Variable	`_seg_data`	Undocumented
Instance Variable	`_uuids`	Undocumented
Property	`_has_scalar_labels`	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	`_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, label_types=None, classes=None, attrs=None, image_ids=None, include_id=True, only_matching=False, load_hierarchy=True, shuffle=False, seed=None, max_samples=None): (source) ¶

overrides fiftyone.utils.data.importers.DatasetImporter.__init__

overridden in fiftyone.utils.openimages.OpenImagesV6DatasetImporter, fiftyone.utils.openimages.OpenImagesV7DatasetImporter

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
`TypeError`	if 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`	`image_path`: the path to the image on disk `image_metadata`: an `fiftyone.core.metadata.ImageMetadata` instances for the image, or `None` if `has_image_metadata` is `False` `label`: an instance of `label_cls`, or a dictionary mapping field names to `fiftyone.core.labels.Label` instances, or `None` if the sample is unlabeled
Raises
`StopIteration`	if 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__.

attrs: None = (source) ¶

overridden in fiftyone.utils.openimages.OpenImagesV6DatasetImporter, fiftyone.utils.openimages.OpenImagesV7DatasetImporter

Undocumented

classes: None = (source) ¶

overridden in fiftyone.utils.openimages.OpenImagesV6DatasetImporter, fiftyone.utils.openimages.OpenImagesV7DatasetImporter

Undocumented

image_ids: None = (source) ¶

overridden in fiftyone.utils.openimages.OpenImagesV6DatasetImporter, fiftyone.utils.openimages.OpenImagesV7DatasetImporter

Undocumented

label_types: None = (source) ¶

overridden in fiftyone.utils.openimages.OpenImagesV6DatasetImporter, fiftyone.utils.openimages.OpenImagesV7DatasetImporter

Undocumented

load_hierarchy: True = (source) ¶

overridden in fiftyone.utils.openimages.OpenImagesV6DatasetImporter, fiftyone.utils.openimages.OpenImagesV7DatasetImporter

Undocumented

only_matching: False = (source) ¶

overridden in fiftyone.utils.openimages.OpenImagesV6DatasetImporter, fiftyone.utils.openimages.OpenImagesV7DatasetImporter

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