fiftyone.utils.data.importers.LabeledImageDatasetImporter

class documentation

class LabeledImageDatasetImporter(DatasetImporter): (source)

Constructor: LabeledImageDatasetImporter(dataset_dir, shuffle, seed, max_samples)

View In Hierarchy

Interface for importing datasets of labeled image 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_dir	the dataset directory. This may be optional for some importers
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 import. By default, all samples are imported

Method	`__next__`	Returns information about the next sample in the dataset.
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.

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) ¶

overrides fiftyone.utils.data.importers.DatasetImporter.__next__

overridden in fiftyone.utils.bdd.BDDDatasetImporter, fiftyone.utils.coco.COCODetectionDatasetImporter, fiftyone.utils.cvat.CVATImageDatasetImporter, fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter, fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter, fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter, fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter, fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter, fiftyone.utils.data.ingestors.LabeledImageDatasetIngestor, fiftyone.utils.dicom.DICOMDatasetImporter, fiftyone.utils.geotiff.GeoTIFFDatasetImporter, fiftyone.utils.kitti.KITTIDetectionDatasetImporter, fiftyone.utils.openimages.OpenImagesDatasetImporter, fiftyone.utils.openlabel.OpenLABELImageDatasetImporter, fiftyone.utils.places.PlacesDatasetImporter, fiftyone.utils.tf.TFRecordsLabeledImageDatasetImporter, fiftyone.utils.voc.VOCDetectionDatasetImporter, fiftyone.utils.yolo.YOLOv4DatasetImporter, fiftyone.utils.yolo.YOLOv5DatasetImporter

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

@property
has_image_metadata = (source) ¶

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

@property
label_cls = (source) ¶

overridden in fiftyone.utils.bdd.BDDDatasetImporter, fiftyone.utils.coco.COCODetectionDatasetImporter, fiftyone.utils.cvat.CVATImageDatasetImporter, fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter, fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter, fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter, fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter, fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter, fiftyone.utils.data.ingestors.LabeledImageDatasetIngestor, fiftyone.utils.dicom.DICOMDatasetImporter, fiftyone.utils.geotiff.GeoTIFFDatasetImporter, fiftyone.utils.kitti.KITTIDetectionDatasetImporter, fiftyone.utils.openimages.OpenImagesDatasetImporter, fiftyone.utils.openlabel.OpenLABELImageDatasetImporter, fiftyone.utils.places.PlacesDatasetImporter, fiftyone.utils.tf.TFImageClassificationDatasetImporter, fiftyone.utils.tf.TFObjectDetectionDatasetImporter, fiftyone.utils.voc.VOCDetectionDatasetImporter, fiftyone.utils.yolo.YOLOv4DatasetImporter, fiftyone.utils.yolo.YOLOv5DatasetImporter

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