# fiftyone.utils.data * [fiftyone.utils.data.base](fiftyone.utils.data.base.md) * [`map_values()`](fiftyone.utils.data.base.md#fiftyone.utils.data.base.map_values) * [`parse_images_dir()`](fiftyone.utils.data.base.md#fiftyone.utils.data.base.parse_images_dir) * [`parse_videos_dir()`](fiftyone.utils.data.base.md#fiftyone.utils.data.base.parse_videos_dir) * [`parse_image_classification_dir_tree()`](fiftyone.utils.data.base.md#fiftyone.utils.data.base.parse_image_classification_dir_tree) * [`download_image_classification_dataset()`](fiftyone.utils.data.base.md#fiftyone.utils.data.base.download_image_classification_dataset) * [`download_images()`](fiftyone.utils.data.base.md#fiftyone.utils.data.base.download_images) * [fiftyone.utils.data.converters](fiftyone.utils.data.converters.md) * [`convert_dataset()`](fiftyone.utils.data.converters.md#fiftyone.utils.data.converters.convert_dataset) * [fiftyone.utils.data.exporters](fiftyone.utils.data.exporters.md) * [`export_samples()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.export_samples) * [`write_dataset()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.write_dataset) * [`build_dataset_exporter()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.build_dataset_exporter) * [`ExportPathsMixin`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.ExportPathsMixin) * [`MediaExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.MediaExporter) * [`MediaExporter.setup()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.MediaExporter.setup) * [`MediaExporter.is_reference_export`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.MediaExporter.is_reference_export) * [`MediaExporter.setup_reference_export()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.MediaExporter.setup_reference_export) * [`MediaExporter.export_reference_asset()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.MediaExporter.export_reference_asset) * [`MediaExporter.export_sample()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.MediaExporter.export_sample) * [`MediaExporter.export()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.MediaExporter.export) * [`MediaExporter.close()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.MediaExporter.close) * [`ImageExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.ImageExporter) * [`ImageExporter.close()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.ImageExporter.close) * [`ImageExporter.export()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.ImageExporter.export) * [`ImageExporter.export_reference_asset()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.ImageExporter.export_reference_asset) * [`ImageExporter.export_sample()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.ImageExporter.export_sample) * [`ImageExporter.is_reference_export`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.ImageExporter.is_reference_export) * [`ImageExporter.setup()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.ImageExporter.setup) * [`ImageExporter.setup_reference_export()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.ImageExporter.setup_reference_export) * [`VideoExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.VideoExporter) * [`VideoExporter.close()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.VideoExporter.close) * [`VideoExporter.export()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.VideoExporter.export) * [`VideoExporter.export_reference_asset()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.VideoExporter.export_reference_asset) * [`VideoExporter.export_sample()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.VideoExporter.export_sample) * [`VideoExporter.is_reference_export`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.VideoExporter.is_reference_export) * [`VideoExporter.setup()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.VideoExporter.setup) * [`VideoExporter.setup_reference_export()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.VideoExporter.setup_reference_export) * [`DatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.DatasetExporter) * [`DatasetExporter.setup()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.DatasetExporter.setup) * [`DatasetExporter.log_collection()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.DatasetExporter.log_collection) * [`DatasetExporter.export_sample()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.DatasetExporter.export_sample) * [`DatasetExporter.close()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.DatasetExporter.close) * [`BatchDatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.BatchDatasetExporter) * [`BatchDatasetExporter.export_sample()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.BatchDatasetExporter.export_sample) * [`BatchDatasetExporter.export_samples()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.BatchDatasetExporter.export_samples) * [`BatchDatasetExporter.close()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.BatchDatasetExporter.close) * [`BatchDatasetExporter.log_collection()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.BatchDatasetExporter.log_collection) * [`BatchDatasetExporter.setup()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.BatchDatasetExporter.setup) * [`GenericSampleDatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.GenericSampleDatasetExporter) * [`GenericSampleDatasetExporter.export_sample()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.GenericSampleDatasetExporter.export_sample) * [`GenericSampleDatasetExporter.close()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.GenericSampleDatasetExporter.close) * [`GenericSampleDatasetExporter.log_collection()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.GenericSampleDatasetExporter.log_collection) * [`GenericSampleDatasetExporter.setup()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.GenericSampleDatasetExporter.setup) * [`GroupDatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.GroupDatasetExporter) * [`GroupDatasetExporter.export_sample()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.GroupDatasetExporter.export_sample) * [`GroupDatasetExporter.export_group()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.GroupDatasetExporter.export_group) * [`GroupDatasetExporter.close()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.GroupDatasetExporter.close) * [`GroupDatasetExporter.log_collection()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.GroupDatasetExporter.log_collection) * [`GroupDatasetExporter.setup()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.GroupDatasetExporter.setup) * [`UnlabeledImageDatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.UnlabeledImageDatasetExporter) * [`UnlabeledImageDatasetExporter.requires_image_metadata`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.UnlabeledImageDatasetExporter.requires_image_metadata) * [`UnlabeledImageDatasetExporter.export_sample()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.UnlabeledImageDatasetExporter.export_sample) * [`UnlabeledImageDatasetExporter.close()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.UnlabeledImageDatasetExporter.close) * [`UnlabeledImageDatasetExporter.log_collection()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.UnlabeledImageDatasetExporter.log_collection) * [`UnlabeledImageDatasetExporter.setup()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.UnlabeledImageDatasetExporter.setup) * [`UnlabeledVideoDatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.UnlabeledVideoDatasetExporter) * [`UnlabeledVideoDatasetExporter.requires_video_metadata`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.UnlabeledVideoDatasetExporter.requires_video_metadata) * [`UnlabeledVideoDatasetExporter.export_sample()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.UnlabeledVideoDatasetExporter.export_sample) * [`UnlabeledVideoDatasetExporter.close()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.UnlabeledVideoDatasetExporter.close) * [`UnlabeledVideoDatasetExporter.log_collection()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.UnlabeledVideoDatasetExporter.log_collection) * [`UnlabeledVideoDatasetExporter.setup()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.UnlabeledVideoDatasetExporter.setup) * [`UnlabeledMediaDatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.UnlabeledMediaDatasetExporter) * [`UnlabeledMediaDatasetExporter.requires_metadata`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.UnlabeledMediaDatasetExporter.requires_metadata) * [`UnlabeledMediaDatasetExporter.export_sample()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.UnlabeledMediaDatasetExporter.export_sample) * [`UnlabeledMediaDatasetExporter.close()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.UnlabeledMediaDatasetExporter.close) * [`UnlabeledMediaDatasetExporter.log_collection()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.UnlabeledMediaDatasetExporter.log_collection) * [`UnlabeledMediaDatasetExporter.setup()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.UnlabeledMediaDatasetExporter.setup) * [`LabeledImageDatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.LabeledImageDatasetExporter) * [`LabeledImageDatasetExporter.requires_image_metadata`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.LabeledImageDatasetExporter.requires_image_metadata) * [`LabeledImageDatasetExporter.label_cls`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.LabeledImageDatasetExporter.label_cls) * [`LabeledImageDatasetExporter.export_sample()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.LabeledImageDatasetExporter.export_sample) * [`LabeledImageDatasetExporter.close()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.LabeledImageDatasetExporter.close) * [`LabeledImageDatasetExporter.log_collection()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.LabeledImageDatasetExporter.log_collection) * [`LabeledImageDatasetExporter.setup()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.LabeledImageDatasetExporter.setup) * [`LabeledVideoDatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.LabeledVideoDatasetExporter) * [`LabeledVideoDatasetExporter.requires_video_metadata`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.LabeledVideoDatasetExporter.requires_video_metadata) * [`LabeledVideoDatasetExporter.label_cls`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.LabeledVideoDatasetExporter.label_cls) * [`LabeledVideoDatasetExporter.frame_labels_cls`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.LabeledVideoDatasetExporter.frame_labels_cls) * [`LabeledVideoDatasetExporter.export_sample()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.LabeledVideoDatasetExporter.export_sample) * [`LabeledVideoDatasetExporter.close()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.LabeledVideoDatasetExporter.close) * [`LabeledVideoDatasetExporter.log_collection()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.LabeledVideoDatasetExporter.log_collection) * [`LabeledVideoDatasetExporter.setup()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.LabeledVideoDatasetExporter.setup) * [`LegacyFiftyOneDatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter) * [`LegacyFiftyOneDatasetExporter.supports_media_references`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.supports_media_references) * [`LegacyFiftyOneDatasetExporter.setup()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.setup) * [`LegacyFiftyOneDatasetExporter.log_collection()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.log_collection) * [`LegacyFiftyOneDatasetExporter.export_sample()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.export_sample) * [`LegacyFiftyOneDatasetExporter.close()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.close) * [`FiftyOneDatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneDatasetExporter) * [`FiftyOneDatasetExporter.supports_media_references`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneDatasetExporter.supports_media_references) * [`FiftyOneDatasetExporter.setup()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneDatasetExporter.setup) * [`FiftyOneDatasetExporter.export_samples()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneDatasetExporter.export_samples) * [`FiftyOneDatasetExporter.close()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneDatasetExporter.close) * [`FiftyOneDatasetExporter.export_sample()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneDatasetExporter.export_sample) * [`FiftyOneDatasetExporter.log_collection()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneDatasetExporter.log_collection) * [`ImageDirectoryExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.ImageDirectoryExporter) * [`ImageDirectoryExporter.requires_image_metadata`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.ImageDirectoryExporter.requires_image_metadata) * [`ImageDirectoryExporter.setup()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.ImageDirectoryExporter.setup) * [`ImageDirectoryExporter.export_sample()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.ImageDirectoryExporter.export_sample) * [`ImageDirectoryExporter.close()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.ImageDirectoryExporter.close) * [`ImageDirectoryExporter.log_collection()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.ImageDirectoryExporter.log_collection) * [`VideoDirectoryExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.VideoDirectoryExporter) * [`VideoDirectoryExporter.requires_video_metadata`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.VideoDirectoryExporter.requires_video_metadata) * [`VideoDirectoryExporter.setup()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.VideoDirectoryExporter.setup) * [`VideoDirectoryExporter.export_sample()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.VideoDirectoryExporter.export_sample) * [`VideoDirectoryExporter.close()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.VideoDirectoryExporter.close) * [`VideoDirectoryExporter.log_collection()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.VideoDirectoryExporter.log_collection) * [`MediaDirectoryExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.MediaDirectoryExporter) * [`MediaDirectoryExporter.requires_metadata`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.MediaDirectoryExporter.requires_metadata) * [`MediaDirectoryExporter.setup()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.MediaDirectoryExporter.setup) * [`MediaDirectoryExporter.export_sample()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.MediaDirectoryExporter.export_sample) * [`MediaDirectoryExporter.close()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.MediaDirectoryExporter.close) * [`MediaDirectoryExporter.log_collection()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.MediaDirectoryExporter.log_collection) * [`FiftyOneImageClassificationDatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter) * [`FiftyOneImageClassificationDatasetExporter.requires_image_metadata`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.requires_image_metadata) * [`FiftyOneImageClassificationDatasetExporter.label_cls`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.label_cls) * [`FiftyOneImageClassificationDatasetExporter.setup()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.setup) * [`FiftyOneImageClassificationDatasetExporter.export_sample()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.export_sample) * [`FiftyOneImageClassificationDatasetExporter.close()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.close) * [`FiftyOneImageClassificationDatasetExporter.log_collection()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.log_collection) * [`ImageClassificationDirectoryTreeExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.ImageClassificationDirectoryTreeExporter) * [`ImageClassificationDirectoryTreeExporter.requires_image_metadata`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.ImageClassificationDirectoryTreeExporter.requires_image_metadata) * [`ImageClassificationDirectoryTreeExporter.label_cls`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.ImageClassificationDirectoryTreeExporter.label_cls) * [`ImageClassificationDirectoryTreeExporter.setup()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.ImageClassificationDirectoryTreeExporter.setup) * [`ImageClassificationDirectoryTreeExporter.export_sample()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.ImageClassificationDirectoryTreeExporter.export_sample) * [`ImageClassificationDirectoryTreeExporter.close()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.ImageClassificationDirectoryTreeExporter.close) * [`ImageClassificationDirectoryTreeExporter.log_collection()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.ImageClassificationDirectoryTreeExporter.log_collection) * [`VideoClassificationDirectoryTreeExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.VideoClassificationDirectoryTreeExporter) * [`VideoClassificationDirectoryTreeExporter.requires_video_metadata`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.VideoClassificationDirectoryTreeExporter.requires_video_metadata) * [`VideoClassificationDirectoryTreeExporter.label_cls`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.VideoClassificationDirectoryTreeExporter.label_cls) * [`VideoClassificationDirectoryTreeExporter.frame_labels_cls`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.VideoClassificationDirectoryTreeExporter.frame_labels_cls) * [`VideoClassificationDirectoryTreeExporter.setup()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.VideoClassificationDirectoryTreeExporter.setup) * [`VideoClassificationDirectoryTreeExporter.export_sample()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.VideoClassificationDirectoryTreeExporter.export_sample) * [`VideoClassificationDirectoryTreeExporter.close()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.VideoClassificationDirectoryTreeExporter.close) * [`VideoClassificationDirectoryTreeExporter.log_collection()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.VideoClassificationDirectoryTreeExporter.log_collection) * [`FiftyOneImageDetectionDatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter) * [`FiftyOneImageDetectionDatasetExporter.requires_image_metadata`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.requires_image_metadata) * [`FiftyOneImageDetectionDatasetExporter.label_cls`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.label_cls) * [`FiftyOneImageDetectionDatasetExporter.setup()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.setup) * [`FiftyOneImageDetectionDatasetExporter.export_sample()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.export_sample) * [`FiftyOneImageDetectionDatasetExporter.close()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.close) * [`FiftyOneImageDetectionDatasetExporter.log_collection()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.log_collection) * [`FiftyOneTemporalDetectionDatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter) * [`FiftyOneTemporalDetectionDatasetExporter.requires_video_metadata`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.requires_video_metadata) * [`FiftyOneTemporalDetectionDatasetExporter.label_cls`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.label_cls) * [`FiftyOneTemporalDetectionDatasetExporter.frame_labels_cls`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.frame_labels_cls) * [`FiftyOneTemporalDetectionDatasetExporter.setup()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.setup) * [`FiftyOneTemporalDetectionDatasetExporter.export_sample()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.export_sample) * [`FiftyOneTemporalDetectionDatasetExporter.close()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.close) * [`FiftyOneTemporalDetectionDatasetExporter.log_collection()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.log_collection) * [`ImageSegmentationDirectoryExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter) * [`ImageSegmentationDirectoryExporter.requires_image_metadata`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter.requires_image_metadata) * [`ImageSegmentationDirectoryExporter.label_cls`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter.label_cls) * [`ImageSegmentationDirectoryExporter.setup()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter.setup) * [`ImageSegmentationDirectoryExporter.export_sample()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter.export_sample) * [`ImageSegmentationDirectoryExporter.close()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter.close) * [`ImageSegmentationDirectoryExporter.log_collection()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter.log_collection) * [`FiftyOneImageLabelsDatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter) * [`FiftyOneImageLabelsDatasetExporter.requires_image_metadata`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter.requires_image_metadata) * [`FiftyOneImageLabelsDatasetExporter.label_cls`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter.label_cls) * [`FiftyOneImageLabelsDatasetExporter.setup()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter.setup) * [`FiftyOneImageLabelsDatasetExporter.log_collection()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter.log_collection) * [`FiftyOneImageLabelsDatasetExporter.export_sample()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter.export_sample) * [`FiftyOneImageLabelsDatasetExporter.close()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter.close) * [`FiftyOneVideoLabelsDatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter) * [`FiftyOneVideoLabelsDatasetExporter.requires_video_metadata`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter.requires_video_metadata) * [`FiftyOneVideoLabelsDatasetExporter.label_cls`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter.label_cls) * [`FiftyOneVideoLabelsDatasetExporter.frame_labels_cls`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter.frame_labels_cls) * [`FiftyOneVideoLabelsDatasetExporter.setup()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter.setup) * [`FiftyOneVideoLabelsDatasetExporter.log_collection()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter.log_collection) * [`FiftyOneVideoLabelsDatasetExporter.export_sample()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter.export_sample) * [`FiftyOneVideoLabelsDatasetExporter.close()`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter.close) * [fiftyone.utils.data.importers](fiftyone.utils.data.importers.md) * [`import_samples()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.import_samples) * [`merge_samples()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.merge_samples) * [`build_dataset_importer()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.build_dataset_importer) * [`parse_dataset_info()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.parse_dataset_info) * [`ImportPathsMixin`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.ImportPathsMixin) * [`DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter) * [`DatasetImporter.__len__()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter.__len__) * [`DatasetImporter.__next__()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter.__next__) * [`DatasetImporter.has_dataset_info`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter.has_dataset_info) * [`DatasetImporter.setup()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter.setup) * [`DatasetImporter.get_media_sources()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter.get_media_sources) * [`DatasetImporter.get_dataset_info()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter.get_dataset_info) * [`DatasetImporter.close()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter.close) * [`BatchDatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.BatchDatasetImporter) * [`BatchDatasetImporter.import_samples()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.BatchDatasetImporter.import_samples) * [`BatchDatasetImporter.close()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.BatchDatasetImporter.close) * [`BatchDatasetImporter.get_dataset_info()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.BatchDatasetImporter.get_dataset_info) * [`BatchDatasetImporter.get_media_sources()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.BatchDatasetImporter.get_media_sources) * [`BatchDatasetImporter.has_dataset_info`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.BatchDatasetImporter.has_dataset_info) * [`BatchDatasetImporter.setup()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.BatchDatasetImporter.setup) * [`GenericSampleDatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.GenericSampleDatasetImporter) * [`GenericSampleDatasetImporter.__len__()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.GenericSampleDatasetImporter.__len__) * [`GenericSampleDatasetImporter.__next__()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.GenericSampleDatasetImporter.__next__) * [`GenericSampleDatasetImporter.has_sample_field_schema`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.GenericSampleDatasetImporter.has_sample_field_schema) * [`GenericSampleDatasetImporter.get_sample_field_schema()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.GenericSampleDatasetImporter.get_sample_field_schema) * [`GenericSampleDatasetImporter.close()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.GenericSampleDatasetImporter.close) * [`GenericSampleDatasetImporter.get_dataset_info()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.GenericSampleDatasetImporter.get_dataset_info) * [`GenericSampleDatasetImporter.get_media_sources()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.GenericSampleDatasetImporter.get_media_sources) * [`GenericSampleDatasetImporter.has_dataset_info`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.GenericSampleDatasetImporter.has_dataset_info) * [`GenericSampleDatasetImporter.setup()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.GenericSampleDatasetImporter.setup) * [`GroupDatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.GroupDatasetImporter) * [`GroupDatasetImporter.__len__()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.GroupDatasetImporter.__len__) * [`GroupDatasetImporter.__next__()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.GroupDatasetImporter.__next__) * [`GroupDatasetImporter.group_field`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.GroupDatasetImporter.group_field) * [`GroupDatasetImporter.get_group_media_types()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.GroupDatasetImporter.get_group_media_types) * [`GroupDatasetImporter.close()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.GroupDatasetImporter.close) * [`GroupDatasetImporter.get_dataset_info()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.GroupDatasetImporter.get_dataset_info) * [`GroupDatasetImporter.get_media_sources()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.GroupDatasetImporter.get_media_sources) * [`GroupDatasetImporter.get_sample_field_schema()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.GroupDatasetImporter.get_sample_field_schema) * [`GroupDatasetImporter.has_dataset_info`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.GroupDatasetImporter.has_dataset_info) * [`GroupDatasetImporter.has_sample_field_schema`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.GroupDatasetImporter.has_sample_field_schema) * [`GroupDatasetImporter.setup()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.GroupDatasetImporter.setup) * [`UnlabeledImageDatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.UnlabeledImageDatasetImporter) * [`UnlabeledImageDatasetImporter.__len__()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.UnlabeledImageDatasetImporter.__len__) * [`UnlabeledImageDatasetImporter.__next__()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.UnlabeledImageDatasetImporter.__next__) * [`UnlabeledImageDatasetImporter.has_image_metadata`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.UnlabeledImageDatasetImporter.has_image_metadata) * [`UnlabeledImageDatasetImporter.close()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.UnlabeledImageDatasetImporter.close) * [`UnlabeledImageDatasetImporter.get_dataset_info()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.UnlabeledImageDatasetImporter.get_dataset_info) * [`UnlabeledImageDatasetImporter.get_media_sources()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.UnlabeledImageDatasetImporter.get_media_sources) * [`UnlabeledImageDatasetImporter.has_dataset_info`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.UnlabeledImageDatasetImporter.has_dataset_info) * [`UnlabeledImageDatasetImporter.setup()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.UnlabeledImageDatasetImporter.setup) * [`UnlabeledVideoDatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.UnlabeledVideoDatasetImporter) * [`UnlabeledVideoDatasetImporter.__len__()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.UnlabeledVideoDatasetImporter.__len__) * [`UnlabeledVideoDatasetImporter.__next__()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.UnlabeledVideoDatasetImporter.__next__) * [`UnlabeledVideoDatasetImporter.has_video_metadata`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.UnlabeledVideoDatasetImporter.has_video_metadata) * [`UnlabeledVideoDatasetImporter.close()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.UnlabeledVideoDatasetImporter.close) * [`UnlabeledVideoDatasetImporter.get_dataset_info()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.UnlabeledVideoDatasetImporter.get_dataset_info) * [`UnlabeledVideoDatasetImporter.get_media_sources()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.UnlabeledVideoDatasetImporter.get_media_sources) * [`UnlabeledVideoDatasetImporter.has_dataset_info`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.UnlabeledVideoDatasetImporter.has_dataset_info) * [`UnlabeledVideoDatasetImporter.setup()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.UnlabeledVideoDatasetImporter.setup) * [`UnlabeledMediaDatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.UnlabeledMediaDatasetImporter) * [`UnlabeledMediaDatasetImporter.__len__()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.UnlabeledMediaDatasetImporter.__len__) * [`UnlabeledMediaDatasetImporter.__next__()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.UnlabeledMediaDatasetImporter.__next__) * [`UnlabeledMediaDatasetImporter.has_metadata`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.UnlabeledMediaDatasetImporter.has_metadata) * [`UnlabeledMediaDatasetImporter.close()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.UnlabeledMediaDatasetImporter.close) * [`UnlabeledMediaDatasetImporter.get_dataset_info()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.UnlabeledMediaDatasetImporter.get_dataset_info) * [`UnlabeledMediaDatasetImporter.get_media_sources()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.UnlabeledMediaDatasetImporter.get_media_sources) * [`UnlabeledMediaDatasetImporter.has_dataset_info`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.UnlabeledMediaDatasetImporter.has_dataset_info) * [`UnlabeledMediaDatasetImporter.setup()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.UnlabeledMediaDatasetImporter.setup) * [`LabeledImageDatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LabeledImageDatasetImporter) * [`LabeledImageDatasetImporter.__len__()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LabeledImageDatasetImporter.__len__) * [`LabeledImageDatasetImporter.__next__()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LabeledImageDatasetImporter.__next__) * [`LabeledImageDatasetImporter.has_image_metadata`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LabeledImageDatasetImporter.has_image_metadata) * [`LabeledImageDatasetImporter.label_cls`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LabeledImageDatasetImporter.label_cls) * [`LabeledImageDatasetImporter.close()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LabeledImageDatasetImporter.close) * [`LabeledImageDatasetImporter.get_dataset_info()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LabeledImageDatasetImporter.get_dataset_info) * [`LabeledImageDatasetImporter.get_media_sources()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LabeledImageDatasetImporter.get_media_sources) * [`LabeledImageDatasetImporter.has_dataset_info`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LabeledImageDatasetImporter.has_dataset_info) * [`LabeledImageDatasetImporter.setup()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LabeledImageDatasetImporter.setup) * [`LabeledVideoDatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LabeledVideoDatasetImporter) * [`LabeledVideoDatasetImporter.__len__()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LabeledVideoDatasetImporter.__len__) * [`LabeledVideoDatasetImporter.__next__()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LabeledVideoDatasetImporter.__next__) * [`LabeledVideoDatasetImporter.has_video_metadata`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LabeledVideoDatasetImporter.has_video_metadata) * [`LabeledVideoDatasetImporter.label_cls`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LabeledVideoDatasetImporter.label_cls) * [`LabeledVideoDatasetImporter.frame_labels_cls`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LabeledVideoDatasetImporter.frame_labels_cls) * [`LabeledVideoDatasetImporter.close()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LabeledVideoDatasetImporter.close) * [`LabeledVideoDatasetImporter.get_dataset_info()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LabeledVideoDatasetImporter.get_dataset_info) * [`LabeledVideoDatasetImporter.get_media_sources()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LabeledVideoDatasetImporter.get_media_sources) * [`LabeledVideoDatasetImporter.has_dataset_info`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LabeledVideoDatasetImporter.has_dataset_info) * [`LabeledVideoDatasetImporter.setup()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LabeledVideoDatasetImporter.setup) * [`LegacyFiftyOneDatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter) * [`LegacyFiftyOneDatasetImporter.has_sample_field_schema`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.has_sample_field_schema) * [`LegacyFiftyOneDatasetImporter.has_dataset_info`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.has_dataset_info) * [`LegacyFiftyOneDatasetImporter.setup()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.setup) * [`LegacyFiftyOneDatasetImporter.get_sample_field_schema()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.get_sample_field_schema) * [`LegacyFiftyOneDatasetImporter.get_dataset_info()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.get_dataset_info) * [`LegacyFiftyOneDatasetImporter.import_extras()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.import_extras) * [`LegacyFiftyOneDatasetImporter.close()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.close) * [`LegacyFiftyOneDatasetImporter.get_media_sources()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.get_media_sources) * [`FiftyOneDatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneDatasetImporter) * [`FiftyOneDatasetImporter.setup()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneDatasetImporter.setup) * [`FiftyOneDatasetImporter.import_samples()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneDatasetImporter.import_samples) * [`FiftyOneDatasetImporter.close()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneDatasetImporter.close) * [`FiftyOneDatasetImporter.get_dataset_info()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneDatasetImporter.get_dataset_info) * [`FiftyOneDatasetImporter.get_media_sources()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneDatasetImporter.get_media_sources) * [`FiftyOneDatasetImporter.has_dataset_info`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneDatasetImporter.has_dataset_info) * [`ImageDirectoryImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.ImageDirectoryImporter) * [`ImageDirectoryImporter.has_dataset_info`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.ImageDirectoryImporter.has_dataset_info) * [`ImageDirectoryImporter.has_image_metadata`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.ImageDirectoryImporter.has_image_metadata) * [`ImageDirectoryImporter.setup()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.ImageDirectoryImporter.setup) * [`ImageDirectoryImporter.close()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.ImageDirectoryImporter.close) * [`ImageDirectoryImporter.get_dataset_info()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.ImageDirectoryImporter.get_dataset_info) * [`ImageDirectoryImporter.get_media_sources()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.ImageDirectoryImporter.get_media_sources) * [`VideoDirectoryImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.VideoDirectoryImporter) * [`VideoDirectoryImporter.has_dataset_info`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.VideoDirectoryImporter.has_dataset_info) * [`VideoDirectoryImporter.has_video_metadata`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.VideoDirectoryImporter.has_video_metadata) * [`VideoDirectoryImporter.setup()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.VideoDirectoryImporter.setup) * [`VideoDirectoryImporter.close()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.VideoDirectoryImporter.close) * [`VideoDirectoryImporter.get_dataset_info()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.VideoDirectoryImporter.get_dataset_info) * [`VideoDirectoryImporter.get_media_sources()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.VideoDirectoryImporter.get_media_sources) * [`MediaDirectoryImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.MediaDirectoryImporter) * [`MediaDirectoryImporter.has_dataset_info`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.MediaDirectoryImporter.has_dataset_info) * [`MediaDirectoryImporter.has_metadata`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.MediaDirectoryImporter.has_metadata) * [`MediaDirectoryImporter.setup()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.MediaDirectoryImporter.setup) * [`MediaDirectoryImporter.close()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.MediaDirectoryImporter.close) * [`MediaDirectoryImporter.get_dataset_info()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.MediaDirectoryImporter.get_dataset_info) * [`MediaDirectoryImporter.get_media_sources()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.MediaDirectoryImporter.get_media_sources) * [`FiftyOneImageClassificationDatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter) * [`FiftyOneImageClassificationDatasetImporter.has_dataset_info`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.has_dataset_info) * [`FiftyOneImageClassificationDatasetImporter.has_image_metadata`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.has_image_metadata) * [`FiftyOneImageClassificationDatasetImporter.label_cls`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.label_cls) * [`FiftyOneImageClassificationDatasetImporter.setup()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.setup) * [`FiftyOneImageClassificationDatasetImporter.get_dataset_info()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.get_dataset_info) * [`FiftyOneImageClassificationDatasetImporter.close()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.close) * [`FiftyOneImageClassificationDatasetImporter.get_media_sources()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.get_media_sources) * [`ImageClassificationDirectoryTreeImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter) * [`ImageClassificationDirectoryTreeImporter.has_image_metadata`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter.has_image_metadata) * [`ImageClassificationDirectoryTreeImporter.has_dataset_info`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter.has_dataset_info) * [`ImageClassificationDirectoryTreeImporter.label_cls`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter.label_cls) * [`ImageClassificationDirectoryTreeImporter.setup()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter.setup) * [`ImageClassificationDirectoryTreeImporter.get_dataset_info()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter.get_dataset_info) * [`ImageClassificationDirectoryTreeImporter.close()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter.close) * [`ImageClassificationDirectoryTreeImporter.get_media_sources()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter.get_media_sources) * [`VideoClassificationDirectoryTreeImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter) * [`VideoClassificationDirectoryTreeImporter.has_video_metadata`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.has_video_metadata) * [`VideoClassificationDirectoryTreeImporter.has_dataset_info`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.has_dataset_info) * [`VideoClassificationDirectoryTreeImporter.label_cls`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.label_cls) * [`VideoClassificationDirectoryTreeImporter.frame_labels_cls`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.frame_labels_cls) * [`VideoClassificationDirectoryTreeImporter.setup()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.setup) * [`VideoClassificationDirectoryTreeImporter.get_dataset_info()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.get_dataset_info) * [`VideoClassificationDirectoryTreeImporter.close()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.close) * [`VideoClassificationDirectoryTreeImporter.get_media_sources()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.get_media_sources) * [`FiftyOneImageDetectionDatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter) * [`FiftyOneImageDetectionDatasetImporter.has_dataset_info`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.has_dataset_info) * [`FiftyOneImageDetectionDatasetImporter.has_image_metadata`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.has_image_metadata) * [`FiftyOneImageDetectionDatasetImporter.label_cls`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.label_cls) * [`FiftyOneImageDetectionDatasetImporter.setup()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.setup) * [`FiftyOneImageDetectionDatasetImporter.get_dataset_info()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.get_dataset_info) * [`FiftyOneImageDetectionDatasetImporter.close()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.close) * [`FiftyOneImageDetectionDatasetImporter.get_media_sources()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.get_media_sources) * [`FiftyOneTemporalDetectionDatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter) * [`FiftyOneTemporalDetectionDatasetImporter.has_dataset_info`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.has_dataset_info) * [`FiftyOneTemporalDetectionDatasetImporter.has_video_metadata`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.has_video_metadata) * [`FiftyOneTemporalDetectionDatasetImporter.label_cls`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.label_cls) * [`FiftyOneTemporalDetectionDatasetImporter.frame_labels_cls`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.frame_labels_cls) * [`FiftyOneTemporalDetectionDatasetImporter.setup()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.setup) * [`FiftyOneTemporalDetectionDatasetImporter.get_dataset_info()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.get_dataset_info) * [`FiftyOneTemporalDetectionDatasetImporter.close()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.close) * [`FiftyOneTemporalDetectionDatasetImporter.get_media_sources()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.get_media_sources) * [`ImageSegmentationDirectoryImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter) * [`ImageSegmentationDirectoryImporter.has_dataset_info`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.has_dataset_info) * [`ImageSegmentationDirectoryImporter.has_image_metadata`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.has_image_metadata) * [`ImageSegmentationDirectoryImporter.label_cls`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.label_cls) * [`ImageSegmentationDirectoryImporter.setup()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.setup) * [`ImageSegmentationDirectoryImporter.close()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.close) * [`ImageSegmentationDirectoryImporter.get_dataset_info()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.get_dataset_info) * [`ImageSegmentationDirectoryImporter.get_media_sources()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.get_media_sources) * [`FiftyOneImageLabelsDatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter) * [`FiftyOneImageLabelsDatasetImporter.has_dataset_info`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.has_dataset_info) * [`FiftyOneImageLabelsDatasetImporter.has_image_metadata`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.has_image_metadata) * [`FiftyOneImageLabelsDatasetImporter.label_cls`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.label_cls) * [`FiftyOneImageLabelsDatasetImporter.setup()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.setup) * [`FiftyOneImageLabelsDatasetImporter.get_dataset_info()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.get_dataset_info) * [`FiftyOneImageLabelsDatasetImporter.close()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.close) * [`FiftyOneImageLabelsDatasetImporter.get_media_sources()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.get_media_sources) * [`FiftyOneVideoLabelsDatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter) * [`FiftyOneVideoLabelsDatasetImporter.has_dataset_info`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.has_dataset_info) * [`FiftyOneVideoLabelsDatasetImporter.has_video_metadata`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.has_video_metadata) * [`FiftyOneVideoLabelsDatasetImporter.label_cls`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.label_cls) * [`FiftyOneVideoLabelsDatasetImporter.frame_labels_cls`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.frame_labels_cls) * [`FiftyOneVideoLabelsDatasetImporter.setup()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.setup) * [`FiftyOneVideoLabelsDatasetImporter.get_dataset_info()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.get_dataset_info) * [`FiftyOneVideoLabelsDatasetImporter.close()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.close) * [`FiftyOneVideoLabelsDatasetImporter.get_media_sources()`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.get_media_sources) * [fiftyone.utils.data.ingestors](fiftyone.utils.data.ingestors.md) * [`ImageIngestor`](fiftyone.utils.data.ingestors.md#fiftyone.utils.data.ingestors.ImageIngestor) * [`UnlabeledImageDatasetIngestor`](fiftyone.utils.data.ingestors.md#fiftyone.utils.data.ingestors.UnlabeledImageDatasetIngestor) * [`UnlabeledImageDatasetIngestor.has_dataset_info`](fiftyone.utils.data.ingestors.md#fiftyone.utils.data.ingestors.UnlabeledImageDatasetIngestor.has_dataset_info) * [`UnlabeledImageDatasetIngestor.has_image_metadata`](fiftyone.utils.data.ingestors.md#fiftyone.utils.data.ingestors.UnlabeledImageDatasetIngestor.has_image_metadata) * [`UnlabeledImageDatasetIngestor.setup()`](fiftyone.utils.data.ingestors.md#fiftyone.utils.data.ingestors.UnlabeledImageDatasetIngestor.setup) * [`UnlabeledImageDatasetIngestor.close()`](fiftyone.utils.data.ingestors.md#fiftyone.utils.data.ingestors.UnlabeledImageDatasetIngestor.close) * [`UnlabeledImageDatasetIngestor.get_dataset_info()`](fiftyone.utils.data.ingestors.md#fiftyone.utils.data.ingestors.UnlabeledImageDatasetIngestor.get_dataset_info) * [`UnlabeledImageDatasetIngestor.get_media_sources()`](fiftyone.utils.data.ingestors.md#fiftyone.utils.data.ingestors.UnlabeledImageDatasetIngestor.get_media_sources) * [`LabeledImageDatasetIngestor`](fiftyone.utils.data.ingestors.md#fiftyone.utils.data.ingestors.LabeledImageDatasetIngestor) * [`LabeledImageDatasetIngestor.has_dataset_info`](fiftyone.utils.data.ingestors.md#fiftyone.utils.data.ingestors.LabeledImageDatasetIngestor.has_dataset_info) * [`LabeledImageDatasetIngestor.has_image_metadata`](fiftyone.utils.data.ingestors.md#fiftyone.utils.data.ingestors.LabeledImageDatasetIngestor.has_image_metadata) * [`LabeledImageDatasetIngestor.label_cls`](fiftyone.utils.data.ingestors.md#fiftyone.utils.data.ingestors.LabeledImageDatasetIngestor.label_cls) * [`LabeledImageDatasetIngestor.setup()`](fiftyone.utils.data.ingestors.md#fiftyone.utils.data.ingestors.LabeledImageDatasetIngestor.setup) * [`LabeledImageDatasetIngestor.close()`](fiftyone.utils.data.ingestors.md#fiftyone.utils.data.ingestors.LabeledImageDatasetIngestor.close) * [`LabeledImageDatasetIngestor.get_dataset_info()`](fiftyone.utils.data.ingestors.md#fiftyone.utils.data.ingestors.LabeledImageDatasetIngestor.get_dataset_info) * [`LabeledImageDatasetIngestor.get_media_sources()`](fiftyone.utils.data.ingestors.md#fiftyone.utils.data.ingestors.LabeledImageDatasetIngestor.get_media_sources) * [`VideoIngestor`](fiftyone.utils.data.ingestors.md#fiftyone.utils.data.ingestors.VideoIngestor) * [`UnlabeledVideoDatasetIngestor`](fiftyone.utils.data.ingestors.md#fiftyone.utils.data.ingestors.UnlabeledVideoDatasetIngestor) * [`UnlabeledVideoDatasetIngestor.has_dataset_info`](fiftyone.utils.data.ingestors.md#fiftyone.utils.data.ingestors.UnlabeledVideoDatasetIngestor.has_dataset_info) * [`UnlabeledVideoDatasetIngestor.has_video_metadata`](fiftyone.utils.data.ingestors.md#fiftyone.utils.data.ingestors.UnlabeledVideoDatasetIngestor.has_video_metadata) * [`UnlabeledVideoDatasetIngestor.setup()`](fiftyone.utils.data.ingestors.md#fiftyone.utils.data.ingestors.UnlabeledVideoDatasetIngestor.setup) * [`UnlabeledVideoDatasetIngestor.close()`](fiftyone.utils.data.ingestors.md#fiftyone.utils.data.ingestors.UnlabeledVideoDatasetIngestor.close) * [`UnlabeledVideoDatasetIngestor.get_dataset_info()`](fiftyone.utils.data.ingestors.md#fiftyone.utils.data.ingestors.UnlabeledVideoDatasetIngestor.get_dataset_info) * [`UnlabeledVideoDatasetIngestor.get_media_sources()`](fiftyone.utils.data.ingestors.md#fiftyone.utils.data.ingestors.UnlabeledVideoDatasetIngestor.get_media_sources) * [`LabeledVideoDatasetIngestor`](fiftyone.utils.data.ingestors.md#fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor) * [`LabeledVideoDatasetIngestor.has_dataset_info`](fiftyone.utils.data.ingestors.md#fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor.has_dataset_info) * [`LabeledVideoDatasetIngestor.has_video_metadata`](fiftyone.utils.data.ingestors.md#fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor.has_video_metadata) * [`LabeledVideoDatasetIngestor.label_cls`](fiftyone.utils.data.ingestors.md#fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor.label_cls) * [`LabeledVideoDatasetIngestor.frame_labels_cls`](fiftyone.utils.data.ingestors.md#fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor.frame_labels_cls) * [`LabeledVideoDatasetIngestor.setup()`](fiftyone.utils.data.ingestors.md#fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor.setup) * [`LabeledVideoDatasetIngestor.close()`](fiftyone.utils.data.ingestors.md#fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor.close) * [`LabeledVideoDatasetIngestor.get_dataset_info()`](fiftyone.utils.data.ingestors.md#fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor.get_dataset_info) * [`LabeledVideoDatasetIngestor.get_media_sources()`](fiftyone.utils.data.ingestors.md#fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor.get_media_sources) * [fiftyone.utils.data.parsers](fiftyone.utils.data.parsers.md) * [`add_images()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.add_images) * [`add_labeled_images()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.add_labeled_images) * [`add_videos()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.add_videos) * [`add_labeled_videos()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.add_labeled_videos) * [`SampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.SampleParser) * [`SampleParser.current_sample`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.SampleParser.current_sample) * [`SampleParser.with_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.SampleParser.with_sample) * [`SampleParser.clear_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.SampleParser.clear_sample) * [`UnlabeledImageSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.UnlabeledImageSampleParser) * [`UnlabeledImageSampleParser.has_image_path`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.UnlabeledImageSampleParser.has_image_path) * [`UnlabeledImageSampleParser.has_image_metadata`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.UnlabeledImageSampleParser.has_image_metadata) * [`UnlabeledImageSampleParser.get_image()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.UnlabeledImageSampleParser.get_image) * [`UnlabeledImageSampleParser.get_image_path()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.UnlabeledImageSampleParser.get_image_path) * [`UnlabeledImageSampleParser.get_image_metadata()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.UnlabeledImageSampleParser.get_image_metadata) * [`UnlabeledImageSampleParser.clear_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.UnlabeledImageSampleParser.clear_sample) * [`UnlabeledImageSampleParser.current_sample`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.UnlabeledImageSampleParser.current_sample) * [`UnlabeledImageSampleParser.with_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.UnlabeledImageSampleParser.with_sample) * [`UnlabeledVideoSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.UnlabeledVideoSampleParser) * [`UnlabeledVideoSampleParser.has_video_metadata`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.UnlabeledVideoSampleParser.has_video_metadata) * [`UnlabeledVideoSampleParser.get_video_path()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.UnlabeledVideoSampleParser.get_video_path) * [`UnlabeledVideoSampleParser.get_video_metadata()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.UnlabeledVideoSampleParser.get_video_metadata) * [`UnlabeledVideoSampleParser.clear_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.UnlabeledVideoSampleParser.clear_sample) * [`UnlabeledVideoSampleParser.current_sample`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.UnlabeledVideoSampleParser.current_sample) * [`UnlabeledVideoSampleParser.with_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.UnlabeledVideoSampleParser.with_sample) * [`UnlabeledMediaSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.UnlabeledMediaSampleParser) * [`UnlabeledMediaSampleParser.has_metadata`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.UnlabeledMediaSampleParser.has_metadata) * [`UnlabeledMediaSampleParser.get_media_path()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.UnlabeledMediaSampleParser.get_media_path) * [`UnlabeledMediaSampleParser.get_metadata()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.UnlabeledMediaSampleParser.get_metadata) * [`UnlabeledMediaSampleParser.clear_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.UnlabeledMediaSampleParser.clear_sample) * [`UnlabeledMediaSampleParser.current_sample`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.UnlabeledMediaSampleParser.current_sample) * [`UnlabeledMediaSampleParser.with_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.UnlabeledMediaSampleParser.with_sample) * [`ImageSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageSampleParser) * [`ImageSampleParser.has_image_path`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageSampleParser.has_image_path) * [`ImageSampleParser.has_image_metadata`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageSampleParser.has_image_metadata) * [`ImageSampleParser.get_image()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageSampleParser.get_image) * [`ImageSampleParser.get_image_path()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageSampleParser.get_image_path) * [`ImageSampleParser.clear_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageSampleParser.clear_sample) * [`ImageSampleParser.current_sample`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageSampleParser.current_sample) * [`ImageSampleParser.get_image_metadata()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageSampleParser.get_image_metadata) * [`ImageSampleParser.with_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageSampleParser.with_sample) * [`VideoSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.VideoSampleParser) * [`VideoSampleParser.has_video_metadata`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.VideoSampleParser.has_video_metadata) * [`VideoSampleParser.get_video_path()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.VideoSampleParser.get_video_path) * [`VideoSampleParser.clear_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.VideoSampleParser.clear_sample) * [`VideoSampleParser.current_sample`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.VideoSampleParser.current_sample) * [`VideoSampleParser.get_video_metadata()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.VideoSampleParser.get_video_metadata) * [`VideoSampleParser.with_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.VideoSampleParser.with_sample) * [`MediaSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.MediaSampleParser) * [`MediaSampleParser.has_metadata`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.MediaSampleParser.has_metadata) * [`MediaSampleParser.get_media_path()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.MediaSampleParser.get_media_path) * [`MediaSampleParser.clear_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.MediaSampleParser.clear_sample) * [`MediaSampleParser.current_sample`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.MediaSampleParser.current_sample) * [`MediaSampleParser.get_metadata()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.MediaSampleParser.get_metadata) * [`MediaSampleParser.with_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.MediaSampleParser.with_sample) * [`LabeledImageSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledImageSampleParser) * [`LabeledImageSampleParser.has_image_path`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledImageSampleParser.has_image_path) * [`LabeledImageSampleParser.has_image_metadata`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledImageSampleParser.has_image_metadata) * [`LabeledImageSampleParser.label_cls`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledImageSampleParser.label_cls) * [`LabeledImageSampleParser.get_image()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledImageSampleParser.get_image) * [`LabeledImageSampleParser.get_image_path()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledImageSampleParser.get_image_path) * [`LabeledImageSampleParser.get_image_metadata()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledImageSampleParser.get_image_metadata) * [`LabeledImageSampleParser.get_label()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledImageSampleParser.get_label) * [`LabeledImageSampleParser.clear_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledImageSampleParser.clear_sample) * [`LabeledImageSampleParser.current_sample`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledImageSampleParser.current_sample) * [`LabeledImageSampleParser.with_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledImageSampleParser.with_sample) * [`LabeledVideoSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledVideoSampleParser) * [`LabeledVideoSampleParser.has_video_metadata`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledVideoSampleParser.has_video_metadata) * [`LabeledVideoSampleParser.label_cls`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledVideoSampleParser.label_cls) * [`LabeledVideoSampleParser.frame_labels_cls`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledVideoSampleParser.frame_labels_cls) * [`LabeledVideoSampleParser.get_video_path()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledVideoSampleParser.get_video_path) * [`LabeledVideoSampleParser.get_video_metadata()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledVideoSampleParser.get_video_metadata) * [`LabeledVideoSampleParser.get_label()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledVideoSampleParser.get_label) * [`LabeledVideoSampleParser.get_frame_labels()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledVideoSampleParser.get_frame_labels) * [`LabeledVideoSampleParser.clear_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledVideoSampleParser.clear_sample) * [`LabeledVideoSampleParser.current_sample`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledVideoSampleParser.current_sample) * [`LabeledVideoSampleParser.with_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledVideoSampleParser.with_sample) * [`LabeledImageTupleSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledImageTupleSampleParser) * [`LabeledImageTupleSampleParser.has_image_path`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledImageTupleSampleParser.has_image_path) * [`LabeledImageTupleSampleParser.has_image_metadata`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledImageTupleSampleParser.has_image_metadata) * [`LabeledImageTupleSampleParser.label_cls`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledImageTupleSampleParser.label_cls) * [`LabeledImageTupleSampleParser.get_image()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledImageTupleSampleParser.get_image) * [`LabeledImageTupleSampleParser.get_image_path()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledImageTupleSampleParser.get_image_path) * [`LabeledImageTupleSampleParser.get_label()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledImageTupleSampleParser.get_label) * [`LabeledImageTupleSampleParser.clear_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledImageTupleSampleParser.clear_sample) * [`LabeledImageTupleSampleParser.current_sample`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledImageTupleSampleParser.current_sample) * [`LabeledImageTupleSampleParser.get_image_metadata()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledImageTupleSampleParser.get_image_metadata) * [`LabeledImageTupleSampleParser.with_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledImageTupleSampleParser.with_sample) * [`ImageClassificationSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageClassificationSampleParser) * [`ImageClassificationSampleParser.label_cls`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageClassificationSampleParser.label_cls) * [`ImageClassificationSampleParser.get_label()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageClassificationSampleParser.get_label) * [`ImageClassificationSampleParser.clear_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageClassificationSampleParser.clear_sample) * [`ImageClassificationSampleParser.current_sample`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageClassificationSampleParser.current_sample) * [`ImageClassificationSampleParser.get_image()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageClassificationSampleParser.get_image) * [`ImageClassificationSampleParser.get_image_metadata()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageClassificationSampleParser.get_image_metadata) * [`ImageClassificationSampleParser.get_image_path()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageClassificationSampleParser.get_image_path) * [`ImageClassificationSampleParser.has_image_metadata`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageClassificationSampleParser.has_image_metadata) * [`ImageClassificationSampleParser.has_image_path`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageClassificationSampleParser.has_image_path) * [`ImageClassificationSampleParser.with_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageClassificationSampleParser.with_sample) * [`ImageDetectionSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageDetectionSampleParser) * [`ImageDetectionSampleParser.label_cls`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageDetectionSampleParser.label_cls) * [`ImageDetectionSampleParser.get_label()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageDetectionSampleParser.get_label) * [`ImageDetectionSampleParser.clear_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageDetectionSampleParser.clear_sample) * [`ImageDetectionSampleParser.current_sample`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageDetectionSampleParser.current_sample) * [`ImageDetectionSampleParser.get_image()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageDetectionSampleParser.get_image) * [`ImageDetectionSampleParser.get_image_metadata()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageDetectionSampleParser.get_image_metadata) * [`ImageDetectionSampleParser.get_image_path()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageDetectionSampleParser.get_image_path) * [`ImageDetectionSampleParser.has_image_metadata`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageDetectionSampleParser.has_image_metadata) * [`ImageDetectionSampleParser.has_image_path`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageDetectionSampleParser.has_image_path) * [`ImageDetectionSampleParser.with_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageDetectionSampleParser.with_sample) * [`ImageLabelsSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageLabelsSampleParser) * [`ImageLabelsSampleParser.label_cls`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageLabelsSampleParser.label_cls) * [`ImageLabelsSampleParser.get_label()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageLabelsSampleParser.get_label) * [`ImageLabelsSampleParser.clear_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageLabelsSampleParser.clear_sample) * [`ImageLabelsSampleParser.current_sample`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageLabelsSampleParser.current_sample) * [`ImageLabelsSampleParser.get_image()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageLabelsSampleParser.get_image) * [`ImageLabelsSampleParser.get_image_metadata()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageLabelsSampleParser.get_image_metadata) * [`ImageLabelsSampleParser.get_image_path()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageLabelsSampleParser.get_image_path) * [`ImageLabelsSampleParser.has_image_metadata`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageLabelsSampleParser.has_image_metadata) * [`ImageLabelsSampleParser.has_image_path`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageLabelsSampleParser.has_image_path) * [`ImageLabelsSampleParser.with_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageLabelsSampleParser.with_sample) * [`FiftyOneImageClassificationSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneImageClassificationSampleParser) * [`FiftyOneImageClassificationSampleParser.clear_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneImageClassificationSampleParser.clear_sample) * [`FiftyOneImageClassificationSampleParser.current_sample`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneImageClassificationSampleParser.current_sample) * [`FiftyOneImageClassificationSampleParser.get_image()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneImageClassificationSampleParser.get_image) * [`FiftyOneImageClassificationSampleParser.get_image_metadata()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneImageClassificationSampleParser.get_image_metadata) * [`FiftyOneImageClassificationSampleParser.get_image_path()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneImageClassificationSampleParser.get_image_path) * [`FiftyOneImageClassificationSampleParser.get_label()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneImageClassificationSampleParser.get_label) * [`FiftyOneImageClassificationSampleParser.has_image_metadata`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneImageClassificationSampleParser.has_image_metadata) * [`FiftyOneImageClassificationSampleParser.has_image_path`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneImageClassificationSampleParser.has_image_path) * [`FiftyOneImageClassificationSampleParser.label_cls`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneImageClassificationSampleParser.label_cls) * [`FiftyOneImageClassificationSampleParser.with_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneImageClassificationSampleParser.with_sample) * [`FiftyOneTemporalDetectionSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser) * [`FiftyOneTemporalDetectionSampleParser.has_video_metadata`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser.has_video_metadata) * [`FiftyOneTemporalDetectionSampleParser.label_cls`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser.label_cls) * [`FiftyOneTemporalDetectionSampleParser.frame_labels_cls`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser.frame_labels_cls) * [`FiftyOneTemporalDetectionSampleParser.with_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser.with_sample) * [`FiftyOneTemporalDetectionSampleParser.get_video_path()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser.get_video_path) * [`FiftyOneTemporalDetectionSampleParser.get_video_metadata()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser.get_video_metadata) * [`FiftyOneTemporalDetectionSampleParser.get_label()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser.get_label) * [`FiftyOneTemporalDetectionSampleParser.get_frame_labels()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser.get_frame_labels) * [`FiftyOneTemporalDetectionSampleParser.clear_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser.clear_sample) * [`FiftyOneTemporalDetectionSampleParser.current_sample`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser.current_sample) * [`FiftyOneImageDetectionSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneImageDetectionSampleParser) * [`FiftyOneImageDetectionSampleParser.clear_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneImageDetectionSampleParser.clear_sample) * [`FiftyOneImageDetectionSampleParser.current_sample`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneImageDetectionSampleParser.current_sample) * [`FiftyOneImageDetectionSampleParser.get_image()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneImageDetectionSampleParser.get_image) * [`FiftyOneImageDetectionSampleParser.get_image_metadata()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneImageDetectionSampleParser.get_image_metadata) * [`FiftyOneImageDetectionSampleParser.get_image_path()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneImageDetectionSampleParser.get_image_path) * [`FiftyOneImageDetectionSampleParser.get_label()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneImageDetectionSampleParser.get_label) * [`FiftyOneImageDetectionSampleParser.has_image_metadata`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneImageDetectionSampleParser.has_image_metadata) * [`FiftyOneImageDetectionSampleParser.has_image_path`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneImageDetectionSampleParser.has_image_path) * [`FiftyOneImageDetectionSampleParser.label_cls`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneImageDetectionSampleParser.label_cls) * [`FiftyOneImageDetectionSampleParser.with_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneImageDetectionSampleParser.with_sample) * [`FiftyOneImageLabelsSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneImageLabelsSampleParser) * [`FiftyOneImageLabelsSampleParser.clear_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneImageLabelsSampleParser.clear_sample) * [`FiftyOneImageLabelsSampleParser.current_sample`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneImageLabelsSampleParser.current_sample) * [`FiftyOneImageLabelsSampleParser.get_image()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneImageLabelsSampleParser.get_image) * [`FiftyOneImageLabelsSampleParser.get_image_metadata()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneImageLabelsSampleParser.get_image_metadata) * [`FiftyOneImageLabelsSampleParser.get_image_path()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneImageLabelsSampleParser.get_image_path) * [`FiftyOneImageLabelsSampleParser.get_label()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneImageLabelsSampleParser.get_label) * [`FiftyOneImageLabelsSampleParser.has_image_metadata`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneImageLabelsSampleParser.has_image_metadata) * [`FiftyOneImageLabelsSampleParser.has_image_path`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneImageLabelsSampleParser.has_image_path) * [`FiftyOneImageLabelsSampleParser.label_cls`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneImageLabelsSampleParser.label_cls) * [`FiftyOneImageLabelsSampleParser.with_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneImageLabelsSampleParser.with_sample) * [`VideoLabelsSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.VideoLabelsSampleParser) * [`VideoLabelsSampleParser.has_video_metadata`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.VideoLabelsSampleParser.has_video_metadata) * [`VideoLabelsSampleParser.label_cls`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.VideoLabelsSampleParser.label_cls) * [`VideoLabelsSampleParser.frame_labels_cls`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.VideoLabelsSampleParser.frame_labels_cls) * [`VideoLabelsSampleParser.get_video_path()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.VideoLabelsSampleParser.get_video_path) * [`VideoLabelsSampleParser.get_label()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.VideoLabelsSampleParser.get_label) * [`VideoLabelsSampleParser.get_frame_labels()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.VideoLabelsSampleParser.get_frame_labels) * [`VideoLabelsSampleParser.clear_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.VideoLabelsSampleParser.clear_sample) * [`VideoLabelsSampleParser.current_sample`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.VideoLabelsSampleParser.current_sample) * [`VideoLabelsSampleParser.get_video_metadata()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.VideoLabelsSampleParser.get_video_metadata) * [`VideoLabelsSampleParser.with_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.VideoLabelsSampleParser.with_sample) * [`FiftyOneVideoLabelsSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneVideoLabelsSampleParser) * [`FiftyOneVideoLabelsSampleParser.clear_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneVideoLabelsSampleParser.clear_sample) * [`FiftyOneVideoLabelsSampleParser.current_sample`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneVideoLabelsSampleParser.current_sample) * [`FiftyOneVideoLabelsSampleParser.frame_labels_cls`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneVideoLabelsSampleParser.frame_labels_cls) * [`FiftyOneVideoLabelsSampleParser.get_frame_labels()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneVideoLabelsSampleParser.get_frame_labels) * [`FiftyOneVideoLabelsSampleParser.get_label()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneVideoLabelsSampleParser.get_label) * [`FiftyOneVideoLabelsSampleParser.get_video_metadata()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneVideoLabelsSampleParser.get_video_metadata) * [`FiftyOneVideoLabelsSampleParser.get_video_path()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneVideoLabelsSampleParser.get_video_path) * [`FiftyOneVideoLabelsSampleParser.has_video_metadata`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneVideoLabelsSampleParser.has_video_metadata) * [`FiftyOneVideoLabelsSampleParser.label_cls`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneVideoLabelsSampleParser.label_cls) * [`FiftyOneVideoLabelsSampleParser.with_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneVideoLabelsSampleParser.with_sample) * [`FiftyOneUnlabeledImageSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneUnlabeledImageSampleParser) * [`FiftyOneUnlabeledImageSampleParser.has_image_path`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneUnlabeledImageSampleParser.has_image_path) * [`FiftyOneUnlabeledImageSampleParser.has_image_metadata`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneUnlabeledImageSampleParser.has_image_metadata) * [`FiftyOneUnlabeledImageSampleParser.get_image()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneUnlabeledImageSampleParser.get_image) * [`FiftyOneUnlabeledImageSampleParser.get_image_path()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneUnlabeledImageSampleParser.get_image_path) * [`FiftyOneUnlabeledImageSampleParser.get_image_metadata()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneUnlabeledImageSampleParser.get_image_metadata) * [`FiftyOneUnlabeledImageSampleParser.clear_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneUnlabeledImageSampleParser.clear_sample) * [`FiftyOneUnlabeledImageSampleParser.current_sample`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneUnlabeledImageSampleParser.current_sample) * [`FiftyOneUnlabeledImageSampleParser.with_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneUnlabeledImageSampleParser.with_sample) * [`FiftyOneLabeledImageSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneLabeledImageSampleParser) * [`FiftyOneLabeledImageSampleParser.has_image_path`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneLabeledImageSampleParser.has_image_path) * [`FiftyOneLabeledImageSampleParser.has_image_metadata`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneLabeledImageSampleParser.has_image_metadata) * [`FiftyOneLabeledImageSampleParser.label_cls`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneLabeledImageSampleParser.label_cls) * [`FiftyOneLabeledImageSampleParser.get_image()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneLabeledImageSampleParser.get_image) * [`FiftyOneLabeledImageSampleParser.get_image_path()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneLabeledImageSampleParser.get_image_path) * [`FiftyOneLabeledImageSampleParser.get_image_metadata()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneLabeledImageSampleParser.get_image_metadata) * [`FiftyOneLabeledImageSampleParser.get_label()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneLabeledImageSampleParser.get_label) * [`FiftyOneLabeledImageSampleParser.clear_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneLabeledImageSampleParser.clear_sample) * [`FiftyOneLabeledImageSampleParser.current_sample`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneLabeledImageSampleParser.current_sample) * [`FiftyOneLabeledImageSampleParser.with_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneLabeledImageSampleParser.with_sample) * [`ExtractClipsMixin`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ExtractClipsMixin) * [`FiftyOneUnlabeledVideoSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneUnlabeledVideoSampleParser) * [`FiftyOneUnlabeledVideoSampleParser.has_video_metadata`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneUnlabeledVideoSampleParser.has_video_metadata) * [`FiftyOneUnlabeledVideoSampleParser.get_video_path()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneUnlabeledVideoSampleParser.get_video_path) * [`FiftyOneUnlabeledVideoSampleParser.get_video_metadata()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneUnlabeledVideoSampleParser.get_video_metadata) * [`FiftyOneUnlabeledVideoSampleParser.clear_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneUnlabeledVideoSampleParser.clear_sample) * [`FiftyOneUnlabeledVideoSampleParser.current_sample`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneUnlabeledVideoSampleParser.current_sample) * [`FiftyOneUnlabeledVideoSampleParser.with_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneUnlabeledVideoSampleParser.with_sample) * [`FiftyOneLabeledVideoSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser) * [`FiftyOneLabeledVideoSampleParser.has_video_metadata`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser.has_video_metadata) * [`FiftyOneLabeledVideoSampleParser.label_cls`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser.label_cls) * [`FiftyOneLabeledVideoSampleParser.frame_labels_cls`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser.frame_labels_cls) * [`FiftyOneLabeledVideoSampleParser.get_video_path()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser.get_video_path) * [`FiftyOneLabeledVideoSampleParser.get_video_metadata()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser.get_video_metadata) * [`FiftyOneLabeledVideoSampleParser.get_label()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser.get_label) * [`FiftyOneLabeledVideoSampleParser.get_frame_labels()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser.get_frame_labels) * [`FiftyOneLabeledVideoSampleParser.clear_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser.clear_sample) * [`FiftyOneLabeledVideoSampleParser.current_sample`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser.current_sample) * [`FiftyOneLabeledVideoSampleParser.with_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser.with_sample) * [`FiftyOneUnlabeledMediaSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneUnlabeledMediaSampleParser) * [`FiftyOneUnlabeledMediaSampleParser.has_metadata`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneUnlabeledMediaSampleParser.has_metadata) * [`FiftyOneUnlabeledMediaSampleParser.get_media_path()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneUnlabeledMediaSampleParser.get_media_path) * [`FiftyOneUnlabeledMediaSampleParser.get_metadata()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneUnlabeledMediaSampleParser.get_metadata) * [`FiftyOneUnlabeledMediaSampleParser.clear_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneUnlabeledMediaSampleParser.clear_sample) * [`FiftyOneUnlabeledMediaSampleParser.current_sample`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneUnlabeledMediaSampleParser.current_sample) * [`FiftyOneUnlabeledMediaSampleParser.with_sample()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.FiftyOneUnlabeledMediaSampleParser.with_sample) ## Module contents Data utilities. Copyright 2017-2026, Voxel51, Inc.
[voxel51.com](https://voxel51.com/)

**Classes:** | [`F`](#fiftyone.utils.data.F) | | |------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`defaultdict`](#fiftyone.utils.data.defaultdict) | defaultdict(default_factory=None, /, [...]) --> dict with default factory | | [`FiftyOneLabeledImageSampleParser`](#fiftyone.utils.data.FiftyOneLabeledImageSampleParser)(label_field) | Parser for [`fiftyone.core.sample.Sample`](fiftyone.core.sample.md#fiftyone.core.sample.Sample) instances that contain labeled images. | | [`FiftyOneLabeledVideoSampleParser`](#fiftyone.utils.data.FiftyOneLabeledVideoSampleParser)([...]) | Parser for [`fiftyone.core.sample.Sample`](fiftyone.core.sample.md#fiftyone.core.sample.Sample) instances that contain labeled videos. | | [`FiftyOneUnlabeledImageSampleParser`](#fiftyone.utils.data.FiftyOneUnlabeledImageSampleParser)([...]) | Parser for [`fiftyone.core.sample.Sample`](fiftyone.core.sample.md#fiftyone.core.sample.Sample) instances that contain images. | | [`FiftyOneUnlabeledMediaSampleParser`](#fiftyone.utils.data.FiftyOneUnlabeledMediaSampleParser)([...]) | Parser for [`fiftyone.core.sample.Sample`](fiftyone.core.sample.md#fiftyone.core.sample.Sample) instances that contain unlabeled media. | | [`FiftyOneUnlabeledVideoSampleParser`](#fiftyone.utils.data.FiftyOneUnlabeledVideoSampleParser)([...]) | Parser for [`fiftyone.core.sample.Sample`](fiftyone.core.sample.md#fiftyone.core.sample.Sample) instances that contain videos. | | [`ImageClassificationSampleParser`](#fiftyone.utils.data.ImageClassificationSampleParser)([classes]) | Generic parser for image classification(s) samples whose labels are represented as [`fiftyone.core.labels.Classification`](fiftyone.core.labels.md#fiftyone.core.labels.Classification) instances. | | [`ImageSampleParser`](#fiftyone.utils.data.ImageSampleParser)() | Sample parser that parses unlabeled image samples. | | [`ExportPathsMixin`](#fiftyone.utils.data.ExportPathsMixin)() | Mixin for [`DatasetExporter`](#fiftyone.utils.data.DatasetExporter) classes that provides convenience methods for parsing the `data_path`, `labels_path`, and `export_media` parameters supported by many exporters. | | [`MediaExporter`](#fiftyone.utils.data.MediaExporter)(export_mode[, export_path, ...]) | Base class for [`DatasetExporter`](#fiftyone.utils.data.DatasetExporter) utilities that provide support for populating a directory or manifest of media files. | | [`ImageExporter`](#fiftyone.utils.data.ImageExporter)(\*args[, default_ext]) | Utility class for [`DatasetExporter`](#fiftyone.utils.data.DatasetExporter) instances that export images. | | [`VideoExporter`](#fiftyone.utils.data.VideoExporter)(\*args[, default_ext]) | Utility class for [`DatasetExporter`](#fiftyone.utils.data.DatasetExporter) instances that export videos. | | [`DatasetExporter`](#fiftyone.utils.data.DatasetExporter)([export_dir]) | Base interface for exporting datasets. | | [`BatchDatasetExporter`](#fiftyone.utils.data.BatchDatasetExporter)([export_dir]) | Base interface for exporters that export entire [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) instances in a single batch. | | [`GenericSampleDatasetExporter`](#fiftyone.utils.data.GenericSampleDatasetExporter)([export_dir]) | Interface for exporting datasets of arbitrary [`fiftyone.core.sample.Sample`](fiftyone.core.sample.md#fiftyone.core.sample.Sample) instances. | | [`GroupDatasetExporter`](#fiftyone.utils.data.GroupDatasetExporter)([export_dir]) | Interface for exporting grouped datasets. | | [`UnlabeledImageDatasetExporter`](#fiftyone.utils.data.UnlabeledImageDatasetExporter)([export_dir]) | Interface for exporting datasets of unlabeled image samples. | | [`UnlabeledVideoDatasetExporter`](#fiftyone.utils.data.UnlabeledVideoDatasetExporter)([export_dir]) | Interface for exporting datasets of unlabeled video samples. | | [`UnlabeledMediaDatasetExporter`](#fiftyone.utils.data.UnlabeledMediaDatasetExporter)([export_dir]) | Interface for exporting datasets of unlabeled samples. | | [`LabeledImageDatasetExporter`](#fiftyone.utils.data.LabeledImageDatasetExporter)([export_dir]) | Interface for exporting datasets of labeled image samples. | | [`LabeledVideoDatasetExporter`](#fiftyone.utils.data.LabeledVideoDatasetExporter)([export_dir]) | Interface for exporting datasets of labeled video samples. | | [`LegacyFiftyOneDatasetExporter`](#fiftyone.utils.data.LegacyFiftyOneDatasetExporter)(export_dir[, ...]) | Legacy exporter that writes an entire FiftyOne dataset to disk in a serialized JSON format along with its source media. | | [`FiftyOneDatasetExporter`](#fiftyone.utils.data.FiftyOneDatasetExporter)(export_dir[, ...]) | Exporter that writes an entire FiftyOne dataset to disk in a serialized JSON format along with its source media. | | [`ImageDirectoryExporter`](#fiftyone.utils.data.ImageDirectoryExporter)(export_dir[, ...]) | Exporter that writes a directory of images to disk. | | [`VideoDirectoryExporter`](#fiftyone.utils.data.VideoDirectoryExporter)(export_dir[, ...]) | Exporter that writes a directory of videos to disk. | | [`MediaDirectoryExporter`](#fiftyone.utils.data.MediaDirectoryExporter)(export_dir[, ...]) | Exporter that writes a directory of media files of arbitrary type to disk. | | [`FiftyOneImageClassificationDatasetExporter`](#fiftyone.utils.data.FiftyOneImageClassificationDatasetExporter)([...]) | Exporter that writes an image classification dataset to disk in a simple JSON format. | | [`ImageClassificationDirectoryTreeExporter`](#fiftyone.utils.data.ImageClassificationDirectoryTreeExporter)(...) | Exporter that writes an image classification directory tree to disk. | | [`VideoClassificationDirectoryTreeExporter`](#fiftyone.utils.data.VideoClassificationDirectoryTreeExporter)(...) | Exporter that writes a video classification directory tree to disk. | | [`FiftyOneImageDetectionDatasetExporter`](#fiftyone.utils.data.FiftyOneImageDetectionDatasetExporter)([...]) | Exporter that writes an image detection dataset to disk in a simple JSON format. | | [`FiftyOneTemporalDetectionDatasetExporter`](#fiftyone.utils.data.FiftyOneTemporalDetectionDatasetExporter)([...]) | Exporter that writes a temporal video detection dataset to disk in a simple JSON format. | | [`ImageSegmentationDirectoryExporter`](#fiftyone.utils.data.ImageSegmentationDirectoryExporter)([...]) | Exporter that writes an image segmentation dataset to disk. | | [`FiftyOneImageLabelsDatasetExporter`](#fiftyone.utils.data.FiftyOneImageLabelsDatasetExporter)(export_dir) | Exporter that writes a labeled image dataset to disk with labels stored in [ETA ImageLabels format](https://github.com/voxel51/eta/blob/main/docs/image_labels_guide.md). | | [`FiftyOneVideoLabelsDatasetExporter`](#fiftyone.utils.data.FiftyOneVideoLabelsDatasetExporter)(export_dir) | Exporter that writes a labeled video dataset with labels stored in [ETA VideoLabels format](https://github.com/voxel51/eta/blob/main/docs/video_labels_guide.md). | | [`datetime`](#fiftyone.utils.data.datetime)(year, month, day[, hour[, minute[, ...) | The year, month and day arguments are required. | | [`Sample`](#fiftyone.utils.data.Sample)([filepath, tags, metadata, ...]) | A sample in a [`fiftyone.core.dataset.Dataset`](fiftyone.core.dataset.md#fiftyone.core.dataset.Dataset). | | [`FiftyOneImageClassificationSampleParser`](#fiftyone.utils.data.FiftyOneImageClassificationSampleParser)([...]) | Parser for samples in FiftyOne image classification datasets. | | [`FiftyOneImageDetectionSampleParser`](#fiftyone.utils.data.FiftyOneImageDetectionSampleParser)([classes]) | Parser for samples in FiftyOne image detection datasets. | | [`FiftyOneImageLabelsSampleParser`](#fiftyone.utils.data.FiftyOneImageLabelsSampleParser)([prefix, ...]) | Parser for samples in FiftyOne image labels datasets. | | [`FiftyOneTemporalDetectionSampleParser`](#fiftyone.utils.data.FiftyOneTemporalDetectionSampleParser)([...]) | Parser for samples in FiftyOne temporal detection datasets. | | [`FiftyOneVideoLabelsSampleParser`](#fiftyone.utils.data.FiftyOneVideoLabelsSampleParser)([prefix, ...]) | Parser for samples in FiftyOne video labels datasets. | | [`ImportPathsMixin`](#fiftyone.utils.data.ImportPathsMixin)() | Mixin for [`DatasetImporter`](#fiftyone.utils.data.DatasetImporter) classes that provides convenience methods for parsing the `data_path` and `labels_path` parameters supported by many importers. | | [`DatasetImporter`](#fiftyone.utils.data.DatasetImporter)([dataset_dir, shuffle, ...]) | Base interface for importing datasets stored on disk into FiftyOne. | | [`BatchDatasetImporter`](#fiftyone.utils.data.BatchDatasetImporter)([dataset_dir, shuffle, ...]) | Base interface for importers that load all of their samples in a single call to [`import_samples()`](#fiftyone.utils.data.import_samples). | | [`GenericSampleDatasetImporter`](#fiftyone.utils.data.GenericSampleDatasetImporter)([dataset_dir, ...]) | Interface for importing datasets that contain arbitrary [`fiftyone.core.sample.Sample`](fiftyone.core.sample.md#fiftyone.core.sample.Sample) instances. | | [`GroupDatasetImporter`](#fiftyone.utils.data.GroupDatasetImporter)([dataset_dir, shuffle, ...]) | Interface for importing datasets that contain arbitrary grouped [`fiftyone.core.sample.Sample`](fiftyone.core.sample.md#fiftyone.core.sample.Sample) instances. | | [`UnlabeledImageDatasetImporter`](#fiftyone.utils.data.UnlabeledImageDatasetImporter)([dataset_dir, ...]) | Interface for importing datasets of unlabeled image samples. | | [`UnlabeledVideoDatasetImporter`](#fiftyone.utils.data.UnlabeledVideoDatasetImporter)([dataset_dir, ...]) | Interface for importing datasets of unlabeled video samples. | | [`UnlabeledMediaDatasetImporter`](#fiftyone.utils.data.UnlabeledMediaDatasetImporter)([dataset_dir, ...]) | Interface for importing datasets of unlabeled media samples. | | [`LabeledImageDatasetImporter`](#fiftyone.utils.data.LabeledImageDatasetImporter)([dataset_dir, ...]) | Interface for importing datasets of labeled image samples. | | [`LabeledVideoDatasetImporter`](#fiftyone.utils.data.LabeledVideoDatasetImporter)([dataset_dir, ...]) | Interface for importing datasets of labeled video samples. | | [`LegacyFiftyOneDatasetImporter`](#fiftyone.utils.data.LegacyFiftyOneDatasetImporter)(dataset_dir[, ...]) | Legacy importer for FiftyOne datasets stored on disk in a serialized JSON format. | | [`FiftyOneDatasetImporter`](#fiftyone.utils.data.FiftyOneDatasetImporter)(dataset_dir[, ...]) | Importer for FiftyOne datasets stored on disk in serialized JSON format. | | [`ImageDirectoryImporter`](#fiftyone.utils.data.ImageDirectoryImporter)(dataset_dir[, ...]) | Importer for a directory of images stored on disk. | | [`VideoDirectoryImporter`](#fiftyone.utils.data.VideoDirectoryImporter)(dataset_dir[, ...]) | Importer for a directory of videos stored on disk. | | [`MediaDirectoryImporter`](#fiftyone.utils.data.MediaDirectoryImporter)(dataset_dir[, ...]) | Importer for a directory of media files stored on disk. | | [`FiftyOneImageClassificationDatasetImporter`](#fiftyone.utils.data.FiftyOneImageClassificationDatasetImporter)([...]) | Importer for image classification datasets stored on disk in a simple JSON format. | | [`ImageClassificationDirectoryTreeImporter`](#fiftyone.utils.data.ImageClassificationDirectoryTreeImporter)(...) | Importer for an image classification directory tree stored on disk. | | [`VideoClassificationDirectoryTreeImporter`](#fiftyone.utils.data.VideoClassificationDirectoryTreeImporter)(...) | Importer for a viideo classification directory tree stored on disk. | | [`FiftyOneImageDetectionDatasetImporter`](#fiftyone.utils.data.FiftyOneImageDetectionDatasetImporter)([...]) | Importer for image detection datasets stored on disk in a simple JSON format. | | [`FiftyOneTemporalDetectionDatasetImporter`](#fiftyone.utils.data.FiftyOneTemporalDetectionDatasetImporter)([...]) | Importer for temporal video detection datasets stored on disk in a simple JSON format. | | [`ImageSegmentationDirectoryImporter`](#fiftyone.utils.data.ImageSegmentationDirectoryImporter)([...]) | Importer for image segmentation datasets stored on disk. | | [`FiftyOneImageLabelsDatasetImporter`](#fiftyone.utils.data.FiftyOneImageLabelsDatasetImporter)(dataset_dir) | Importer for labeled image datasets whose labels are stored in [ETA ImageLabels format](https://github.com/voxel51/eta/blob/main/docs/image_labels_guide.md). | | [`FiftyOneVideoLabelsDatasetImporter`](#fiftyone.utils.data.FiftyOneVideoLabelsDatasetImporter)(dataset_dir) | Importer for labeled video datasets whose labels are stored in [ETA VideoLabels format](https://github.com/voxel51/eta/blob/main/docs/video_labels_guide.md). | | [`ImageIngestor`](#fiftyone.utils.data.ImageIngestor)(dataset_dir[, image_format]) | Mixin for [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter) instances that ingest images into the provided `dataset_dir` during import. | | [`UnlabeledImageDatasetIngestor`](#fiftyone.utils.data.UnlabeledImageDatasetIngestor)(dataset_dir, ...) | Dataset importer that ingests unlabeled images into the provided `dataset_dir` during import. | | [`LabeledImageDatasetIngestor`](#fiftyone.utils.data.LabeledImageDatasetIngestor)(dataset_dir, ...) | Dataset importer that ingests labeled images into the provided `dataset_dir` during import. | | [`VideoIngestor`](#fiftyone.utils.data.VideoIngestor)(dataset_dir) | Mixin for [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter) instances that ingest videos into the provided `dataset_dir` during import. | | [`UnlabeledVideoDatasetIngestor`](#fiftyone.utils.data.UnlabeledVideoDatasetIngestor)(dataset_dir, ...) | Dataset importer that ingests unlabeled videos into the provided `dataset_dir` during import. | | [`LabeledVideoDatasetIngestor`](#fiftyone.utils.data.LabeledVideoDatasetIngestor)(dataset_dir, ...) | Dataset importer that ingests labeled videos into the provided `dataset_dir` during import. | | [`SampleParser`](#fiftyone.utils.data.SampleParser)() | Base interface for sample parsers. | | [`UnlabeledImageSampleParser`](#fiftyone.utils.data.UnlabeledImageSampleParser)() | Interface for [`SampleParser`](#fiftyone.utils.data.SampleParser) instances that parse unlabeled image samples. | | [`UnlabeledVideoSampleParser`](#fiftyone.utils.data.UnlabeledVideoSampleParser)() | Interface for [`SampleParser`](#fiftyone.utils.data.SampleParser) instances that parse unlabeled video samples. | | [`UnlabeledMediaSampleParser`](#fiftyone.utils.data.UnlabeledMediaSampleParser)() | Interface for [`SampleParser`](#fiftyone.utils.data.SampleParser) instances that parse unlabeled media samples. | | [`VideoSampleParser`](#fiftyone.utils.data.VideoSampleParser)() | Sample parser that parses unlabeled video samples. | | [`MediaSampleParser`](#fiftyone.utils.data.MediaSampleParser)() | Sample parser that parses unlabeled media samples. | | [`LabeledImageSampleParser`](#fiftyone.utils.data.LabeledImageSampleParser)() | Interface for [`SampleParser`](#fiftyone.utils.data.SampleParser) instances that parse labeled image samples. | | [`LabeledVideoSampleParser`](#fiftyone.utils.data.LabeledVideoSampleParser)() | Interface for [`SampleParser`](#fiftyone.utils.data.SampleParser) instances that parse labeled video samples. | | [`LabeledImageTupleSampleParser`](#fiftyone.utils.data.LabeledImageTupleSampleParser)() | Generic sample parser that parses samples that are `(image_or_path, label)` tuples, where: | | [`ImageDetectionSampleParser`](#fiftyone.utils.data.ImageDetectionSampleParser)([label_field, ...]) | Generic parser for image detection samples whose labels are represented as [`fiftyone.core.labels.Detections`](fiftyone.core.labels.md#fiftyone.core.labels.Detections) instances. | | [`ImageLabelsSampleParser`](#fiftyone.utils.data.ImageLabelsSampleParser)([prefix, ...]) | Generic parser for multitask image prediction samples whose labels are stored in `eta.core.image.ImageLabels` format. | | [`VideoLabelsSampleParser`](#fiftyone.utils.data.VideoLabelsSampleParser)([prefix, ...]) | Generic parser for labeled video samples whose labels are represented in `eta.core.video.VideoLabels` format. | | [`ExtractClipsMixin`](#fiftyone.utils.data.ExtractClipsMixin)([compute_metadata, ...]) | Mixin for sample parsers that extract clips from [`fiftyone.core.clips.ClipView`](fiftyone.core.clips.md#fiftyone.core.clips.ClipView) instances. | **Functions:** | [`map_values`](#fiftyone.utils.data.map_values)(sample_collection, path, map[, ...]) | Maps the values in the given field to new values for each sample in the collection. | |-------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`parse_images_dir`](#fiftyone.utils.data.parse_images_dir)(dataset_dir[, recursive]) | Parses the contents of the given directory of images. | | [`parse_videos_dir`](#fiftyone.utils.data.parse_videos_dir)(dataset_dir[, recursive]) | Parses the contents of the given directory of videos. | | [`parse_image_classification_dir_tree`](#fiftyone.utils.data.parse_image_classification_dir_tree)(dataset_dir) | Parses the contents of the given image classification dataset directory tree, which should have the following format. | | [`download_image_classification_dataset`](#fiftyone.utils.data.download_image_classification_dataset)(...[, ...]) | Downloads the classification dataset specified by the given CSV file, which should have the following format. | | [`download_images`](#fiftyone.utils.data.download_images)(image_urls, output_dir[, ...]) | Downloads the images from the given URLs. | | [`build_dataset_exporter`](#fiftyone.utils.data.build_dataset_exporter)(dataset_type[, ...]) | Builds the [`DatasetExporter`](#fiftyone.utils.data.DatasetExporter) instance for the given parameters. | | [`build_dataset_importer`](#fiftyone.utils.data.build_dataset_importer)(dataset_type[, ...]) | Builds the [`DatasetImporter`](#fiftyone.utils.data.DatasetImporter) instance for the given parameters. | | [`convert_dataset`](#fiftyone.utils.data.convert_dataset)([input_dir, input_type, ...]) | Converts a dataset stored on disk to another format on disk. | | [`export_samples`](#fiftyone.utils.data.export_samples)(samples[, export_dir, ...]) | Exports the given samples to disk. | | [`write_dataset`](#fiftyone.utils.data.write_dataset)(samples, sample_parser, ...[, ...]) | Writes the samples to disk as a dataset in the specified format. | | [`get_document`](#fiftyone.utils.data.get_document)(name) | Get a registered Document class by name. | | [`import_samples`](#fiftyone.utils.data.import_samples)(dataset, dataset_importer[, ...]) | Adds the samples from the given [`DatasetImporter`](#fiftyone.utils.data.DatasetImporter) to the dataset. | | [`merge_samples`](#fiftyone.utils.data.merge_samples)(dataset, dataset_importer[, ...]) | Merges the samples from the given [`DatasetImporter`](#fiftyone.utils.data.DatasetImporter) into the dataset. | | [`parse_dataset_info`](#fiftyone.utils.data.parse_dataset_info)(dataset, info[, overwrite]) | Parses the info returned by [`DatasetImporter.get_dataset_info()`](#fiftyone.utils.data.DatasetImporter.get_dataset_info) and stores it on the relevant properties of the dataset. | | [`add_images`](#fiftyone.utils.data.add_images)(dataset, samples, sample_parser) | Adds the given images to the dataset. | | [`add_labeled_images`](#fiftyone.utils.data.add_labeled_images)(dataset, samples, ...[, ...]) | Adds the given labeled images to the dataset. | | [`add_videos`](#fiftyone.utils.data.add_videos)(dataset, samples, sample_parser) | Adds the given videos to the dataset. | | [`add_labeled_videos`](#fiftyone.utils.data.add_labeled_videos)(dataset, samples, ...[, ...]) | Adds the given labeled videos to the dataset. | ### fiftyone.utils.data.F alias of [`ViewField`](fiftyone.core.expressions.md#fiftyone.core.expressions.ViewField) ### fiftyone.utils.data.map_values(sample_collection, path, map, progress=False) Maps the values in the given field to new values for each sample in the collection. This function performs the same operation as [`map_values()`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection.map_values) but it immediately saves the mapped values to the database rather than creating a view. Examples: ```default import random import fiftyone as fo import fiftyone.zoo as foz import fiftyone.utils.data as foud from fiftyone import ViewField as F ANIMALS = [ "bear", "bird", "cat", "cow", "dog", "elephant", "giraffe", "horse", "sheep", "zebra" ] dataset = foz.load_zoo_dataset("quickstart") values = [random.choice(ANIMALS) for _ in range(len(dataset))] dataset.set_values("str_field", values) dataset.set_values("list_field", [[v] for v in values]) dataset.set_field("ground_truth.detections.tags", [F("label")]).save() # Map all animals to string "animal" mapping = {a: "animal" for a in ANIMALS} # # Map values in top-level fields # foud.map_values(dataset, "str_field", mapping) print(dataset.count_values("str_field")) # {"animal": 200} foud.map_values(dataset, "list_field", mapping) print(dataset.count_values("list_field")) # {"animal": 200} # # Map values in nested fields # foud.map_values(dataset, "ground_truth.detections.label", mapping) print(dataset.count_values("ground_truth.detections.label")) # {"animal": 183, ...} foud.map_values(dataset, "ground_truth.detections.tags", mapping) print(dataset.count_values("ground_truth.detections.tags")) # {"animal": 183, ...} ``` * **Parameters:** * **sample_collection** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) * **path** – the field or `embedded.field.name` to map * **map** – a dict mapping values to new values * **progress** (*False*) – whether to render a progress bar (True/False), use the default value `fiftyone.config.show_progress_bars` (None), or a progress callback function to invoke instead ### fiftyone.utils.data.parse_images_dir(dataset_dir, recursive=True) Parses the contents of the given directory of images. * **Parameters:** * **dataset_dir** – the dataset directory * **recursive** (*True*) – whether to recursively traverse subdirectories * **Returns:** a list of image paths ### fiftyone.utils.data.parse_videos_dir(dataset_dir, recursive=True) Parses the contents of the given directory of videos. * **Parameters:** * **dataset_dir** – the dataset directory * **recursive** (*True*) – whether to recursively traverse subdirectories * **Returns:** a list of video paths ### fiftyone.utils.data.parse_image_classification_dir_tree(dataset_dir) Parses the contents of the given image classification dataset directory tree, which should have the following format: ```default / / . . ... / . . ... ``` * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** a list of `(image_path, target)` pairs classes: a list of class label strings * **Return type:** [samples](fiftyone.brain.internal.core.elasticsearch.md#fiftyone.brain.internal.core.elasticsearch.ElasticsearchSimilarityIndex.samples) ### fiftyone.utils.data.download_image_classification_dataset(csv_path, dataset_dir, classes=None, num_workers=None) Downloads the classification dataset specified by the given CSV file, which should have the following format: ```default , , ... ``` The image filenames are the basenames of the URLs, which are assumed to be unique. The dataset is written to disk in [`fiftyone.types.FiftyOneImageClassificationDataset`](fiftyone.types.md#fiftyone.types.FiftyOneImageClassificationDataset) format. * **Parameters:** * **csv_path** – a CSV file containing the labels and image URLs * **dataset_dir** – the directory to write the dataset * **classes** (*None*) – an optional list of classes. By default, this will be inferred from the contents of `csv_path` * **num_workers** (*None*) – a suggested number of threads to use to download images ### fiftyone.utils.data.download_images(image_urls, output_dir, num_workers=None) Downloads the images from the given URLs. The filenames in `output_dir` are the basenames of the URLs, which are assumed to be unique. * **Parameters:** * **image_urls** – a list of image URLs to download * **output_dir** – the directory to write the images * **num_workers** (*None*) – a suggested number of threads to use * **Returns:** the list of downloaded image paths ### fiftyone.utils.data.build_dataset_exporter(dataset_type, strip_none=True, warn_unused=True, \*\*kwargs) Builds the [`DatasetExporter`](#fiftyone.utils.data.DatasetExporter) instance for the given parameters. * **Parameters:** * **dataset_type** – the [`fiftyone.types.Dataset`](fiftyone.types.md#fiftyone.types.Dataset) type * **strip_none** (*True*) – whether to exclude None-valued items from `kwargs` * **warn_unused** (*True*) – whether to issue warnings for any non-None unused parameters encountered * **\*\*kwargs** – keyword arguments to pass to the dataset exporter’s constructor via `DatasetExporter(**kwargs)` * **Returns:** - the [`DatasetExporter`](#fiftyone.utils.data.DatasetExporter) instance - a dict of unused keyword arguments * **Return type:** a tuple of ### fiftyone.utils.data.build_dataset_importer(dataset_type, strip_none=True, warn_unused=True, name=None, \*\*kwargs) Builds the [`DatasetImporter`](#fiftyone.utils.data.DatasetImporter) instance for the given parameters. * **Parameters:** * **dataset_type** – the [`fiftyone.types.Dataset`](fiftyone.types.md#fiftyone.types.Dataset) type * **strip_none** (*True*) – whether to exclude None-valued items from `kwargs` * **warn_unused** (*True*) – whether to issue warnings for any non-None unused parameters encountered * **name** (*None*) – the name of the dataset being imported into, if known * **\*\*kwargs** – keyword arguments to pass to the dataset importer’s constructor via `DatasetImporter(**kwargs)` * **Returns:** - the [`DatasetImporter`](#fiftyone.utils.data.DatasetImporter) instance - a dict of unused keyword arguments * **Return type:** a tuple of ### fiftyone.utils.data.convert_dataset(input_dir=None, input_type=None, input_kwargs=None, dataset_importer=None, output_dir=None, output_type=None, output_kwargs=None, dataset_exporter=None, overwrite=False) Converts a dataset stored on disk to another format on disk. The input dataset may be specified by providing either an `input_dir` and a corresponding `input_type` or by providing a `dataset_importer`. The output dataset may be specified by providing either an `output_dir` and a corresponding `output_type` or by providing a `dataset_exporter`. * **Parameters:** * **input_dir** (*None*) – the input dataset directory * **input_type** (*None*) – the [`fiftyone.types.Dataset`](fiftyone.types.md#fiftyone.types.Dataset) type of the dataset in `input_dir` * **input_kwargs** (*None*) – optional kwargs dict to pass to the constructor of the [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter) for the `input_type` you specify * **dataset_importer** (*None*) – a [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter) to use to import the input dataset * **output_dir** (*None*) – the directory to which to write the output dataset * **output_type** (*None*) – the [`fiftyone.types.Dataset`](fiftyone.types.md#fiftyone.types.Dataset) type to write to `output_dir` * **output_kwargs** (*None*) – optional kwargs dict to pass to the constructor of the [`fiftyone.utils.data.exporters.DatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.DatasetExporter) for the `output_type` you specify * **dataset_exporter** (*None*) – a [`fiftyone.utils.data.exporters.DatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.DatasetExporter) to use to export the dataset * **overwrite** (*False*) – whether to delete existing directories before performing the export (True) or to merge the export with existing files and directories (False) ### *class* fiftyone.utils.data.defaultdict Bases: `dict` defaultdict(default_factory=None, /, […]) –> dict with default factory The default factory is called without arguments to produce a new value when a key is not present, in \_\_getitem_\_ only. A defaultdict compares equal to a dict with the same items. All remaining arguments are treated the same as if they were passed to the dict constructor, including keyword arguments. **Methods:** | [`clear`](#fiftyone.utils.data.defaultdict.clear)() | Remove all items from the dict. | |-----------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`copy`](#fiftyone.utils.data.defaultdict.copy)() | | | [`fromkeys`](#fiftyone.utils.data.defaultdict.fromkeys)(iterable[, value]) | Create a new dictionary with keys from iterable and values set to value. | | [`get`](#fiftyone.utils.data.defaultdict.get)(key[, default]) | Return the value for key if key is in the dictionary, else default. | | [`items`](#fiftyone.utils.data.defaultdict.items)() | Return a set-like object providing a view on the dict's items. | | [`keys`](#fiftyone.utils.data.defaultdict.keys)() | Return a set-like object providing a view on the dict's keys. | | [`pop`](#fiftyone.utils.data.defaultdict.pop)(k[,d]) | If the key is not found, return the default if given; otherwise, raise a KeyError. | | [`popitem`](#fiftyone.utils.data.defaultdict.popitem)() | Remove and return a (key, value) pair as a 2-tuple. | | [`setdefault`](#fiftyone.utils.data.defaultdict.setdefault)(key[, default]) | Insert key with a value of default if key is not in the dictionary. | | [`update`](#fiftyone.utils.data.defaultdict.update)([E, ]\*\*F) | If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k] | | [`values`](#fiftyone.utils.data.defaultdict.values)() | Return an object providing a view on the dict's values. | **Attributes:** | [`default_factory`](#fiftyone.utils.data.defaultdict.default_factory) | Factory for default value called by \_\_missing_\_(). | |-------------------------------------------------------------------------|---------------------------------------------------------| #### clear() Remove all items from the dict. #### copy() → a shallow copy of D. #### default_factory Factory for default value called by \_\_missing_\_(). #### *classmethod* fromkeys(iterable, value=None,) Create a new dictionary with keys from iterable and values set to value. #### get(key, default=None,) Return the value for key if key is in the dictionary, else default. #### items() Return a set-like object providing a view on the dict’s items. #### keys() Return a set-like object providing a view on the dict’s keys. #### pop(k) → v, remove specified key and return the corresponding value. If the key is not found, return the default if given; otherwise, raise a KeyError. #### popitem() Remove and return a (key, value) pair as a 2-tuple. Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty. #### setdefault(key, default=None,) Insert key with a value of default if key is not in the dictionary. Return the value for key if key is in the dictionary, else default. #### update(\*\*F) → None. Update D from mapping/iterable E and F. If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k] #### values() Return an object providing a view on the dict’s values. ### *class* fiftyone.utils.data.FiftyOneLabeledImageSampleParser(label_field, label_fcn=None, compute_metadata=False) Bases: [`LabeledImageSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledImageSampleParser) Parser for [`fiftyone.core.sample.Sample`](fiftyone.core.sample.md#fiftyone.core.sample.Sample) instances that contain labeled images. * **Parameters:** * **label_field** – the name of the label field to parse, or a dictionary mapping label field names to keys for the return label dictionaries * **label_fcn** (*None*) – an optional function or dictionary mapping label field names to functions (must match `label_field`) to apply to each label before returning it * **compute_metadata** (*False*) – whether to compute [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances on-the-fly if [`get_image_metadata()`](#fiftyone.utils.data.FiftyOneLabeledImageSampleParser.get_image_metadata) is called and no metadata is available **Attributes:** | [`has_image_path`](#fiftyone.utils.data.FiftyOneLabeledImageSampleParser.has_image_path) | Whether this parser produces paths to images on disk for samples that it parses. | |--------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`has_image_metadata`](#fiftyone.utils.data.FiftyOneLabeledImageSampleParser.has_image_metadata) | Whether this parser produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for samples that it parses. | | [`label_cls`](#fiftyone.utils.data.FiftyOneLabeledImageSampleParser.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this parser. | | [`current_sample`](#fiftyone.utils.data.FiftyOneLabeledImageSampleParser.current_sample) | The current sample. | **Methods:** | [`get_image`](#fiftyone.utils.data.FiftyOneLabeledImageSampleParser.get_image)() | Returns the image from the current sample. | |----------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------| | [`get_image_path`](#fiftyone.utils.data.FiftyOneLabeledImageSampleParser.get_image_path)() | Returns the image path for the current sample. | | [`get_image_metadata`](#fiftyone.utils.data.FiftyOneLabeledImageSampleParser.get_image_metadata)() | Returns the image metadata for the current sample. | | [`get_label`](#fiftyone.utils.data.FiftyOneLabeledImageSampleParser.get_label)() | Returns the label for the current sample. | | [`clear_sample`](#fiftyone.utils.data.FiftyOneLabeledImageSampleParser.clear_sample)() | Clears the current sample. | | [`with_sample`](#fiftyone.utils.data.FiftyOneLabeledImageSampleParser.with_sample)(sample) | Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. | #### *property* has_image_path Whether this parser produces paths to images on disk for samples that it parses. #### *property* has_image_metadata Whether this parser produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for samples that it parses. #### *property* label_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this parser. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class. In this case, the parser is guaranteed to return labels of this type - a list or tuple of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the parser can produce a single label field of any of these types - a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the parser 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 parser makes no guarantees about the labels that it may return #### get_image() Returns the image from the current sample. * **Returns:** a numpy image #### get_image_path() Returns the image path for the current sample. * **Returns:** the path to the image on disk #### get_image_metadata() Returns the image metadata for the current sample. * **Returns:** a [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instance #### get_label() Returns the label for the current sample. * **Returns:** a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instance, or a dictionary mapping field names to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances, or `None` if the sample is unlabeled #### clear_sample() Clears the current sample. Also clears any cached sample information stored by the parser. #### *property* current_sample The current sample. * **Raises:** **ValueError** – if there is no current sample #### with_sample(sample) Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. Guaranteed to call [`clear_sample()`](#fiftyone.utils.data.FiftyOneLabeledImageSampleParser.clear_sample) before setting the current sample. * **Parameters:** **sample** – a sample ### *class* fiftyone.utils.data.FiftyOneLabeledVideoSampleParser(label_field=None, frame_labels_field=None, label_fcn=None, frame_labels_fcn=None, compute_metadata=False, write_clips=True, clip_dir=None, video_format=None) Bases: [`ExtractClipsMixin`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ExtractClipsMixin), [`LabeledVideoSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledVideoSampleParser) Parser for [`fiftyone.core.sample.Sample`](fiftyone.core.sample.md#fiftyone.core.sample.Sample) instances that contain labeled videos. This class also supports [`fiftyone.core.clips.ClipView`](fiftyone.core.clips.md#fiftyone.core.clips.ClipView) instances. * **Parameters:** * **label_field** (*None*) – the name of a label field to parse, or a dictionary mapping label field names to output keys to use in the returned sample-level labels dictionary * **frame_labels_field** (*None*) – the name of a frame label field to parse, or a dictionary mapping field names to output keys describing the frame label fields to export * **label_fcn** (*None*) – an optional function or dictionary mapping label field names to functions (must match `label_field`) to apply to each sample label before returning it * **frame_labels_fcn** (*None*) – an optional function or dictionary mapping frame label field names to functions (must match `frame_labels_field`) to apply to each frame label before returning it * **compute_metadata** (*False*) – whether to compute [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances on-the-fly if [`get_video_metadata()`](#fiftyone.utils.data.FiftyOneLabeledVideoSampleParser.get_video_metadata) is called and no metadata is available * **write_clips** (*True*) – whether to write clips when [`get_video_path()`](#fiftyone.utils.data.FiftyOneLabeledVideoSampleParser.get_video_path) is called * **clip_dir** (*None*) – a directory to write clips. Only applicable when parsing [`fiftyone.core.clips.ClipView`](fiftyone.core.clips.md#fiftyone.core.clips.ClipView) instances * **video_format** (*None*) – the video format to use when writing video clips to disk. By default, `fiftyone.config.default_video_ext` is used **Attributes:** | [`has_video_metadata`](#fiftyone.utils.data.FiftyOneLabeledVideoSampleParser.has_video_metadata) | Whether this parser produces [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for samples that it parses. | |----------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`label_cls`](#fiftyone.utils.data.FiftyOneLabeledVideoSampleParser.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this parser within the sample-level labels that it produces. | | [`frame_labels_cls`](#fiftyone.utils.data.FiftyOneLabeledVideoSampleParser.frame_labels_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this parser within the frame labels that it produces. | | [`current_sample`](#fiftyone.utils.data.FiftyOneLabeledVideoSampleParser.current_sample) | The current sample. | **Methods:** | [`get_video_path`](#fiftyone.utils.data.FiftyOneLabeledVideoSampleParser.get_video_path)() | Returns the video path for the current sample. | |----------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------| | [`get_video_metadata`](#fiftyone.utils.data.FiftyOneLabeledVideoSampleParser.get_video_metadata)() | Returns the video metadata for the current sample. | | [`get_label`](#fiftyone.utils.data.FiftyOneLabeledVideoSampleParser.get_label)() | Returns the sample-level labels for the current sample. | | [`get_frame_labels`](#fiftyone.utils.data.FiftyOneLabeledVideoSampleParser.get_frame_labels)() | Returns the frame labels for the current sample. | | [`clear_sample`](#fiftyone.utils.data.FiftyOneLabeledVideoSampleParser.clear_sample)() | Clears the current sample. | | [`with_sample`](#fiftyone.utils.data.FiftyOneLabeledVideoSampleParser.with_sample)(sample) | Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. | #### *property* has_video_metadata Whether this parser produces [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for samples that it parses. #### *property* label_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this parser within the sample-level labels that it produces. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class. In this case, the parser is guaranteed to return sample-level labels of this type - a list or tuple of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the parser can produce a single sample-level label field of any of these types - a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the parser 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 parser makes no guarantees about the sample-level labels that it may return #### *property* frame_labels_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this parser within the frame labels that it produces. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class. In this case, the parser is guaranteed to return frame labels of this type - a list or tuple of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the parser can produce a single frame label field of any of these types - a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the parser 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 parser makes no guarantees about the frame labels that it may return #### get_video_path() Returns the video path for the current sample. * **Returns:** the path to the video on disk #### get_video_metadata() Returns the video metadata for the current sample. * **Returns:** a [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instance #### get_label() Returns the sample-level labels for the current sample. * **Returns:** a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instance, or a dictionary mapping field names to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances, or `None` if the sample has no sample-level labels #### get_frame_labels() Returns the frame labels for the current sample. * **Returns:** a dictionary mapping frame numbers to dictionaries that map label fields to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances for each video frame, or `None` if the sample has no frame labels #### clear_sample() Clears the current sample. Also clears any cached sample information stored by the parser. #### *property* current_sample The current sample. * **Raises:** **ValueError** – if there is no current sample #### with_sample(sample) Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. Guaranteed to call [`clear_sample()`](#fiftyone.utils.data.FiftyOneLabeledVideoSampleParser.clear_sample) before setting the current sample. * **Parameters:** **sample** – a sample ### *class* fiftyone.utils.data.FiftyOneUnlabeledImageSampleParser(compute_metadata=False) Bases: [`UnlabeledImageSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.UnlabeledImageSampleParser) Parser for [`fiftyone.core.sample.Sample`](fiftyone.core.sample.md#fiftyone.core.sample.Sample) instances that contain images. * **Parameters:** **compute_metadata** (*False*) – whether to compute [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances on-the-fly if [`get_image_metadata()`](#fiftyone.utils.data.FiftyOneUnlabeledImageSampleParser.get_image_metadata) is called and no metadata is available **Attributes:** | [`has_image_path`](#fiftyone.utils.data.FiftyOneUnlabeledImageSampleParser.has_image_path) | Whether this parser produces paths to images on disk for samples that it parses. | |----------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`has_image_metadata`](#fiftyone.utils.data.FiftyOneUnlabeledImageSampleParser.has_image_metadata) | Whether this parser produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for samples that it parses. | | [`current_sample`](#fiftyone.utils.data.FiftyOneUnlabeledImageSampleParser.current_sample) | The current sample. | **Methods:** | [`get_image`](#fiftyone.utils.data.FiftyOneUnlabeledImageSampleParser.get_image)() | Returns the image from the current sample. | |------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------| | [`get_image_path`](#fiftyone.utils.data.FiftyOneUnlabeledImageSampleParser.get_image_path)() | Returns the image path for the current sample. | | [`get_image_metadata`](#fiftyone.utils.data.FiftyOneUnlabeledImageSampleParser.get_image_metadata)() | Returns the image metadata for the current sample. | | [`clear_sample`](#fiftyone.utils.data.FiftyOneUnlabeledImageSampleParser.clear_sample)() | Clears the current sample. | | [`with_sample`](#fiftyone.utils.data.FiftyOneUnlabeledImageSampleParser.with_sample)(sample) | Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. | #### *property* has_image_path Whether this parser produces paths to images on disk for samples that it parses. #### *property* has_image_metadata Whether this parser produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for samples that it parses. #### get_image() Returns the image from the current sample. * **Returns:** a numpy image #### get_image_path() Returns the image path for the current sample. * **Returns:** the path to the image on disk #### get_image_metadata() Returns the image metadata for the current sample. * **Returns:** a [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instance #### clear_sample() Clears the current sample. Also clears any cached sample information stored by the parser. #### *property* current_sample The current sample. * **Raises:** **ValueError** – if there is no current sample #### with_sample(sample) Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. Guaranteed to call [`clear_sample()`](#fiftyone.utils.data.FiftyOneUnlabeledImageSampleParser.clear_sample) before setting the current sample. * **Parameters:** **sample** – a sample ### *class* fiftyone.utils.data.FiftyOneUnlabeledMediaSampleParser(compute_metadata=False) Bases: [`MediaSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.MediaSampleParser) Parser for [`fiftyone.core.sample.Sample`](fiftyone.core.sample.md#fiftyone.core.sample.Sample) instances that contain unlabeled media. * **Parameters:** **compute_metadata** (*False*) – whether to compute [`fiftyone.core.metadata.Metadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.Metadata) instances on-the-fly if [`get_metadata()`](#fiftyone.utils.data.FiftyOneUnlabeledMediaSampleParser.get_metadata) is called and no metadata is available **Attributes:** | [`has_metadata`](#fiftyone.utils.data.FiftyOneUnlabeledMediaSampleParser.has_metadata) | Whether this parser produces [`fiftyone.core.metadata.Metadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.Metadata) instances for samples that it parses. | |--------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`current_sample`](#fiftyone.utils.data.FiftyOneUnlabeledMediaSampleParser.current_sample) | The current sample. | **Methods:** | [`get_media_path`](#fiftyone.utils.data.FiftyOneUnlabeledMediaSampleParser.get_media_path)() | Returns the media path for the current sample. | |------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------| | [`get_metadata`](#fiftyone.utils.data.FiftyOneUnlabeledMediaSampleParser.get_metadata)() | Returns the metadata for the current sample. | | [`clear_sample`](#fiftyone.utils.data.FiftyOneUnlabeledMediaSampleParser.clear_sample)() | Clears the current sample. | | [`with_sample`](#fiftyone.utils.data.FiftyOneUnlabeledMediaSampleParser.with_sample)(sample) | Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. | #### *property* has_metadata Whether this parser produces [`fiftyone.core.metadata.Metadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.Metadata) instances for samples that it parses. #### get_media_path() Returns the media path for the current sample. * **Returns:** the path to the media on disk #### get_metadata() Returns the metadata for the current sample. * **Returns:** a [`fiftyone.core.metadata.Metadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.Metadata) instance #### clear_sample() Clears the current sample. Also clears any cached sample information stored by the parser. #### *property* current_sample The current sample. * **Raises:** **ValueError** – if there is no current sample #### with_sample(sample) Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. Guaranteed to call [`clear_sample()`](#fiftyone.utils.data.FiftyOneUnlabeledMediaSampleParser.clear_sample) before setting the current sample. * **Parameters:** **sample** – a sample ### *class* fiftyone.utils.data.FiftyOneUnlabeledVideoSampleParser(compute_metadata=False, write_clips=True, clip_dir=None, video_format=None) Bases: [`ExtractClipsMixin`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ExtractClipsMixin), [`UnlabeledVideoSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.UnlabeledVideoSampleParser) Parser for [`fiftyone.core.sample.Sample`](fiftyone.core.sample.md#fiftyone.core.sample.Sample) instances that contain videos. This class also supports [`fiftyone.core.clips.ClipView`](fiftyone.core.clips.md#fiftyone.core.clips.ClipView) instances. * **Parameters:** * **compute_metadata** (*False*) – whether to compute [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances on-the-fly if [`get_video_metadata()`](#fiftyone.utils.data.FiftyOneUnlabeledVideoSampleParser.get_video_metadata) is called and no metadata is available * **write_clips** (*True*) – whether to write clips when [`get_video_path()`](#fiftyone.utils.data.FiftyOneUnlabeledVideoSampleParser.get_video_path) is called * **clip_dir** (*None*) – a directory to write clips. Only applicable when parsing [`fiftyone.core.clips.ClipView`](fiftyone.core.clips.md#fiftyone.core.clips.ClipView) instances * **video_format** (*None*) – the video format to use when writing video clips to disk. By default, `fiftyone.config.default_video_ext` is used **Attributes:** | [`has_video_metadata`](#fiftyone.utils.data.FiftyOneUnlabeledVideoSampleParser.has_video_metadata) | Whether this parser produces [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for samples that it parses. | |------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`current_sample`](#fiftyone.utils.data.FiftyOneUnlabeledVideoSampleParser.current_sample) | The current sample. | **Methods:** | [`get_video_path`](#fiftyone.utils.data.FiftyOneUnlabeledVideoSampleParser.get_video_path)() | Returns the video path for the current sample. | |------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------| | [`get_video_metadata`](#fiftyone.utils.data.FiftyOneUnlabeledVideoSampleParser.get_video_metadata)() | Returns the video metadata for the current sample. | | [`clear_sample`](#fiftyone.utils.data.FiftyOneUnlabeledVideoSampleParser.clear_sample)() | Clears the current sample. | | [`with_sample`](#fiftyone.utils.data.FiftyOneUnlabeledVideoSampleParser.with_sample)(sample) | Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. | #### *property* has_video_metadata Whether this parser produces [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for samples that it parses. #### get_video_path() Returns the video path for the current sample. * **Returns:** the path to the video on disk #### get_video_metadata() Returns the video metadata for the current sample. * **Returns:** a [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instance #### clear_sample() Clears the current sample. Also clears any cached sample information stored by the parser. #### *property* current_sample The current sample. * **Raises:** **ValueError** – if there is no current sample #### with_sample(sample) Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. Guaranteed to call [`clear_sample()`](#fiftyone.utils.data.FiftyOneUnlabeledVideoSampleParser.clear_sample) before setting the current sample. * **Parameters:** **sample** – a sample ### *class* fiftyone.utils.data.ImageClassificationSampleParser(classes=None) Bases: [`LabeledImageTupleSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledImageTupleSampleParser) Generic parser for image classification(s) samples whose labels are represented as [`fiftyone.core.labels.Classification`](fiftyone.core.labels.md#fiftyone.core.labels.Classification) instances. This implementation supports samples that are `(image_or_path, target)` tuples, where: > - `image_or_path` is either an image that can be converted to numpy > format via `np.asarray()` or the path to an image on disk > - `target` can be any of the following: > - None, for unlabeled images > - a label string or list of label strings > - a class ID or list of class IDs, if `classes` is provided > - a dict or list of dicts of the following form: > ```default > { > "label": , > "confidence": , > "attributes": , > } > ``` > - a [`fiftyone.core.labels.Classification`](fiftyone.core.labels.md#fiftyone.core.labels.Classification) or > [`fiftyone.core.labels.Classifications`](fiftyone.core.labels.md#fiftyone.core.labels.Classifications) instance * **Parameters:** **classes** (*None*) – an optional list of class label strings. If provided, it is assumed that `target` contains class ID that should be mapped to label strings via `classes[target]` **Attributes:** | [`label_cls`](#fiftyone.utils.data.ImageClassificationSampleParser.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this parser. | |-------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`current_sample`](#fiftyone.utils.data.ImageClassificationSampleParser.current_sample) | The current sample. | | [`has_image_metadata`](#fiftyone.utils.data.ImageClassificationSampleParser.has_image_metadata) | Whether this parser produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for samples that it parses. | | [`has_image_path`](#fiftyone.utils.data.ImageClassificationSampleParser.has_image_path) | Whether this parser produces paths to images on disk for samples that it parses. | **Methods:** | [`get_label`](#fiftyone.utils.data.ImageClassificationSampleParser.get_label)() | Returns the label for the current sample. | |---------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------| | [`clear_sample`](#fiftyone.utils.data.ImageClassificationSampleParser.clear_sample)() | Clears the current sample. | | [`get_image`](#fiftyone.utils.data.ImageClassificationSampleParser.get_image)() | Returns the image from the current sample. | | [`get_image_metadata`](#fiftyone.utils.data.ImageClassificationSampleParser.get_image_metadata)() | Returns the image metadata for the current sample. | | [`get_image_path`](#fiftyone.utils.data.ImageClassificationSampleParser.get_image_path)() | Returns the image path for the current sample. | | [`with_sample`](#fiftyone.utils.data.ImageClassificationSampleParser.with_sample)(sample) | Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. | #### *property* label_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this parser. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class. In this case, the parser is guaranteed to return labels of this type - a list or tuple of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the parser can produce a single label field of any of these types - a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the parser 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 parser makes no guarantees about the labels that it may return #### get_label() Returns the label for the current sample. * **Parameters:** **sample** – the sample * **Returns:** a [`fiftyone.core.labels.Classification`](fiftyone.core.labels.md#fiftyone.core.labels.Classification) instance #### clear_sample() Clears the current sample. Also clears any cached sample information stored by the parser. #### *property* current_sample The current sample. * **Raises:** **ValueError** – if there is no current sample #### get_image() Returns the image from the current sample. * **Returns:** a numpy image #### get_image_metadata() Returns the image metadata for the current sample. * **Returns:** a [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instance #### get_image_path() Returns the image path for the current sample. * **Returns:** the path to the image on disk #### *property* has_image_metadata Whether this parser produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for samples that it parses. #### *property* has_image_path Whether this parser produces paths to images on disk for samples that it parses. #### with_sample(sample) Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. Guaranteed to call [`clear_sample()`](#fiftyone.utils.data.ImageClassificationSampleParser.clear_sample) before setting the current sample. * **Parameters:** **sample** – a sample ### *class* fiftyone.utils.data.ImageSampleParser Bases: [`UnlabeledImageSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.UnlabeledImageSampleParser) Sample parser that parses unlabeled image samples. This implementation assumes that the provided sample is either an image that can be converted to numpy format via `np.asarray()` or the path to an image on disk. **Attributes:** | [`has_image_path`](#fiftyone.utils.data.ImageSampleParser.has_image_path) | Whether this parser produces paths to images on disk for samples that it parses. | |-----------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`has_image_metadata`](#fiftyone.utils.data.ImageSampleParser.has_image_metadata) | Whether this parser produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for samples that it parses. | | [`current_sample`](#fiftyone.utils.data.ImageSampleParser.current_sample) | The current sample. | **Methods:** | [`get_image`](#fiftyone.utils.data.ImageSampleParser.get_image)() | Returns the image from the current sample. | |-------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------| | [`get_image_path`](#fiftyone.utils.data.ImageSampleParser.get_image_path)() | Returns the image path for the current sample. | | [`clear_sample`](#fiftyone.utils.data.ImageSampleParser.clear_sample)() | Clears the current sample. | | [`get_image_metadata`](#fiftyone.utils.data.ImageSampleParser.get_image_metadata)() | Returns the image metadata for the current sample. | | [`with_sample`](#fiftyone.utils.data.ImageSampleParser.with_sample)(sample) | Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. | #### *property* has_image_path Whether this parser produces paths to images on disk for samples that it parses. #### *property* has_image_metadata Whether this parser produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for samples that it parses. #### get_image() Returns the image from the current sample. * **Returns:** a numpy image #### get_image_path() Returns the image path for the current sample. * **Returns:** the path to the image on disk #### clear_sample() Clears the current sample. Also clears any cached sample information stored by the parser. #### *property* current_sample The current sample. * **Raises:** **ValueError** – if there is no current sample #### get_image_metadata() Returns the image metadata for the current sample. * **Returns:** a [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instance #### with_sample(sample) Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. Guaranteed to call [`clear_sample()`](#fiftyone.utils.data.ImageSampleParser.clear_sample) before setting the current sample. * **Parameters:** **sample** – a sample ### fiftyone.utils.data.export_samples(samples, export_dir=None, dataset_type=None, data_path=None, labels_path=None, export_media=None, rel_dir=None, dataset_exporter=None, label_field=None, frame_labels_field=None, progress=None, num_samples=None, \*\*kwargs) Exports the given samples to disk. You can perform exports with this method via the following basic patterns: 1. Provide `export_dir` and `dataset_type` to export the content to a directory in the default layout for the specified format, as documented in [this page](../user_guide/export_datasets.md#exporting-datasets) 2. Provide `dataset_type` along with `data_path`, `labels_path`, and/or `export_media` to directly specify where to export the source media and/or labels (if applicable) in your desired format. This syntax provides the flexibility to, for example, perform workflows like labels-only exports 3. Provide a `dataset_exporter` to which to feed samples to perform a fully-customized export In all workflows, the remaining parameters of this method can be provided to further configure the export. See [this page](../user_guide/export_datasets.md#exporting-datasets) for more information about the available export formats and examples of using this method. See [this guide](../user_guide/export_datasets.md#custom-dataset-exporter) for more details about exporting datasets in custom formats by defining your own [`fiftyone.utils.data.exporters.DatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.DatasetExporter). This method will automatically coerce the data to match the requested export in the following cases: - When exporting in either an unlabeled image or image classification format, if a spatial label field is provided ([`fiftyone.core.labels.Detection`](fiftyone.core.labels.md#fiftyone.core.labels.Detection), [`fiftyone.core.labels.Detections`](fiftyone.core.labels.md#fiftyone.core.labels.Detections), [`fiftyone.core.labels.Polyline`](fiftyone.core.labels.md#fiftyone.core.labels.Polyline), or [`fiftyone.core.labels.Polylines`](fiftyone.core.labels.md#fiftyone.core.labels.Polylines)), then the **image patches** of the provided samples will be exported - When exporting in labeled image dataset formats that expect list-type labels ([`fiftyone.core.labels.Classifications`](fiftyone.core.labels.md#fiftyone.core.labels.Classifications), [`fiftyone.core.labels.Detections`](fiftyone.core.labels.md#fiftyone.core.labels.Detections), [`fiftyone.core.labels.Keypoints`](fiftyone.core.labels.md#fiftyone.core.labels.Keypoints), or [`fiftyone.core.labels.Polylines`](fiftyone.core.labels.md#fiftyone.core.labels.Polylines)), if a label field contains labels in non-list format (e.g., [`fiftyone.core.labels.Classification`](fiftyone.core.labels.md#fiftyone.core.labels.Classification)), the labels will be automatically upgraded to single-label lists - When exporting in labeled image dataset formats that expect [`fiftyone.core.labels.Detections`](fiftyone.core.labels.md#fiftyone.core.labels.Detections) labels, if a [`fiftyone.core.labels.Classification`](fiftyone.core.labels.md#fiftyone.core.labels.Classification) field is provided, the labels will be automatically upgraded to detections that span the entire images * **Parameters:** * **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) * **export_dir** (*None*) – the directory to which to export the samples in format `dataset_type` * **dataset_type** (*None*) – the [`fiftyone.types.Dataset`](fiftyone.types.md#fiftyone.types.Dataset) type to write * **data_path** (*None*) – an optional parameter that enables explicit control over the location of the exported media for certain export formats. Can be any of the following: - a folder name like `"data"` or `"data/"` specifying a subfolder of `export_dir` in which to export the media - an absolute directory path in which to export the media. In this case, the `export_dir` has no effect on the location of the data - a filename like `"data.json"` specifying the filename of a JSON manifest file in `export_dir` generated when `export_media` is `"manifest"` - an absolute filepath specifying the location to write the JSON manifest file when `export_media` is `"manifest"`. In this case, `export_dir` has no effect on the location of the data If None, a default value of this parameter will be chosen based on the value of the `export_media` parameter. Note that this parameter is not applicable to certain export formats such as binary types like TF records * **labels_path** (*None*) – an optional parameter that enables explicit control over the location of the exported labels. Only applicable when exporting in certain labeled dataset formats. Can be any of the following: - a type-specific folder name like `"labels"` or `"labels/"` or a filename like `"labels.json"` or `"labels.xml"` specifying the location in `export_dir` in which to export the labels - an absolute directory or filepath in which to export the labels. In this case, the `export_dir` has no effect on the location of the labels For labeled datasets, the default value of this parameter will be chosen based on the export format so that the labels will be exported into `export_dir` * **export_media** (*None*) – controls how to export the raw media. The supported values are: - `True`: copy all media files into the output directory - `False`: don’t export media. This option is only useful when exporting labeled datasets whose label format stores sufficient information to locate the associated media - `"move"`: move all media files into the output directory - `"symlink"`: create symlinks to the media files in the output directory - `"manifest"`: create a `data.json` in the output directory that maps UUIDs used in the labels files to the filepaths of the source media, rather than exporting the actual media If None, an appropriate default value of this parameter will be chosen based on the value of the `data_path` parameter. Note that some dataset formats may not support certain values for this parameter (e.g., when exporting in binary formats such as TF records, “symlink” is not an option) * **rel_dir** (*None*) – an optional relative directory to strip from each input filepath to generate a unique identifier for each media. When exporting media, this identifier is joined with `data_path` to generate an output path for each exported media. This argument allows for populating nested subdirectories that match the shape of the input paths. The path is converted to an absolute path (if necessary) via [`fiftyone.core.storage.normalize_path()`](fiftyone.core.storage.md#fiftyone.core.storage.normalize_path) * **dataset_exporter** (*None*) – a [`DatasetExporter`](#fiftyone.utils.data.DatasetExporter) to use to write the dataset * **label_field** (*None*) – the name of the label field to export, or a dictionary mapping field names to output keys describing the label fields to export. Only applicable if `dataset_exporter` is a [`LabeledImageDatasetExporter`](#fiftyone.utils.data.LabeledImageDatasetExporter) or [`LabeledVideoDatasetExporter`](#fiftyone.utils.data.LabeledVideoDatasetExporter), or if you are exporting image patches * **frame_labels_field** (*None*) – the name of the frame label field to export, or a dictionary mapping field names to output keys describing the frame label fields to export. Only applicable if `dataset_exporter` is a [`LabeledVideoDatasetExporter`](#fiftyone.utils.data.LabeledVideoDatasetExporter) * **progress** (*None*) – whether to render a progress bar (True/False), use the default value `fiftyone.config.show_progress_bars` (None), or a progress callback function to invoke instead * **num_samples** (*None*) – the number of samples in `samples`. If omitted, this is computed (if possible) via `len(samples)` if needed for progress tracking * **\*\*kwargs** – optional keyword arguments to pass to the dataset exporter’s constructor. If you are exporting image patches, this can also contain keyword arguments for [`fiftyone.utils.patches.ImagePatchesExtractor`](fiftyone.utils.patches.md#fiftyone.utils.patches.ImagePatchesExtractor) ### fiftyone.utils.data.write_dataset(samples, sample_parser, dataset_exporter, sample_collection=None, progress=None, num_samples=None) Writes the samples to disk as a dataset in the specified format. * **Parameters:** * **samples** – an iterable of samples that can be parsed by `sample_parser` * **sample_parser** – a [`fiftyone.utils.data.parsers.SampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.SampleParser) to use to parse the samples * **dataset_exporter** – a [`DatasetExporter`](#fiftyone.utils.data.DatasetExporter) to use to write the dataset * **sample_collection** (*None*) – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) from which `samples` were extracted. If `samples` is itself a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection), this parameter defaults to `samples`. This parameter is optional and is only passed to [`DatasetExporter.log_collection()`](#fiftyone.utils.data.DatasetExporter.log_collection) * **progress** (*None*) – whether to render a progress bar (True/False), use the default value `fiftyone.config.show_progress_bars` (None), or a progress callback function to invoke instead * **num_samples** (*None*) – the number of samples in `samples`. If omitted, this is computed (if possible) via `len(samples)` if needed for progress tracking ### *class* fiftyone.utils.data.ExportPathsMixin Bases: `object` Mixin for [`DatasetExporter`](#fiftyone.utils.data.DatasetExporter) classes that provides convenience methods for parsing the `data_path`, `labels_path`, and `export_media` parameters supported by many exporters. ### *class* fiftyone.utils.data.MediaExporter(export_mode, export_path=None, rel_dir=None, chunk_size=None, supported_modes=None, default_ext=None, ignore_exts=False) Bases: `object` Base class for [`DatasetExporter`](#fiftyone.utils.data.DatasetExporter) utilities that provide support for populating a directory or manifest of media files. This class is designed for populating a single, flat directory or manifest of media files, and automatically takes care of things like name clashes as necessary. The export strategy used is defined by the `export_mode` parameter, and users of this class can restrict the available options via the `supported_modes` parameter. * **Parameters:** * **export_mode** – the export mode to use. The supported values are: - `True`: copy all media files into the output directory - `False`: don’t export media. This option is only useful when exporting labeled datasets whose label format stores sufficient information to locate the associated media - `"move"`: move all media files into the output directory - `"symlink"`: create symlinks to the media files in the output directory - `"manifest"`: create a `data.json` in the output directory that maps UUIDs used in the labels files to the filepaths of the source media, rather than exporting the actual media * **export_path** (*None*) – the location to export the media. Can be any of the following: - When `export_media` is True, “move”, or “symlink”, a directory in which to export the media - When `export_mode` is “manifest”, the path to write a JSON file mapping UUIDs to input filepaths - When `export_media` is False, this parameter has no effect * **rel_dir** (*None*) – an optional relative directory to strip from each input filepath to generate a unique identifier for each media. When exporting media, this identifier is joined with `export_path` to generate an output path for each exported media. This argument allows for populating nested subdirectories that match the shape of the input paths. The path is converted to an absolute path (if necessary) via [`fiftyone.core.storage.normalize_path()`](fiftyone.core.storage.md#fiftyone.core.storage.normalize_path) * **chunk_size** (*None*) – an optional chunk size to use when exporting media files. If provided, media files will be nested in subdirectories of the output directory with at most this many media files per subdirectory. Has no effect if a `rel_dir` is provided * **supported_modes** (*None*) – an optional tuple specifying a subset of the `export_mode` values that are allowed * **default_ext** (*None*) – the file extension to use when generating default output paths * **ignore_exts** (*False*) – whether to omit file extensions when generating UUIDs for files **Methods:** | [`setup`](#fiftyone.utils.data.MediaExporter.setup)() | Performs necessary setup to begin exporting media. | |---------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------| | [`setup_reference_export`](#fiftyone.utils.data.MediaExporter.setup_reference_export)(sample_collection, ...) | Configures the exporter to export media with reference assets. | | [`export_reference_asset`](#fiftyone.utils.data.MediaExporter.export_reference_asset)(asset, outpath) | Exports one planned physical reference asset exactly once. | | [`export_sample`](#fiftyone.utils.data.MediaExporter.export_sample)(sample_or_dict) | Exports the given sample's media. | | [`export`](#fiftyone.utils.data.MediaExporter.export)(media_or_path[, outpath]) | Exports the given media. | | [`close`](#fiftyone.utils.data.MediaExporter.close)() | Performs any necessary actions to complete the export. | **Attributes:** | [`is_reference_export`](#fiftyone.utils.data.MediaExporter.is_reference_export) | Whether this export involves reference assets. | |-----------------------------------------------------------------------------------|--------------------------------------------------| #### setup() Performs necessary setup to begin exporting media. [`DatasetExporter`](#fiftyone.utils.data.DatasetExporter) classes using this class should invoke this method in [`DatasetExporter.setup()`](#fiftyone.utils.data.DatasetExporter.setup). #### *property* is_reference_export Whether this export involves reference assets. #### setup_reference_export(sample_collection, export_root) Configures the exporter to export media with reference assets. * **Parameters:** * **sample_collection** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported * **export_root** – the root export directory #### export_reference_asset(asset, outpath) Exports one planned physical reference asset exactly once. * **Parameters:** * **asset** – the reference asset * **outpath** – the output path * **Returns:** the normalized path to the asset #### export_sample(sample_or_dict) Exports the given sample’s media. * **Parameters:** **sample_or_dict** – a [`fiftyone.core.sample.Sample`](fiftyone.core.sample.md#fiftyone.core.sample.Sample) or sample dict * **Returns:** - the path to the exported media - the UUID of the exported media * **Return type:** a tuple of #### export(media_or_path, outpath=None) Exports the given media. * **Parameters:** * **media_or_path** – the media or path to the media on disk * **outpath** (*None*) – a manually-specified location to which to export the media. By default, the media will be exported into `export_path` * **Returns:** - the path to the exported media - the UUID of the exported media * **Return type:** a tuple of #### close() Performs any necessary actions to complete the export. ### *class* fiftyone.utils.data.ImageExporter(\*args, default_ext=None, \*\*kwargs) Bases: [`MediaExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.MediaExporter) Utility class for [`DatasetExporter`](#fiftyone.utils.data.DatasetExporter) instances that export images. See [`MediaExporter`](#fiftyone.utils.data.MediaExporter) for details. **Methods:** | [`close`](#fiftyone.utils.data.ImageExporter.close)() | Performs any necessary actions to complete the export. | |---------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------| | [`export`](#fiftyone.utils.data.ImageExporter.export)(media_or_path[, outpath]) | Exports the given media. | | [`export_reference_asset`](#fiftyone.utils.data.ImageExporter.export_reference_asset)(asset, outpath) | Exports one planned physical reference asset exactly once. | | [`export_sample`](#fiftyone.utils.data.ImageExporter.export_sample)(sample_or_dict) | Exports the given sample's media. | | [`setup`](#fiftyone.utils.data.ImageExporter.setup)() | Performs necessary setup to begin exporting media. | | [`setup_reference_export`](#fiftyone.utils.data.ImageExporter.setup_reference_export)(sample_collection, ...) | Configures the exporter to export media with reference assets. | **Attributes:** | [`is_reference_export`](#fiftyone.utils.data.ImageExporter.is_reference_export) | Whether this export involves reference assets. | |-----------------------------------------------------------------------------------|--------------------------------------------------| #### close() Performs any necessary actions to complete the export. #### export(media_or_path, outpath=None) Exports the given media. * **Parameters:** * **media_or_path** – the media or path to the media on disk * **outpath** (*None*) – a manually-specified location to which to export the media. By default, the media will be exported into `export_path` * **Returns:** - the path to the exported media - the UUID of the exported media * **Return type:** a tuple of #### export_reference_asset(asset, outpath) Exports one planned physical reference asset exactly once. * **Parameters:** * **asset** – the reference asset * **outpath** – the output path * **Returns:** the normalized path to the asset #### export_sample(sample_or_dict) Exports the given sample’s media. * **Parameters:** **sample_or_dict** – a [`fiftyone.core.sample.Sample`](fiftyone.core.sample.md#fiftyone.core.sample.Sample) or sample dict * **Returns:** - the path to the exported media - the UUID of the exported media * **Return type:** a tuple of #### *property* is_reference_export Whether this export involves reference assets. #### setup() Performs necessary setup to begin exporting media. [`DatasetExporter`](#fiftyone.utils.data.DatasetExporter) classes using this class should invoke this method in [`DatasetExporter.setup()`](#fiftyone.utils.data.DatasetExporter.setup). #### setup_reference_export(sample_collection, export_root) Configures the exporter to export media with reference assets. * **Parameters:** * **sample_collection** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported * **export_root** – the root export directory ### *class* fiftyone.utils.data.VideoExporter(\*args, default_ext=None, \*\*kwargs) Bases: [`MediaExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.MediaExporter) Utility class for [`DatasetExporter`](#fiftyone.utils.data.DatasetExporter) instances that export videos. See [`MediaExporter`](#fiftyone.utils.data.MediaExporter) for details. **Methods:** | [`close`](#fiftyone.utils.data.VideoExporter.close)() | Performs any necessary actions to complete the export. | |---------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------| | [`export`](#fiftyone.utils.data.VideoExporter.export)(media_or_path[, outpath]) | Exports the given media. | | [`export_reference_asset`](#fiftyone.utils.data.VideoExporter.export_reference_asset)(asset, outpath) | Exports one planned physical reference asset exactly once. | | [`export_sample`](#fiftyone.utils.data.VideoExporter.export_sample)(sample_or_dict) | Exports the given sample's media. | | [`setup`](#fiftyone.utils.data.VideoExporter.setup)() | Performs necessary setup to begin exporting media. | | [`setup_reference_export`](#fiftyone.utils.data.VideoExporter.setup_reference_export)(sample_collection, ...) | Configures the exporter to export media with reference assets. | **Attributes:** | [`is_reference_export`](#fiftyone.utils.data.VideoExporter.is_reference_export) | Whether this export involves reference assets. | |-----------------------------------------------------------------------------------|--------------------------------------------------| #### close() Performs any necessary actions to complete the export. #### export(media_or_path, outpath=None) Exports the given media. * **Parameters:** * **media_or_path** – the media or path to the media on disk * **outpath** (*None*) – a manually-specified location to which to export the media. By default, the media will be exported into `export_path` * **Returns:** - the path to the exported media - the UUID of the exported media * **Return type:** a tuple of #### export_reference_asset(asset, outpath) Exports one planned physical reference asset exactly once. * **Parameters:** * **asset** – the reference asset * **outpath** – the output path * **Returns:** the normalized path to the asset #### export_sample(sample_or_dict) Exports the given sample’s media. * **Parameters:** **sample_or_dict** – a [`fiftyone.core.sample.Sample`](fiftyone.core.sample.md#fiftyone.core.sample.Sample) or sample dict * **Returns:** - the path to the exported media - the UUID of the exported media * **Return type:** a tuple of #### *property* is_reference_export Whether this export involves reference assets. #### setup() Performs necessary setup to begin exporting media. [`DatasetExporter`](#fiftyone.utils.data.DatasetExporter) classes using this class should invoke this method in [`DatasetExporter.setup()`](#fiftyone.utils.data.DatasetExporter.setup). #### setup_reference_export(sample_collection, export_root) Configures the exporter to export media with reference assets. * **Parameters:** * **sample_collection** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported * **export_root** – the root export directory ### *class* fiftyone.utils.data.DatasetExporter(export_dir=None) Bases: `object` Base interface for exporting datasets. See [this page](../user_guide/export_datasets.md#writing-a-custom-dataset-exporter) for information about implementing/using dataset exporters. * **Parameters:** **export_dir** (*None*) – the directory to write the export. This may be optional for some exporters **Methods:** | [`setup`](#fiftyone.utils.data.DatasetExporter.setup)() | Performs any necessary setup before exporting the first sample in the dataset. | |--------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`log_collection`](#fiftyone.utils.data.DatasetExporter.log_collection)(sample_collection) | Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. | | [`export_sample`](#fiftyone.utils.data.DatasetExporter.export_sample)(\*args, \*\*kwargs) | Exports the given sample to the dataset. | | [`close`](#fiftyone.utils.data.DatasetExporter.close)(\*args) | Performs any necessary actions after the last sample has been exported. | #### setup() Performs any necessary setup before exporting the first sample in the dataset. This method is called when the exporter’s context manager interface is entered, `DatasetExporter.__enter__()`. #### log_collection(sample_collection) Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. Subclasses can optionally implement this method if their export format can record information such as the [`fiftyone.core.collections.SampleCollection.info()`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection.info) of the collection being exported. By convention, this method must be optional; i.e., if it is not called before the first call to [`export_sample()`](#fiftyone.utils.data.DatasetExporter.export_sample), then the exporter must make do without any information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) (which may not be available, for example, if the samples being exported are not stored in a collection). * **Parameters:** **sample_collection** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported #### export_sample(\*args, \*\*kwargs) Exports the given sample to the dataset. * **Parameters:** * **\*args** – subclass-specific positional arguments * **\*\*kwargs** – subclass-specific keyword arguments #### close(\*args) Performs any necessary actions after the last sample has been exported. This method is called when the exporter’s context manager interface is exited, `DatasetExporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetExporter.__exit__()` ### *class* fiftyone.utils.data.BatchDatasetExporter(export_dir=None) Bases: [`DatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.DatasetExporter) Base interface for exporters that export entire [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) instances in a single batch. This interface allows for greater efficiency for export formats that handle aggregating over the samples themselves. * **Parameters:** **export_dir** (*None*) – the directory to write the export. This may be optional for some exporters **Methods:** | [`export_sample`](#fiftyone.utils.data.BatchDatasetExporter.export_sample)(\*args, \*\*kwargs) | Exports the given sample to the dataset. | |-------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`export_samples`](#fiftyone.utils.data.BatchDatasetExporter.export_samples)(sample_collection[, progress]) | Exports the given sample collection. | | [`close`](#fiftyone.utils.data.BatchDatasetExporter.close)(\*args) | Performs any necessary actions after the last sample has been exported. | | [`log_collection`](#fiftyone.utils.data.BatchDatasetExporter.log_collection)(sample_collection) | Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. | | [`setup`](#fiftyone.utils.data.BatchDatasetExporter.setup)() | Performs any necessary setup before exporting the first sample in the dataset. | #### export_sample(\*args, \*\*kwargs) Exports the given sample to the dataset. * **Parameters:** * **\*args** – subclass-specific positional arguments * **\*\*kwargs** – subclass-specific keyword arguments #### export_samples(sample_collection, progress=None) Exports the given sample collection. * **Parameters:** * **sample_collection** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) * **progress** (*None*) – whether to render a progress bar (True/False), use the default value `fiftyone.config.show_progress_bars` (None), or a progress callback function to invoke instead #### close(\*args) Performs any necessary actions after the last sample has been exported. This method is called when the exporter’s context manager interface is exited, `DatasetExporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetExporter.__exit__()` #### log_collection(sample_collection) Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. Subclasses can optionally implement this method if their export format can record information such as the [`fiftyone.core.collections.SampleCollection.info()`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection.info) of the collection being exported. By convention, this method must be optional; i.e., if it is not called before the first call to [`export_sample()`](#fiftyone.utils.data.BatchDatasetExporter.export_sample), then the exporter must make do without any information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) (which may not be available, for example, if the samples being exported are not stored in a collection). * **Parameters:** **sample_collection** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported #### setup() Performs any necessary setup before exporting the first sample in the dataset. This method is called when the exporter’s context manager interface is entered, `DatasetExporter.__enter__()`. ### *class* fiftyone.utils.data.GenericSampleDatasetExporter(export_dir=None) Bases: [`DatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.DatasetExporter) Interface for exporting datasets of arbitrary [`fiftyone.core.sample.Sample`](fiftyone.core.sample.md#fiftyone.core.sample.Sample) instances. See [this page](../user_guide/export_datasets.md#writing-a-custom-dataset-exporter) for information about implementing/using dataset exporters. * **Parameters:** **export_dir** (*None*) – the directory to write the export. This may be optional for some exporters **Methods:** | [`export_sample`](#fiftyone.utils.data.GenericSampleDatasetExporter.export_sample)(sample) | Exports the given sample to the dataset. | |---------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`close`](#fiftyone.utils.data.GenericSampleDatasetExporter.close)(\*args) | Performs any necessary actions after the last sample has been exported. | | [`log_collection`](#fiftyone.utils.data.GenericSampleDatasetExporter.log_collection)(sample_collection) | Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. | | [`setup`](#fiftyone.utils.data.GenericSampleDatasetExporter.setup)() | Performs any necessary setup before exporting the first sample in the dataset. | #### export_sample(sample) Exports the given sample to the dataset. * **Parameters:** **sample** – a [`fiftyone.core.sample.Sample`](fiftyone.core.sample.md#fiftyone.core.sample.Sample) #### close(\*args) Performs any necessary actions after the last sample has been exported. This method is called when the exporter’s context manager interface is exited, `DatasetExporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetExporter.__exit__()` #### log_collection(sample_collection) Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. Subclasses can optionally implement this method if their export format can record information such as the [`fiftyone.core.collections.SampleCollection.info()`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection.info) of the collection being exported. By convention, this method must be optional; i.e., if it is not called before the first call to [`export_sample()`](#fiftyone.utils.data.GenericSampleDatasetExporter.export_sample), then the exporter must make do without any information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) (which may not be available, for example, if the samples being exported are not stored in a collection). * **Parameters:** **sample_collection** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported #### setup() Performs any necessary setup before exporting the first sample in the dataset. This method is called when the exporter’s context manager interface is entered, `DatasetExporter.__enter__()`. ### *class* fiftyone.utils.data.GroupDatasetExporter(export_dir=None) Bases: [`DatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.DatasetExporter) Interface for exporting grouped datasets. See [this page](../user_guide/export_datasets.md#writing-a-custom-dataset-exporter) for information about implementing/using dataset exporters. * **Parameters:** **export_dir** (*None*) – the directory to write the export. This may be optional for some exporters **Methods:** | [`export_sample`](#fiftyone.utils.data.GroupDatasetExporter.export_sample)(\*args, \*\*kwargs) | Exports the given sample to the dataset. | |--------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`export_group`](#fiftyone.utils.data.GroupDatasetExporter.export_group)(group) | Exports the given group to the dataset. | | [`close`](#fiftyone.utils.data.GroupDatasetExporter.close)(\*args) | Performs any necessary actions after the last sample has been exported. | | [`log_collection`](#fiftyone.utils.data.GroupDatasetExporter.log_collection)(sample_collection) | Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. | | [`setup`](#fiftyone.utils.data.GroupDatasetExporter.setup)() | Performs any necessary setup before exporting the first sample in the dataset. | #### export_sample(\*args, \*\*kwargs) Exports the given sample to the dataset. * **Parameters:** * **\*args** – subclass-specific positional arguments * **\*\*kwargs** – subclass-specific keyword arguments #### export_group(group) Exports the given group to the dataset. * **Parameters:** **group** – a dict mapping group slice names to [`fiftyone.core.sample.Sample`](fiftyone.core.sample.md#fiftyone.core.sample.Sample) instances #### close(\*args) Performs any necessary actions after the last sample has been exported. This method is called when the exporter’s context manager interface is exited, `DatasetExporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetExporter.__exit__()` #### log_collection(sample_collection) Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. Subclasses can optionally implement this method if their export format can record information such as the [`fiftyone.core.collections.SampleCollection.info()`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection.info) of the collection being exported. By convention, this method must be optional; i.e., if it is not called before the first call to [`export_sample()`](#fiftyone.utils.data.GroupDatasetExporter.export_sample), then the exporter must make do without any information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) (which may not be available, for example, if the samples being exported are not stored in a collection). * **Parameters:** **sample_collection** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported #### setup() Performs any necessary setup before exporting the first sample in the dataset. This method is called when the exporter’s context manager interface is entered, `DatasetExporter.__enter__()`. ### *class* fiftyone.utils.data.UnlabeledImageDatasetExporter(export_dir=None) Bases: [`DatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.DatasetExporter) Interface for exporting datasets of unlabeled image samples. See [this page](../user_guide/export_datasets.md#writing-a-custom-dataset-exporter) for information about implementing/using dataset exporters. * **Parameters:** **export_dir** (*None*) – the directory to write the export. This may be optional for some exporters **Attributes:** | [`requires_image_metadata`](#fiftyone.utils.data.UnlabeledImageDatasetExporter.requires_image_metadata) | Whether this exporter requires [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each sample being exported. | |-----------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| **Methods:** | [`export_sample`](#fiftyone.utils.data.UnlabeledImageDatasetExporter.export_sample)(image_or_path[, metadata]) | Exports the given sample to the dataset. | |------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`close`](#fiftyone.utils.data.UnlabeledImageDatasetExporter.close)(\*args) | Performs any necessary actions after the last sample has been exported. | | [`log_collection`](#fiftyone.utils.data.UnlabeledImageDatasetExporter.log_collection)(sample_collection) | Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. | | [`setup`](#fiftyone.utils.data.UnlabeledImageDatasetExporter.setup)() | Performs any necessary setup before exporting the first sample in the dataset. | #### *property* requires_image_metadata Whether this exporter requires [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each sample being exported. #### export_sample(image_or_path, metadata=None) Exports the given sample to the dataset. * **Parameters:** * **image_or_path** – an image or the path to the image on disk * **metadata** (*None*) – a [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instance for the sample. Only required when [`requires_image_metadata()`](#fiftyone.utils.data.UnlabeledImageDatasetExporter.requires_image_metadata) is `True` #### close(\*args) Performs any necessary actions after the last sample has been exported. This method is called when the exporter’s context manager interface is exited, `DatasetExporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetExporter.__exit__()` #### log_collection(sample_collection) Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. Subclasses can optionally implement this method if their export format can record information such as the [`fiftyone.core.collections.SampleCollection.info()`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection.info) of the collection being exported. By convention, this method must be optional; i.e., if it is not called before the first call to [`export_sample()`](#fiftyone.utils.data.UnlabeledImageDatasetExporter.export_sample), then the exporter must make do without any information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) (which may not be available, for example, if the samples being exported are not stored in a collection). * **Parameters:** **sample_collection** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported #### setup() Performs any necessary setup before exporting the first sample in the dataset. This method is called when the exporter’s context manager interface is entered, `DatasetExporter.__enter__()`. ### *class* fiftyone.utils.data.UnlabeledVideoDatasetExporter(export_dir=None) Bases: [`DatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.DatasetExporter) Interface for exporting datasets of unlabeled video samples. See [this page](../user_guide/export_datasets.md#writing-a-custom-dataset-exporter) for information about implementing/using dataset exporters. * **Parameters:** **export_dir** (*None*) – the directory to write the export. This may be optional for some exporters **Attributes:** | [`requires_video_metadata`](#fiftyone.utils.data.UnlabeledVideoDatasetExporter.requires_video_metadata) | Whether this exporter requires [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for each sample being exported. | |-----------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| **Methods:** | [`export_sample`](#fiftyone.utils.data.UnlabeledVideoDatasetExporter.export_sample)(video_path[, metadata]) | Exports the given sample to the dataset. | |---------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`close`](#fiftyone.utils.data.UnlabeledVideoDatasetExporter.close)(\*args) | Performs any necessary actions after the last sample has been exported. | | [`log_collection`](#fiftyone.utils.data.UnlabeledVideoDatasetExporter.log_collection)(sample_collection) | Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. | | [`setup`](#fiftyone.utils.data.UnlabeledVideoDatasetExporter.setup)() | Performs any necessary setup before exporting the first sample in the dataset. | #### *property* requires_video_metadata Whether this exporter requires [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for each sample being exported. #### export_sample(video_path, metadata=None) Exports the given sample to the dataset. * **Parameters:** * **video_path** – the path to a video on disk * **metadata** (*None*) – a [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instance for the sample. Only required when [`requires_video_metadata()`](#fiftyone.utils.data.UnlabeledVideoDatasetExporter.requires_video_metadata) is `True` #### close(\*args) Performs any necessary actions after the last sample has been exported. This method is called when the exporter’s context manager interface is exited, `DatasetExporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetExporter.__exit__()` #### log_collection(sample_collection) Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. Subclasses can optionally implement this method if their export format can record information such as the [`fiftyone.core.collections.SampleCollection.info()`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection.info) of the collection being exported. By convention, this method must be optional; i.e., if it is not called before the first call to [`export_sample()`](#fiftyone.utils.data.UnlabeledVideoDatasetExporter.export_sample), then the exporter must make do without any information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) (which may not be available, for example, if the samples being exported are not stored in a collection). * **Parameters:** **sample_collection** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported #### setup() Performs any necessary setup before exporting the first sample in the dataset. This method is called when the exporter’s context manager interface is entered, `DatasetExporter.__enter__()`. ### *class* fiftyone.utils.data.UnlabeledMediaDatasetExporter(export_dir=None) Bases: [`DatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.DatasetExporter) Interface for exporting datasets of unlabeled samples. See [this page](../user_guide/export_datasets.md#writing-a-custom-dataset-exporter) for information about implementing/using dataset exporters. * **Parameters:** **export_dir** (*None*) – the directory to write the export. This may be optional for some exporters **Attributes:** | [`requires_metadata`](#fiftyone.utils.data.UnlabeledMediaDatasetExporter.requires_metadata) | Whether this exporter requires [`fiftyone.core.metadata.Metadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.Metadata) instances for each sample being exported. | |-----------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| **Methods:** | [`export_sample`](#fiftyone.utils.data.UnlabeledMediaDatasetExporter.export_sample)(filepath[, metadata]) | Exports the given sample to the dataset. | |-------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`close`](#fiftyone.utils.data.UnlabeledMediaDatasetExporter.close)(\*args) | Performs any necessary actions after the last sample has been exported. | | [`log_collection`](#fiftyone.utils.data.UnlabeledMediaDatasetExporter.log_collection)(sample_collection) | Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. | | [`setup`](#fiftyone.utils.data.UnlabeledMediaDatasetExporter.setup)() | Performs any necessary setup before exporting the first sample in the dataset. | #### *property* requires_metadata Whether this exporter requires [`fiftyone.core.metadata.Metadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.Metadata) instances for each sample being exported. #### export_sample(filepath, metadata=None) Exports the given sample to the dataset. * **Parameters:** * **filepath** – a media path * **metadata** (*None*) – a [`fiftyone.core.metadata.Metadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.Metadata) instance for the sample. Only required when [`requires_metadata()`](#fiftyone.utils.data.UnlabeledMediaDatasetExporter.requires_metadata) is `True` #### close(\*args) Performs any necessary actions after the last sample has been exported. This method is called when the exporter’s context manager interface is exited, `DatasetExporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetExporter.__exit__()` #### log_collection(sample_collection) Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. Subclasses can optionally implement this method if their export format can record information such as the [`fiftyone.core.collections.SampleCollection.info()`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection.info) of the collection being exported. By convention, this method must be optional; i.e., if it is not called before the first call to [`export_sample()`](#fiftyone.utils.data.UnlabeledMediaDatasetExporter.export_sample), then the exporter must make do without any information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) (which may not be available, for example, if the samples being exported are not stored in a collection). * **Parameters:** **sample_collection** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported #### setup() Performs any necessary setup before exporting the first sample in the dataset. This method is called when the exporter’s context manager interface is entered, `DatasetExporter.__enter__()`. ### *class* fiftyone.utils.data.LabeledImageDatasetExporter(export_dir=None) Bases: [`DatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.DatasetExporter) Interface for exporting datasets of labeled image samples. See [this page](../user_guide/export_datasets.md#writing-a-custom-dataset-exporter) for information about implementing/using dataset exporters. * **Parameters:** **export_dir** (*None*) – the directory to write the export. This may be optional for some exporters **Attributes:** | [`requires_image_metadata`](#fiftyone.utils.data.LabeledImageDatasetExporter.requires_image_metadata) | Whether this exporter requires [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each sample being exported. | |---------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`label_cls`](#fiftyone.utils.data.LabeledImageDatasetExporter.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) exported by this exporter. | **Methods:** | [`export_sample`](#fiftyone.utils.data.LabeledImageDatasetExporter.export_sample)(image_or_path, label[, metadata]) | Exports the given sample to the dataset. | |-----------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`close`](#fiftyone.utils.data.LabeledImageDatasetExporter.close)(\*args) | Performs any necessary actions after the last sample has been exported. | | [`log_collection`](#fiftyone.utils.data.LabeledImageDatasetExporter.log_collection)(sample_collection) | Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. | | [`setup`](#fiftyone.utils.data.LabeledImageDatasetExporter.setup)() | Performs any necessary setup before exporting the first sample in the dataset. | #### *property* requires_image_metadata Whether this exporter requires [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each sample being exported. #### *property* label_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) exported by this exporter. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class. In this case, the exporter directly exports labels of this type - a list or tuple of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the exporter can export a single label field of any of these types - a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the exporter can handle label dictionaries with value-types specified by this dictionary. Not all keys need be present in the exported label dicts - `None`. In this case, the exporter makes no guarantees about the labels that it can export #### export_sample(image_or_path, label, metadata=None) Exports the given sample to the dataset. * **Parameters:** * **image_or_path** – an image or the path to the image on disk * **label** – an instance of [`label_cls()`](#fiftyone.utils.data.LabeledImageDatasetExporter.label_cls), or a dictionary mapping field names to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances, or `None` if the sample is unlabeled * **metadata** (*None*) – a [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instance for the sample. Only required when [`requires_image_metadata()`](#fiftyone.utils.data.LabeledImageDatasetExporter.requires_image_metadata) is `True` #### close(\*args) Performs any necessary actions after the last sample has been exported. This method is called when the exporter’s context manager interface is exited, `DatasetExporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetExporter.__exit__()` #### log_collection(sample_collection) Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. Subclasses can optionally implement this method if their export format can record information such as the [`fiftyone.core.collections.SampleCollection.info()`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection.info) of the collection being exported. By convention, this method must be optional; i.e., if it is not called before the first call to [`export_sample()`](#fiftyone.utils.data.LabeledImageDatasetExporter.export_sample), then the exporter must make do without any information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) (which may not be available, for example, if the samples being exported are not stored in a collection). * **Parameters:** **sample_collection** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported #### setup() Performs any necessary setup before exporting the first sample in the dataset. This method is called when the exporter’s context manager interface is entered, `DatasetExporter.__enter__()`. ### *class* fiftyone.utils.data.LabeledVideoDatasetExporter(export_dir=None) Bases: [`DatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.DatasetExporter) Interface for exporting datasets of labeled video samples. See [this page](../user_guide/export_datasets.md#writing-a-custom-dataset-exporter) for information about implementing/using dataset exporters. * **Parameters:** **export_dir** (*None*) – the directory to write the export. This may be optional for some exporters **Attributes:** | [`requires_video_metadata`](#fiftyone.utils.data.LabeledVideoDatasetExporter.requires_video_metadata) | Whether this exporter requires [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for each sample being exported. | |---------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`label_cls`](#fiftyone.utils.data.LabeledVideoDatasetExporter.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) that can be exported at the sample-level. | | [`frame_labels_cls`](#fiftyone.utils.data.LabeledVideoDatasetExporter.frame_labels_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) that can be exported by this exporter at the frame-level. | **Methods:** | [`export_sample`](#fiftyone.utils.data.LabeledVideoDatasetExporter.export_sample)(video_path, label, frames[, ...]) | Exports the given sample to the dataset. | |-----------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`close`](#fiftyone.utils.data.LabeledVideoDatasetExporter.close)(\*args) | Performs any necessary actions after the last sample has been exported. | | [`log_collection`](#fiftyone.utils.data.LabeledVideoDatasetExporter.log_collection)(sample_collection) | Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. | | [`setup`](#fiftyone.utils.data.LabeledVideoDatasetExporter.setup)() | Performs any necessary setup before exporting the first sample in the dataset. | #### *property* requires_video_metadata Whether this exporter requires [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for each sample being exported. #### *property* label_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) that can be exported at the sample-level. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class. In this case, the exporter directly exports sample-level labels of this type - a list or tuple of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the exporter can export a single sample-level label field of any of these types - a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the exporter can export multiple label fields with value-types specified by this dictionary. Not all keys need be present in the exported sample-level labels - `None`. In this case, the exporter makes no guarantees about the sample-level labels that it can export #### *property* frame_labels_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) that can be exported by this exporter at the frame-level. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class. In this case, the exporter directly exports frame labels of this type - a list or tuple of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the exporter can export a single frame label field of any of these types - a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the exporter can export multiple frame label fields with value-types specified by this dictionary. Not all keys need be present in the exported frame labels - `None`. In this case, the exporter makes no guarantees about the frame labels that it can export #### export_sample(video_path, label, frames, metadata=None) Exports the given sample to the dataset. * **Parameters:** * **video_path** – the path to a video on disk * **label** – an instance of [`label_cls()`](#fiftyone.utils.data.LabeledVideoDatasetExporter.label_cls), or a dictionary mapping field names to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances, or `None` if the sample has no sample-level labels * **frames** – a dictionary mapping frame numbers to dictionaries that map field names to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances, or `None` if the sample has no frame-level labels * **metadata** (*None*) – a [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instance for the sample. Only required when [`requires_video_metadata()`](#fiftyone.utils.data.LabeledVideoDatasetExporter.requires_video_metadata) is `True` #### close(\*args) Performs any necessary actions after the last sample has been exported. This method is called when the exporter’s context manager interface is exited, `DatasetExporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetExporter.__exit__()` #### log_collection(sample_collection) Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. Subclasses can optionally implement this method if their export format can record information such as the [`fiftyone.core.collections.SampleCollection.info()`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection.info) of the collection being exported. By convention, this method must be optional; i.e., if it is not called before the first call to [`export_sample()`](#fiftyone.utils.data.LabeledVideoDatasetExporter.export_sample), then the exporter must make do without any information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) (which may not be available, for example, if the samples being exported are not stored in a collection). * **Parameters:** **sample_collection** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported #### setup() Performs any necessary setup before exporting the first sample in the dataset. This method is called when the exporter’s context manager interface is entered, `DatasetExporter.__enter__()`. ### *class* fiftyone.utils.data.LegacyFiftyOneDatasetExporter(export_dir, export_media=None, rel_dir=None, chunk_size=None, abs_paths=False, export_saved_views=True, export_runs=True, export_workspaces=True, pretty_print=False) Bases: [`GenericSampleDatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.GenericSampleDatasetExporter) Legacy exporter that writes an entire FiftyOne dataset to disk in a serialized JSON format along with its source media. #### WARNING The [`fiftyone.types.FiftyOneDataset`](fiftyone.types.md#fiftyone.types.FiftyOneDataset) format was upgraded in `fiftyone==0.8` and this exporter is now deprecated. The new exporter is [`FiftyOneDatasetExporter`](#fiftyone.utils.data.FiftyOneDatasetExporter). * **Parameters:** * **export_dir** – the directory to write the export * **export_media** (*None*) – defines how to export the raw media contained in the dataset. The supported values are: - `True` (default): copy all media files into the export directory - `False`: don’t export media - `"move"`: move media files into the export directory - `"symlink"`: create symlinks to each media file in the export directory * **rel_dir** (*None*) – an optional relative directory to strip from each input filepath to generate a unique identifier for each media. When exporting media, this identifier is joined with `export_dir` to generate an output path for each exported media. This argument allows for populating nested subdirectories that match the shape of the input paths. The path is converted to an absolute path (if necessary) via [`fiftyone.core.storage.normalize_path()`](fiftyone.core.storage.md#fiftyone.core.storage.normalize_path) * **chunk_size** (*None*) – an optional chunk size to use when exporting media files. If provided, media files will be nested in subdirectories of the output directory with at most this many media files per subdirectory. Has no effect if a `rel_dir` is provided * **abs_paths** (*False*) – whether to store absolute paths to the media in the exported labels * **export_saved_views** (*True*) – whether to include saved views in the export. Only applicable when exporting full datasets * **export_runs** (*True*) – whether to include annotation/brain/evaluation runs in the export. Only applicable when exporting full datasets * **export_workspaces** (*True*) – whether to include saved workspaces in the export. Only applicable when exporting full datasets * **pretty_print** (*False*) – whether to render the JSON in human readable format with newlines and indentations **Attributes:** | [`supports_media_references`](#fiftyone.utils.data.LegacyFiftyOneDatasetExporter.supports_media_references) | | |---------------------------------------------------------------------------------------------------------------|----| **Methods:** | [`setup`](#fiftyone.utils.data.LegacyFiftyOneDatasetExporter.setup)() | Performs any necessary setup before exporting the first sample in the dataset. | |----------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`log_collection`](#fiftyone.utils.data.LegacyFiftyOneDatasetExporter.log_collection)(sample_collection) | Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. | | [`export_sample`](#fiftyone.utils.data.LegacyFiftyOneDatasetExporter.export_sample)(sample) | Exports the given sample to the dataset. | | [`close`](#fiftyone.utils.data.LegacyFiftyOneDatasetExporter.close)(\*args) | Performs any necessary actions after the last sample has been exported. | #### supports_media_references *= True* #### setup() Performs any necessary setup before exporting the first sample in the dataset. This method is called when the exporter’s context manager interface is entered, `DatasetExporter.__enter__()`. #### log_collection(sample_collection) Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. Subclasses can optionally implement this method if their export format can record information such as the [`fiftyone.core.collections.SampleCollection.info()`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection.info) of the collection being exported. By convention, this method must be optional; i.e., if it is not called before the first call to [`export_sample()`](#fiftyone.utils.data.LegacyFiftyOneDatasetExporter.export_sample), then the exporter must make do without any information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) (which may not be available, for example, if the samples being exported are not stored in a collection). * **Parameters:** **sample_collection** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported #### export_sample(sample) Exports the given sample to the dataset. * **Parameters:** **sample** – a [`fiftyone.core.sample.Sample`](fiftyone.core.sample.md#fiftyone.core.sample.Sample) #### close(\*args) Performs any necessary actions after the last sample has been exported. This method is called when the exporter’s context manager interface is exited, `DatasetExporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetExporter.__exit__()` ### *class* fiftyone.utils.data.FiftyOneDatasetExporter(export_dir, export_media=None, rel_dir=None, chunk_size=None, export_saved_views=True, export_runs=True, export_workspaces=True, use_dirs=False, ordered=True) Bases: [`BatchDatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.BatchDatasetExporter) Exporter that writes an entire FiftyOne dataset to disk in a serialized JSON format along with its source media. See [this page](../user_guide/export_datasets.md#fiftyonedataset-export) for format details. * **Parameters:** * **export_dir** – the directory to write the export * **export_media** (*None*) – defines how to export the raw media contained in the dataset. The supported values are: - `True` (default): copy all media files into the export directory - `False`: don’t export media - `"move"`: move media files into the export directory - `"symlink"`: create symlinks to each media file in the export directory * **rel_dir** (*None*) – an optional relative directory to strip from each input filepath to generate a unique identifier for each media. When exporting media, this identifier is joined with `export_dir` to generate an output path for each exported media. This argument allows for populating nested subdirectories that match the shape of the input paths. The path is converted to an absolute path (if necessary) via [`fiftyone.core.storage.normalize_path()`](fiftyone.core.storage.md#fiftyone.core.storage.normalize_path) * **chunk_size** (*None*) – an optional chunk size to use when exporting media files. If provided, media files will be nested in subdirectories of the output directory with at most this many media files per subdirectory. Has no effect if a `rel_dir` is provided * **export_saved_views** (*True*) – whether to include saved views in the export. Only applicable when exporting full datasets * **export_runs** (*True*) – whether to include annotation/brain/evaluation runs in the export. Only applicable when exporting full datasets * **export_workspaces** (*True*) – whether to include saved workspaces in the export. Only applicable when exporting full datasets * **use_dirs** (*False*) – whether to export metadata into directories of per sample/frame files * **ordered** (*True*) – whether to preserve the order of the exported collections **Attributes:** | [`supports_media_references`](#fiftyone.utils.data.FiftyOneDatasetExporter.supports_media_references) | | |---------------------------------------------------------------------------------------------------------|----| **Methods:** | [`setup`](#fiftyone.utils.data.FiftyOneDatasetExporter.setup)() | Performs any necessary setup before exporting the first sample in the dataset. | |----------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`export_samples`](#fiftyone.utils.data.FiftyOneDatasetExporter.export_samples)(sample_collection[, progress]) | Exports the given sample collection. | | [`close`](#fiftyone.utils.data.FiftyOneDatasetExporter.close)(\*args) | Performs any necessary actions after the last sample has been exported. | | [`export_sample`](#fiftyone.utils.data.FiftyOneDatasetExporter.export_sample)(\*args, \*\*kwargs) | Exports the given sample to the dataset. | | [`log_collection`](#fiftyone.utils.data.FiftyOneDatasetExporter.log_collection)(sample_collection) | Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. | #### supports_media_references *= True* #### setup() Performs any necessary setup before exporting the first sample in the dataset. This method is called when the exporter’s context manager interface is entered, `DatasetExporter.__enter__()`. #### export_samples(sample_collection, progress=None) Exports the given sample collection. * **Parameters:** * **sample_collection** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) * **progress** (*None*) – whether to render a progress bar (True/False), use the default value `fiftyone.config.show_progress_bars` (None), or a progress callback function to invoke instead #### close(\*args) Performs any necessary actions after the last sample has been exported. This method is called when the exporter’s context manager interface is exited, `DatasetExporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetExporter.__exit__()` #### export_sample(\*args, \*\*kwargs) Exports the given sample to the dataset. * **Parameters:** * **\*args** – subclass-specific positional arguments * **\*\*kwargs** – subclass-specific keyword arguments #### log_collection(sample_collection) Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. Subclasses can optionally implement this method if their export format can record information such as the [`fiftyone.core.collections.SampleCollection.info()`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection.info) of the collection being exported. By convention, this method must be optional; i.e., if it is not called before the first call to [`export_sample()`](#fiftyone.utils.data.FiftyOneDatasetExporter.export_sample), then the exporter must make do without any information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) (which may not be available, for example, if the samples being exported are not stored in a collection). * **Parameters:** **sample_collection** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported ### *class* fiftyone.utils.data.ImageDirectoryExporter(export_dir, export_media=None, rel_dir=None, image_format=None) Bases: [`UnlabeledImageDatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.UnlabeledImageDatasetExporter) Exporter that writes a directory of images to disk. See [this page](../user_guide/export_datasets.md#imagedirectory-export) for format details. The filenames of input image paths will be maintained in the export directory, unless a name conflict would occur, in which case an index of the form `"-%d" % count` is appended to the base filename. * **Parameters:** * **export_dir** – the directory to write the export * **export_media** (*None*) – defines how to export the raw media contained in the dataset. The supported values are: - `True` (default): copy all media files into the export directory - `"move"`: move media files into the export directory - `"symlink"`: create symlinks to each media file in the export directory * **rel_dir** (*None*) – an optional relative directory to strip from each input filepath to generate a unique identifier for each image. When exporting media, this identifier is joined with `export_dir` to generate an output path for each exported image. This argument allows for populating nested subdirectories that match the shape of the input paths. The path is converted to an absolute path (if necessary) via [`fiftyone.core.storage.normalize_path()`](fiftyone.core.storage.md#fiftyone.core.storage.normalize_path) * **image_format** (*None*) – the image format to use when writing in-memory images to disk. By default, `fiftyone.config.default_image_ext` is used **Attributes:** | [`requires_image_metadata`](#fiftyone.utils.data.ImageDirectoryExporter.requires_image_metadata) | Whether this exporter requires [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each sample being exported. | |----------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| **Methods:** | [`setup`](#fiftyone.utils.data.ImageDirectoryExporter.setup)() | Performs any necessary setup before exporting the first sample in the dataset. | |---------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`export_sample`](#fiftyone.utils.data.ImageDirectoryExporter.export_sample)(image_or_path[, metadata]) | Exports the given sample to the dataset. | | [`close`](#fiftyone.utils.data.ImageDirectoryExporter.close)(\*args) | Performs any necessary actions after the last sample has been exported. | | [`log_collection`](#fiftyone.utils.data.ImageDirectoryExporter.log_collection)(sample_collection) | Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. | #### *property* requires_image_metadata Whether this exporter requires [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each sample being exported. #### setup() Performs any necessary setup before exporting the first sample in the dataset. This method is called when the exporter’s context manager interface is entered, `DatasetExporter.__enter__()`. #### export_sample(image_or_path, metadata=None) Exports the given sample to the dataset. * **Parameters:** * **image_or_path** – an image or the path to the image on disk * **metadata** (*None*) – a [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instance for the sample. Only required when [`requires_image_metadata()`](#fiftyone.utils.data.ImageDirectoryExporter.requires_image_metadata) is `True` #### close(\*args) Performs any necessary actions after the last sample has been exported. This method is called when the exporter’s context manager interface is exited, `DatasetExporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetExporter.__exit__()` #### log_collection(sample_collection) Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. Subclasses can optionally implement this method if their export format can record information such as the [`fiftyone.core.collections.SampleCollection.info()`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection.info) of the collection being exported. By convention, this method must be optional; i.e., if it is not called before the first call to [`export_sample()`](#fiftyone.utils.data.ImageDirectoryExporter.export_sample), then the exporter must make do without any information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) (which may not be available, for example, if the samples being exported are not stored in a collection). * **Parameters:** **sample_collection** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported ### *class* fiftyone.utils.data.VideoDirectoryExporter(export_dir, export_media=None, rel_dir=None) Bases: [`UnlabeledVideoDatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.UnlabeledVideoDatasetExporter) Exporter that writes a directory of videos to disk. See [this page](../user_guide/export_datasets.md#videodirectory-export) for format details. The filenames of the input videos will be maintained in the export directory, unless a name conflict would occur, in which case an index of the form `"-%d" % count` is appended to the base filename. * **Parameters:** * **export_dir** – the directory to write the export * **export_media** (*None*) – defines how to export the raw media contained in the dataset. The supported values are: - `True` (default): copy all media files into the export directory - `"move"`: move media files into the export directory - `"symlink"`: create symlinks to each media file in the export directory * **rel_dir** (*None*) – an optional relative directory to strip from each input filepath to generate a unique identifier for each video. When exporting media, this identifier is joined with `export_dir` to generate an output path for each exported video. This argument allows for populating nested subdirectories that match the shape of the input paths. The path is converted to an absolute path (if necessary) via [`fiftyone.core.storage.normalize_path()`](fiftyone.core.storage.md#fiftyone.core.storage.normalize_path) **Attributes:** | [`requires_video_metadata`](#fiftyone.utils.data.VideoDirectoryExporter.requires_video_metadata) | Whether this exporter requires [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for each sample being exported. | |----------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| **Methods:** | [`setup`](#fiftyone.utils.data.VideoDirectoryExporter.setup)() | Performs any necessary setup before exporting the first sample in the dataset. | |------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`export_sample`](#fiftyone.utils.data.VideoDirectoryExporter.export_sample)(video_path[, metadata]) | Exports the given sample to the dataset. | | [`close`](#fiftyone.utils.data.VideoDirectoryExporter.close)(\*args) | Performs any necessary actions after the last sample has been exported. | | [`log_collection`](#fiftyone.utils.data.VideoDirectoryExporter.log_collection)(sample_collection) | Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. | #### *property* requires_video_metadata Whether this exporter requires [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for each sample being exported. #### setup() Performs any necessary setup before exporting the first sample in the dataset. This method is called when the exporter’s context manager interface is entered, `DatasetExporter.__enter__()`. #### export_sample(video_path, metadata=None) Exports the given sample to the dataset. * **Parameters:** * **video_path** – the path to a video on disk * **metadata** (*None*) – a [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instance for the sample. Only required when [`requires_video_metadata()`](#fiftyone.utils.data.VideoDirectoryExporter.requires_video_metadata) is `True` #### close(\*args) Performs any necessary actions after the last sample has been exported. This method is called when the exporter’s context manager interface is exited, `DatasetExporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetExporter.__exit__()` #### log_collection(sample_collection) Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. Subclasses can optionally implement this method if their export format can record information such as the [`fiftyone.core.collections.SampleCollection.info()`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection.info) of the collection being exported. By convention, this method must be optional; i.e., if it is not called before the first call to [`export_sample()`](#fiftyone.utils.data.VideoDirectoryExporter.export_sample), then the exporter must make do without any information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) (which may not be available, for example, if the samples being exported are not stored in a collection). * **Parameters:** **sample_collection** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported ### *class* fiftyone.utils.data.MediaDirectoryExporter(export_dir, export_media=None, rel_dir=None) Bases: [`UnlabeledMediaDatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.UnlabeledMediaDatasetExporter) Exporter that writes a directory of media files of arbitrary type to disk. See [this page](../user_guide/export_datasets.md#mediadirectory-export) for format details. The filenames of the input media files will be maintained in the export directory, unless a name conflict would occur, in which case an index of the form `"-%d" % count` is appended to the base filename. * **Parameters:** * **export_dir** – the directory to write the export * **export_media** (*None*) – defines how to export the raw media contained in the dataset. The supported values are: - `True` (default): copy all media files into the export directory - `"move"`: move media files into the export directory - `"symlink"`: create symlinks to each media file in the export directory * **rel_dir** (*None*) – an optional relative directory to strip from each input filepath to generate a unique identifier for each output file. This identifier is joined with `export_dir` to generate an output path for each exported media. This argument allows for populating nested subdirectories that match the shape of the input paths. The path is converted to an absolute path (if necessary) via [`fiftyone.core.storage.normalize_path()`](fiftyone.core.storage.md#fiftyone.core.storage.normalize_path) **Attributes:** | [`requires_metadata`](#fiftyone.utils.data.MediaDirectoryExporter.requires_metadata) | Whether this exporter requires [`fiftyone.core.metadata.Metadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.Metadata) instances for each sample being exported. | |----------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| **Methods:** | [`setup`](#fiftyone.utils.data.MediaDirectoryExporter.setup)() | Performs any necessary setup before exporting the first sample in the dataset. | |----------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`export_sample`](#fiftyone.utils.data.MediaDirectoryExporter.export_sample)(filepath[, metadata]) | Exports the given sample to the dataset. | | [`close`](#fiftyone.utils.data.MediaDirectoryExporter.close)(\*args) | Performs any necessary actions after the last sample has been exported. | | [`log_collection`](#fiftyone.utils.data.MediaDirectoryExporter.log_collection)(sample_collection) | Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. | #### *property* requires_metadata Whether this exporter requires [`fiftyone.core.metadata.Metadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.Metadata) instances for each sample being exported. #### setup() Performs any necessary setup before exporting the first sample in the dataset. This method is called when the exporter’s context manager interface is entered, `DatasetExporter.__enter__()`. #### export_sample(filepath, metadata=None) Exports the given sample to the dataset. * **Parameters:** * **filepath** – a media path * **metadata** (*None*) – a [`fiftyone.core.metadata.Metadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.Metadata) instance for the sample. Only required when [`requires_metadata()`](#fiftyone.utils.data.MediaDirectoryExporter.requires_metadata) is `True` #### close(\*args) Performs any necessary actions after the last sample has been exported. This method is called when the exporter’s context manager interface is exited, `DatasetExporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetExporter.__exit__()` #### log_collection(sample_collection) Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. Subclasses can optionally implement this method if their export format can record information such as the [`fiftyone.core.collections.SampleCollection.info()`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection.info) of the collection being exported. By convention, this method must be optional; i.e., if it is not called before the first call to [`export_sample()`](#fiftyone.utils.data.MediaDirectoryExporter.export_sample), then the exporter must make do without any information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) (which may not be available, for example, if the samples being exported are not stored in a collection). * **Parameters:** **sample_collection** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported ### *class* fiftyone.utils.data.FiftyOneImageClassificationDatasetExporter(export_dir=None, data_path=None, labels_path=None, export_media=None, rel_dir=None, abs_paths=False, include_confidence=False, include_attributes=False, classes=None, image_format=None, pretty_print=False) Bases: [`LabeledImageDatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.LabeledImageDatasetExporter), [`ExportPathsMixin`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.ExportPathsMixin) Exporter that writes an image classification dataset to disk in a simple JSON format. See [this page](../user_guide/export_datasets.md#fiftyoneimageclassificationdataset-export) for format details. If the path to an image is provided, the image is directly copied to its destination, maintaining the original filename, unless a name conflict would occur, in which case an index of the form `"-%d" % count` is appended to the base filename. * **Parameters:** * **export_dir** (*None*) – the directory to write the export. This has no effect if `data_path` and `labels_path` are absolute paths * **data_path** (*None*) – an optional parameter that enables explicit control over the location of the exported media. Can be any of the following: - a folder name like `"data"` or `"data/"` specifying a subfolder of `export_dir` in which to export the media - an absolute directory path in which to export the media. In this case, the `export_dir` has no effect on the location of the data - a JSON filename like `"data.json"` specifying the filename of the manifest file in `export_dir` generated when `export_media` is `"manifest"` - an absolute filepath specifying the location to write the JSON manifest file when `export_media` is `"manifest"`. In this case, `export_dir` has no effect on the location of the data If None, the default value of this parameter will be chosen based on the value of the `export_media` parameter * **labels_path** (*None*) – an optional parameter that enables explicit control over the location of the exported labels. Can be any of the following: - a filename like `"labels.json"` specifying the location in `export_dir` in which to export the labels - an absolute filepath to which to export the labels. In this case, the `export_dir` has no effect on the location of the labels If None, the labels will be exported into `export_dir` using the default filename * **export_media** (*None*) – controls how to export the raw media. The supported values are: - `True`: copy all media files into the output directory - `False`: don’t export media - `"move"`: move all media files into the output directory - `"symlink"`: create symlinks to the media files in the output directory - `"manifest"`: create a `data.json` in the output directory that maps UUIDs used in the labels files to the filepaths of the source media, rather than exporting the actual media If None, the default value of this parameter will be chosen based on the value of the `data_path` parameter * **rel_dir** (*None*) – an optional relative directory to strip from each input filepath to generate a unique identifier for each image. When exporting media, this identifier is joined with `data_path` to generate an output path for each exported image. This argument allows for populating nested subdirectories that match the shape of the input paths. The path is converted to an absolute path (if necessary) via [`fiftyone.core.storage.normalize_path()`](fiftyone.core.storage.md#fiftyone.core.storage.normalize_path) * **abs_paths** (*False*) – whether to store absolute paths to the images in the exported labels * **include_confidence** (*False*) – whether to include classification confidences in the export. The supported values are: - `False` (default): do not include confidences - `True`: always include confidences - `None`: include confidences only if they exist * **include_attributes** (*False*) – whether to include dynamic attributes of the classifications in the export. Supported values are: - `False` (default): do not include attributes - `True`: always include a (possibly empty) attributes dict - `None`: include attributes only if they exist - a name or iterable of names of specific attributes to include * **classes** (*None*) – the list of possible class labels * **image_format** (*None*) – the image format to use when writing in-memory images to disk. By default, `fiftyone.config.default_image_ext` is used * **pretty_print** (*False*) – whether to render the JSON in human readable format with newlines and indentations **Attributes:** | [`requires_image_metadata`](#fiftyone.utils.data.FiftyOneImageClassificationDatasetExporter.requires_image_metadata) | Whether this exporter requires [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each sample being exported. | |------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`label_cls`](#fiftyone.utils.data.FiftyOneImageClassificationDatasetExporter.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) exported by this exporter. | **Methods:** | [`setup`](#fiftyone.utils.data.FiftyOneImageClassificationDatasetExporter.setup)() | Performs any necessary setup before exporting the first sample in the dataset. | |------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`export_sample`](#fiftyone.utils.data.FiftyOneImageClassificationDatasetExporter.export_sample)(image_or_path, label[, metadata]) | Exports the given sample to the dataset. | | [`close`](#fiftyone.utils.data.FiftyOneImageClassificationDatasetExporter.close)(\*args) | Performs any necessary actions after the last sample has been exported. | | [`log_collection`](#fiftyone.utils.data.FiftyOneImageClassificationDatasetExporter.log_collection)(sample_collection) | Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. | #### *property* requires_image_metadata Whether this exporter requires [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each sample being exported. #### *property* label_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) exported by this exporter. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class. In this case, the exporter directly exports labels of this type - a list or tuple of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the exporter can export a single label field of any of these types - a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the exporter can handle label dictionaries with value-types specified by this dictionary. Not all keys need be present in the exported label dicts - `None`. In this case, the exporter makes no guarantees about the labels that it can export #### setup() Performs any necessary setup before exporting the first sample in the dataset. This method is called when the exporter’s context manager interface is entered, `DatasetExporter.__enter__()`. #### export_sample(image_or_path, label, metadata=None) Exports the given sample to the dataset. * **Parameters:** * **image_or_path** – an image or the path to the image on disk * **label** – an instance of [`label_cls()`](#fiftyone.utils.data.FiftyOneImageClassificationDatasetExporter.label_cls), or a dictionary mapping field names to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances, or `None` if the sample is unlabeled * **metadata** (*None*) – a [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instance for the sample. Only required when [`requires_image_metadata()`](#fiftyone.utils.data.FiftyOneImageClassificationDatasetExporter.requires_image_metadata) is `True` #### close(\*args) Performs any necessary actions after the last sample has been exported. This method is called when the exporter’s context manager interface is exited, `DatasetExporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetExporter.__exit__()` #### log_collection(sample_collection) Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. Subclasses can optionally implement this method if their export format can record information such as the [`fiftyone.core.collections.SampleCollection.info()`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection.info) of the collection being exported. By convention, this method must be optional; i.e., if it is not called before the first call to [`export_sample()`](#fiftyone.utils.data.FiftyOneImageClassificationDatasetExporter.export_sample), then the exporter must make do without any information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) (which may not be available, for example, if the samples being exported are not stored in a collection). * **Parameters:** **sample_collection** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported ### *class* fiftyone.utils.data.ImageClassificationDirectoryTreeExporter(export_dir, export_media=None, rel_dir=None, image_format=None) Bases: [`LabeledImageDatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.LabeledImageDatasetExporter) Exporter that writes an image classification directory tree to disk. See [this page](../user_guide/export_datasets.md#imageclassificationdirectorytree-export) for format details. The filenames of the input images are maintained, unless a name conflict would occur, in which case an index of the form `"-%d" % count` is appended to the base filename. * **Parameters:** * **export_dir** – the directory to write the export * **export_media** (*None*) – controls how to export the raw media. The supported values are: - `True` (default): copy all media files into the output directory - `"move"`: move all media files into the output directory - `"symlink"`: create symlinks to the media files in the output directory * **rel_dir** (*None*) – an optional relative directory to strip from each input filepath to generate a unique identifier for each image. When exporting media, this identifier is joined with `export_dir` to generate an output path for each exported image. This argument allows for populating nested subdirectories that match the shape of the input paths. The path is converted to an absolute path (if necessary) via [`fiftyone.core.storage.normalize_path()`](fiftyone.core.storage.md#fiftyone.core.storage.normalize_path) * **image_format** (*None*) – the image format to use when writing in-memory images to disk. By default, `fiftyone.config.default_image_ext` is used **Attributes:** | [`requires_image_metadata`](#fiftyone.utils.data.ImageClassificationDirectoryTreeExporter.requires_image_metadata) | Whether this exporter requires [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each sample being exported. | |----------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`label_cls`](#fiftyone.utils.data.ImageClassificationDirectoryTreeExporter.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) exported by this exporter. | **Methods:** | [`setup`](#fiftyone.utils.data.ImageClassificationDirectoryTreeExporter.setup)() | Performs any necessary setup before exporting the first sample in the dataset. | |-------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`export_sample`](#fiftyone.utils.data.ImageClassificationDirectoryTreeExporter.export_sample)(image_or_path, classification) | Exports the given sample to the dataset. | | [`close`](#fiftyone.utils.data.ImageClassificationDirectoryTreeExporter.close)(\*args) | Performs any necessary actions after the last sample has been exported. | | [`log_collection`](#fiftyone.utils.data.ImageClassificationDirectoryTreeExporter.log_collection)(sample_collection) | Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. | #### *property* requires_image_metadata Whether this exporter requires [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each sample being exported. #### *property* label_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) exported by this exporter. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class. In this case, the exporter directly exports labels of this type - a list or tuple of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the exporter can export a single label field of any of these types - a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the exporter can handle label dictionaries with value-types specified by this dictionary. Not all keys need be present in the exported label dicts - `None`. In this case, the exporter makes no guarantees about the labels that it can export #### setup() Performs any necessary setup before exporting the first sample in the dataset. This method is called when the exporter’s context manager interface is entered, `DatasetExporter.__enter__()`. #### export_sample(image_or_path, classification, metadata=None) Exports the given sample to the dataset. * **Parameters:** * **image_or_path** – an image or the path to the image on disk * **label** – an instance of [`label_cls()`](#fiftyone.utils.data.ImageClassificationDirectoryTreeExporter.label_cls), or a dictionary mapping field names to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances, or `None` if the sample is unlabeled * **metadata** (*None*) – a [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instance for the sample. Only required when [`requires_image_metadata()`](#fiftyone.utils.data.ImageClassificationDirectoryTreeExporter.requires_image_metadata) is `True` #### close(\*args) Performs any necessary actions after the last sample has been exported. This method is called when the exporter’s context manager interface is exited, `DatasetExporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetExporter.__exit__()` #### log_collection(sample_collection) Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. Subclasses can optionally implement this method if their export format can record information such as the [`fiftyone.core.collections.SampleCollection.info()`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection.info) of the collection being exported. By convention, this method must be optional; i.e., if it is not called before the first call to [`export_sample()`](#fiftyone.utils.data.ImageClassificationDirectoryTreeExporter.export_sample), then the exporter must make do without any information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) (which may not be available, for example, if the samples being exported are not stored in a collection). * **Parameters:** **sample_collection** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported ### *class* fiftyone.utils.data.VideoClassificationDirectoryTreeExporter(export_dir, export_media=None, rel_dir=None) Bases: [`LabeledVideoDatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.LabeledVideoDatasetExporter) Exporter that writes a video classification directory tree to disk. See [this page](../user_guide/export_datasets.md#videoclassificationdirectorytree-export) for format details. The filenames of the input images are maintained, unless a name conflict would occur, in which case an index of the form `"-%d" % count` is appended to the base filename. * **Parameters:** * **export_dir** – the directory to write the export * **export_media** (*None*) – controls how to export the raw media. The supported values are: - `True` (default): copy all media files into the output directory - `False`: don’t export media - `"move"`: move all media files into the output directory - `"symlink"`: create symlinks to the media files in the output directory * **rel_dir** (*None*) – an optional relative directory to strip from each input filepath to generate a unique identifier for each video. When exporting media, this identifier is joined with `export_dir` to generate an output path for each exported video. This argument allows for populating nested subdirectories that match the shape of the input paths. The path is converted to an absolute path (if necessary) via [`fiftyone.core.storage.normalize_path()`](fiftyone.core.storage.md#fiftyone.core.storage.normalize_path) **Attributes:** | [`requires_video_metadata`](#fiftyone.utils.data.VideoClassificationDirectoryTreeExporter.requires_video_metadata) | Whether this exporter requires [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for each sample being exported. | |----------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`label_cls`](#fiftyone.utils.data.VideoClassificationDirectoryTreeExporter.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) that can be exported at the sample-level. | | [`frame_labels_cls`](#fiftyone.utils.data.VideoClassificationDirectoryTreeExporter.frame_labels_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) that can be exported by this exporter at the frame-level. | **Methods:** | [`setup`](#fiftyone.utils.data.VideoClassificationDirectoryTreeExporter.setup)() | Performs any necessary setup before exporting the first sample in the dataset. | |--------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`export_sample`](#fiftyone.utils.data.VideoClassificationDirectoryTreeExporter.export_sample)(video_path, classification, \_) | Exports the given sample to the dataset. | | [`close`](#fiftyone.utils.data.VideoClassificationDirectoryTreeExporter.close)(\*args) | Performs any necessary actions after the last sample has been exported. | | [`log_collection`](#fiftyone.utils.data.VideoClassificationDirectoryTreeExporter.log_collection)(sample_collection) | Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. | #### *property* requires_video_metadata Whether this exporter requires [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for each sample being exported. #### *property* label_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) that can be exported at the sample-level. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class. In this case, the exporter directly exports sample-level labels of this type - a list or tuple of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the exporter can export a single sample-level label field of any of these types - a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the exporter can export multiple label fields with value-types specified by this dictionary. Not all keys need be present in the exported sample-level labels - `None`. In this case, the exporter makes no guarantees about the sample-level labels that it can export #### *property* frame_labels_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) that can be exported by this exporter at the frame-level. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class. In this case, the exporter directly exports frame labels of this type - a list or tuple of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the exporter can export a single frame label field of any of these types - a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the exporter can export multiple frame label fields with value-types specified by this dictionary. Not all keys need be present in the exported frame labels - `None`. In this case, the exporter makes no guarantees about the frame labels that it can export #### setup() Performs any necessary setup before exporting the first sample in the dataset. This method is called when the exporter’s context manager interface is entered, `DatasetExporter.__enter__()`. #### export_sample(video_path, classification, \_, metadata=None) Exports the given sample to the dataset. * **Parameters:** * **video_path** – the path to a video on disk * **label** – an instance of [`label_cls()`](#fiftyone.utils.data.VideoClassificationDirectoryTreeExporter.label_cls), or a dictionary mapping field names to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances, or `None` if the sample has no sample-level labels * **frames** – a dictionary mapping frame numbers to dictionaries that map field names to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances, or `None` if the sample has no frame-level labels * **metadata** (*None*) – a [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instance for the sample. Only required when [`requires_video_metadata()`](#fiftyone.utils.data.VideoClassificationDirectoryTreeExporter.requires_video_metadata) is `True` #### close(\*args) Performs any necessary actions after the last sample has been exported. This method is called when the exporter’s context manager interface is exited, `DatasetExporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetExporter.__exit__()` #### log_collection(sample_collection) Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. Subclasses can optionally implement this method if their export format can record information such as the [`fiftyone.core.collections.SampleCollection.info()`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection.info) of the collection being exported. By convention, this method must be optional; i.e., if it is not called before the first call to [`export_sample()`](#fiftyone.utils.data.VideoClassificationDirectoryTreeExporter.export_sample), then the exporter must make do without any information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) (which may not be available, for example, if the samples being exported are not stored in a collection). * **Parameters:** **sample_collection** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported ### *class* fiftyone.utils.data.FiftyOneImageDetectionDatasetExporter(export_dir=None, data_path=None, labels_path=None, export_media=None, rel_dir=None, abs_paths=False, classes=None, include_confidence=None, include_attributes=None, image_format=None, pretty_print=False) Bases: [`LabeledImageDatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.LabeledImageDatasetExporter), [`ExportPathsMixin`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.ExportPathsMixin) Exporter that writes an image detection dataset to disk in a simple JSON format. See [this page](../user_guide/export_datasets.md#fiftyoneimagedetectiondataset-export) for format details. If the path to an image is provided, the image is directly copied to its destination, maintaining the original filename, unless a name conflict would occur, in which case an index of the form `"-%d" % count` is appended to the base filename. * **Parameters:** * **export_dir** (*None*) – the directory to write the export. This has no effect if `data_path` and `labels_path` are absolute paths * **data_path** (*None*) – an optional parameter that enables explicit control over the location of the exported media. Can be any of the following: - a folder name like `"data"` or `"data/"` specifying a subfolder of `export_dir` in which to export the media - an absolute directory path in which to export the media. In this case, the `export_dir` has no effect on the location of the data - a JSON filename like `"data.json"` specifying the filename of the manifest file in `export_dir` generated when `export_media` is `"manifest"` - an absolute filepath specifying the location to write the JSON manifest file when `export_media` is `"manifest"`. In this case, `export_dir` has no effect on the location of the data If None, the default value of this parameter will be chosen based on the value of the `export_media` parameter * **labels_path** (*None*) – an optional parameter that enables explicit control over the location of the exported labels. Can be any of the following: - a filename like `"labels.json"` specifying the location in `export_dir` in which to export the labels - an absolute filepath to which to export the labels. In this case, the `export_dir` has no effect on the location of the labels If None, the labels will be exported into `export_dir` using the default filename * **export_media** (*None*) – controls how to export the raw media. The supported values are: - `True`: copy all media files into the output directory - `False`: don’t export media - `"move"`: move all media files into the output directory - `"symlink"`: create symlinks to the media files in the output directory - `"manifest"`: create a `data.json` in the output directory that maps UUIDs used in the labels files to the filepaths of the source media, rather than exporting the actual media If None, the default value of this parameter will be chosen based on the value of the `data_path` parameter * **rel_dir** (*None*) – an optional relative directory to strip from each input filepath to generate a unique identifier for each image. When exporting media, this identifier is joined with `data_path` to generate an output path for each exported image. This argument allows for populating nested subdirectories that match the shape of the input paths. The path is converted to an absolute path (if necessary) via [`fiftyone.core.storage.normalize_path()`](fiftyone.core.storage.md#fiftyone.core.storage.normalize_path) * **abs_paths** (*False*) – whether to store absolute paths to the images in the exported labels * **classes** (*None*) – the list of possible class labels * **include_confidence** (*None*) – whether to include detection confidences in the export. The supported values are: - `None` (default): include confidences only if they exist - `True`: always include confidences - `False`: do not include confidences * **include_attributes** (*None*) – whether to include dynamic attributes of the detections in the export. Supported values are: - `None` (default): include attributes only if they exist - `True`: always include a (possibly empty) attributes dict - `False`: do not include attributes - a name or iterable of names of specific attributes to include * **image_format** (*None*) – the image format to use when writing in-memory images to disk. By default, `fiftyone.config.default_image_ext` is used * **pretty_print** (*False*) – whether to render the JSON in human readable format with newlines and indentations **Attributes:** | [`requires_image_metadata`](#fiftyone.utils.data.FiftyOneImageDetectionDatasetExporter.requires_image_metadata) | Whether this exporter requires [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each sample being exported. | |-------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`label_cls`](#fiftyone.utils.data.FiftyOneImageDetectionDatasetExporter.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) exported by this exporter. | **Methods:** | [`setup`](#fiftyone.utils.data.FiftyOneImageDetectionDatasetExporter.setup)() | Performs any necessary setup before exporting the first sample in the dataset. | |-------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`export_sample`](#fiftyone.utils.data.FiftyOneImageDetectionDatasetExporter.export_sample)(image_or_path, detections[, ...]) | Exports the given sample to the dataset. | | [`close`](#fiftyone.utils.data.FiftyOneImageDetectionDatasetExporter.close)(\*args) | Performs any necessary actions after the last sample has been exported. | | [`log_collection`](#fiftyone.utils.data.FiftyOneImageDetectionDatasetExporter.log_collection)(sample_collection) | Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. | #### *property* requires_image_metadata Whether this exporter requires [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each sample being exported. #### *property* label_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) exported by this exporter. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class. In this case, the exporter directly exports labels of this type - a list or tuple of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the exporter can export a single label field of any of these types - a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the exporter can handle label dictionaries with value-types specified by this dictionary. Not all keys need be present in the exported label dicts - `None`. In this case, the exporter makes no guarantees about the labels that it can export #### setup() Performs any necessary setup before exporting the first sample in the dataset. This method is called when the exporter’s context manager interface is entered, `DatasetExporter.__enter__()`. #### export_sample(image_or_path, detections, metadata=None) Exports the given sample to the dataset. * **Parameters:** * **image_or_path** – an image or the path to the image on disk * **label** – an instance of [`label_cls()`](#fiftyone.utils.data.FiftyOneImageDetectionDatasetExporter.label_cls), or a dictionary mapping field names to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances, or `None` if the sample is unlabeled * **metadata** (*None*) – a [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instance for the sample. Only required when [`requires_image_metadata()`](#fiftyone.utils.data.FiftyOneImageDetectionDatasetExporter.requires_image_metadata) is `True` #### close(\*args) Performs any necessary actions after the last sample has been exported. This method is called when the exporter’s context manager interface is exited, `DatasetExporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetExporter.__exit__()` #### log_collection(sample_collection) Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. Subclasses can optionally implement this method if their export format can record information such as the [`fiftyone.core.collections.SampleCollection.info()`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection.info) of the collection being exported. By convention, this method must be optional; i.e., if it is not called before the first call to [`export_sample()`](#fiftyone.utils.data.FiftyOneImageDetectionDatasetExporter.export_sample), then the exporter must make do without any information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) (which may not be available, for example, if the samples being exported are not stored in a collection). * **Parameters:** **sample_collection** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported ### *class* fiftyone.utils.data.FiftyOneTemporalDetectionDatasetExporter(export_dir=None, data_path=None, labels_path=None, export_media=None, rel_dir=None, abs_paths=False, use_timestamps=False, classes=None, include_confidence=None, include_attributes=None, pretty_print=False) Bases: [`LabeledVideoDatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.LabeledVideoDatasetExporter), [`ExportPathsMixin`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.ExportPathsMixin) Exporter that writes a temporal video detection dataset to disk in a simple JSON format. See [this page](../user_guide/export_datasets.md#fiftyonetemporaldetectiondataset-export) for format details. Each input video is directly copied to its destination, maintaining the original filename, unless a name conflict would occur, in which case an index of the form `"-%d" % count` is appended to the base filename. * **Parameters:** * **export_dir** (*None*) – the directory to write the export. This has no effect if `data_path` and `labels_path` are absolute paths * **data_path** (*None*) – an optional parameter that enables explicit control over the location of the exported media. Can be any of the following: - a folder name like `"data"` or `"data/"` specifying a subfolder of `export_dir` in which to export the media - an absolute directory path in which to export the media. In this case, the `export_dir` has no effect on the location of the data - a JSON filename like `"data.json"` specifying the filename of the manifest file in `export_dir` generated when `export_media` is `"manifest"` - an absolute filepath specifying the location to write the JSON manifest file when `export_media` is `"manifest"`. In this case, `export_dir` has no effect on the location of the data If None, the default value of this parameter will be chosen based on the value of the `export_media` parameter * **labels_path** (*None*) – an optional parameter that enables explicit control over the location of the exported labels. Can be any of the following: - a filename like `"labels.json"` specifying the location in `export_dir` in which to export the labels - an absolute filepath to which to export the labels. In this case, the `export_dir` has no effect on the location of the labels If None, the labels will be exported into `export_dir` using the default filename * **export_media** (*None*) – controls how to export the raw media. The supported values are: - `True`: copy all media files into the output directory - `False`: don’t export media - `"move"`: move all media files into the output directory - `"symlink"`: create symlinks to the media files in the output directory - `"manifest"`: create a `data.json` in the output directory that maps UUIDs used in the labels files to the filepaths of the source media, rather than exporting the actual media If None, the default value of this parameter will be chosen based on the value of the `data_path` parameter * **rel_dir** (*None*) – an optional relative directory to strip from each input filepath to generate a unique identifier for each video. When exporting media, this identifier is joined with `data_path` to generate an output path for each exported video. This argument allows for populating nested subdirectories that match the shape of the input paths. The path is converted to an absolute path (if necessary) via [`fiftyone.core.storage.normalize_path()`](fiftyone.core.storage.md#fiftyone.core.storage.normalize_path) * **abs_paths** (*False*) – whether to store absolute paths to the videos in the exported labels * **use_timestamps** (*False*) – whether to export the support of each temporal detection in seconds rather than frame numbers * **classes** (*None*) – the list of possible class labels * **include_confidence** (*None*) – whether to include detection confidences in the export. The supported values are: - `None` (default): include confidences only if they exist - `True`: always include confidences - `False`: do not include confidences * **include_attributes** (*None*) – whether to include dynamic attributes of the detections in the export. Supported values are: - `None` (default): include attributes only if they exist - `True`: always include a (possibly empty) attributes dict - `False`: do not include attributes - a name or iterable of names of specific attributes to include * **pretty_print** (*False*) – whether to render the JSON in human readable format with newlines and indentations **Attributes:** | [`requires_video_metadata`](#fiftyone.utils.data.FiftyOneTemporalDetectionDatasetExporter.requires_video_metadata) | Whether this exporter requires [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for each sample being exported. | |----------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`label_cls`](#fiftyone.utils.data.FiftyOneTemporalDetectionDatasetExporter.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) that can be exported at the sample-level. | | [`frame_labels_cls`](#fiftyone.utils.data.FiftyOneTemporalDetectionDatasetExporter.frame_labels_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) that can be exported by this exporter at the frame-level. | **Methods:** | [`setup`](#fiftyone.utils.data.FiftyOneTemporalDetectionDatasetExporter.setup)() | Performs any necessary setup before exporting the first sample in the dataset. | |-------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`export_sample`](#fiftyone.utils.data.FiftyOneTemporalDetectionDatasetExporter.export_sample)(video_path, temporal_detections, \_) | Exports the given sample to the dataset. | | [`close`](#fiftyone.utils.data.FiftyOneTemporalDetectionDatasetExporter.close)(\*args) | Performs any necessary actions after the last sample has been exported. | | [`log_collection`](#fiftyone.utils.data.FiftyOneTemporalDetectionDatasetExporter.log_collection)(sample_collection) | Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. | #### *property* requires_video_metadata Whether this exporter requires [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for each sample being exported. #### *property* label_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) that can be exported at the sample-level. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class. In this case, the exporter directly exports sample-level labels of this type - a list or tuple of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the exporter can export a single sample-level label field of any of these types - a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the exporter can export multiple label fields with value-types specified by this dictionary. Not all keys need be present in the exported sample-level labels - `None`. In this case, the exporter makes no guarantees about the sample-level labels that it can export #### *property* frame_labels_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) that can be exported by this exporter at the frame-level. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class. In this case, the exporter directly exports frame labels of this type - a list or tuple of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the exporter can export a single frame label field of any of these types - a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the exporter can export multiple frame label fields with value-types specified by this dictionary. Not all keys need be present in the exported frame labels - `None`. In this case, the exporter makes no guarantees about the frame labels that it can export #### setup() Performs any necessary setup before exporting the first sample in the dataset. This method is called when the exporter’s context manager interface is entered, `DatasetExporter.__enter__()`. #### export_sample(video_path, temporal_detections, \_, metadata=None) Exports the given sample to the dataset. * **Parameters:** * **video_path** – the path to a video on disk * **label** – an instance of [`label_cls()`](#fiftyone.utils.data.FiftyOneTemporalDetectionDatasetExporter.label_cls), or a dictionary mapping field names to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances, or `None` if the sample has no sample-level labels * **frames** – a dictionary mapping frame numbers to dictionaries that map field names to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances, or `None` if the sample has no frame-level labels * **metadata** (*None*) – a [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instance for the sample. Only required when [`requires_video_metadata()`](#fiftyone.utils.data.FiftyOneTemporalDetectionDatasetExporter.requires_video_metadata) is `True` #### close(\*args) Performs any necessary actions after the last sample has been exported. This method is called when the exporter’s context manager interface is exited, `DatasetExporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetExporter.__exit__()` #### log_collection(sample_collection) Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. Subclasses can optionally implement this method if their export format can record information such as the [`fiftyone.core.collections.SampleCollection.info()`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection.info) of the collection being exported. By convention, this method must be optional; i.e., if it is not called before the first call to [`export_sample()`](#fiftyone.utils.data.FiftyOneTemporalDetectionDatasetExporter.export_sample), then the exporter must make do without any information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) (which may not be available, for example, if the samples being exported are not stored in a collection). * **Parameters:** **sample_collection** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported ### *class* fiftyone.utils.data.ImageSegmentationDirectoryExporter(export_dir=None, data_path=None, labels_path=None, export_media=None, rel_dir=None, image_format=None, mask_format='.png', mask_size=None, mask_targets=None, thickness=1) Bases: [`LabeledImageDatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.LabeledImageDatasetExporter), [`ExportPathsMixin`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.ExportPathsMixin) Exporter that writes an image segmentation dataset to disk. See [this page](../user_guide/export_datasets.md#imagesegmentationdirectory-export) for format details. If the path to an image is provided, the image is directly copied to its destination, maintaining the original filename, unless a name conflict would occur, in which case an index of the form `"-%d" % count` is appended to the base filename. * **Parameters:** * **export_dir** (*None*) – the directory to write the export. This has no effect if `data_path` and `labels_path` are absolute paths * **data_path** (*None*) – an optional parameter that enables explicit control over the location of the exported media. Can be any of the following: - a folder name like `"data"` or `"data/"` specifying a subfolder of `export_dir` in which to export the media - an absolute directory path in which to export the media. In this case, the `export_dir` has no effect on the location of the data - a JSON filename like `"data.json"` specifying the filename of the manifest file in `export_dir` generated when `export_media` is `"manifest"` - an absolute filepath specifying the location to write the JSON manifest file when `export_media` is `"manifest"`. In this case, `export_dir` has no effect on the location of the data If None, the default value of this parameter will be chosen based on the value of the `export_media` parameter * **labels_path** (*None*) – an optional parameter that enables explicit control over the location of the exported labels. Can be any of the following: - a folder name like `"labels"` or `"labels/"` specifying the location in `export_dir` in which to export the masks - an absolute directory in which to export the masks. In this case, the `export_dir` has no effect on the location of the masks If None, the masks will be exported into `export_dir` using the default folder name * **export_media** (*None*) – controls how to export the raw media. The supported values are: - `True`: copy all media files into the output directory - `False`: don’t export media - `"move"`: move all media files into the output directory - `"symlink"`: create symlinks to the media files in the output directory - `"manifest"`: create a `data.json` in the output directory that maps UUIDs used in the labels files to the filepaths of the source media, rather than exporting the actual media If None, the default value of this parameter will be chosen based on the value of the `data_path` parameter * **rel_dir** (*None*) – an optional relative directory to strip from each input filepath to generate a unique identifier for each image. When exporting media, this identifier is joined with `data_path` and `labels_path` to generate output paths for each exported image and mask. This argument allows for populating nested subdirectories that match the shape of the input paths. The path is converted to an absolute path (if necessary) via [`fiftyone.core.storage.normalize_path()`](fiftyone.core.storage.md#fiftyone.core.storage.normalize_path) * **image_format** (*None*) – the image format to use when writing in-memory images to disk. By default, `fiftyone.config.default_image_ext` is used * **mask_format** ( *".png"*) – the image format to use when writing masks to disk * **mask_size** (*None*) – the `(width, height)` at which to render segmentation masks when exporting instances or polylines. If not provided, masks will be rendered to match the resolution of each input image * **mask_targets** (*None*) – a dict mapping integer pixel values in `[0, 255]` to label strings defining which object classes to render and which pixel values to use for each class. If omitted, all objects are rendered with pixel value 255 * **thickness** (*1*) – the thickness, in pixels, at which to render (non-filled) polylines **Attributes:** | [`requires_image_metadata`](#fiftyone.utils.data.ImageSegmentationDirectoryExporter.requires_image_metadata) | Whether this exporter requires [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each sample being exported. | |----------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`label_cls`](#fiftyone.utils.data.ImageSegmentationDirectoryExporter.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) exported by this exporter. | **Methods:** | [`setup`](#fiftyone.utils.data.ImageSegmentationDirectoryExporter.setup)() | Performs any necessary setup before exporting the first sample in the dataset. | |----------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`export_sample`](#fiftyone.utils.data.ImageSegmentationDirectoryExporter.export_sample)(image_or_path, label[, metadata]) | Exports the given sample to the dataset. | | [`close`](#fiftyone.utils.data.ImageSegmentationDirectoryExporter.close)(\*args) | Performs any necessary actions after the last sample has been exported. | | [`log_collection`](#fiftyone.utils.data.ImageSegmentationDirectoryExporter.log_collection)(sample_collection) | Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. | #### *property* requires_image_metadata Whether this exporter requires [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each sample being exported. #### *property* label_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) exported by this exporter. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class. In this case, the exporter directly exports labels of this type - a list or tuple of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the exporter can export a single label field of any of these types - a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the exporter can handle label dictionaries with value-types specified by this dictionary. Not all keys need be present in the exported label dicts - `None`. In this case, the exporter makes no guarantees about the labels that it can export #### setup() Performs any necessary setup before exporting the first sample in the dataset. This method is called when the exporter’s context manager interface is entered, `DatasetExporter.__enter__()`. #### export_sample(image_or_path, label, metadata=None) Exports the given sample to the dataset. * **Parameters:** * **image_or_path** – an image or the path to the image on disk * **label** – an instance of [`label_cls()`](#fiftyone.utils.data.ImageSegmentationDirectoryExporter.label_cls), or a dictionary mapping field names to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances, or `None` if the sample is unlabeled * **metadata** (*None*) – a [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instance for the sample. Only required when [`requires_image_metadata()`](#fiftyone.utils.data.ImageSegmentationDirectoryExporter.requires_image_metadata) is `True` #### close(\*args) Performs any necessary actions after the last sample has been exported. This method is called when the exporter’s context manager interface is exited, `DatasetExporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetExporter.__exit__()` #### log_collection(sample_collection) Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. Subclasses can optionally implement this method if their export format can record information such as the [`fiftyone.core.collections.SampleCollection.info()`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection.info) of the collection being exported. By convention, this method must be optional; i.e., if it is not called before the first call to [`export_sample()`](#fiftyone.utils.data.ImageSegmentationDirectoryExporter.export_sample), then the exporter must make do without any information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) (which may not be available, for example, if the samples being exported are not stored in a collection). * **Parameters:** **sample_collection** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported ### *class* fiftyone.utils.data.FiftyOneImageLabelsDatasetExporter(export_dir, export_media=None, rel_dir=None, image_format=None, pretty_print=False) Bases: [`LabeledImageDatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.LabeledImageDatasetExporter) Exporter that writes a labeled image dataset to disk with labels stored in [ETA ImageLabels format](https://github.com/voxel51/eta/blob/main/docs/image_labels_guide.md). See [this page](../user_guide/export_datasets.md#fiftyoneimagelabelsdataset-export) for format details. If the path to an image is provided, the image is directly copied to its destination, maintaining the original filename, unless a name conflict would occur, in which case an index of the form `"-%d" % count` is appended to the base filename. * **Parameters:** * **export_dir** – the directory to write the export * **export_media** (*None*) – controls how to export the raw media. The supported values are: - `True` (default): copy all media files into the output directory - `"move"`: move all media files into the output directory - `"symlink"`: create symlinks to the media files in the output directory * **rel_dir** (*None*) – an optional relative directory to strip from each input filepath to generate a unique identifier for each image. When exporting media, this identifier is joined with `export_dir` to generate an output path for each exported image. This argument allows for populating nested subdirectories that match the shape of the input paths. The path is converted to an absolute path (if necessary) via [`fiftyone.core.storage.normalize_path()`](fiftyone.core.storage.md#fiftyone.core.storage.normalize_path) * **image_format** (*None*) – the image format to use when writing in-memory images to disk. By default, `fiftyone.config.default_image_ext` is used * **pretty_print** (*False*) – whether to render the JSON in human readable format with newlines and indentations **Attributes:** | [`requires_image_metadata`](#fiftyone.utils.data.FiftyOneImageLabelsDatasetExporter.requires_image_metadata) | Whether this exporter requires [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each sample being exported. | |----------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`label_cls`](#fiftyone.utils.data.FiftyOneImageLabelsDatasetExporter.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) exported by this exporter. | **Methods:** | [`setup`](#fiftyone.utils.data.FiftyOneImageLabelsDatasetExporter.setup)() | Performs any necessary setup before exporting the first sample in the dataset. | |-----------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`log_collection`](#fiftyone.utils.data.FiftyOneImageLabelsDatasetExporter.log_collection)(sample_collection) | Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. | | [`export_sample`](#fiftyone.utils.data.FiftyOneImageLabelsDatasetExporter.export_sample)(image_or_path, labels[, metadata]) | Exports the given sample to the dataset. | | [`close`](#fiftyone.utils.data.FiftyOneImageLabelsDatasetExporter.close)(\*args) | Performs any necessary actions after the last sample has been exported. | #### *property* requires_image_metadata Whether this exporter requires [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each sample being exported. #### *property* label_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) exported by this exporter. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class. In this case, the exporter directly exports labels of this type - a list or tuple of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the exporter can export a single label field of any of these types - a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the exporter can handle label dictionaries with value-types specified by this dictionary. Not all keys need be present in the exported label dicts - `None`. In this case, the exporter makes no guarantees about the labels that it can export #### setup() Performs any necessary setup before exporting the first sample in the dataset. This method is called when the exporter’s context manager interface is entered, `DatasetExporter.__enter__()`. #### log_collection(sample_collection) Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. Subclasses can optionally implement this method if their export format can record information such as the [`fiftyone.core.collections.SampleCollection.info()`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection.info) of the collection being exported. By convention, this method must be optional; i.e., if it is not called before the first call to [`export_sample()`](#fiftyone.utils.data.FiftyOneImageLabelsDatasetExporter.export_sample), then the exporter must make do without any information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) (which may not be available, for example, if the samples being exported are not stored in a collection). * **Parameters:** **sample_collection** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported #### export_sample(image_or_path, labels, metadata=None) Exports the given sample to the dataset. * **Parameters:** * **image_or_path** – an image or the path to the image on disk * **label** – an instance of [`label_cls()`](#fiftyone.utils.data.FiftyOneImageLabelsDatasetExporter.label_cls), or a dictionary mapping field names to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances, or `None` if the sample is unlabeled * **metadata** (*None*) – a [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instance for the sample. Only required when [`requires_image_metadata()`](#fiftyone.utils.data.FiftyOneImageLabelsDatasetExporter.requires_image_metadata) is `True` #### close(\*args) Performs any necessary actions after the last sample has been exported. This method is called when the exporter’s context manager interface is exited, `DatasetExporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetExporter.__exit__()` ### *class* fiftyone.utils.data.FiftyOneVideoLabelsDatasetExporter(export_dir, export_media=None, rel_dir=None, pretty_print=False) Bases: [`LabeledVideoDatasetExporter`](fiftyone.utils.data.exporters.md#fiftyone.utils.data.exporters.LabeledVideoDatasetExporter) Exporter that writes a labeled video dataset with labels stored in [ETA VideoLabels format](https://github.com/voxel51/eta/blob/main/docs/video_labels_guide.md). See [this page](../user_guide/export_datasets.md#fiftyonevideolabelsdataset-export) for format details. If the path to a video is provided, the video is directly copied to its destination, maintaining the original filename, unless a name conflict would occur, in which case an index of the form `"-%d" % count` is appended to the base filename. * **Parameters:** * **export_dir** – the directory to write the export * **export_media** (*None*) – controls how to export the raw media. The supported values are: - `True` (default): copy all media files into the output directory - `"move"`: move all media files into the output directory - `"symlink"`: create symlinks to the media files in the output directory * **rel_dir** (*None*) – an optional relative directory to strip from each input filepath to generate a unique identifier for each video. When exporting media, this identifier is joined with `export_dir` to generate an output path for each exported video. This argument allows for populating nested subdirectories that match the shape of the input paths. The path is converted to an absolute path (if necessary) via [`fiftyone.core.storage.normalize_path()`](fiftyone.core.storage.md#fiftyone.core.storage.normalize_path) * **pretty_print** (*False*) – whether to render the JSON in human readable format with newlines and indentations **Attributes:** | [`requires_video_metadata`](#fiftyone.utils.data.FiftyOneVideoLabelsDatasetExporter.requires_video_metadata) | Whether this exporter requires [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for each sample being exported. | |----------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`label_cls`](#fiftyone.utils.data.FiftyOneVideoLabelsDatasetExporter.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) that can be exported at the sample-level. | | [`frame_labels_cls`](#fiftyone.utils.data.FiftyOneVideoLabelsDatasetExporter.frame_labels_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) that can be exported by this exporter at the frame-level. | **Methods:** | [`setup`](#fiftyone.utils.data.FiftyOneVideoLabelsDatasetExporter.setup)() | Performs any necessary setup before exporting the first sample in the dataset. | |----------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`log_collection`](#fiftyone.utils.data.FiftyOneVideoLabelsDatasetExporter.log_collection)(sample_collection) | Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. | | [`export_sample`](#fiftyone.utils.data.FiftyOneVideoLabelsDatasetExporter.export_sample)(video_path, label, frames[, ...]) | Exports the given sample to the dataset. | | [`close`](#fiftyone.utils.data.FiftyOneVideoLabelsDatasetExporter.close)(\*args) | Performs any necessary actions after the last sample has been exported. | #### *property* requires_video_metadata Whether this exporter requires [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for each sample being exported. #### *property* label_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) that can be exported at the sample-level. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class. In this case, the exporter directly exports sample-level labels of this type - a list or tuple of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the exporter can export a single sample-level label field of any of these types - a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the exporter can export multiple label fields with value-types specified by this dictionary. Not all keys need be present in the exported sample-level labels - `None`. In this case, the exporter makes no guarantees about the sample-level labels that it can export #### *property* frame_labels_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) that can be exported by this exporter at the frame-level. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class. In this case, the exporter directly exports frame labels of this type - a list or tuple of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the exporter can export a single frame label field of any of these types - a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the exporter can export multiple frame label fields with value-types specified by this dictionary. Not all keys need be present in the exported frame labels - `None`. In this case, the exporter makes no guarantees about the frame labels that it can export #### setup() Performs any necessary setup before exporting the first sample in the dataset. This method is called when the exporter’s context manager interface is entered, `DatasetExporter.__enter__()`. #### log_collection(sample_collection) Logs any relevant information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported. Subclasses can optionally implement this method if their export format can record information such as the [`fiftyone.core.collections.SampleCollection.info()`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection.info) of the collection being exported. By convention, this method must be optional; i.e., if it is not called before the first call to [`export_sample()`](#fiftyone.utils.data.FiftyOneVideoLabelsDatasetExporter.export_sample), then the exporter must make do without any information about the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) (which may not be available, for example, if the samples being exported are not stored in a collection). * **Parameters:** **sample_collection** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) whose samples will be exported #### export_sample(video_path, label, frames, metadata=None) Exports the given sample to the dataset. * **Parameters:** * **video_path** – the path to a video on disk * **label** – an instance of [`label_cls()`](#fiftyone.utils.data.FiftyOneVideoLabelsDatasetExporter.label_cls), or a dictionary mapping field names to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances, or `None` if the sample has no sample-level labels * **frames** – a dictionary mapping frame numbers to dictionaries that map field names to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances, or `None` if the sample has no frame-level labels * **metadata** (*None*) – a [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instance for the sample. Only required when [`requires_video_metadata()`](#fiftyone.utils.data.FiftyOneVideoLabelsDatasetExporter.requires_video_metadata) is `True` #### close(\*args) Performs any necessary actions after the last sample has been exported. This method is called when the exporter’s context manager interface is exited, `DatasetExporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetExporter.__exit__()` ### *class* fiftyone.utils.data.datetime(year, month, day) Bases: [`date`](#fiftyone.utils.data.datetime.date) The year, month and day arguments are required. tzinfo may be None, or an instance of a tzinfo subclass. The remaining arguments may be ints. **Methods:** | [`astimezone`](#fiftyone.utils.data.datetime.astimezone) | tz -> convert to local time in new timezone tz | |---------------------------------------------------------------------------|-----------------------------------------------------------------------------------| | [`combine`](#fiftyone.utils.data.datetime.combine) | date, time -> datetime with same date and time fields | | [`ctime`](#fiftyone.utils.data.datetime.ctime)() | Return ctime() style string. | | [`date`](#fiftyone.utils.data.datetime.date)() | Return date object with same year, month and day. | | [`dst`](#fiftyone.utils.data.datetime.dst)() | Return self.tzinfo.dst(self). | | [`fromisocalendar`](#fiftyone.utils.data.datetime.fromisocalendar) | int, int, int -> Construct a date from the ISO year, week number and weekday. | | [`fromisoformat`](#fiftyone.utils.data.datetime.fromisoformat)(object, /) | string -> datetime from a string in most ISO 8601 formats | | [`fromordinal`](#fiftyone.utils.data.datetime.fromordinal) | int -> date corresponding to a proleptic Gregorian ordinal. | | [`fromtimestamp`](#fiftyone.utils.data.datetime.fromtimestamp) | timestamp[, tz] -> tz's local time from POSIX timestamp. | | [`isocalendar`](#fiftyone.utils.data.datetime.isocalendar)() | Return a named tuple containing ISO year, week number, and weekday. | | [`isoformat`](#fiftyone.utils.data.datetime.isoformat) | [sep] -> string in ISO 8601 format, YYYY-MM-DDT[HH[:MM[:SS[.mmm[uuu]]]]][+HH:MM]. | | [`isoweekday`](#fiftyone.utils.data.datetime.isoweekday)() | Return the day of the week represented by the date. | | [`now`](#fiftyone.utils.data.datetime.now)([tz]) | Returns new datetime object representing current time local to tz. | | [`replace`](#fiftyone.utils.data.datetime.replace) | Return datetime with new specified fields. | | [`strftime`](#fiftyone.utils.data.datetime.strftime) | format -> strftime() style string. | | [`strptime`](#fiftyone.utils.data.datetime.strptime) | string, format -> new datetime parsed from a string (like time.strptime()). | | [`time`](#fiftyone.utils.data.datetime.time)() | Return time object with same time but with tzinfo=None. | | [`timestamp`](#fiftyone.utils.data.datetime.timestamp)() | Return POSIX timestamp as float. | | [`timetuple`](#fiftyone.utils.data.datetime.timetuple)() | Return time tuple, compatible with time.localtime(). | | [`timetz`](#fiftyone.utils.data.datetime.timetz)() | Return time object with same time and tzinfo. | | [`today`](#fiftyone.utils.data.datetime.today)() | Current date or datetime: same as self._\_class_\_.fromtimestamp(time.time()). | | [`toordinal`](#fiftyone.utils.data.datetime.toordinal)() | Return proleptic Gregorian ordinal. | | [`tzname`](#fiftyone.utils.data.datetime.tzname)() | Return self.tzinfo.tzname(self). | | [`utcfromtimestamp`](#fiftyone.utils.data.datetime.utcfromtimestamp) | Construct a naive UTC datetime from a POSIX timestamp. | | [`utcnow`](#fiftyone.utils.data.datetime.utcnow)() | Return a new datetime representing UTC day and time. | | [`utcoffset`](#fiftyone.utils.data.datetime.utcoffset)() | Return self.tzinfo.utcoffset(self). | | [`utctimetuple`](#fiftyone.utils.data.datetime.utctimetuple)() | Return UTC time tuple, compatible with time.localtime(). | | [`weekday`](#fiftyone.utils.data.datetime.weekday)() | Return the day of the week represented by the date. | **Attributes:** | [`day`](#fiftyone.utils.data.datetime.day) | | |------------------------------------------------------------|----| | [`fold`](#fiftyone.utils.data.datetime.fold) | | | [`hour`](#fiftyone.utils.data.datetime.hour) | | | [`max`](#fiftyone.utils.data.datetime.max) | | | [`microsecond`](#fiftyone.utils.data.datetime.microsecond) | | | [`min`](#fiftyone.utils.data.datetime.min) | | | [`minute`](#fiftyone.utils.data.datetime.minute) | | | [`month`](#fiftyone.utils.data.datetime.month) | | | [`resolution`](#fiftyone.utils.data.datetime.resolution) | | | [`second`](#fiftyone.utils.data.datetime.second) | | | [`tzinfo`](#fiftyone.utils.data.datetime.tzinfo) | | | [`year`](#fiftyone.utils.data.datetime.year) | | #### astimezone() tz -> convert to local time in new timezone tz #### *classmethod* combine() date, time -> datetime with same date and time fields #### ctime() Return ctime() style string. #### date() Return date object with same year, month and day. #### day #### dst() Return self.tzinfo.dst(self). #### fold #### *classmethod* fromisocalendar() int, int, int -> Construct a date from the ISO year, week number and weekday. This is the inverse of the date.isocalendar() function #### *classmethod* fromisoformat(object,) string -> datetime from a string in most ISO 8601 formats #### *classmethod* fromordinal() int -> date corresponding to a proleptic Gregorian ordinal. #### *classmethod* fromtimestamp() timestamp[, tz] -> tz’s local time from POSIX timestamp. #### hour #### isocalendar() Return a named tuple containing ISO year, week number, and weekday. #### isoformat() [sep] -> string in ISO 8601 format, YYYY-MM-DDT[HH[:MM[:SS[.mmm[uuu]]]]][+HH:MM]. sep is used to separate the year from the time, and defaults to ‘T’. The optional argument timespec specifies the number of additional terms of the time to include. Valid options are ‘auto’, ‘hours’, ‘minutes’, ‘seconds’, ‘milliseconds’ and ‘microseconds’. #### isoweekday() Return the day of the week represented by the date. Monday == 1 … Sunday == 7 #### max *= datetime.datetime(9999, 12, 31, 23, 59, 59, 999999)* #### microsecond #### min *= datetime.datetime(1, 1, 1, 0, 0)* #### minute #### month #### *classmethod* now(tz=None) Returns new datetime object representing current time local to tz. > tz > : Timezone object. If no tz is specified, uses local timezone. #### replace() Return datetime with new specified fields. #### resolution *= datetime.timedelta(microseconds=1)* #### second #### strftime() format -> strftime() style string. #### *classmethod* strptime() string, format -> new datetime parsed from a string (like time.strptime()). #### time() Return time object with same time but with tzinfo=None. #### timestamp() Return POSIX timestamp as float. #### timetuple() Return time tuple, compatible with time.localtime(). #### timetz() Return time object with same time and tzinfo. #### *classmethod* today() Current date or datetime: same as self._\_class_\_.fromtimestamp(time.time()). #### toordinal() Return proleptic Gregorian ordinal. January 1 of year 1 is day 1. #### tzinfo #### tzname() Return self.tzinfo.tzname(self). #### *classmethod* utcfromtimestamp() Construct a naive UTC datetime from a POSIX timestamp. #### *classmethod* utcnow() Return a new datetime representing UTC day and time. #### utcoffset() Return self.tzinfo.utcoffset(self). #### utctimetuple() Return UTC time tuple, compatible with time.localtime(). #### weekday() Return the day of the week represented by the date. Monday == 0 … Sunday == 6 #### year ### fiftyone.utils.data.get_document(name) Get a registered Document class by name. ### *class* fiftyone.utils.data.Sample(filepath=None, tags=None, metadata=None, media_reference=None, \*\*kwargs) Bases: `_SampleMixin`, [`Document`](fiftyone.core.document.md#fiftyone.core.document.Document) A sample in a [`fiftyone.core.dataset.Dataset`](fiftyone.core.dataset.md#fiftyone.core.dataset.Dataset). Samples store all information associated with a particular piece of data in a dataset, including basic metadata about the data, one or more sets of labels (ground truth, user-provided, or FiftyOne-generated), and additional features associated with subsets of the data and/or label sets. #### NOTE [`Sample`](#fiftyone.utils.data.Sample) instances that are **in datasets** are singletons, i.e., `dataset[sample_id]` will always return the same [`Sample`](#fiftyone.utils.data.Sample) instance. * **Parameters:** * **filepath** (*None*) – the path to the data on disk for a filepath-backed sample. The path is converted to an absolute path (if necessary) via [`fiftyone.core.storage.normalize_path()`](fiftyone.core.storage.md#fiftyone.core.storage.normalize_path) * **media_reference** (*None*) – an immutable [`fiftyone.core.media_reference.MediaReference`](fiftyone.core.media_reference.md#fiftyone.core.media_reference.MediaReference) for a reference-backed sample * **tags** (*None*) – a list of tags for the sample * **metadata** (*None*) – a [`fiftyone.core.metadata.Metadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.Metadata) instance * **\*\*kwargs** – additional fields to dynamically set on the sample **Methods:** | [`reload`](#fiftyone.utils.data.Sample.reload)([hard, include_frames]) | Reloads the sample from the database. | |-------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------| | [`save`](#fiftyone.utils.data.Sample.save)() | Saves the sample to the database. | | [`from_frame`](#fiftyone.utils.data.Sample.from_frame)(frame[, filepath]) | Creates a sample from the given frame. | | [`from_doc`](#fiftyone.utils.data.Sample.from_doc)(doc[, dataset]) | Creates a sample backed by the given document. | | [`from_dict`](#fiftyone.utils.data.Sample.from_dict)(d) | Loads the sample from a JSON dictionary. | | [`add_labels`](#fiftyone.utils.data.Sample.add_labels)(labels[, label_field, ...]) | Adds the given labels to the sample. | | [`clear_field`](#fiftyone.utils.data.Sample.clear_field)(field_name) | Clears the value of a field of the document. | | [`compute_metadata`](#fiftyone.utils.data.Sample.compute_metadata)([overwrite, skip_failures]) | Populates the `metadata` field of the sample. | | [`copy`](#fiftyone.utils.data.Sample.copy)([fields, omit_fields]) | Returns a deep copy of the sample that has not been added to the database. | | [`from_json`](#fiftyone.utils.data.Sample.from_json)(s) | Loads the document from a JSON string. | | [`get_field`](#fiftyone.utils.data.Sample.get_field)(field_name) | Gets the value of a field of the document. | | [`get_media_key`](#fiftyone.utils.data.Sample.get_media_key)() | Returns the sample's active logical media key. | | [`has_field`](#fiftyone.utils.data.Sample.has_field)(field_name) | Determines whether the document has the given field. | | [`iter_fields`](#fiftyone.utils.data.Sample.iter_fields)([include_id, include_timestamps]) | Returns an iterator over the `(name, value)` pairs of the public fields of the document. | | [`merge`](#fiftyone.utils.data.Sample.merge)(sample[, fields, omit_fields, ...]) | Merges the fields of the given sample into this sample. | | [`set_field`](#fiftyone.utils.data.Sample.set_field)(field_name, value[, create, ...]) | Sets the value of a field of the document. | | [`to_dict`](#fiftyone.utils.data.Sample.to_dict)([include_frames, include_private]) | Serializes the sample to a JSON dictionary. | | [`to_json`](#fiftyone.utils.data.Sample.to_json)([pretty_print]) | Serializes the document to a JSON string. | | [`to_mongo_dict`](#fiftyone.utils.data.Sample.to_mongo_dict)([include_id]) | Serializes the document to a BSON dictionary equivalent to the representation that would be stored in the database. | | [`update_fields`](#fiftyone.utils.data.Sample.update_fields)(fields_dict[, expand_schema, ...]) | Sets the dictionary of fields on the document. | **Attributes:** | [`dataset`](#fiftyone.utils.data.Sample.dataset) | The dataset to which this document belongs, or `None` if it has not been added to a dataset. | |------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`dataset_id`](#fiftyone.utils.data.Sample.dataset_id) | | | [`field_names`](#fiftyone.utils.data.Sample.field_names) | An ordered tuple of the public field names of this document. | | [`filename`](#fiftyone.utils.data.Sample.filename) | The basename or logical display name of the sample's media. | | [`in_dataset`](#fiftyone.utils.data.Sample.in_dataset) | Whether the document has been added to a dataset. | | [`media_reference`](#fiftyone.utils.data.Sample.media_reference) | The sample's [`fiftyone.core.media_reference.MediaReference`](fiftyone.core.media_reference.md#fiftyone.core.media_reference.MediaReference), or None for a filepath-backed sample. | | [`media_type`](#fiftyone.utils.data.Sample.media_type) | The media type of the sample. | #### reload(hard=False, include_frames=True) Reloads the sample from the database. * **Parameters:** * **hard** (*False*) – whether to reload the sample’s schema in addition to its field values. This is necessary if new fields may have been added to the dataset schema * **include_frames** (*True*) – whether to reload any in-memory frames of video samples #### save() Saves the sample to the database. #### *classmethod* from_frame(frame, filepath=None) Creates a sample from the given frame. * **Parameters:** * **frame** – a [`fiftyone.core.frame.Frame`](fiftyone.core.frame.md#fiftyone.core.frame.Frame) * **filepath** (*None*) – the path to the corresponding image frame on disk, if not available * **Returns:** a [`Sample`](#fiftyone.utils.data.Sample) #### *classmethod* from_doc(doc, dataset=None) Creates a sample backed by the given document. * **Parameters:** * **doc** – a [`fiftyone.core.odm.sample.DatasetSampleDocument`](fiftyone.core.odm.sample.md#fiftyone.core.odm.sample.DatasetSampleDocument) or [`fiftyone.core.odm.sample.NoDatasetSampleDocument`](fiftyone.core.odm.sample.md#fiftyone.core.odm.sample.NoDatasetSampleDocument) * **dataset** (*None*) – the [`fiftyone.core.dataset.Dataset`](fiftyone.core.dataset.md#fiftyone.core.dataset.Dataset) that the sample belongs to * **Returns:** a [`Sample`](#fiftyone.utils.data.Sample) #### *classmethod* from_dict(d) Loads the sample from a JSON dictionary. The returned sample will not belong to a dataset. * **Returns:** a [`Sample`](#fiftyone.utils.data.Sample) #### add_labels(labels, label_field=None, confidence_thresh=None, classes=None, expand_schema=True, validate=True, dynamic=False) Adds the given labels to the sample. The provided `labels` can be any of the following: - A [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instance, in which case the labels are directly saved in the specified `label_field` - A dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances. In this case, the labels are added as follows: ```default for key, value in labels.items(): sample[label_key(key)] = value ``` - A dict mapping frame numbers to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances. In this case, the provided labels are interpreted as frame-level labels that should be added as follows: ```default sample.frames.merge( { frame_number: {label_field: label} for frame_number, label in labels.items() } ) ``` - A dict mapping frame numbers to dicts mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances. In this case, the provided labels are interpreted as frame-level labels that should be added as follows: ```default sample.frames.merge( { frame_number: { label_key(key): value for key, value in frame_dict.items() } for frame_number, frame_dict in labels.items() } ) ``` In the above, the `label_key` function maps label dict keys to field names, and is defined from `label_field` as follows: ```default if isinstance(label_field, dict): label_key = lambda k: label_field.get(k, k) elif label_field is not None: label_key = lambda k: label_field + "_" + k else: label_key = lambda k: k ``` * **Parameters:** * **labels** – a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) or dict of labels per the description above * **label_field** (*None*) – the sample field, prefix, or dict defining in which field(s) to save the labels * **confidence_thresh** (*None*) – an optional confidence threshold to apply to any applicable labels before saving them * **classes** (*None*) – an optional iterable of classes to which to restrict any applicable labels generated by the model * **expand_schema** (*True*) – whether to dynamically add new fields encountered to the dataset schema. If False, an error is raised if any fields are not in the dataset schema * **validate** (*True*) – whether to validate values for existing fields * **dynamic** (*False*) – whether to declare dynamic attributes #### clear_field(field_name) Clears the value of a field of the document. * **Parameters:** **field_name** – the name of the field to clear * **Raises:** **AttributeError** – if the field does not exist #### compute_metadata(overwrite=False, skip_failures=False) Populates the `metadata` field of the sample. * **Parameters:** * **overwrite** (*False*) – whether to overwrite existing metadata * **skip_failures** (*False*) – whether to gracefully continue without raising an error if metadata cannot be computed #### copy(fields=None, omit_fields=None) Returns a deep copy of the sample that has not been added to the database. * **Parameters:** * **fields** (*None*) – an optional field or iterable of fields to which to restrict the copy. This can also be a dict mapping existing field names to new field names * **omit_fields** (*None*) – an optional field or iterable of fields to exclude from the copy * **Returns:** a [`Sample`](#fiftyone.utils.data.Sample) #### *property* dataset The dataset to which this document belongs, or `None` if it has not been added to a dataset. #### *property* dataset_id #### *property* field_names An ordered tuple of the public field names of this document. #### *property* filename The basename or logical display name of the sample’s media. #### *classmethod* from_json(s) Loads the document from a JSON string. The returned document will not belong to a dataset. * **Parameters:** **s** – the JSON string * **Returns:** a `Document` #### get_field(field_name) Gets the value of a field of the document. * **Parameters:** **field_name** – the field name * **Returns:** the field value * **Raises:** **AttributeError** – if the field does not exist #### get_media_key() Returns the sample’s active logical media key. Reference-backed samples return their reference’s key. All other samples return their filepath. #### has_field(field_name) Determines whether the document has the given field. * **Parameters:** **field_name** – the field name * **Returns:** True/False #### *property* in_dataset Whether the document has been added to a dataset. #### iter_fields(include_id=False, include_timestamps=False) Returns an iterator over the `(name, value)` pairs of the public fields of the document. * **Parameters:** * **include_id** (*False*) – whether to include the `id` field * **include_timestamps** (*False*) – whether to include the `created_at` and `last_modified_at` fields * **Returns:** an iterator that emits `(name, value)` tuples #### *property* media_reference The sample’s [`fiftyone.core.media_reference.MediaReference`](fiftyone.core.media_reference.md#fiftyone.core.media_reference.MediaReference), or None for a filepath-backed sample. The reference says which media source the sample’s media comes from and where in it the sample is; the source itself is recorded once on the dataset. #### *property* media_type The media type of the sample. #### merge(sample, fields=None, omit_fields=None, merge_lists=True, merge_embedded_docs=False, overwrite=True, expand_schema=True, validate=True, dynamic=False) Merges the fields of the given sample into this sample. The behavior of this method is highly customizable. By default, all top-level fields from the provided sample are merged in, overwriting any existing values for those fields, with the exception of list fields (e.g., `tags`) and label list fields (e.g., [`fiftyone.core.labels.Detections`](fiftyone.core.labels.md#fiftyone.core.labels.Detections) fields), in which case the elements of the lists themselves are merged. In the case of label list fields, labels with the same `id` in both samples are updated rather than duplicated. To avoid confusion between missing fields and fields whose value is `None`, `None`-valued fields are always treated as missing while merging. This method can be configured in numerous ways, including: - Whether new fields can be added to the dataset schema - Whether list fields should be treated as ordinary fields and merged as a whole rather than merging their elements - Whether to merge only specific fields, or all but certain fields - Mapping input sample fields to different field names of this sample * **Parameters:** * **sample** – a [`fiftyone.core.sample.Sample`](fiftyone.core.sample.md#fiftyone.core.sample.Sample) * **fields** (*None*) – an optional field or iterable of fields to which to restrict the merge. May contain frame fields for video samples. This can also be a dict mapping field names of the input sample to field names of this sample * **omit_fields** (*None*) – an optional field or iterable of fields to exclude from the merge. May contain frame fields for video samples * **merge_lists** (*True*) – whether to merge the elements of list fields (e.g., `tags`) and label list fields (e.g., [`fiftyone.core.labels.Detections`](fiftyone.core.labels.md#fiftyone.core.labels.Detections) fields) rather than merging the entire top-level field like other field types. For label lists fields, existing `fiftyone.core.label.Label` elements are either replaced (when `overwrite` is True) or kept (when `overwrite` is False) when their `id` matches a label from the provided sample * **merge_embedded_docs** (*False*) – whether to merge the attributes of embedded documents (True) rather than merging the entire top-level field (False) * **overwrite** (*True*) – whether to overwrite (True) or skip (False) existing fields and label elements * **expand_schema** (*True*) – whether to dynamically add new fields encountered to the dataset schema. If False, an error is raised if any fields are not in the dataset schema * **validate** (*True*) – whether to validate values for existing fields * **dynamic** (*False*) – whether to declare dynamic embedded document fields #### set_field(field_name, value, create=True, validate=True, dynamic=False) Sets the value of a field of the document. * **Parameters:** * **field_name** – the field name * **value** – the field value * **create** (*True*) – whether to create the field if it does not exist * **validate** (*True*) – whether to validate values for existing fields * **dynamic** (*False*) – whether to declare dynamic embedded document fields * **Raises:** * **ValueError** – if `field_name` is not an allowed field name * **AttributeError** – if the field does not exist and `create == False` #### to_dict(include_frames=False, include_private=False) Serializes the sample to a JSON dictionary. * **Parameters:** * **include_frames** (*False*) – whether to include the frame labels for video samples * **include_private** (*False*) – whether to include private fields * **Returns:** a JSON dict #### to_json(pretty_print=False) Serializes the document to a JSON string. The document ID and private fields are excluded in this representation. * **Parameters:** **pretty_print** (*False*) – whether to render the JSON in human readable format with newlines and indentations * **Returns:** a JSON string #### to_mongo_dict(include_id=False) Serializes the document to a BSON dictionary equivalent to the representation that would be stored in the database. * **Parameters:** **include_id** (*False*) – whether to include the document ID * **Returns:** a BSON dict #### update_fields(fields_dict, expand_schema=True, validate=True, dynamic=False) Sets the dictionary of fields on the document. * **Parameters:** * **fields_dict** – a dict mapping field names to values * **expand_schema** (*True*) – whether to dynamically add new fields encountered to the document schema. If False, an error is raised if any fields are not in the document schema * **validate** (*True*) – whether to validate values for existing fields * **dynamic** (*False*) – whether to declare dynamic embedded document fields * **Raises:** **AttributeError** – if `expand_schema == False` and a field does not exist ### *class* fiftyone.utils.data.FiftyOneImageClassificationSampleParser(classes=None) Bases: [`ImageClassificationSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageClassificationSampleParser) Parser for samples in FiftyOne image classification datasets. See [this page](../user_guide/import_datasets.md#fiftyoneimageclassificationdataset-import) for format details. * **Parameters:** **classes** (*None*) – an optional list of class label strings. If provided, it is assumed that `target` is a class ID that should be mapped to a label string via `classes[target]` **Methods:** | [`clear_sample`](#fiftyone.utils.data.FiftyOneImageClassificationSampleParser.clear_sample)() | Clears the current sample. | |-----------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------| | [`get_image`](#fiftyone.utils.data.FiftyOneImageClassificationSampleParser.get_image)() | Returns the image from the current sample. | | [`get_image_metadata`](#fiftyone.utils.data.FiftyOneImageClassificationSampleParser.get_image_metadata)() | Returns the image metadata for the current sample. | | [`get_image_path`](#fiftyone.utils.data.FiftyOneImageClassificationSampleParser.get_image_path)() | Returns the image path for the current sample. | | [`get_label`](#fiftyone.utils.data.FiftyOneImageClassificationSampleParser.get_label)() | Returns the label for the current sample. | | [`with_sample`](#fiftyone.utils.data.FiftyOneImageClassificationSampleParser.with_sample)(sample) | Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. | **Attributes:** | [`current_sample`](#fiftyone.utils.data.FiftyOneImageClassificationSampleParser.current_sample) | The current sample. | |---------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`has_image_metadata`](#fiftyone.utils.data.FiftyOneImageClassificationSampleParser.has_image_metadata) | Whether this parser produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for samples that it parses. | | [`has_image_path`](#fiftyone.utils.data.FiftyOneImageClassificationSampleParser.has_image_path) | Whether this parser produces paths to images on disk for samples that it parses. | | [`label_cls`](#fiftyone.utils.data.FiftyOneImageClassificationSampleParser.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this parser. | #### clear_sample() Clears the current sample. Also clears any cached sample information stored by the parser. #### *property* current_sample The current sample. * **Raises:** **ValueError** – if there is no current sample #### get_image() Returns the image from the current sample. * **Returns:** a numpy image #### get_image_metadata() Returns the image metadata for the current sample. * **Returns:** a [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instance #### get_image_path() Returns the image path for the current sample. * **Returns:** the path to the image on disk #### get_label() Returns the label for the current sample. * **Parameters:** **sample** – the sample * **Returns:** a [`fiftyone.core.labels.Classification`](fiftyone.core.labels.md#fiftyone.core.labels.Classification) instance #### *property* has_image_metadata Whether this parser produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for samples that it parses. #### *property* has_image_path Whether this parser produces paths to images on disk for samples that it parses. #### *property* label_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this parser. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class. In this case, the parser is guaranteed to return labels of this type - a list or tuple of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the parser can produce a single label field of any of these types - a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the parser 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 parser makes no guarantees about the labels that it may return #### with_sample(sample) Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. Guaranteed to call [`clear_sample()`](#fiftyone.utils.data.FiftyOneImageClassificationSampleParser.clear_sample) before setting the current sample. * **Parameters:** **sample** – a sample ### *class* fiftyone.utils.data.FiftyOneImageDetectionSampleParser(classes=None) Bases: [`ImageDetectionSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageDetectionSampleParser) Parser for samples in FiftyOne image detection datasets. See [this page](../user_guide/import_datasets.md#fiftyoneimagedetectiondataset-import) for format details. * **Parameters:** **classes** (*None*) – an optional list of class label strings. If provided, it is assumed that the `target` values are class IDs that should be mapped to label strings via `classes[target]` **Methods:** | [`clear_sample`](#fiftyone.utils.data.FiftyOneImageDetectionSampleParser.clear_sample)() | Clears the current sample. | |------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------| | [`get_image`](#fiftyone.utils.data.FiftyOneImageDetectionSampleParser.get_image)() | Returns the image from the current sample. | | [`get_image_metadata`](#fiftyone.utils.data.FiftyOneImageDetectionSampleParser.get_image_metadata)() | Returns the image metadata for the current sample. | | [`get_image_path`](#fiftyone.utils.data.FiftyOneImageDetectionSampleParser.get_image_path)() | Returns the image path for the current sample. | | [`get_label`](#fiftyone.utils.data.FiftyOneImageDetectionSampleParser.get_label)() | Returns the label for the current sample. | | [`with_sample`](#fiftyone.utils.data.FiftyOneImageDetectionSampleParser.with_sample)(sample) | Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. | **Attributes:** | [`current_sample`](#fiftyone.utils.data.FiftyOneImageDetectionSampleParser.current_sample) | The current sample. | |----------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`has_image_metadata`](#fiftyone.utils.data.FiftyOneImageDetectionSampleParser.has_image_metadata) | Whether this parser produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for samples that it parses. | | [`has_image_path`](#fiftyone.utils.data.FiftyOneImageDetectionSampleParser.has_image_path) | Whether this parser produces paths to images on disk for samples that it parses. | | [`label_cls`](#fiftyone.utils.data.FiftyOneImageDetectionSampleParser.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this parser. | #### clear_sample() Clears the current sample. Also clears any cached sample information stored by the parser. #### *property* current_sample The current sample. * **Raises:** **ValueError** – if there is no current sample #### get_image() Returns the image from the current sample. * **Returns:** a numpy image #### get_image_metadata() Returns the image metadata for the current sample. * **Returns:** a [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instance #### get_image_path() Returns the image path for the current sample. * **Returns:** the path to the image on disk #### get_label() Returns the label for the current sample. * **Returns:** a [`fiftyone.core.labels.Detections`](fiftyone.core.labels.md#fiftyone.core.labels.Detections) instance #### *property* has_image_metadata Whether this parser produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for samples that it parses. #### *property* has_image_path Whether this parser produces paths to images on disk for samples that it parses. #### *property* label_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this parser. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class. In this case, the parser is guaranteed to return labels of this type - a list or tuple of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the parser can produce a single label field of any of these types - a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the parser 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 parser makes no guarantees about the labels that it may return #### with_sample(sample) Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. Guaranteed to call [`clear_sample()`](#fiftyone.utils.data.FiftyOneImageDetectionSampleParser.clear_sample) before setting the current sample. * **Parameters:** **sample** – a sample ### *class* fiftyone.utils.data.FiftyOneImageLabelsSampleParser(prefix=None, labels_dict=None, multilabel=False, skip_non_categorical=False) Bases: [`ImageLabelsSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.ImageLabelsSampleParser) Parser for samples in FiftyOne image labels datasets. See [this page](../user_guide/import_datasets.md#fiftyoneimagelabelsdataset-import) for format details. * **Parameters:** * **prefix** (*None*) – a string prefix to prepend to each label name in the expanded label dictionary * **labels_dict** (*None*) – a dictionary mapping names of attributes/objects in the image labels to field names into which to expand them * **multilabel** (*False*) – whether to store attributes in a single [`fiftyone.core.labels.Classifications`](fiftyone.core.labels.md#fiftyone.core.labels.Classifications) instance * **skip_non_categorical** (*False*) – whether to skip non-categorical attributes (True) or cast them to strings (False) **Methods:** | [`clear_sample`](#fiftyone.utils.data.FiftyOneImageLabelsSampleParser.clear_sample)() | Clears the current sample. | |---------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------| | [`get_image`](#fiftyone.utils.data.FiftyOneImageLabelsSampleParser.get_image)() | Returns the image from the current sample. | | [`get_image_metadata`](#fiftyone.utils.data.FiftyOneImageLabelsSampleParser.get_image_metadata)() | Returns the image metadata for the current sample. | | [`get_image_path`](#fiftyone.utils.data.FiftyOneImageLabelsSampleParser.get_image_path)() | Returns the image path for the current sample. | | [`get_label`](#fiftyone.utils.data.FiftyOneImageLabelsSampleParser.get_label)() | Returns the label for the current sample. | | [`with_sample`](#fiftyone.utils.data.FiftyOneImageLabelsSampleParser.with_sample)(sample) | Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. | **Attributes:** | [`current_sample`](#fiftyone.utils.data.FiftyOneImageLabelsSampleParser.current_sample) | The current sample. | |-------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`has_image_metadata`](#fiftyone.utils.data.FiftyOneImageLabelsSampleParser.has_image_metadata) | Whether this parser produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for samples that it parses. | | [`has_image_path`](#fiftyone.utils.data.FiftyOneImageLabelsSampleParser.has_image_path) | Whether this parser produces paths to images on disk for samples that it parses. | | [`label_cls`](#fiftyone.utils.data.FiftyOneImageLabelsSampleParser.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this parser. | #### clear_sample() Clears the current sample. Also clears any cached sample information stored by the parser. #### *property* current_sample The current sample. * **Raises:** **ValueError** – if there is no current sample #### get_image() Returns the image from the current sample. * **Returns:** a numpy image #### get_image_metadata() Returns the image metadata for the current sample. * **Returns:** a [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instance #### get_image_path() Returns the image path for the current sample. * **Returns:** the path to the image on disk #### get_label() Returns the label for the current sample. * **Returns:** a labels dictionary #### *property* has_image_metadata Whether this parser produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for samples that it parses. #### *property* has_image_path Whether this parser produces paths to images on disk for samples that it parses. #### *property* label_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this parser. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class. In this case, the parser is guaranteed to return labels of this type - a list or tuple of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the parser can produce a single label field of any of these types - a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the parser 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 parser makes no guarantees about the labels that it may return #### with_sample(sample) Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. Guaranteed to call [`clear_sample()`](#fiftyone.utils.data.FiftyOneImageLabelsSampleParser.clear_sample) before setting the current sample. * **Parameters:** **sample** – a sample ### *class* fiftyone.utils.data.FiftyOneTemporalDetectionSampleParser(classes=None, compute_metadata=False) Bases: [`LabeledVideoSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledVideoSampleParser) Parser for samples in FiftyOne temporal detection datasets. See [this page](../user_guide/import_datasets.md#fiftyonetemporaldetectiondataset-import) for format details. * **Parameters:** * **classes** (*None*) – an optional list of class label strings. If provided, it is assumed that `target` is a class ID that should be mapped to a label string via `classes[target]` * **compute_metadata** (*False*) – whether to compute [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances on-the-fly if [`get_video_metadata()`](#fiftyone.utils.data.FiftyOneTemporalDetectionSampleParser.get_video_metadata) is called and no metadata is available **Attributes:** | [`has_video_metadata`](#fiftyone.utils.data.FiftyOneTemporalDetectionSampleParser.has_video_metadata) | Whether this parser produces [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for samples that it parses. | |---------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`label_cls`](#fiftyone.utils.data.FiftyOneTemporalDetectionSampleParser.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this parser within the sample-level labels that it produces. | | [`frame_labels_cls`](#fiftyone.utils.data.FiftyOneTemporalDetectionSampleParser.frame_labels_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this parser within the frame labels that it produces. | | [`current_sample`](#fiftyone.utils.data.FiftyOneTemporalDetectionSampleParser.current_sample) | The current sample. | **Methods:** | [`with_sample`](#fiftyone.utils.data.FiftyOneTemporalDetectionSampleParser.with_sample)(sample[, metadata]) | Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. | |---------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------| | [`get_video_path`](#fiftyone.utils.data.FiftyOneTemporalDetectionSampleParser.get_video_path)() | Returns the video path for the current sample. | | [`get_video_metadata`](#fiftyone.utils.data.FiftyOneTemporalDetectionSampleParser.get_video_metadata)() | Returns the video metadata for the current sample. | | [`get_label`](#fiftyone.utils.data.FiftyOneTemporalDetectionSampleParser.get_label)() | Returns the sample-level labels for the current sample. | | [`get_frame_labels`](#fiftyone.utils.data.FiftyOneTemporalDetectionSampleParser.get_frame_labels)() | Returns the frame labels for the current sample. | | [`clear_sample`](#fiftyone.utils.data.FiftyOneTemporalDetectionSampleParser.clear_sample)() | Clears the current sample. | #### *property* has_video_metadata Whether this parser produces [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for samples that it parses. #### *property* label_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this parser within the sample-level labels that it produces. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class. In this case, the parser is guaranteed to return sample-level labels of this type - a list or tuple of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the parser can produce a single sample-level label field of any of these types - a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the parser 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 parser makes no guarantees about the sample-level labels that it may return #### *property* frame_labels_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this parser within the frame labels that it produces. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class. In this case, the parser is guaranteed to return frame labels of this type - a list or tuple of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the parser can produce a single frame label field of any of these types - a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the parser 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 parser makes no guarantees about the frame labels that it may return #### with_sample(sample, metadata=None) Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. Guaranteed to call [`clear_sample()`](#fiftyone.utils.data.FiftyOneTemporalDetectionSampleParser.clear_sample) before setting the current sample. * **Parameters:** **sample** – a sample #### get_video_path() Returns the video path for the current sample. * **Returns:** the path to the video on disk #### get_video_metadata() Returns the video metadata for the current sample. * **Returns:** a [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instance #### get_label() Returns the sample-level labels for the current sample. * **Returns:** a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instance, or a dictionary mapping field names to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances, or `None` if the sample has no sample-level labels #### get_frame_labels() Returns the frame labels for the current sample. * **Returns:** a dictionary mapping frame numbers to dictionaries that map label fields to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances for each video frame, or `None` if the sample has no frame labels #### clear_sample() Clears the current sample. Also clears any cached sample information stored by the parser. #### *property* current_sample The current sample. * **Raises:** **ValueError** – if there is no current sample ### *class* fiftyone.utils.data.FiftyOneVideoLabelsSampleParser(prefix=None, labels_dict=None, frame_labels_dict=None, multilabel=False, skip_non_categorical=False) Bases: [`VideoLabelsSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.VideoLabelsSampleParser) Parser for samples in FiftyOne video labels datasets. See [this page](../user_guide/import_datasets.md#fiftyonevideolabelsdataset-import) for format details. * **Parameters:** * **expand** (*True*) – whether to expand the labels for each frame into separate [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances * **prefix** (*None*) – a string prefix to prepend to each label name in the expanded frame label dictionaries * **labels_dict** (*None*) – a dictionary mapping names of attributes/objects in the frame labels to field names into which to expand them * **multilabel** (*False*) – whether to store attributes in a single [`fiftyone.core.labels.Classifications`](fiftyone.core.labels.md#fiftyone.core.labels.Classifications) instance * **skip_non_categorical** (*False*) – whether to skip non-categorical attributes (True) or cast them to strings (False) **Methods:** | [`clear_sample`](#fiftyone.utils.data.FiftyOneVideoLabelsSampleParser.clear_sample)() | Clears the current sample. | |---------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------| | [`get_frame_labels`](#fiftyone.utils.data.FiftyOneVideoLabelsSampleParser.get_frame_labels)() | Returns the frame labels for the current sample. | | [`get_label`](#fiftyone.utils.data.FiftyOneVideoLabelsSampleParser.get_label)() | Returns the sample-level labels for the current sample. | | [`get_video_metadata`](#fiftyone.utils.data.FiftyOneVideoLabelsSampleParser.get_video_metadata)() | Returns the video metadata for the current sample. | | [`get_video_path`](#fiftyone.utils.data.FiftyOneVideoLabelsSampleParser.get_video_path)() | Returns the video path for the current sample. | | [`with_sample`](#fiftyone.utils.data.FiftyOneVideoLabelsSampleParser.with_sample)(sample) | Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. | **Attributes:** | [`current_sample`](#fiftyone.utils.data.FiftyOneVideoLabelsSampleParser.current_sample) | The current sample. | |-------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`frame_labels_cls`](#fiftyone.utils.data.FiftyOneVideoLabelsSampleParser.frame_labels_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this parser within the frame labels that it produces. | | [`has_video_metadata`](#fiftyone.utils.data.FiftyOneVideoLabelsSampleParser.has_video_metadata) | Whether this parser produces [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for samples that it parses. | | [`label_cls`](#fiftyone.utils.data.FiftyOneVideoLabelsSampleParser.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this parser within the sample-level labels that it produces. | #### clear_sample() Clears the current sample. Also clears any cached sample information stored by the parser. #### *property* current_sample The current sample. * **Raises:** **ValueError** – if there is no current sample #### *property* frame_labels_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this parser within the frame labels that it produces. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class. In this case, the parser is guaranteed to return frame labels of this type - a list or tuple of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the parser can produce a single frame label field of any of these types - a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the parser 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 parser makes no guarantees about the frame labels that it may return #### get_frame_labels() Returns the frame labels for the current sample. * **Returns:** a dictionary mapping frame numbers to dictionaries that map label fields to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances for each video frame, or `None` if the sample has no frame labels #### get_label() Returns the sample-level labels for the current sample. * **Returns:** a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instance, or a dictionary mapping field names to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances, or `None` if the sample has no sample-level labels #### get_video_metadata() Returns the video metadata for the current sample. * **Returns:** a [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instance #### get_video_path() Returns the video path for the current sample. * **Returns:** the path to the video on disk #### *property* has_video_metadata Whether this parser produces [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for samples that it parses. #### *property* label_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this parser within the sample-level labels that it produces. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class. In this case, the parser is guaranteed to return sample-level labels of this type - a list or tuple of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the parser can produce a single sample-level label field of any of these types - a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the parser 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 parser makes no guarantees about the sample-level labels that it may return #### with_sample(sample) Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. Guaranteed to call [`clear_sample()`](#fiftyone.utils.data.FiftyOneVideoLabelsSampleParser.clear_sample) before setting the current sample. * **Parameters:** **sample** – a sample ### fiftyone.utils.data.import_samples(dataset, dataset_importer, label_field=None, tags=None, expand_schema=True, dynamic=False, add_info=True, generator=False, progress=None) Adds the samples from the given [`DatasetImporter`](#fiftyone.utils.data.DatasetImporter) to the dataset. See [this guide](../user_guide/import_datasets.md#custom-dataset-importer) for more details about importing datasets in custom formats by defining your own [`DatasetImporter`](#fiftyone.utils.data.DatasetImporter). * **Parameters:** * **dataset** – a [`fiftyone.core.dataset.Dataset`](fiftyone.core.dataset.md#fiftyone.core.dataset.Dataset) * **dataset_importer** – a [`DatasetImporter`](#fiftyone.utils.data.DatasetImporter) * **label_field** (*None*) – controls the field(s) in which imported labels are stored. Only applicable if `dataset_importer` is a [`LabeledImageDatasetImporter`](#fiftyone.utils.data.LabeledImageDatasetImporter) or [`LabeledVideoDatasetImporter`](#fiftyone.utils.data.LabeledVideoDatasetImporter). If the importer produces a single [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instance per sample/frame, this argument specifies the name of the field to use; the default is `"ground_truth"`. If the importer produces a dictionary of labels per sample, this argument can be either a string prefix to prepend to each label key or a dict mapping label keys to field names; the default in this case is to directly use the keys of the imported label dictionaries as field names * **tags** (*None*) – an optional tag or iterable of tags to attach to each sample * **expand_schema** (*True*) – whether to dynamically add new sample fields encountered to the dataset schema. If False, an error is raised if a sample’s schema is not a subset of the dataset schema * **dynamic** (*False*) – whether to declare dynamic attributes of embedded document fields that are encountered * **add_info** (*True*) – whether to add dataset info from the importer (if any) to the dataset * **generator** (*False*) – whether to yield ID batches as a generator as samples are added to the dataset * **progress** (*None*) – whether to render a progress bar (True/False), use the default value `fiftyone.config.show_progress_bars` (None), or a progress callback function to invoke instead * **Returns:** a list of IDs of the samples that were added to the dataset ### fiftyone.utils.data.merge_samples(dataset, dataset_importer, label_field=None, tags=None, key_field=None, key_fcn=None, skip_existing=False, insert_new=True, fields=None, omit_fields=None, merge_lists=True, merge_embedded_docs=False, overwrite=True, expand_schema=True, dynamic=False, add_info=True, progress=None) Merges the samples from the given [`DatasetImporter`](#fiftyone.utils.data.DatasetImporter) into the dataset. See [this guide](../user_guide/import_datasets.md#custom-dataset-importer) for more details about importing datasets in custom formats by defining your own [`DatasetImporter`](#fiftyone.utils.data.DatasetImporter). By default, samples with the same filepath or media reference key are merged, but you can customize this behavior via the `key_field` and `key_fcn` parameters. For example, you could set `key_fcn = lambda sample: os.path.basename(sample.filepath)` to merge samples with the same base filename. The behavior of this method is highly customizable. By default, all top-level fields from the imported samples are merged in, overwriting any existing values for those fields, with the exception of list fields (e.g., `tags`) and label list fields (e.g., [`fiftyone.core.labels.Detections`](fiftyone.core.labels.md#fiftyone.core.labels.Detections) fields), in which case the elements of the lists themselves are merged. In the case of label list fields, labels with the same `id` in both collections are updated rather than duplicated. To avoid confusion between missing fields and fields whose value is `None`, `None`-valued fields are always treated as missing while merging. This method can be configured in numerous ways, including: - Whether existing samples should be modified or skipped - Whether new samples should be added or omitted - Whether new fields can be added to the dataset schema - Whether list fields should be treated as ordinary fields and merged as a whole rather than merging their elements - Whether to merge only specific fields, or all but certain fields - Mapping input fields to different field names of this dataset * **Parameters:** * **dataset** – a [`fiftyone.core.dataset.Dataset`](fiftyone.core.dataset.md#fiftyone.core.dataset.Dataset) * **dataset_importer** – a [`DatasetImporter`](#fiftyone.utils.data.DatasetImporter) * **label_field** (*None*) – controls the field(s) in which imported labels are stored. Only applicable if `dataset_importer` is a [`LabeledImageDatasetImporter`](#fiftyone.utils.data.LabeledImageDatasetImporter) or [`LabeledVideoDatasetImporter`](#fiftyone.utils.data.LabeledVideoDatasetImporter). If the importer produces a single [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instance per sample/frame, this argument specifies the name of the field to use; the default is `"ground_truth"`. If the importer produces a dictionary of labels per sample, this argument can be either a string prefix to prepend to each label key or a dict mapping label keys to field names; the default in this case is to directly use the keys of the imported label dictionaries as field names * **tags** (*None*) – an optional tag or iterable of tags to attach to each sample * **key_field** (*None*) – the sample field to use to decide whether to join with an existing sample. By default, `filepath` or `media_reference.key` is used according to the media source of the samples * **key_fcn** (*None*) – a function that accepts a [`fiftyone.core.sample.Sample`](fiftyone.core.sample.md#fiftyone.core.sample.Sample) instance and computes a key to decide if two samples should be merged. If a `key_fcn` is provided, `key_field` is ignored * **skip_existing** (*False*) – whether to skip existing samples (True) or merge them (False) * **insert_new** (*True*) – whether to insert new samples (True) or skip them (False) * **fields** (*None*) – an optional field or iterable of fields to which to restrict the merge. If provided, fields other than these are omitted from `samples` when merging or adding samples. The active media source is always included when adding new samples, since it is required. This can also be a dict mapping field names of the input collection to field names of this dataset * **omit_fields** (*None*) – an optional field or iterable of fields to exclude from the merge. If provided, these fields are omitted from imported samples, if present. The active media source is always included when adding new samples, since it is required * **merge_lists** (*True*) – whether to merge the elements of list fields (e.g., `tags`) and label list fields (e.g., [`fiftyone.core.labels.Detections`](fiftyone.core.labels.md#fiftyone.core.labels.Detections) fields) rather than merging the entire top-level field like other field types. For label lists fields, existing `fiftyone.core.label.Label` elements are either replaced (when `overwrite` is True) or kept (when `overwrite` is False) when their `id` matches a label from the provided samples * **merge_embedded_docs** (*False*) – whether to merge the attributes of embedded documents (True) rather than merging the entire top-level field (False) * **overwrite** (*True*) – whether to overwrite (True) or skip (False) existing fields and label elements * **expand_schema** (*True*) – whether to dynamically add new fields encountered to the dataset schema. If False, an error is raised if a sample’s schema is not a subset of the dataset schema * **dynamic** (*False*) – whether to declare dynamic attributes of embedded document fields that are encountered * **add_info** (*True*) – whether to add dataset info from the importer (if any) to the dataset * **progress** (*None*) – whether to render a progress bar (True/False), use the default value `fiftyone.config.show_progress_bars` (None), or a progress callback function to invoke instead ### fiftyone.utils.data.parse_dataset_info(dataset, info, overwrite=True) Parses the info returned by [`DatasetImporter.get_dataset_info()`](#fiftyone.utils.data.DatasetImporter.get_dataset_info) and stores it on the relevant properties of the dataset. * **Parameters:** * **dataset** – a [`fiftyone.core.dataset.Dataset`](fiftyone.core.dataset.md#fiftyone.core.dataset.Dataset) * **info** – an info dict * **overwrite** (*True*) – whether to overwrite existing dataset info fields ### *class* fiftyone.utils.data.ImportPathsMixin Bases: `object` Mixin for [`DatasetImporter`](#fiftyone.utils.data.DatasetImporter) classes that provides convenience methods for parsing the `data_path` and `labels_path` parameters supported by many importers. ### *class* fiftyone.utils.data.DatasetImporter(dataset_dir=None, shuffle=False, seed=None, max_samples=None) Bases: `object` Base interface for importing datasets stored on disk into FiftyOne. Typically, dataset importers should implement the parameters documented on this class, although this is not mandatory. See [this page](../user_guide/import_datasets.md#writing-a-custom-dataset-importer) for information about implementing/using dataset importers. #### \_\_len_\_() The total number of samples that will be imported. * **Raises:** **TypeError** – if the total number is not known #### \_\_next_\_() Returns information about the next sample in the dataset. * **Returns:** subclass-specific information for the sample * **Raises:** **StopIteration** – if there are no more samples to import * **Parameters:** * **dataset_dir** (*None*) – the dataset directory. This may be optional for some importers * **shuffle** (*False*) – whether to randomly shuffle the order in which the samples are imported * **seed** (*None*) – a random seed to use when shuffling * **max_samples** (*None*) – a maximum number of samples to import. By default, all samples are imported **Attributes:** | [`has_dataset_info`](#fiftyone.utils.data.DatasetImporter.has_dataset_info) | Whether this importer produces a dataset info dictionary. | |-------------------------------------------------------------------------------|-------------------------------------------------------------| **Methods:** | [`setup`](#fiftyone.utils.data.DatasetImporter.setup)() | Performs any necessary setup before importing the first sample in the dataset. | |---------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| | [`get_media_sources`](#fiftyone.utils.data.DatasetImporter.get_media_sources)() | Returns the media-source entries the importing dataset records before any sample is added, or None. | | [`get_dataset_info`](#fiftyone.utils.data.DatasetImporter.get_dataset_info)() | Returns the dataset info for the dataset. | | [`close`](#fiftyone.utils.data.DatasetImporter.close)(\*args) | Performs any necessary actions after the last sample has been imported. | #### *property* has_dataset_info Whether this importer produces a dataset info dictionary. #### 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__()`. #### get_media_sources() Returns the media-source entries the importing dataset records before any sample is added, or None. Only importers of media-reference-backed samples provide these; see [`fiftyone.utils.lerobot.LeRobotDatasetImporter`](fiftyone.utils.lerobot.md#fiftyone.utils.lerobot.LeRobotDatasetImporter). #### 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 #### close(\*args) Performs any necessary actions after the last sample has been imported. This method is called when the importer’s context manager interface is exited, `DatasetImporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetImporter.__exit__()` ### *class* fiftyone.utils.data.BatchDatasetImporter(dataset_dir=None, shuffle=False, seed=None, max_samples=None) Bases: [`DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter) Base interface for importers that load all of their samples in a single call to [`import_samples()`](#fiftyone.utils.data.import_samples). This interface allows for greater efficiency for import formats that handle aggregating over the samples themselves. Typically, dataset importers should implement the parameters documented on this class, although this is not mandatory. * **Parameters:** * **dataset_dir** (*None*) – the dataset directory. This may be optional for some importers * **shuffle** (*False*) – whether to randomly shuffle the order in which the samples are imported * **seed** (*None*) – a random seed to use when shuffling * **max_samples** (*None*) – a maximum number of samples to import. By default, all samples are imported **Methods:** | [`import_samples`](#fiftyone.utils.data.BatchDatasetImporter.import_samples)(dataset[, tags, progress]) | Imports the samples into the given dataset. | |-----------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| | [`close`](#fiftyone.utils.data.BatchDatasetImporter.close)(\*args) | Performs any necessary actions after the last sample has been imported. | | [`get_dataset_info`](#fiftyone.utils.data.BatchDatasetImporter.get_dataset_info)() | Returns the dataset info for the dataset. | | [`get_media_sources`](#fiftyone.utils.data.BatchDatasetImporter.get_media_sources)() | Returns the media-source entries the importing dataset records before any sample is added, or None. | | [`setup`](#fiftyone.utils.data.BatchDatasetImporter.setup)() | Performs any necessary setup before importing the first sample in the dataset. | **Attributes:** | [`has_dataset_info`](#fiftyone.utils.data.BatchDatasetImporter.has_dataset_info) | Whether this importer produces a dataset info dictionary. | |------------------------------------------------------------------------------------|-------------------------------------------------------------| #### import_samples(dataset, tags=None, progress=None) Imports the samples into the given dataset. * **Parameters:** * **dataset** – a [`fiftyone.core.dataset.Dataset`](fiftyone.core.dataset.md#fiftyone.core.dataset.Dataset) * **tags** (*None*) – an optional list of tags to attach to each sample * **progress** (*None*) – whether to render a progress bar (True/False), use the default value `fiftyone.config.show_progress_bars` (None), or a progress callback function to invoke instead * **Returns:** a list of IDs of the samples that were added to the dataset #### close(\*args) Performs any necessary actions after the last sample has been imported. This method is called when the importer’s context manager interface is exited, `DatasetImporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetImporter.__exit__()` #### 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 #### get_media_sources() Returns the media-source entries the importing dataset records before any sample is added, or None. Only importers of media-reference-backed samples provide these; see [`fiftyone.utils.lerobot.LeRobotDatasetImporter`](fiftyone.utils.lerobot.md#fiftyone.utils.lerobot.LeRobotDatasetImporter). #### *property* has_dataset_info Whether this importer produces a dataset info dictionary. #### 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__()`. ### *class* fiftyone.utils.data.GenericSampleDatasetImporter(dataset_dir=None, shuffle=False, seed=None, max_samples=None) Bases: [`DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter) Interface for importing datasets that contain arbitrary [`fiftyone.core.sample.Sample`](fiftyone.core.sample.md#fiftyone.core.sample.Sample) instances. Typically, dataset importers should implement the parameters documented on this class, although this is not mandatory. See [this page](../user_guide/import_datasets.md#writing-a-custom-dataset-importer) for information about implementing/using dataset importers. #### \_\_len_\_() The total number of samples that will be imported. * **Raises:** **TypeError** – if the total number is not known #### \_\_next_\_() Returns information about the next sample in the dataset. * **Returns:** a [`fiftyone.core.sample.Sample`](fiftyone.core.sample.md#fiftyone.core.sample.Sample) instance * **Raises:** **StopIteration** – if there are no more samples to import * **Parameters:** * **dataset_dir** (*None*) – the dataset directory. This may be optional for some importers * **shuffle** (*False*) – whether to randomly shuffle the order in which the samples are imported * **seed** (*None*) – a random seed to use when shuffling * **max_samples** (*None*) – a maximum number of samples to import. By default, all samples are imported **Attributes:** | [`has_sample_field_schema`](#fiftyone.utils.data.GenericSampleDatasetImporter.has_sample_field_schema) | Whether this importer produces a sample field schema. | |----------------------------------------------------------------------------------------------------------|-----------------------------------------------------------| | [`has_dataset_info`](#fiftyone.utils.data.GenericSampleDatasetImporter.has_dataset_info) | Whether this importer produces a dataset info dictionary. | **Methods:** | [`get_sample_field_schema`](#fiftyone.utils.data.GenericSampleDatasetImporter.get_sample_field_schema)() | Returns a dictionary describing the field schema of the samples loaded by this importer. | |------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| | [`close`](#fiftyone.utils.data.GenericSampleDatasetImporter.close)(\*args) | Performs any necessary actions after the last sample has been imported. | | [`get_dataset_info`](#fiftyone.utils.data.GenericSampleDatasetImporter.get_dataset_info)() | Returns the dataset info for the dataset. | | [`get_media_sources`](#fiftyone.utils.data.GenericSampleDatasetImporter.get_media_sources)() | Returns the media-source entries the importing dataset records before any sample is added, or None. | | [`setup`](#fiftyone.utils.data.GenericSampleDatasetImporter.setup)() | Performs any necessary setup before importing the first sample in the dataset. | #### *property* has_sample_field_schema Whether this importer produces a sample field schema. #### get_sample_field_schema() Returns a dictionary describing the field schema of the samples loaded by this importer. * **Returns:** a dict mapping field names to [`fiftyone.core.fields.Field`](fiftyone.core.fields.md#fiftyone.core.fields.Field) instances or `str(field)` representations of them #### close(\*args) Performs any necessary actions after the last sample has been imported. This method is called when the importer’s context manager interface is exited, `DatasetImporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetImporter.__exit__()` #### 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 #### get_media_sources() Returns the media-source entries the importing dataset records before any sample is added, or None. Only importers of media-reference-backed samples provide these; see [`fiftyone.utils.lerobot.LeRobotDatasetImporter`](fiftyone.utils.lerobot.md#fiftyone.utils.lerobot.LeRobotDatasetImporter). #### *property* has_dataset_info Whether this importer produces a dataset info dictionary. #### 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__()`. ### *class* fiftyone.utils.data.GroupDatasetImporter(dataset_dir=None, shuffle=False, seed=None, max_samples=None) Bases: [`GenericSampleDatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.GenericSampleDatasetImporter) Interface for importing datasets that contain arbitrary grouped [`fiftyone.core.sample.Sample`](fiftyone.core.sample.md#fiftyone.core.sample.Sample) instances. Typically, dataset importers should implement the parameters documented on this class, although this is not mandatory. See [this page](../user_guide/import_datasets.md#writing-a-custom-dataset-importer) for information about implementing/using dataset importers. #### \_\_len_\_() The total number of samples that will be imported across all group slices. * **Raises:** **TypeError** – if the total number is not known #### \_\_next_\_() Returns information about the next group in the dataset. * **Returns:** a dict mapping slice names to [`fiftyone.core.sample.Sample`](fiftyone.core.sample.md#fiftyone.core.sample.Sample) instances * **Raises:** **StopIteration** – if there are no more samples to import * **Parameters:** * **dataset_dir** (*None*) – the dataset directory. This may be optional for some importers * **shuffle** (*False*) – whether to randomly shuffle the order in which the samples are imported * **seed** (*None*) – a random seed to use when shuffling * **max_samples** (*None*) – a maximum number of samples to import. By default, all samples are imported **Attributes:** | [`group_field`](#fiftyone.utils.data.GroupDatasetImporter.group_field) | The name of the group field to populate on each sample. | |------------------------------------------------------------------------------------------------|-----------------------------------------------------------| | [`has_dataset_info`](#fiftyone.utils.data.GroupDatasetImporter.has_dataset_info) | Whether this importer produces a dataset info dictionary. | | [`has_sample_field_schema`](#fiftyone.utils.data.GroupDatasetImporter.has_sample_field_schema) | Whether this importer produces a sample field schema. | **Methods:** | [`get_group_media_types`](#fiftyone.utils.data.GroupDatasetImporter.get_group_media_types)() | Returns a dictionary describing the group slices of the samples loaded by this importer. | |--------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| | [`close`](#fiftyone.utils.data.GroupDatasetImporter.close)(\*args) | Performs any necessary actions after the last sample has been imported. | | [`get_dataset_info`](#fiftyone.utils.data.GroupDatasetImporter.get_dataset_info)() | Returns the dataset info for the dataset. | | [`get_media_sources`](#fiftyone.utils.data.GroupDatasetImporter.get_media_sources)() | Returns the media-source entries the importing dataset records before any sample is added, or None. | | [`get_sample_field_schema`](#fiftyone.utils.data.GroupDatasetImporter.get_sample_field_schema)() | Returns a dictionary describing the field schema of the samples loaded by this importer. | | [`setup`](#fiftyone.utils.data.GroupDatasetImporter.setup)() | Performs any necessary setup before importing the first sample in the dataset. | #### *property* group_field The name of the group field to populate on each sample. #### get_group_media_types() Returns a dictionary describing the group slices of the samples loaded by this importer. * **Returns:** a dict mapping slice names to media types #### close(\*args) Performs any necessary actions after the last sample has been imported. This method is called when the importer’s context manager interface is exited, `DatasetImporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetImporter.__exit__()` #### 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 #### get_media_sources() Returns the media-source entries the importing dataset records before any sample is added, or None. Only importers of media-reference-backed samples provide these; see [`fiftyone.utils.lerobot.LeRobotDatasetImporter`](fiftyone.utils.lerobot.md#fiftyone.utils.lerobot.LeRobotDatasetImporter). #### get_sample_field_schema() Returns a dictionary describing the field schema of the samples loaded by this importer. * **Returns:** a dict mapping field names to [`fiftyone.core.fields.Field`](fiftyone.core.fields.md#fiftyone.core.fields.Field) instances or `str(field)` representations of them #### *property* has_dataset_info Whether this importer produces a dataset info dictionary. #### *property* has_sample_field_schema Whether this importer produces a sample field schema. #### 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__()`. ### *class* fiftyone.utils.data.UnlabeledImageDatasetImporter(dataset_dir=None, shuffle=False, seed=None, max_samples=None) Bases: [`DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter) Interface for importing datasets of unlabeled image samples. Typically, dataset importers should implement the parameters documented on this class, although this is not mandatory. See [this page](../user_guide/import_datasets.md#writing-a-custom-dataset-importer) for information about implementing/using dataset importers. #### \_\_len_\_() The total number of samples that will be imported. * **Raises:** **TypeError** – if the total number is not known #### \_\_next_\_() Returns information about the next sample in the dataset. * **Returns:** an `(image_path, image_metadata)` tuple, where - `image_path`: the path to the image on disk - `image_metadata`: an [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for the image, or `None` if [`has_image_metadata()`](#fiftyone.utils.data.UnlabeledImageDatasetImporter.has_image_metadata) is `False` * **Raises:** **StopIteration** – if there are no more samples to import * **Parameters:** * **dataset_dir** (*None*) – the dataset directory. This may be optional for some importers * **shuffle** (*False*) – whether to randomly shuffle the order in which the samples are imported * **seed** (*None*) – a random seed to use when shuffling * **max_samples** (*None*) – a maximum number of samples to import. By default, all samples are imported **Attributes:** | [`has_image_metadata`](#fiftyone.utils.data.UnlabeledImageDatasetImporter.has_image_metadata) | Whether this importer produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each image. | |-------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`has_dataset_info`](#fiftyone.utils.data.UnlabeledImageDatasetImporter.has_dataset_info) | Whether this importer produces a dataset info dictionary. | **Methods:** | [`close`](#fiftyone.utils.data.UnlabeledImageDatasetImporter.close)(\*args) | Performs any necessary actions after the last sample has been imported. | |-----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| | [`get_dataset_info`](#fiftyone.utils.data.UnlabeledImageDatasetImporter.get_dataset_info)() | Returns the dataset info for the dataset. | | [`get_media_sources`](#fiftyone.utils.data.UnlabeledImageDatasetImporter.get_media_sources)() | Returns the media-source entries the importing dataset records before any sample is added, or None. | | [`setup`](#fiftyone.utils.data.UnlabeledImageDatasetImporter.setup)() | Performs any necessary setup before importing the first sample in the dataset. | #### *property* has_image_metadata Whether this importer produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each image. #### close(\*args) Performs any necessary actions after the last sample has been imported. This method is called when the importer’s context manager interface is exited, `DatasetImporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetImporter.__exit__()` #### 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 #### get_media_sources() Returns the media-source entries the importing dataset records before any sample is added, or None. Only importers of media-reference-backed samples provide these; see [`fiftyone.utils.lerobot.LeRobotDatasetImporter`](fiftyone.utils.lerobot.md#fiftyone.utils.lerobot.LeRobotDatasetImporter). #### *property* has_dataset_info Whether this importer produces a dataset info dictionary. #### 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__()`. ### *class* fiftyone.utils.data.UnlabeledVideoDatasetImporter(dataset_dir=None, shuffle=False, seed=None, max_samples=None) Bases: [`DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter) 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 [this page](../user_guide/import_datasets.md#writing-a-custom-dataset-importer) for information about implementing/using dataset importers. #### \_\_len_\_() The total number of samples that will be imported. * **Raises:** **TypeError** – if the total number is not known #### \_\_next_\_() Returns information about the next sample in the dataset. * **Returns:** an `(video_path, video_metadata)` tuple, where - `video_path`: the path to the video on disk - `video_metadata`: an [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for the video, or `None` if [`has_video_metadata()`](#fiftyone.utils.data.UnlabeledVideoDatasetImporter.has_video_metadata) is `False` * **Raises:** **StopIteration** – if there are no more samples to import * **Parameters:** * **dataset_dir** (*None*) – the dataset directory. This may be optional for some importers * **shuffle** (*False*) – whether to randomly shuffle the order in which the samples are imported * **seed** (*None*) – a random seed to use when shuffling * **max_samples** (*None*) – a maximum number of samples to import. By default, all samples are imported **Attributes:** | [`has_video_metadata`](#fiftyone.utils.data.UnlabeledVideoDatasetImporter.has_video_metadata) | Whether this importer produces [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for each video. | |-------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`has_dataset_info`](#fiftyone.utils.data.UnlabeledVideoDatasetImporter.has_dataset_info) | Whether this importer produces a dataset info dictionary. | **Methods:** | [`close`](#fiftyone.utils.data.UnlabeledVideoDatasetImporter.close)(\*args) | Performs any necessary actions after the last sample has been imported. | |-----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| | [`get_dataset_info`](#fiftyone.utils.data.UnlabeledVideoDatasetImporter.get_dataset_info)() | Returns the dataset info for the dataset. | | [`get_media_sources`](#fiftyone.utils.data.UnlabeledVideoDatasetImporter.get_media_sources)() | Returns the media-source entries the importing dataset records before any sample is added, or None. | | [`setup`](#fiftyone.utils.data.UnlabeledVideoDatasetImporter.setup)() | Performs any necessary setup before importing the first sample in the dataset. | #### *property* has_video_metadata Whether this importer produces [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for each video. #### close(\*args) Performs any necessary actions after the last sample has been imported. This method is called when the importer’s context manager interface is exited, `DatasetImporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetImporter.__exit__()` #### 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 #### get_media_sources() Returns the media-source entries the importing dataset records before any sample is added, or None. Only importers of media-reference-backed samples provide these; see [`fiftyone.utils.lerobot.LeRobotDatasetImporter`](fiftyone.utils.lerobot.md#fiftyone.utils.lerobot.LeRobotDatasetImporter). #### *property* has_dataset_info Whether this importer produces a dataset info dictionary. #### 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__()`. ### *class* fiftyone.utils.data.UnlabeledMediaDatasetImporter(dataset_dir=None, shuffle=False, seed=None, max_samples=None) Bases: [`DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter) Interface for importing datasets of unlabeled media samples. Typically, dataset importers should implement the parameters documented on this class, although this is not mandatory. See [this page](../user_guide/import_datasets.md#writing-a-custom-dataset-importer) for information about implementing/using dataset importers. #### \_\_len_\_() The total number of samples that will be imported. * **Raises:** **TypeError** – if the total number is not known #### \_\_next_\_() Returns information about the next sample in the dataset. * **Returns:** an `(filepath, metadata)` tuple, where - `filepath`: the path to the media on disk - `metadata`: a [`fiftyone.core.metadata.Metadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.Metadata) instance for the media, or `None` if [`has_metadata()`](#fiftyone.utils.data.UnlabeledMediaDatasetImporter.has_metadata) is `False` * **Raises:** **StopIteration** – if there are no more samples to import * **Parameters:** * **dataset_dir** (*None*) – the dataset directory. This may be optional for some importers * **shuffle** (*False*) – whether to randomly shuffle the order in which the samples are imported * **seed** (*None*) – a random seed to use when shuffling * **max_samples** (*None*) – a maximum number of samples to import. By default, all samples are imported **Attributes:** | [`has_metadata`](#fiftyone.utils.data.UnlabeledMediaDatasetImporter.has_metadata) | Whether this importer produces [`fiftyone.core.metadata.Metadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.Metadata) instances for each sample. | |-------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`has_dataset_info`](#fiftyone.utils.data.UnlabeledMediaDatasetImporter.has_dataset_info) | Whether this importer produces a dataset info dictionary. | **Methods:** | [`close`](#fiftyone.utils.data.UnlabeledMediaDatasetImporter.close)(\*args) | Performs any necessary actions after the last sample has been imported. | |-----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| | [`get_dataset_info`](#fiftyone.utils.data.UnlabeledMediaDatasetImporter.get_dataset_info)() | Returns the dataset info for the dataset. | | [`get_media_sources`](#fiftyone.utils.data.UnlabeledMediaDatasetImporter.get_media_sources)() | Returns the media-source entries the importing dataset records before any sample is added, or None. | | [`setup`](#fiftyone.utils.data.UnlabeledMediaDatasetImporter.setup)() | Performs any necessary setup before importing the first sample in the dataset. | #### *property* has_metadata Whether this importer produces [`fiftyone.core.metadata.Metadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.Metadata) instances for each sample. #### close(\*args) Performs any necessary actions after the last sample has been imported. This method is called when the importer’s context manager interface is exited, `DatasetImporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetImporter.__exit__()` #### 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 #### get_media_sources() Returns the media-source entries the importing dataset records before any sample is added, or None. Only importers of media-reference-backed samples provide these; see [`fiftyone.utils.lerobot.LeRobotDatasetImporter`](fiftyone.utils.lerobot.md#fiftyone.utils.lerobot.LeRobotDatasetImporter). #### *property* has_dataset_info Whether this importer produces a dataset info dictionary. #### 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__()`. ### *class* fiftyone.utils.data.LabeledImageDatasetImporter(dataset_dir=None, shuffle=False, seed=None, max_samples=None) Bases: [`DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter) 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 [this page](../user_guide/import_datasets.md#writing-a-custom-dataset-importer) for information about implementing/using dataset importers. #### \_\_len_\_() The total number of samples that will be imported. * **Raises:** **TypeError** – if the total number is not known #### \_\_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`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for the image, or `None` if [`has_image_metadata()`](#fiftyone.utils.data.LabeledImageDatasetImporter.has_image_metadata) is `False` - `label`: an instance of [`label_cls()`](#fiftyone.utils.data.LabeledImageDatasetImporter.label_cls), or a dictionary mapping field names to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances, or `None` if the sample is unlabeled * **Raises:** **StopIteration** – if there are no more samples to import * **Parameters:** * **dataset_dir** (*None*) – the dataset directory. This may be optional for some importers * **shuffle** (*False*) – whether to randomly shuffle the order in which the samples are imported * **seed** (*None*) – a random seed to use when shuffling * **max_samples** (*None*) – a maximum number of samples to import. By default, all samples are imported **Attributes:** | [`has_image_metadata`](#fiftyone.utils.data.LabeledImageDatasetImporter.has_image_metadata) | Whether this importer produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each image. | |-----------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`label_cls`](#fiftyone.utils.data.LabeledImageDatasetImporter.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this importer. | | [`has_dataset_info`](#fiftyone.utils.data.LabeledImageDatasetImporter.has_dataset_info) | Whether this importer produces a dataset info dictionary. | **Methods:** | [`close`](#fiftyone.utils.data.LabeledImageDatasetImporter.close)(\*args) | Performs any necessary actions after the last sample has been imported. | |---------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| | [`get_dataset_info`](#fiftyone.utils.data.LabeledImageDatasetImporter.get_dataset_info)() | Returns the dataset info for the dataset. | | [`get_media_sources`](#fiftyone.utils.data.LabeledImageDatasetImporter.get_media_sources)() | Returns the media-source entries the importing dataset records before any sample is added, or None. | | [`setup`](#fiftyone.utils.data.LabeledImageDatasetImporter.setup)() | Performs any necessary setup before importing the first sample in the dataset. | #### *property* has_image_metadata Whether this importer produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each image. #### *property* label_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this importer. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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 #### close(\*args) Performs any necessary actions after the last sample has been imported. This method is called when the importer’s context manager interface is exited, `DatasetImporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetImporter.__exit__()` #### 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 #### get_media_sources() Returns the media-source entries the importing dataset records before any sample is added, or None. Only importers of media-reference-backed samples provide these; see [`fiftyone.utils.lerobot.LeRobotDatasetImporter`](fiftyone.utils.lerobot.md#fiftyone.utils.lerobot.LeRobotDatasetImporter). #### *property* has_dataset_info Whether this importer produces a dataset info dictionary. #### 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__()`. ### *class* fiftyone.utils.data.LabeledVideoDatasetImporter(dataset_dir=None, shuffle=False, seed=None, max_samples=None) Bases: [`DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter) Interface for importing datasets of labeled video samples. Typically, dataset importers should implement the parameters documented on this class, although this is not mandatory. See [this page](../user_guide/import_datasets.md#writing-a-custom-dataset-importer) for information about implementing/using dataset importers. #### \_\_len_\_() The total number of samples that will be imported. * **Raises:** **TypeError** – if the total number is not known #### \_\_next_\_() Returns information about the next sample in the dataset. * **Returns:** an `(video_path, video_metadata, labels, frames)` tuple, where - `video_path`: the path to the video on disk - `video_metadata`: an [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for the video, or `None` if [`has_video_metadata()`](#fiftyone.utils.data.LabeledVideoDatasetImporter.has_video_metadata) is `False` - `labels`: sample-level labels for the video, which can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instance - a dictionary mapping label fields to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances - `None` if the sample has no sample-level labels - `frames`: frame-level labels for the video, which can be any of the following: - a dictionary mapping frame numbers to dictionaries that map label fields to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances for each video frame - `None` if the sample has no frame-level labels * **Raises:** **StopIteration** – if there are no more samples to import * **Parameters:** * **dataset_dir** (*None*) – the dataset directory. This may be optional for some importers * **shuffle** (*False*) – whether to randomly shuffle the order in which the samples are imported * **seed** (*None*) – a random seed to use when shuffling * **max_samples** (*None*) – a maximum number of samples to import. By default, all samples are imported **Attributes:** | [`has_video_metadata`](#fiftyone.utils.data.LabeledVideoDatasetImporter.has_video_metadata) | Whether this importer produces [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for each video. | |-----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`label_cls`](#fiftyone.utils.data.LabeledVideoDatasetImporter.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this importer within the sample-level labels that it produces. | | [`frame_labels_cls`](#fiftyone.utils.data.LabeledVideoDatasetImporter.frame_labels_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this importer within the frame labels that it produces. | | [`has_dataset_info`](#fiftyone.utils.data.LabeledVideoDatasetImporter.has_dataset_info) | Whether this importer produces a dataset info dictionary. | **Methods:** | [`close`](#fiftyone.utils.data.LabeledVideoDatasetImporter.close)(\*args) | Performs any necessary actions after the last sample has been imported. | |---------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| | [`get_dataset_info`](#fiftyone.utils.data.LabeledVideoDatasetImporter.get_dataset_info)() | Returns the dataset info for the dataset. | | [`get_media_sources`](#fiftyone.utils.data.LabeledVideoDatasetImporter.get_media_sources)() | Returns the media-source entries the importing dataset records before any sample is added, or None. | | [`setup`](#fiftyone.utils.data.LabeledVideoDatasetImporter.setup)() | Performs any necessary setup before importing the first sample in the dataset. | #### *property* has_video_metadata Whether this importer produces [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for each video. #### *property* label_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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 #### *property* frame_labels_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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 #### close(\*args) Performs any necessary actions after the last sample has been imported. This method is called when the importer’s context manager interface is exited, `DatasetImporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetImporter.__exit__()` #### 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 #### get_media_sources() Returns the media-source entries the importing dataset records before any sample is added, or None. Only importers of media-reference-backed samples provide these; see [`fiftyone.utils.lerobot.LeRobotDatasetImporter`](fiftyone.utils.lerobot.md#fiftyone.utils.lerobot.LeRobotDatasetImporter). #### *property* has_dataset_info Whether this importer produces a dataset info dictionary. #### 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__()`. ### *class* fiftyone.utils.data.LegacyFiftyOneDatasetImporter(dataset_dir, rel_dir=None, import_saved_views=True, import_runs=True, import_workspaces=True, shuffle=False, seed=None, max_samples=None) Bases: [`GenericSampleDatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.GenericSampleDatasetImporter) Legacy importer for FiftyOne datasets stored on disk in a serialized JSON format. #### WARNING The [`fiftyone.types.FiftyOneDataset`](fiftyone.types.md#fiftyone.types.FiftyOneDataset) format was upgraded in `fiftyone==0.8` and this importer is now deprecated. However, to maintain backwards compatibility, [`FiftyOneDatasetImporter`](#fiftyone.utils.data.FiftyOneDatasetImporter) will check for instances of datasets of this type at runtime and defer to this class to load them. * **Parameters:** * **dataset_dir** – the dataset directory * **rel_dir** (*None*) – a relative directory to prepend to each filepath if it is not absolute. This path is converted to an absolute path (if necessary) via [`fiftyone.core.storage.normalize_path()`](fiftyone.core.storage.md#fiftyone.core.storage.normalize_path) * **import_saved_views** (*True*) – whether to include saved views in the import. Only applicable when importing full datasets * **import_runs** (*True*) – whether to include annotation/brain/evaluation runs in the import. Only applicable when importing full datasets * **import_workspaces** (*True*) – whether to include saved workspaces in the import. Only applicable when importing full datasets * **shuffle** (*False*) – whether to randomly shuffle the order in which the samples are imported * **seed** (*None*) – a random seed to use when shuffling * **max_samples** (*None*) – a maximum number of samples to import. By default, all samples are imported **Attributes:** | [`has_sample_field_schema`](#fiftyone.utils.data.LegacyFiftyOneDatasetImporter.has_sample_field_schema) | Whether this importer produces a sample field schema. | |-----------------------------------------------------------------------------------------------------------|-----------------------------------------------------------| | [`has_dataset_info`](#fiftyone.utils.data.LegacyFiftyOneDatasetImporter.has_dataset_info) | Whether this importer produces a dataset info dictionary. | **Methods:** | [`setup`](#fiftyone.utils.data.LegacyFiftyOneDatasetImporter.setup)() | Performs any necessary setup before importing the first sample in the dataset. | |-----------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| | [`get_sample_field_schema`](#fiftyone.utils.data.LegacyFiftyOneDatasetImporter.get_sample_field_schema)() | Returns a dictionary describing the field schema of the samples loaded by this importer. | | [`get_dataset_info`](#fiftyone.utils.data.LegacyFiftyOneDatasetImporter.get_dataset_info)() | Returns the dataset info for the dataset. | | [`import_extras`](#fiftyone.utils.data.LegacyFiftyOneDatasetImporter.import_extras)(sample_collection) | | | [`close`](#fiftyone.utils.data.LegacyFiftyOneDatasetImporter.close)(\*args) | Performs any necessary actions after the last sample has been imported. | | [`get_media_sources`](#fiftyone.utils.data.LegacyFiftyOneDatasetImporter.get_media_sources)() | Returns the media-source entries the importing dataset records before any sample is added, or None. | #### *property* has_sample_field_schema Whether this importer produces a sample field schema. #### *property* has_dataset_info Whether this importer produces a dataset info dictionary. #### 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__()`. #### get_sample_field_schema() Returns a dictionary describing the field schema of the samples loaded by this importer. * **Returns:** a dict mapping field names to [`fiftyone.core.fields.Field`](fiftyone.core.fields.md#fiftyone.core.fields.Field) instances or `str(field)` representations of them #### 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 #### import_extras(sample_collection) #### close(\*args) Performs any necessary actions after the last sample has been imported. This method is called when the importer’s context manager interface is exited, `DatasetImporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetImporter.__exit__()` #### get_media_sources() Returns the media-source entries the importing dataset records before any sample is added, or None. Only importers of media-reference-backed samples provide these; see [`fiftyone.utils.lerobot.LeRobotDatasetImporter`](fiftyone.utils.lerobot.md#fiftyone.utils.lerobot.LeRobotDatasetImporter). ### *class* fiftyone.utils.data.FiftyOneDatasetImporter(dataset_dir, rel_dir=None, import_saved_views=True, import_runs=True, import_workspaces=True, ordered=True, shuffle=False, seed=None, max_samples=None) Bases: [`BatchDatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.BatchDatasetImporter) Importer for FiftyOne datasets stored on disk in serialized JSON format. See [this page](../user_guide/import_datasets.md#fiftyonedataset-import) for format details. * **Parameters:** * **dataset_dir** – the dataset directory * **rel_dir** (*None*) – a relative directory to prepend to the `filepath` of each sample if the filepath is not absolute. This path is converted to an absolute path (if necessary) via [`fiftyone.core.storage.normalize_path()`](fiftyone.core.storage.md#fiftyone.core.storage.normalize_path) * **import_saved_views** (*True*) – whether to include saved views in the import. Only applicable when importing full datasets * **import_runs** (*True*) – whether to include annotation/brain/evaluation runs in the import. Only applicable when importing full datasets * **import_workspaces** (*True*) – whether to include saved workspaces in the import. Only applicable when importing full datasets * **ordered** (*True*) – whether to preserve document order when importing * **shuffle** (*False*) – whether to randomly shuffle the order in which the samples are imported * **seed** (*None*) – a random seed to use when shuffling * **max_samples** (*None*) – a maximum number of samples to import. By default, all samples are imported **Methods:** | [`setup`](#fiftyone.utils.data.FiftyOneDatasetImporter.setup)() | Performs any necessary setup before importing the first sample in the dataset. | |------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| | [`import_samples`](#fiftyone.utils.data.FiftyOneDatasetImporter.import_samples)(dataset[, tags, progress]) | Imports the samples into the given dataset. | | [`close`](#fiftyone.utils.data.FiftyOneDatasetImporter.close)(\*args) | Performs any necessary actions after the last sample has been imported. | | [`get_dataset_info`](#fiftyone.utils.data.FiftyOneDatasetImporter.get_dataset_info)() | Returns the dataset info for the dataset. | | [`get_media_sources`](#fiftyone.utils.data.FiftyOneDatasetImporter.get_media_sources)() | Returns the media-source entries the importing dataset records before any sample is added, or None. | **Attributes:** | [`has_dataset_info`](#fiftyone.utils.data.FiftyOneDatasetImporter.has_dataset_info) | Whether this importer produces a dataset info dictionary. | |---------------------------------------------------------------------------------------|-------------------------------------------------------------| #### 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__()`. #### import_samples(dataset, tags=None, progress=None) Imports the samples into the given dataset. * **Parameters:** * **dataset** – a [`fiftyone.core.dataset.Dataset`](fiftyone.core.dataset.md#fiftyone.core.dataset.Dataset) * **tags** (*None*) – an optional list of tags to attach to each sample * **progress** (*None*) – whether to render a progress bar (True/False), use the default value `fiftyone.config.show_progress_bars` (None), or a progress callback function to invoke instead * **Returns:** a list of IDs of the samples that were added to the dataset #### close(\*args) Performs any necessary actions after the last sample has been imported. This method is called when the importer’s context manager interface is exited, `DatasetImporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetImporter.__exit__()` #### 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 #### get_media_sources() Returns the media-source entries the importing dataset records before any sample is added, or None. Only importers of media-reference-backed samples provide these; see [`fiftyone.utils.lerobot.LeRobotDatasetImporter`](fiftyone.utils.lerobot.md#fiftyone.utils.lerobot.LeRobotDatasetImporter). #### *property* has_dataset_info Whether this importer produces a dataset info dictionary. ### *class* fiftyone.utils.data.ImageDirectoryImporter(dataset_dir, recursive=True, compute_metadata=False, shuffle=False, seed=None, max_samples=None) Bases: [`UnlabeledImageDatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.UnlabeledImageDatasetImporter) Importer for a directory of images stored on disk. See [this page](../user_guide/import_datasets.md#imagedirectory-import) for format details. * **Parameters:** * **dataset_dir** – the dataset directory * **recursive** (*True*) – whether to recursively traverse subdirectories * **compute_metadata** (*False*) – whether to produce [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each image when importing * **shuffle** (*False*) – whether to randomly shuffle the order in which the samples are imported * **seed** (*None*) – a random seed to use when shuffling * **max_samples** (*None*) – a maximum number of samples to import. By default, all samples are imported **Attributes:** | [`has_dataset_info`](#fiftyone.utils.data.ImageDirectoryImporter.has_dataset_info) | Whether this importer produces a dataset info dictionary. | |----------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`has_image_metadata`](#fiftyone.utils.data.ImageDirectoryImporter.has_image_metadata) | Whether this importer produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each image. | **Methods:** | [`setup`](#fiftyone.utils.data.ImageDirectoryImporter.setup)() | Performs any necessary setup before importing the first sample in the dataset. | |----------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| | [`close`](#fiftyone.utils.data.ImageDirectoryImporter.close)(\*args) | Performs any necessary actions after the last sample has been imported. | | [`get_dataset_info`](#fiftyone.utils.data.ImageDirectoryImporter.get_dataset_info)() | Returns the dataset info for the dataset. | | [`get_media_sources`](#fiftyone.utils.data.ImageDirectoryImporter.get_media_sources)() | Returns the media-source entries the importing dataset records before any sample is added, or None. | #### *property* has_dataset_info Whether this importer produces a dataset info dictionary. #### *property* has_image_metadata Whether this importer produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each image. #### 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__()`. #### close(\*args) Performs any necessary actions after the last sample has been imported. This method is called when the importer’s context manager interface is exited, `DatasetImporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetImporter.__exit__()` #### 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 #### get_media_sources() Returns the media-source entries the importing dataset records before any sample is added, or None. Only importers of media-reference-backed samples provide these; see [`fiftyone.utils.lerobot.LeRobotDatasetImporter`](fiftyone.utils.lerobot.md#fiftyone.utils.lerobot.LeRobotDatasetImporter). ### *class* fiftyone.utils.data.VideoDirectoryImporter(dataset_dir, recursive=True, compute_metadata=False, shuffle=False, seed=None, max_samples=None) Bases: [`UnlabeledVideoDatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.UnlabeledVideoDatasetImporter) Importer for a directory of videos stored on disk. See [this page](../user_guide/import_datasets.md#videodirectory-import) for format details. * **Parameters:** * **dataset_dir** – the dataset directory * **recursive** (*True*) – whether to recursively traverse subdirectories * **compute_metadata** (*False*) – whether to produce [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for each video when importing * **shuffle** (*False*) – whether to randomly shuffle the order in which the samples are imported * **seed** (*None*) – a random seed to use when shuffling * **max_samples** (*None*) – a maximum number of samples to import. By default, all samples are imported **Attributes:** | [`has_dataset_info`](#fiftyone.utils.data.VideoDirectoryImporter.has_dataset_info) | Whether this importer produces a dataset info dictionary. | |----------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`has_video_metadata`](#fiftyone.utils.data.VideoDirectoryImporter.has_video_metadata) | Whether this importer produces [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for each video. | **Methods:** | [`setup`](#fiftyone.utils.data.VideoDirectoryImporter.setup)() | Performs any necessary setup before importing the first sample in the dataset. | |----------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| | [`close`](#fiftyone.utils.data.VideoDirectoryImporter.close)(\*args) | Performs any necessary actions after the last sample has been imported. | | [`get_dataset_info`](#fiftyone.utils.data.VideoDirectoryImporter.get_dataset_info)() | Returns the dataset info for the dataset. | | [`get_media_sources`](#fiftyone.utils.data.VideoDirectoryImporter.get_media_sources)() | Returns the media-source entries the importing dataset records before any sample is added, or None. | #### *property* has_dataset_info Whether this importer produces a dataset info dictionary. #### *property* has_video_metadata Whether this importer produces [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for each video. #### 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__()`. #### close(\*args) Performs any necessary actions after the last sample has been imported. This method is called when the importer’s context manager interface is exited, `DatasetImporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetImporter.__exit__()` #### 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 #### get_media_sources() Returns the media-source entries the importing dataset records before any sample is added, or None. Only importers of media-reference-backed samples provide these; see [`fiftyone.utils.lerobot.LeRobotDatasetImporter`](fiftyone.utils.lerobot.md#fiftyone.utils.lerobot.LeRobotDatasetImporter). ### *class* fiftyone.utils.data.MediaDirectoryImporter(dataset_dir, recursive=True, compute_metadata=False, shuffle=False, seed=None, max_samples=None) Bases: [`UnlabeledMediaDatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.UnlabeledMediaDatasetImporter) Importer for a directory of media files stored on disk. See [this page](../user_guide/import_datasets.md#mediadirectory-import) for format details. * **Parameters:** * **dataset_dir** – the dataset directory * **recursive** (*True*) – whether to recursively traverse subdirectories * **compute_metadata** (*False*) – whether to produce [`fiftyone.core.metadata.Metadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.Metadata) instances for each media file when importing * **shuffle** (*False*) – whether to randomly shuffle the order in which the samples are imported * **seed** (*None*) – a random seed to use when shuffling * **max_samples** (*None*) – a maximum number of samples to import. By default, all samples are imported **Attributes:** | [`has_dataset_info`](#fiftyone.utils.data.MediaDirectoryImporter.has_dataset_info) | Whether this importer produces a dataset info dictionary. | |--------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| | [`has_metadata`](#fiftyone.utils.data.MediaDirectoryImporter.has_metadata) | Whether this importer produces [`fiftyone.core.metadata.Metadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.Metadata) instances for each sample. | **Methods:** | [`setup`](#fiftyone.utils.data.MediaDirectoryImporter.setup)() | Performs any necessary setup before importing the first sample in the dataset. | |----------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| | [`close`](#fiftyone.utils.data.MediaDirectoryImporter.close)(\*args) | Performs any necessary actions after the last sample has been imported. | | [`get_dataset_info`](#fiftyone.utils.data.MediaDirectoryImporter.get_dataset_info)() | Returns the dataset info for the dataset. | | [`get_media_sources`](#fiftyone.utils.data.MediaDirectoryImporter.get_media_sources)() | Returns the media-source entries the importing dataset records before any sample is added, or None. | #### *property* has_dataset_info Whether this importer produces a dataset info dictionary. #### *property* has_metadata Whether this importer produces [`fiftyone.core.metadata.Metadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.Metadata) instances for each sample. #### 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__()`. #### close(\*args) Performs any necessary actions after the last sample has been imported. This method is called when the importer’s context manager interface is exited, `DatasetImporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetImporter.__exit__()` #### 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 #### get_media_sources() Returns the media-source entries the importing dataset records before any sample is added, or None. Only importers of media-reference-backed samples provide these; see [`fiftyone.utils.lerobot.LeRobotDatasetImporter`](fiftyone.utils.lerobot.md#fiftyone.utils.lerobot.LeRobotDatasetImporter). ### *class* fiftyone.utils.data.FiftyOneImageClassificationDatasetImporter(dataset_dir=None, data_path=None, labels_path=None, compute_metadata=False, include_all_data=False, shuffle=False, seed=None, max_samples=None) Bases: [`LabeledImageDatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LabeledImageDatasetImporter), [`ImportPathsMixin`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.ImportPathsMixin) Importer for image classification datasets stored on disk in a simple JSON format. See [this page](../user_guide/import_datasets.md#fiftyoneimageclassificationdataset-import) for format details. * **Parameters:** * **dataset_dir** (*None*) – the dataset directory. If omitted, `data_path` and/or `labels_path` must be provided * **data_path** (*None*) – 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** (*None*) – an optional parameter that enables explicit control over the location of the labels. Can be any of the following: - a filename like `"labels.json"` specifying the location of the labels in `dataset_dir` - an absolute filepath 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.json` * **compute_metadata** (*False*) – whether to produce [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each image when importing * **include_all_data** (*False*) – whether to generate samples for all images in the data directory (True) rather than only creating samples for images with labels (False) * **shuffle** (*False*) – whether to randomly shuffle the order in which the samples are imported * **seed** (*None*) – a random seed to use when shuffling * **max_samples** (*None*) – a maximum number of samples to import. By default, all samples are imported **Attributes:** | [`has_dataset_info`](#fiftyone.utils.data.FiftyOneImageClassificationDatasetImporter.has_dataset_info) | Whether this importer produces a dataset info dictionary. | |------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`has_image_metadata`](#fiftyone.utils.data.FiftyOneImageClassificationDatasetImporter.has_image_metadata) | Whether this importer produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each image. | | [`label_cls`](#fiftyone.utils.data.FiftyOneImageClassificationDatasetImporter.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this importer. | **Methods:** | [`setup`](#fiftyone.utils.data.FiftyOneImageClassificationDatasetImporter.setup)() | Performs any necessary setup before importing the first sample in the dataset. | |------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| | [`get_dataset_info`](#fiftyone.utils.data.FiftyOneImageClassificationDatasetImporter.get_dataset_info)() | Returns the dataset info for the dataset. | | [`close`](#fiftyone.utils.data.FiftyOneImageClassificationDatasetImporter.close)(\*args) | Performs any necessary actions after the last sample has been imported. | | [`get_media_sources`](#fiftyone.utils.data.FiftyOneImageClassificationDatasetImporter.get_media_sources)() | Returns the media-source entries the importing dataset records before any sample is added, or None. | #### *property* has_dataset_info Whether this importer produces a dataset info dictionary. #### *property* has_image_metadata Whether this importer produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each image. #### *property* label_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this importer. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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 #### 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__()`. #### 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 #### close(\*args) Performs any necessary actions after the last sample has been imported. This method is called when the importer’s context manager interface is exited, `DatasetImporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetImporter.__exit__()` #### get_media_sources() Returns the media-source entries the importing dataset records before any sample is added, or None. Only importers of media-reference-backed samples provide these; see [`fiftyone.utils.lerobot.LeRobotDatasetImporter`](fiftyone.utils.lerobot.md#fiftyone.utils.lerobot.LeRobotDatasetImporter). ### *class* fiftyone.utils.data.ImageClassificationDirectoryTreeImporter(dataset_dir, compute_metadata=False, classes=None, unlabeled='_unlabeled', shuffle=False, seed=None, max_samples=None) Bases: [`LabeledImageDatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LabeledImageDatasetImporter) Importer for an image classification directory tree stored on disk. See [this page](../user_guide/import_datasets.md#imageclassificationdirectorytree-import) for format details. * **Parameters:** * **dataset_dir** – the dataset directory * **compute_metadata** (*False*) – whether to produce [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each image when importing * **classes** (*None*) – an optional string or list of strings specifying a subset of classes to load * **unlabeled** ( *"_unlabeled"*) – the name of the subdirectory containing unlabeled images * **shuffle** (*False*) – whether to randomly shuffle the order in which the samples are imported * **seed** (*None*) – a random seed to use when shuffling * **max_samples** (*None*) – a maximum number of samples to import. By default, all samples are imported **Attributes:** | [`has_image_metadata`](#fiftyone.utils.data.ImageClassificationDirectoryTreeImporter.has_image_metadata) | Whether this importer produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each image. | |------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`has_dataset_info`](#fiftyone.utils.data.ImageClassificationDirectoryTreeImporter.has_dataset_info) | Whether this importer produces a dataset info dictionary. | | [`label_cls`](#fiftyone.utils.data.ImageClassificationDirectoryTreeImporter.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this importer. | **Methods:** | [`setup`](#fiftyone.utils.data.ImageClassificationDirectoryTreeImporter.setup)() | Performs any necessary setup before importing the first sample in the dataset. | |----------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| | [`get_dataset_info`](#fiftyone.utils.data.ImageClassificationDirectoryTreeImporter.get_dataset_info)() | Returns the dataset info for the dataset. | | [`close`](#fiftyone.utils.data.ImageClassificationDirectoryTreeImporter.close)(\*args) | Performs any necessary actions after the last sample has been imported. | | [`get_media_sources`](#fiftyone.utils.data.ImageClassificationDirectoryTreeImporter.get_media_sources)() | Returns the media-source entries the importing dataset records before any sample is added, or None. | #### *property* has_image_metadata Whether this importer produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each image. #### *property* has_dataset_info Whether this importer produces a dataset info dictionary. #### *property* label_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this importer. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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 #### 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__()`. #### 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 #### close(\*args) Performs any necessary actions after the last sample has been imported. This method is called when the importer’s context manager interface is exited, `DatasetImporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetImporter.__exit__()` #### get_media_sources() Returns the media-source entries the importing dataset records before any sample is added, or None. Only importers of media-reference-backed samples provide these; see [`fiftyone.utils.lerobot.LeRobotDatasetImporter`](fiftyone.utils.lerobot.md#fiftyone.utils.lerobot.LeRobotDatasetImporter). ### *class* fiftyone.utils.data.VideoClassificationDirectoryTreeImporter(dataset_dir, compute_metadata=False, classes=None, unlabeled='_unlabeled', shuffle=False, seed=None, max_samples=None) Bases: [`LabeledVideoDatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LabeledVideoDatasetImporter) Importer for a viideo classification directory tree stored on disk. See [this page](../user_guide/import_datasets.md#videoclassificationdirectorytree-import) for format details. * **Parameters:** * **dataset_dir** – the dataset directory * **compute_metadata** (*False*) – whether to produce [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for each video when importing * **classes** (*None*) – an optional string or list of strings specifying a subset of classes to load * **unlabeled** ( *"_unlabeled"*) – the name of the subdirectory containing unlabeled images * **shuffle** (*False*) – whether to randomly shuffle the order in which the samples are imported * **seed** (*None*) – a random seed to use when shuffling * **max_samples** (*None*) – a maximum number of samples to import. By default, all samples are imported **Attributes:** | [`has_video_metadata`](#fiftyone.utils.data.VideoClassificationDirectoryTreeImporter.has_video_metadata) | Whether this importer produces [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for each video. | |------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`has_dataset_info`](#fiftyone.utils.data.VideoClassificationDirectoryTreeImporter.has_dataset_info) | Whether this importer produces a dataset info dictionary. | | [`label_cls`](#fiftyone.utils.data.VideoClassificationDirectoryTreeImporter.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this importer within the sample-level labels that it produces. | | [`frame_labels_cls`](#fiftyone.utils.data.VideoClassificationDirectoryTreeImporter.frame_labels_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this importer within the frame labels that it produces. | **Methods:** | [`setup`](#fiftyone.utils.data.VideoClassificationDirectoryTreeImporter.setup)() | Performs any necessary setup before importing the first sample in the dataset. | |----------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| | [`get_dataset_info`](#fiftyone.utils.data.VideoClassificationDirectoryTreeImporter.get_dataset_info)() | Returns the dataset info for the dataset. | | [`close`](#fiftyone.utils.data.VideoClassificationDirectoryTreeImporter.close)(\*args) | Performs any necessary actions after the last sample has been imported. | | [`get_media_sources`](#fiftyone.utils.data.VideoClassificationDirectoryTreeImporter.get_media_sources)() | Returns the media-source entries the importing dataset records before any sample is added, or None. | #### *property* has_video_metadata Whether this importer produces [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for each video. #### *property* has_dataset_info Whether this importer produces a dataset info dictionary. #### *property* label_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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 #### *property* frame_labels_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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 #### 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__()`. #### 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 #### close(\*args) Performs any necessary actions after the last sample has been imported. This method is called when the importer’s context manager interface is exited, `DatasetImporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetImporter.__exit__()` #### get_media_sources() Returns the media-source entries the importing dataset records before any sample is added, or None. Only importers of media-reference-backed samples provide these; see [`fiftyone.utils.lerobot.LeRobotDatasetImporter`](fiftyone.utils.lerobot.md#fiftyone.utils.lerobot.LeRobotDatasetImporter). ### *class* fiftyone.utils.data.FiftyOneImageDetectionDatasetImporter(dataset_dir=None, data_path=None, labels_path=None, compute_metadata=False, include_all_data=False, shuffle=False, seed=None, max_samples=None) Bases: [`LabeledImageDatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LabeledImageDatasetImporter), [`ImportPathsMixin`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.ImportPathsMixin) Importer for image detection datasets stored on disk in a simple JSON format. See [this page](../user_guide/import_datasets.md#fiftyoneimagedetectiondataset-import) for format details. * **Parameters:** * **dataset_dir** (*None*) – the dataset directory. If omitted, `data_path` and/or `labels_path` must be provided * **data_path** (*None*) – 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** (*None*) – an optional parameter that enables explicit control over the location of the labels. Can be any of the following: - a filename like `"labels.json"` specifying the location of the labels in `dataset_dir` - an absolute filepath 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.json` * **compute_metadata** (*False*) – whether to produce [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each image when importing * **include_all_data** (*False*) – whether to generate samples for all images in the data directory (True) rather than only creating samples for images with labels (False) * **shuffle** (*False*) – whether to randomly shuffle the order in which the samples are imported * **seed** (*None*) – a random seed to use when shuffling * **max_samples** (*None*) – a maximum number of samples to import. By default, all samples are imported **Attributes:** | [`has_dataset_info`](#fiftyone.utils.data.FiftyOneImageDetectionDatasetImporter.has_dataset_info) | Whether this importer produces a dataset info dictionary. | |-------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`has_image_metadata`](#fiftyone.utils.data.FiftyOneImageDetectionDatasetImporter.has_image_metadata) | Whether this importer produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each image. | | [`label_cls`](#fiftyone.utils.data.FiftyOneImageDetectionDatasetImporter.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this importer. | **Methods:** | [`setup`](#fiftyone.utils.data.FiftyOneImageDetectionDatasetImporter.setup)() | Performs any necessary setup before importing the first sample in the dataset. | |-------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| | [`get_dataset_info`](#fiftyone.utils.data.FiftyOneImageDetectionDatasetImporter.get_dataset_info)() | Returns the dataset info for the dataset. | | [`close`](#fiftyone.utils.data.FiftyOneImageDetectionDatasetImporter.close)(\*args) | Performs any necessary actions after the last sample has been imported. | | [`get_media_sources`](#fiftyone.utils.data.FiftyOneImageDetectionDatasetImporter.get_media_sources)() | Returns the media-source entries the importing dataset records before any sample is added, or None. | #### *property* has_dataset_info Whether this importer produces a dataset info dictionary. #### *property* has_image_metadata Whether this importer produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each image. #### *property* label_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this importer. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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 #### 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__()`. #### 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 #### close(\*args) Performs any necessary actions after the last sample has been imported. This method is called when the importer’s context manager interface is exited, `DatasetImporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetImporter.__exit__()` #### get_media_sources() Returns the media-source entries the importing dataset records before any sample is added, or None. Only importers of media-reference-backed samples provide these; see [`fiftyone.utils.lerobot.LeRobotDatasetImporter`](fiftyone.utils.lerobot.md#fiftyone.utils.lerobot.LeRobotDatasetImporter). ### *class* fiftyone.utils.data.FiftyOneTemporalDetectionDatasetImporter(dataset_dir=None, data_path=None, labels_path=None, compute_metadata=False, include_all_data=False, shuffle=False, seed=None, max_samples=None) Bases: [`LabeledVideoDatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LabeledVideoDatasetImporter), [`ImportPathsMixin`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.ImportPathsMixin) Importer for temporal video detection datasets stored on disk in a simple JSON format. See [this page](../user_guide/import_datasets.md#fiftyonetemporaldetectiondataset-import) for format details. * **Parameters:** * **dataset_dir** (*None*) – the dataset directory. If omitted, `data_path` and/or `labels_path` must be provided * **data_path** (*None*) – 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** (*None*) – an optional parameter that enables explicit control over the location of the labels. Can be any of the following: - a filename like `"labels.json"` specifying the location of the labels in `dataset_dir` - an absolute filepath 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.json` * **compute_metadata** (*False*) – whether to produce [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for each video when importing * **include_all_data** (*False*) – whether to generate samples for all videos in the data directory (True) rather than only creating samples for videos with labels (False) * **shuffle** (*False*) – whether to randomly shuffle the order in which the samples are imported * **seed** (*None*) – a random seed to use when shuffling * **max_samples** (*None*) – a maximum number of samples to import. By default, all samples are imported **Attributes:** | [`has_dataset_info`](#fiftyone.utils.data.FiftyOneTemporalDetectionDatasetImporter.has_dataset_info) | Whether this importer produces a dataset info dictionary. | |----------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`has_video_metadata`](#fiftyone.utils.data.FiftyOneTemporalDetectionDatasetImporter.has_video_metadata) | Whether this importer produces [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for each video. | | [`label_cls`](#fiftyone.utils.data.FiftyOneTemporalDetectionDatasetImporter.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this importer within the sample-level labels that it produces. | | [`frame_labels_cls`](#fiftyone.utils.data.FiftyOneTemporalDetectionDatasetImporter.frame_labels_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this importer within the frame labels that it produces. | **Methods:** | [`setup`](#fiftyone.utils.data.FiftyOneTemporalDetectionDatasetImporter.setup)() | Performs any necessary setup before importing the first sample in the dataset. | |----------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| | [`get_dataset_info`](#fiftyone.utils.data.FiftyOneTemporalDetectionDatasetImporter.get_dataset_info)() | Returns the dataset info for the dataset. | | [`close`](#fiftyone.utils.data.FiftyOneTemporalDetectionDatasetImporter.close)(\*args) | Performs any necessary actions after the last sample has been imported. | | [`get_media_sources`](#fiftyone.utils.data.FiftyOneTemporalDetectionDatasetImporter.get_media_sources)() | Returns the media-source entries the importing dataset records before any sample is added, or None. | #### *property* has_dataset_info Whether this importer produces a dataset info dictionary. #### *property* has_video_metadata Whether this importer produces [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for each video. #### *property* label_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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 #### *property* frame_labels_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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 #### 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__()`. #### 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 #### close(\*args) Performs any necessary actions after the last sample has been imported. This method is called when the importer’s context manager interface is exited, `DatasetImporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetImporter.__exit__()` #### get_media_sources() Returns the media-source entries the importing dataset records before any sample is added, or None. Only importers of media-reference-backed samples provide these; see [`fiftyone.utils.lerobot.LeRobotDatasetImporter`](fiftyone.utils.lerobot.md#fiftyone.utils.lerobot.LeRobotDatasetImporter). ### *class* fiftyone.utils.data.ImageSegmentationDirectoryImporter(dataset_dir=None, data_path=None, labels_path=None, load_masks=False, force_grayscale=False, compute_metadata=False, include_all_data=False, shuffle=False, seed=None, max_samples=None) Bases: [`LabeledImageDatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LabeledImageDatasetImporter), [`ImportPathsMixin`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.ImportPathsMixin) Importer for image segmentation datasets stored on disk. See [this page](../user_guide/import_datasets.md#imagesegmentationdirectory-import) for format details. * **Parameters:** * **dataset_dir** (*None*) – the dataset directory. If omitted, `data_path` and/or `labels_path` must be provided * **data_path** (*None*) – 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** (*None*) – 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 filepath 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/` * **load_masks** (*False*) – whether to load the masks into the database (True) or simply record the paths to the masks (False) * **force_grayscale** (*False*) – whether to load RGB masks as grayscale by storing only the first channel * **compute_metadata** (*False*) – whether to produce [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each image when importing * **include_all_data** (*False*) – whether to generate samples for all images in the data directory (True) rather than only creating samples for images with masks (False) * **shuffle** (*False*) – whether to randomly shuffle the order in which the samples are imported * **seed** (*None*) – a random seed to use when shuffling * **max_samples** (*None*) – a maximum number of samples to import. By default, all samples are imported **Attributes:** | [`has_dataset_info`](#fiftyone.utils.data.ImageSegmentationDirectoryImporter.has_dataset_info) | Whether this importer produces a dataset info dictionary. | |----------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`has_image_metadata`](#fiftyone.utils.data.ImageSegmentationDirectoryImporter.has_image_metadata) | Whether this importer produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each image. | | [`label_cls`](#fiftyone.utils.data.ImageSegmentationDirectoryImporter.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this importer. | **Methods:** | [`setup`](#fiftyone.utils.data.ImageSegmentationDirectoryImporter.setup)() | Performs any necessary setup before importing the first sample in the dataset. | |----------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| | [`close`](#fiftyone.utils.data.ImageSegmentationDirectoryImporter.close)(\*args) | Performs any necessary actions after the last sample has been imported. | | [`get_dataset_info`](#fiftyone.utils.data.ImageSegmentationDirectoryImporter.get_dataset_info)() | Returns the dataset info for the dataset. | | [`get_media_sources`](#fiftyone.utils.data.ImageSegmentationDirectoryImporter.get_media_sources)() | Returns the media-source entries the importing dataset records before any sample is added, or None. | #### *property* has_dataset_info Whether this importer produces a dataset info dictionary. #### *property* has_image_metadata Whether this importer produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each image. #### *property* label_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this importer. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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 #### 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__()`. #### close(\*args) Performs any necessary actions after the last sample has been imported. This method is called when the importer’s context manager interface is exited, `DatasetImporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetImporter.__exit__()` #### 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 #### get_media_sources() Returns the media-source entries the importing dataset records before any sample is added, or None. Only importers of media-reference-backed samples provide these; see [`fiftyone.utils.lerobot.LeRobotDatasetImporter`](fiftyone.utils.lerobot.md#fiftyone.utils.lerobot.LeRobotDatasetImporter). ### *class* fiftyone.utils.data.FiftyOneImageLabelsDatasetImporter(dataset_dir, compute_metadata=False, prefix=None, labels_dict=None, multilabel=False, skip_non_categorical=False, shuffle=False, seed=None, max_samples=None) Bases: [`LabeledImageDatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LabeledImageDatasetImporter) Importer for labeled image datasets whose labels are stored in [ETA ImageLabels format](https://github.com/voxel51/eta/blob/main/docs/image_labels_guide.md). See [this page](../user_guide/import_datasets.md#fiftyoneimagelabelsdataset-import) for format details. * **Parameters:** * **dataset_dir** – the dataset directory * **compute_metadata** (*False*) – whether to produce [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each image when importing * **prefix** (*None*) – a string prefix to prepend to each label name in the expanded label dictionary * **labels_dict** (*None*) – a dictionary mapping names of attributes/objects in the image labels to field names into which to expand them * **multilabel** (*False*) – whether to store frame attributes in a single [`fiftyone.core.labels.Classifications`](fiftyone.core.labels.md#fiftyone.core.labels.Classifications) instance * **skip_non_categorical** (*False*) – whether to skip non-categorical frame attributes (True) or cast them to strings (False) * **shuffle** (*False*) – whether to randomly shuffle the order in which the samples are imported * **seed** (*None*) – a random seed to use when shuffling * **max_samples** (*None*) – a maximum number of samples to import. By default, all samples are imported **Attributes:** | [`has_dataset_info`](#fiftyone.utils.data.FiftyOneImageLabelsDatasetImporter.has_dataset_info) | Whether this importer produces a dataset info dictionary. | |----------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`has_image_metadata`](#fiftyone.utils.data.FiftyOneImageLabelsDatasetImporter.has_image_metadata) | Whether this importer produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each image. | | [`label_cls`](#fiftyone.utils.data.FiftyOneImageLabelsDatasetImporter.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this importer. | **Methods:** | [`setup`](#fiftyone.utils.data.FiftyOneImageLabelsDatasetImporter.setup)() | Performs any necessary setup before importing the first sample in the dataset. | |----------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| | [`get_dataset_info`](#fiftyone.utils.data.FiftyOneImageLabelsDatasetImporter.get_dataset_info)() | Returns the dataset info for the dataset. | | [`close`](#fiftyone.utils.data.FiftyOneImageLabelsDatasetImporter.close)(\*args) | Performs any necessary actions after the last sample has been imported. | | [`get_media_sources`](#fiftyone.utils.data.FiftyOneImageLabelsDatasetImporter.get_media_sources)() | Returns the media-source entries the importing dataset records before any sample is added, or None. | #### *property* has_dataset_info Whether this importer produces a dataset info dictionary. #### *property* has_image_metadata Whether this importer produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each image. #### *property* label_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this importer. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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 #### 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__()`. #### 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 #### close(\*args) Performs any necessary actions after the last sample has been imported. This method is called when the importer’s context manager interface is exited, `DatasetImporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetImporter.__exit__()` #### get_media_sources() Returns the media-source entries the importing dataset records before any sample is added, or None. Only importers of media-reference-backed samples provide these; see [`fiftyone.utils.lerobot.LeRobotDatasetImporter`](fiftyone.utils.lerobot.md#fiftyone.utils.lerobot.LeRobotDatasetImporter). ### *class* fiftyone.utils.data.FiftyOneVideoLabelsDatasetImporter(dataset_dir, compute_metadata=False, prefix=None, labels_dict=None, frame_labels_dict=None, multilabel=False, skip_non_categorical=False, shuffle=False, seed=None, max_samples=None) Bases: [`LabeledVideoDatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LabeledVideoDatasetImporter) Importer for labeled video datasets whose labels are stored in [ETA VideoLabels format](https://github.com/voxel51/eta/blob/main/docs/video_labels_guide.md). See [this page](../user_guide/import_datasets.md#fiftyonevideolabelsdataset-import) for format details. * **Parameters:** * **dataset_dir** – the dataset directory * **compute_metadata** (*False*) – whether to produce [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for each video when importing * **prefix** (*None*) – a string prefix to prepend to each label name in the expanded sample/frame label dictionaries * **labels_dict** (*None*) – a dictionary mapping names of attributes/objects in the sample labels to field names into which to expand them. By default, all sample labels are loaded * **frame_labels_dict** (*None*) – a dictionary mapping names of attributes/objects in the frame labels to field names into which to expand them. By default, all frame labels are loaded * **multilabel** (*False*) – whether to store frame attributes in a single [`fiftyone.core.labels.Classifications`](fiftyone.core.labels.md#fiftyone.core.labels.Classifications) instance * **skip_non_categorical** (*False*) – whether to skip non-categorical frame attributes (True) or cast them to strings (False) * **shuffle** (*False*) – whether to randomly shuffle the order in which the samples are imported * **seed** (*None*) – a random seed to use when shuffling * **max_samples** (*None*) – a maximum number of samples to import. By default, all samples are imported **Attributes:** | [`has_dataset_info`](#fiftyone.utils.data.FiftyOneVideoLabelsDatasetImporter.has_dataset_info) | Whether this importer produces a dataset info dictionary. | |----------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`has_video_metadata`](#fiftyone.utils.data.FiftyOneVideoLabelsDatasetImporter.has_video_metadata) | Whether this importer produces [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for each video. | | [`label_cls`](#fiftyone.utils.data.FiftyOneVideoLabelsDatasetImporter.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this importer within the sample-level labels that it produces. | | [`frame_labels_cls`](#fiftyone.utils.data.FiftyOneVideoLabelsDatasetImporter.frame_labels_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this importer within the frame labels that it produces. | **Methods:** | [`setup`](#fiftyone.utils.data.FiftyOneVideoLabelsDatasetImporter.setup)() | Performs any necessary setup before importing the first sample in the dataset. | |----------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| | [`get_dataset_info`](#fiftyone.utils.data.FiftyOneVideoLabelsDatasetImporter.get_dataset_info)() | Returns the dataset info for the dataset. | | [`close`](#fiftyone.utils.data.FiftyOneVideoLabelsDatasetImporter.close)(\*args) | Performs any necessary actions after the last sample has been imported. | | [`get_media_sources`](#fiftyone.utils.data.FiftyOneVideoLabelsDatasetImporter.get_media_sources)() | Returns the media-source entries the importing dataset records before any sample is added, or None. | #### *property* has_dataset_info Whether this importer produces a dataset info dictionary. #### *property* has_video_metadata Whether this importer produces [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for each video. #### *property* label_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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 #### *property* frame_labels_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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 #### 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__()`. #### 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 #### close(\*args) Performs any necessary actions after the last sample has been imported. This method is called when the importer’s context manager interface is exited, `DatasetImporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetImporter.__exit__()` #### get_media_sources() Returns the media-source entries the importing dataset records before any sample is added, or None. Only importers of media-reference-backed samples provide these; see [`fiftyone.utils.lerobot.LeRobotDatasetImporter`](fiftyone.utils.lerobot.md#fiftyone.utils.lerobot.LeRobotDatasetImporter). ### *class* fiftyone.utils.data.ImageIngestor(dataset_dir, image_format=None) Bases: `object` Mixin for [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter) instances that ingest images into the provided `dataset_dir` during import. * **Parameters:** * **dataset_dir** – the directory where input images will be ingested into * **image_format** (*None*) – the image format to use when writing in-memory images to disk. By default, `fiftyone.config.default_image_ext` is used ### *class* fiftyone.utils.data.UnlabeledImageDatasetIngestor(dataset_dir, samples, sample_parser, image_format=None, max_samples=None) Bases: [`UnlabeledImageDatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.UnlabeledImageDatasetImporter), [`ImageIngestor`](fiftyone.utils.data.ingestors.md#fiftyone.utils.data.ingestors.ImageIngestor) Dataset importer that ingests unlabeled images into the provided `dataset_dir` during import. The source images are parsed from the provided `samples` using the provided [`fiftyone.utils.data.parsers.UnlabeledImageSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.UnlabeledImageSampleParser). If an image path is available via [`fiftyone.utils.data.parsers.UnlabeledImageSampleParser.get_image_path()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.UnlabeledImageSampleParser.get_image_path), then the image is directly copied from its source location into `dataset_dir`. In this case, the original filename is maintained, unless a name conflict would occur, in which case an index of the form `"-%d" % count` is appended to the base filename. If no image path is available, the image is read in-memory via [`fiftyone.utils.data.parsers.UnlabeledImageSampleParser.get_image()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.UnlabeledImageSampleParser.get_image) and written to `dataset_dir` in the following format: ```default / ``` where `image_count` is the number of files in `dataset_dir`. * **Parameters:** * **dataset_dir** – the directory where input images will be ingested into * **samples** – an iterable of samples that can be parsed by `sample_parser` * **sample_parser** – an [`fiftyone.utils.data.parsers.UnlabeledImageSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.UnlabeledImageSampleParser) to use to parse the samples * **image_format** (*None*) – the image format to use when writing in-memory images to disk. By default, `fiftyone.config.default_image_ext` is used * **max_samples** (*None*) – a maximum number of samples to import. By default, all samples are imported **Attributes:** | [`has_dataset_info`](#fiftyone.utils.data.UnlabeledImageDatasetIngestor.has_dataset_info) | Whether this importer produces a dataset info dictionary. | |-----------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`has_image_metadata`](#fiftyone.utils.data.UnlabeledImageDatasetIngestor.has_image_metadata) | Whether this importer produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each image. | **Methods:** | [`setup`](#fiftyone.utils.data.UnlabeledImageDatasetIngestor.setup)() | Performs any necessary setup before importing the first sample in the dataset. | |-----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| | [`close`](#fiftyone.utils.data.UnlabeledImageDatasetIngestor.close)(\*args) | Performs any necessary actions after the last sample has been imported. | | [`get_dataset_info`](#fiftyone.utils.data.UnlabeledImageDatasetIngestor.get_dataset_info)() | Returns the dataset info for the dataset. | | [`get_media_sources`](#fiftyone.utils.data.UnlabeledImageDatasetIngestor.get_media_sources)() | Returns the media-source entries the importing dataset records before any sample is added, or None. | #### *property* has_dataset_info Whether this importer produces a dataset info dictionary. #### *property* has_image_metadata Whether this importer produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each image. #### 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__()`. #### close(\*args) Performs any necessary actions after the last sample has been imported. This method is called when the importer’s context manager interface is exited, `DatasetImporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetImporter.__exit__()` #### 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 #### get_media_sources() Returns the media-source entries the importing dataset records before any sample is added, or None. Only importers of media-reference-backed samples provide these; see [`fiftyone.utils.lerobot.LeRobotDatasetImporter`](fiftyone.utils.lerobot.md#fiftyone.utils.lerobot.LeRobotDatasetImporter). ### *class* fiftyone.utils.data.LabeledImageDatasetIngestor(dataset_dir, samples, sample_parser, image_format=None, max_samples=None) Bases: [`LabeledImageDatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LabeledImageDatasetImporter), [`ImageIngestor`](fiftyone.utils.data.ingestors.md#fiftyone.utils.data.ingestors.ImageIngestor) Dataset importer that ingests labeled images into the provided `dataset_dir` during import. The source images and labels are parsed from the provided `samples` using the provided [`fiftyone.utils.data.parsers.LabeledImageSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledImageSampleParser). If an image path is available via [`fiftyone.utils.data.parsers.LabeledImageSampleParser.get_image_path()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledImageSampleParser.get_image_path), then the image is directly copied from its source location into `dataset_dir`. In this case, the original filename is maintained, unless a name conflict would occur, in which case an index of the form `"-%d" % count` is appended to the base filename. If no image path is available, the image is read in-memory via [`fiftyone.utils.data.parsers.LabeledImageSampleParser.get_image()`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledImageSampleParser.get_image) and written to `dataset_dir` in the following format: ```default / ``` where `image_count` is the number of files in `dataset_dir`. * **Parameters:** * **dataset_dir** – the directory where input images will be ingested into * **samples** – an iterable of samples that can be parsed by `sample_parser` * **sample_parser** – an [`fiftyone.utils.data.parsers.LabeledImageSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledImageSampleParser) to use to parse the samples * **image_format** (*None*) – the image format to use when writing in-memory images to disk. By default, `fiftyone.config.default_image_ext` is used * **max_samples** (*None*) – a maximum number of samples to import. By default, all samples are imported **Attributes:** | [`has_dataset_info`](#fiftyone.utils.data.LabeledImageDatasetIngestor.has_dataset_info) | Whether this importer produces a dataset info dictionary. | |---------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`has_image_metadata`](#fiftyone.utils.data.LabeledImageDatasetIngestor.has_image_metadata) | Whether this importer produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each image. | | [`label_cls`](#fiftyone.utils.data.LabeledImageDatasetIngestor.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this importer. | **Methods:** | [`setup`](#fiftyone.utils.data.LabeledImageDatasetIngestor.setup)() | Performs any necessary setup before importing the first sample in the dataset. | |---------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| | [`close`](#fiftyone.utils.data.LabeledImageDatasetIngestor.close)(\*args) | Performs any necessary actions after the last sample has been imported. | | [`get_dataset_info`](#fiftyone.utils.data.LabeledImageDatasetIngestor.get_dataset_info)() | Returns the dataset info for the dataset. | | [`get_media_sources`](#fiftyone.utils.data.LabeledImageDatasetIngestor.get_media_sources)() | Returns the media-source entries the importing dataset records before any sample is added, or None. | #### *property* has_dataset_info Whether this importer produces a dataset info dictionary. #### *property* has_image_metadata Whether this importer produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for each image. #### *property* label_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this importer. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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 #### 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__()`. #### close(\*args) Performs any necessary actions after the last sample has been imported. This method is called when the importer’s context manager interface is exited, `DatasetImporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetImporter.__exit__()` #### 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 #### get_media_sources() Returns the media-source entries the importing dataset records before any sample is added, or None. Only importers of media-reference-backed samples provide these; see [`fiftyone.utils.lerobot.LeRobotDatasetImporter`](fiftyone.utils.lerobot.md#fiftyone.utils.lerobot.LeRobotDatasetImporter). ### *class* fiftyone.utils.data.VideoIngestor(dataset_dir) Bases: `object` Mixin for [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter) instances that ingest videos into the provided `dataset_dir` during import. * **Parameters:** **dataset_dir** – the directory where input videos will be ingested into ### *class* fiftyone.utils.data.UnlabeledVideoDatasetIngestor(dataset_dir, samples, sample_parser, max_samples=None) Bases: [`UnlabeledVideoDatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.UnlabeledVideoDatasetImporter), [`VideoIngestor`](fiftyone.utils.data.ingestors.md#fiftyone.utils.data.ingestors.VideoIngestor) Dataset importer that ingests unlabeled videos into the provided `dataset_dir` during import. The source videos are parsed from the provided `samples` using the provided [`fiftyone.utils.data.parsers.UnlabeledVideoSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.UnlabeledVideoSampleParser). The source videos are directly copied from their source locations into `dataset_dir`, maintaining the original filenames, unless a name conflict would occur, in which case an index of the form `"-%d" % count` is appended to the base filename. * **Parameters:** * **dataset_dir** – the directory where input videos will be ingested into * **samples** – an iterable of samples that can be parsed by `sample_parser` * **sample_parser** – an [`fiftyone.utils.data.parsers.UnlabeledVideoSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.UnlabeledVideoSampleParser) to use to parse the samples * **max_samples** (*None*) – a maximum number of samples to import. By default, all samples are imported **Attributes:** | [`has_dataset_info`](#fiftyone.utils.data.UnlabeledVideoDatasetIngestor.has_dataset_info) | Whether this importer produces a dataset info dictionary. | |-----------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`has_video_metadata`](#fiftyone.utils.data.UnlabeledVideoDatasetIngestor.has_video_metadata) | Whether this importer produces [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for each video. | **Methods:** | [`setup`](#fiftyone.utils.data.UnlabeledVideoDatasetIngestor.setup)() | Performs any necessary setup before importing the first sample in the dataset. | |-----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| | [`close`](#fiftyone.utils.data.UnlabeledVideoDatasetIngestor.close)(\*args) | Performs any necessary actions after the last sample has been imported. | | [`get_dataset_info`](#fiftyone.utils.data.UnlabeledVideoDatasetIngestor.get_dataset_info)() | Returns the dataset info for the dataset. | | [`get_media_sources`](#fiftyone.utils.data.UnlabeledVideoDatasetIngestor.get_media_sources)() | Returns the media-source entries the importing dataset records before any sample is added, or None. | #### *property* has_dataset_info Whether this importer produces a dataset info dictionary. #### *property* has_video_metadata Whether this importer produces [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for each video. #### 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__()`. #### close(\*args) Performs any necessary actions after the last sample has been imported. This method is called when the importer’s context manager interface is exited, `DatasetImporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetImporter.__exit__()` #### 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 #### get_media_sources() Returns the media-source entries the importing dataset records before any sample is added, or None. Only importers of media-reference-backed samples provide these; see [`fiftyone.utils.lerobot.LeRobotDatasetImporter`](fiftyone.utils.lerobot.md#fiftyone.utils.lerobot.LeRobotDatasetImporter). ### *class* fiftyone.utils.data.LabeledVideoDatasetIngestor(dataset_dir, samples, sample_parser, max_samples=None) Bases: [`LabeledVideoDatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.LabeledVideoDatasetImporter), [`VideoIngestor`](fiftyone.utils.data.ingestors.md#fiftyone.utils.data.ingestors.VideoIngestor) Dataset importer that ingests labeled videos into the provided `dataset_dir` during import. The source videos and labels are parsed from the provided `samples` using the provided [`fiftyone.utils.data.parsers.LabeledVideoSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledVideoSampleParser). The source videos are directly copied from their source locations into `dataset_dir`, maintaining the original filenames, unless a name conflict would occur, in which case an index of the form `"-%d" % count` is appended to the base filename. * **Parameters:** * **dataset_dir** – the directory where input videos will be ingested into * **samples** – an iterable of samples that can be parsed by `sample_parser` * **sample_parser** – an [`fiftyone.utils.data.parsers.LabeledVideoSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledVideoSampleParser) to use to parse the samples * **max_samples** (*None*) – a maximum number of samples to import. By default, all samples are imported **Attributes:** | [`has_dataset_info`](#fiftyone.utils.data.LabeledVideoDatasetIngestor.has_dataset_info) | Whether this importer produces a dataset info dictionary. | |---------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`has_video_metadata`](#fiftyone.utils.data.LabeledVideoDatasetIngestor.has_video_metadata) | Whether this importer produces [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for each video. | | [`label_cls`](#fiftyone.utils.data.LabeledVideoDatasetIngestor.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this importer within the sample-level labels that it produces. | | [`frame_labels_cls`](#fiftyone.utils.data.LabeledVideoDatasetIngestor.frame_labels_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this importer within the frame labels that it produces. | **Methods:** | [`setup`](#fiftyone.utils.data.LabeledVideoDatasetIngestor.setup)() | Performs any necessary setup before importing the first sample in the dataset. | |---------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| | [`close`](#fiftyone.utils.data.LabeledVideoDatasetIngestor.close)(\*args) | Performs any necessary actions after the last sample has been imported. | | [`get_dataset_info`](#fiftyone.utils.data.LabeledVideoDatasetIngestor.get_dataset_info)() | Returns the dataset info for the dataset. | | [`get_media_sources`](#fiftyone.utils.data.LabeledVideoDatasetIngestor.get_media_sources)() | Returns the media-source entries the importing dataset records before any sample is added, or None. | #### *property* has_dataset_info Whether this importer produces a dataset info dictionary. #### *property* has_video_metadata Whether this importer produces [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for each video. #### *property* label_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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 #### *property* frame_labels_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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`](fiftyone.core.labels.md#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 #### 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__()`. #### close(\*args) Performs any necessary actions after the last sample has been imported. This method is called when the importer’s context manager interface is exited, `DatasetImporter.__exit__()`. * **Parameters:** **\*args** – the arguments to `DatasetImporter.__exit__()` #### 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 #### get_media_sources() Returns the media-source entries the importing dataset records before any sample is added, or None. Only importers of media-reference-backed samples provide these; see [`fiftyone.utils.lerobot.LeRobotDatasetImporter`](fiftyone.utils.lerobot.md#fiftyone.utils.lerobot.LeRobotDatasetImporter). ### fiftyone.utils.data.add_images(dataset, samples, sample_parser, tags=None, generator=False, progress=None) Adds the given images to the dataset. This operation does not read the images. See [this guide](../user_guide/sample_parsers.md#custom-sample-parser) for more details about adding images to a dataset by defining your own [`UnlabeledImageSampleParser`](#fiftyone.utils.data.UnlabeledImageSampleParser). * **Parameters:** * **dataset** – a [`fiftyone.core.dataset.Dataset`](fiftyone.core.dataset.md#fiftyone.core.dataset.Dataset) * **samples** – an iterable of samples that can be parsed by `sample_parser` * **sample_parser** – a [`UnlabeledImageSampleParser`](#fiftyone.utils.data.UnlabeledImageSampleParser) instance to use to parse the samples * **tags** (*None*) – an optional tag or iterable of tags to attach to each sample * **generator** (*False*) – whether to yield ID batches as a generator as samples are added to the dataset * **progress** (*None*) – whether to render a progress bar (True/False), use the default value `fiftyone.config.show_progress_bars` (None), or a progress callback function to invoke instead * **Returns:** a list of IDs of the samples that were added to the dataset ### fiftyone.utils.data.add_labeled_images(dataset, samples, sample_parser, label_field=None, tags=None, expand_schema=True, dynamic=False, generator=False, progress=None) Adds the given labeled images to the dataset. This operation will iterate over all provided samples, but the images will not be read (unless the sample parser requires it in order to compute image metadata). See [this guide](../user_guide/sample_parsers.md#custom-sample-parser) for more details about adding labeled images to a dataset by defining your own [`LabeledImageSampleParser`](#fiftyone.utils.data.LabeledImageSampleParser). * **Parameters:** * **dataset** – a [`fiftyone.core.dataset.Dataset`](fiftyone.core.dataset.md#fiftyone.core.dataset.Dataset) * **samples** – an iterable of samples that can be parsed by `sample_parser` * **sample_parser** – a [`LabeledImageSampleParser`](#fiftyone.utils.data.LabeledImageSampleParser) instance to use to parse the samples * **label_field** (*None*) – controls the field(s) in which imported labels are stored. If the parser produces a single [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instance per sample, this argument specifies the name of the field to use; the default is `"ground_truth"`. If the parser produces a dictionary of labels per sample, this argument can be either a string prefix to prepend to each label key or a dict mapping label keys to field names; the default in this case is to directly use the keys of the imported label dictionaries as field names * **tags** (*None*) – an optional tag or iterable of tags to attach to each sample * **expand_schema** (*True*) – whether to dynamically add new sample fields encountered to the dataset schema. If False, an error is raised if a sample’s schema is not a subset of the dataset schema * **dynamic** (*False*) – whether to declare dynamic attributes of embedded document fields that are encountered * **generator** (*False*) – whether to yield ID batches as a generator as samples are added to the dataset * **progress** (*None*) – whether to render a progress bar (True/False), use the default value `fiftyone.config.show_progress_bars` (None), or a progress callback function to invoke instead * **Returns:** a list of IDs of the samples that were added to the dataset ### fiftyone.utils.data.add_videos(dataset, samples, sample_parser, tags=None, generator=False, progress=None) Adds the given videos to the dataset. This operation does not read the videos. See [this guide](../user_guide/sample_parsers.md#custom-sample-parser) for more details about adding videos to a dataset by defining your own [`UnlabeledVideoSampleParser`](#fiftyone.utils.data.UnlabeledVideoSampleParser). * **Parameters:** * **dataset** – a [`fiftyone.core.dataset.Dataset`](fiftyone.core.dataset.md#fiftyone.core.dataset.Dataset) * **samples** – an iterable of samples that can be parsed by `sample_parser` * **sample_parser** – a [`UnlabeledVideoSampleParser`](#fiftyone.utils.data.UnlabeledVideoSampleParser) instance to use to parse the samples * **tags** (*None*) – an optional tag or iterable of tags to attach to each sample * **generator** (*False*) – whether to yield ID batches as a generator as samples are added to the dataset * **progress** (*None*) – whether to render a progress bar (True/False), use the default value `fiftyone.config.show_progress_bars` (None), or a progress callback function to invoke instead * **Returns:** a list of IDs of the samples that were added to the dataset ### fiftyone.utils.data.add_labeled_videos(dataset, samples, sample_parser, label_field=None, tags=None, expand_schema=True, dynamic=False, generator=False, progress=None) Adds the given labeled videos to the dataset. This operation will iterate over all provided samples, but the videos will not be read/decoded/etc. See [this guide](../user_guide/sample_parsers.md#custom-sample-parser) for more details about adding labeled videos to a dataset by defining your own [`LabeledVideoSampleParser`](#fiftyone.utils.data.LabeledVideoSampleParser). * **Parameters:** * **dataset** – a [`fiftyone.core.dataset.Dataset`](fiftyone.core.dataset.md#fiftyone.core.dataset.Dataset) * **samples** – an iterable of samples that can be parsed by `sample_parser` * **sample_parser** – a [`LabeledVideoSampleParser`](#fiftyone.utils.data.LabeledVideoSampleParser) instance to use to parse the samples * **label_field** (*None*) – controls the field(s) in which imported labels are stored. If the parser produces a single [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instance per sample/frame, this argument specifies the name of the field to use; the default is `"ground_truth"`. If the parser produces a dictionary of labels per sample/frame, this argument can be either a string prefix to prepend to each label key or a dict mapping label keys to field names; the default in this case is to directly use the keys of the imported label dictionaries as field names * **tags** (*None*) – an optional tag or iterable of tags to attach to each sample * **expand_schema** (*True*) – whether to dynamically add new sample fields encountered to the dataset schema. If False, an error is raised if a sample’s schema is not a subset of the dataset schema * **dynamic** (*False*) – whether to declare dynamic attributes of embedded document fields that are encountered * **generator** (*False*) – whether to yield ID batches as a generator as samples are added to the dataset * **progress** (*None*) – whether to render a progress bar (True/False), use the default value `fiftyone.config.show_progress_bars` (None), or a progress callback function to invoke instead * **Returns:** a list of IDs of the samples that were added to the dataset ### *class* fiftyone.utils.data.SampleParser Bases: `object` Base interface for sample parsers. [`SampleParser`](#fiftyone.utils.data.SampleParser) instances are used to parse samples emitted by dataset iterators when ingesting them into [`fiftyone.core.dataset.Dataset`](fiftyone.core.dataset.md#fiftyone.core.dataset.Dataset) instances. The general recipe for using [`SampleParser`](#fiftyone.utils.data.SampleParser) instances is as follows: ```default sample_parser = SampleParser(...) for sample in samples: sample_parser.with_sample(sample) field = sample_parser.get_() ``` where `field` is a subclass specific field to parse from the sample. **Attributes:** | [`current_sample`](#fiftyone.utils.data.SampleParser.current_sample) | The current sample. | |------------------------------------------------------------------------|-----------------------| **Methods:** | [`with_sample`](#fiftyone.utils.data.SampleParser.with_sample)(sample) | Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. | |--------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------| | [`clear_sample`](#fiftyone.utils.data.SampleParser.clear_sample)() | Clears the current sample. | #### *property* current_sample The current sample. * **Raises:** **ValueError** – if there is no current sample #### with_sample(sample) Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. Guaranteed to call [`clear_sample()`](#fiftyone.utils.data.SampleParser.clear_sample) before setting the current sample. * **Parameters:** **sample** – a sample #### clear_sample() Clears the current sample. Also clears any cached sample information stored by the parser. ### *class* fiftyone.utils.data.UnlabeledImageSampleParser Bases: [`SampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.SampleParser) Interface for [`SampleParser`](#fiftyone.utils.data.SampleParser) instances that parse unlabeled image samples. Instances of this class must return images in `numpy` format. The general recipe for using [`UnlabeledImageSampleParser`](#fiftyone.utils.data.UnlabeledImageSampleParser) instances is as follows: ```default sample_parser = UnlabeledImageSampleParser(...) for sample in samples: sample_parser.with_sample(sample) img = sample_parser.get_image() if sample_parser.has_image_path: image_path = sample_parser.get_image_path() if sample_parser.has_image_metadata: image_metadata = sample_parser.get_image_metadata() ``` **Attributes:** | [`has_image_path`](#fiftyone.utils.data.UnlabeledImageSampleParser.has_image_path) | Whether this parser produces paths to images on disk for samples that it parses. | |--------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`has_image_metadata`](#fiftyone.utils.data.UnlabeledImageSampleParser.has_image_metadata) | Whether this parser produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for samples that it parses. | | [`current_sample`](#fiftyone.utils.data.UnlabeledImageSampleParser.current_sample) | The current sample. | **Methods:** | [`get_image`](#fiftyone.utils.data.UnlabeledImageSampleParser.get_image)() | Returns the image from the current sample. | |----------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------| | [`get_image_path`](#fiftyone.utils.data.UnlabeledImageSampleParser.get_image_path)() | Returns the image path for the current sample. | | [`get_image_metadata`](#fiftyone.utils.data.UnlabeledImageSampleParser.get_image_metadata)() | Returns the image metadata for the current sample. | | [`clear_sample`](#fiftyone.utils.data.UnlabeledImageSampleParser.clear_sample)() | Clears the current sample. | | [`with_sample`](#fiftyone.utils.data.UnlabeledImageSampleParser.with_sample)(sample) | Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. | #### *property* has_image_path Whether this parser produces paths to images on disk for samples that it parses. #### *property* has_image_metadata Whether this parser produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for samples that it parses. #### get_image() Returns the image from the current sample. * **Returns:** a numpy image #### get_image_path() Returns the image path for the current sample. * **Returns:** the path to the image on disk #### get_image_metadata() Returns the image metadata for the current sample. * **Returns:** a [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instance #### clear_sample() Clears the current sample. Also clears any cached sample information stored by the parser. #### *property* current_sample The current sample. * **Raises:** **ValueError** – if there is no current sample #### with_sample(sample) Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. Guaranteed to call [`clear_sample()`](#fiftyone.utils.data.UnlabeledImageSampleParser.clear_sample) before setting the current sample. * **Parameters:** **sample** – a sample ### *class* fiftyone.utils.data.UnlabeledVideoSampleParser Bases: [`SampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.SampleParser) Interface for [`SampleParser`](#fiftyone.utils.data.SampleParser) instances that parse unlabeled video samples. The general recipe for using [`UnlabeledVideoSampleParser`](#fiftyone.utils.data.UnlabeledVideoSampleParser) instances is as follows: ```default sample_parser = UnlabeledVideoSampleParser(...) for sample in samples: sample_parser.with_sample(sample) video_path = sample_parser.get_video_path() video_metadata = sample_parser.get_video_metadata() ``` **Attributes:** | [`has_video_metadata`](#fiftyone.utils.data.UnlabeledVideoSampleParser.has_video_metadata) | Whether this parser produces [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for samples that it parses. | |----------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`current_sample`](#fiftyone.utils.data.UnlabeledVideoSampleParser.current_sample) | The current sample. | **Methods:** | [`get_video_path`](#fiftyone.utils.data.UnlabeledVideoSampleParser.get_video_path)() | Returns the video path for the current sample. | |----------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------| | [`get_video_metadata`](#fiftyone.utils.data.UnlabeledVideoSampleParser.get_video_metadata)() | Returns the video metadata for the current sample. | | [`clear_sample`](#fiftyone.utils.data.UnlabeledVideoSampleParser.clear_sample)() | Clears the current sample. | | [`with_sample`](#fiftyone.utils.data.UnlabeledVideoSampleParser.with_sample)(sample) | Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. | #### *property* has_video_metadata Whether this parser produces [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for samples that it parses. #### get_video_path() Returns the video path for the current sample. * **Returns:** the path to the video on disk #### get_video_metadata() Returns the video metadata for the current sample. * **Returns:** a [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instance #### clear_sample() Clears the current sample. Also clears any cached sample information stored by the parser. #### *property* current_sample The current sample. * **Raises:** **ValueError** – if there is no current sample #### with_sample(sample) Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. Guaranteed to call [`clear_sample()`](#fiftyone.utils.data.UnlabeledVideoSampleParser.clear_sample) before setting the current sample. * **Parameters:** **sample** – a sample ### *class* fiftyone.utils.data.UnlabeledMediaSampleParser Bases: [`SampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.SampleParser) Interface for [`SampleParser`](#fiftyone.utils.data.SampleParser) instances that parse unlabeled media samples. The general recipe for using [`UnlabeledMediaSampleParser`](#fiftyone.utils.data.UnlabeledMediaSampleParser) instances is as follows: ```default sample_parser = UnlabeledMediaSampleParser(...) for sample in samples: sample_parser.with_sample(sample) filepath = sample_parser.get_media_path() metadata = sample_parser.get_metadata() ``` **Attributes:** | [`has_metadata`](#fiftyone.utils.data.UnlabeledMediaSampleParser.has_metadata) | Whether this parser produces [`fiftyone.core.metadata.Metadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.Metadata) instances for samples that it parses. | |------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`current_sample`](#fiftyone.utils.data.UnlabeledMediaSampleParser.current_sample) | The current sample. | **Methods:** | [`get_media_path`](#fiftyone.utils.data.UnlabeledMediaSampleParser.get_media_path)() | Returns the media path for the current sample. | |----------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------| | [`get_metadata`](#fiftyone.utils.data.UnlabeledMediaSampleParser.get_metadata)() | Returns the metadata for the current sample. | | [`clear_sample`](#fiftyone.utils.data.UnlabeledMediaSampleParser.clear_sample)() | Clears the current sample. | | [`with_sample`](#fiftyone.utils.data.UnlabeledMediaSampleParser.with_sample)(sample) | Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. | #### *property* has_metadata Whether this parser produces [`fiftyone.core.metadata.Metadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.Metadata) instances for samples that it parses. #### get_media_path() Returns the media path for the current sample. * **Returns:** the path to the media on disk #### get_metadata() Returns the metadata for the current sample. * **Returns:** a [`fiftyone.core.metadata.Metadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.Metadata) instance #### clear_sample() Clears the current sample. Also clears any cached sample information stored by the parser. #### *property* current_sample The current sample. * **Raises:** **ValueError** – if there is no current sample #### with_sample(sample) Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. Guaranteed to call [`clear_sample()`](#fiftyone.utils.data.UnlabeledMediaSampleParser.clear_sample) before setting the current sample. * **Parameters:** **sample** – a sample ### *class* fiftyone.utils.data.VideoSampleParser Bases: [`UnlabeledVideoSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.UnlabeledVideoSampleParser) Sample parser that parses unlabeled video samples. This implementation assumes that the provided sample is a path to a video on disk. **Attributes:** | [`has_video_metadata`](#fiftyone.utils.data.VideoSampleParser.has_video_metadata) | Whether this parser produces [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for samples that it parses. | |-------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`current_sample`](#fiftyone.utils.data.VideoSampleParser.current_sample) | The current sample. | **Methods:** | [`get_video_path`](#fiftyone.utils.data.VideoSampleParser.get_video_path)() | Returns the video path for the current sample. | |-------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------| | [`clear_sample`](#fiftyone.utils.data.VideoSampleParser.clear_sample)() | Clears the current sample. | | [`get_video_metadata`](#fiftyone.utils.data.VideoSampleParser.get_video_metadata)() | Returns the video metadata for the current sample. | | [`with_sample`](#fiftyone.utils.data.VideoSampleParser.with_sample)(sample) | Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. | #### *property* has_video_metadata Whether this parser produces [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for samples that it parses. #### get_video_path() Returns the video path for the current sample. * **Returns:** the path to the video on disk #### clear_sample() Clears the current sample. Also clears any cached sample information stored by the parser. #### *property* current_sample The current sample. * **Raises:** **ValueError** – if there is no current sample #### get_video_metadata() Returns the video metadata for the current sample. * **Returns:** a [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instance #### with_sample(sample) Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. Guaranteed to call [`clear_sample()`](#fiftyone.utils.data.VideoSampleParser.clear_sample) before setting the current sample. * **Parameters:** **sample** – a sample ### *class* fiftyone.utils.data.MediaSampleParser Bases: [`UnlabeledMediaSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.UnlabeledMediaSampleParser) Sample parser that parses unlabeled media samples. This implementation assumes that the provided sample is a path to a media file on disk. **Attributes:** | [`has_metadata`](#fiftyone.utils.data.MediaSampleParser.has_metadata) | Whether this parser produces [`fiftyone.core.metadata.Metadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.Metadata) instances for samples that it parses. | |---------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`current_sample`](#fiftyone.utils.data.MediaSampleParser.current_sample) | The current sample. | **Methods:** | [`get_media_path`](#fiftyone.utils.data.MediaSampleParser.get_media_path)() | Returns the media path for the current sample. | |-------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------| | [`clear_sample`](#fiftyone.utils.data.MediaSampleParser.clear_sample)() | Clears the current sample. | | [`get_metadata`](#fiftyone.utils.data.MediaSampleParser.get_metadata)() | Returns the metadata for the current sample. | | [`with_sample`](#fiftyone.utils.data.MediaSampleParser.with_sample)(sample) | Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. | #### *property* has_metadata Whether this parser produces [`fiftyone.core.metadata.Metadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.Metadata) instances for samples that it parses. #### get_media_path() Returns the media path for the current sample. * **Returns:** the path to the media on disk #### clear_sample() Clears the current sample. Also clears any cached sample information stored by the parser. #### *property* current_sample The current sample. * **Raises:** **ValueError** – if there is no current sample #### get_metadata() Returns the metadata for the current sample. * **Returns:** a [`fiftyone.core.metadata.Metadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.Metadata) instance #### with_sample(sample) Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. Guaranteed to call [`clear_sample()`](#fiftyone.utils.data.MediaSampleParser.clear_sample) before setting the current sample. * **Parameters:** **sample** – a sample ### *class* fiftyone.utils.data.LabeledImageSampleParser Bases: [`SampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.SampleParser) Interface for [`SampleParser`](#fiftyone.utils.data.SampleParser) instances that parse labeled image samples. Instances of this class must return images in `numpy` format and labels as [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances. The general recipe for using [`LabeledImageSampleParser`](#fiftyone.utils.data.LabeledImageSampleParser) instances is as follows: ```default sample_parser = LabeledImageSampleParser(...) for sample in samples: sample_parser.with_sample(sample) img = sample_parser.get_image() label = sample_parser.get_label() if sample_parser.has_image_path: image_path = sample_parser.get_image_path() if sample_parser.has_image_metadata: image_metadata = sample_parser.get_image_metadata() ``` **Attributes:** | [`has_image_path`](#fiftyone.utils.data.LabeledImageSampleParser.has_image_path) | Whether this parser produces paths to images on disk for samples that it parses. | |------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`has_image_metadata`](#fiftyone.utils.data.LabeledImageSampleParser.has_image_metadata) | Whether this parser produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for samples that it parses. | | [`label_cls`](#fiftyone.utils.data.LabeledImageSampleParser.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this parser. | | [`current_sample`](#fiftyone.utils.data.LabeledImageSampleParser.current_sample) | The current sample. | **Methods:** | [`get_image`](#fiftyone.utils.data.LabeledImageSampleParser.get_image)() | Returns the image from the current sample. | |--------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------| | [`get_image_path`](#fiftyone.utils.data.LabeledImageSampleParser.get_image_path)() | Returns the image path for the current sample. | | [`get_image_metadata`](#fiftyone.utils.data.LabeledImageSampleParser.get_image_metadata)() | Returns the image metadata for the current sample. | | [`get_label`](#fiftyone.utils.data.LabeledImageSampleParser.get_label)() | Returns the label for the current sample. | | [`clear_sample`](#fiftyone.utils.data.LabeledImageSampleParser.clear_sample)() | Clears the current sample. | | [`with_sample`](#fiftyone.utils.data.LabeledImageSampleParser.with_sample)(sample) | Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. | #### *property* has_image_path Whether this parser produces paths to images on disk for samples that it parses. #### *property* has_image_metadata Whether this parser produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for samples that it parses. #### *property* label_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this parser. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class. In this case, the parser is guaranteed to return labels of this type - a list or tuple of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the parser can produce a single label field of any of these types - a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the parser 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 parser makes no guarantees about the labels that it may return #### get_image() Returns the image from the current sample. * **Returns:** a numpy image #### get_image_path() Returns the image path for the current sample. * **Returns:** the path to the image on disk #### get_image_metadata() Returns the image metadata for the current sample. * **Returns:** a [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instance #### get_label() Returns the label for the current sample. * **Returns:** a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instance, or a dictionary mapping field names to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances, or `None` if the sample is unlabeled #### clear_sample() Clears the current sample. Also clears any cached sample information stored by the parser. #### *property* current_sample The current sample. * **Raises:** **ValueError** – if there is no current sample #### with_sample(sample) Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. Guaranteed to call [`clear_sample()`](#fiftyone.utils.data.LabeledImageSampleParser.clear_sample) before setting the current sample. * **Parameters:** **sample** – a sample ### *class* fiftyone.utils.data.LabeledVideoSampleParser Bases: [`SampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.SampleParser) Interface for [`SampleParser`](#fiftyone.utils.data.SampleParser) instances that parse labeled video samples. The general recipe for using [`LabeledVideoSampleParser`](#fiftyone.utils.data.LabeledVideoSampleParser) instances is as follows: ```default sample_parser = LabeledVideoSampleParser(...) for sample in samples: sample_parser.with_sample(sample) video_path = sample_parser.get_video_path() label = sample_parser.get_label() frames = sample_parser.get_frame_labels() if sample_parser.has_video_metadata: video_metadata = sample_parser.get_video_metadata() ``` **Attributes:** | [`has_video_metadata`](#fiftyone.utils.data.LabeledVideoSampleParser.has_video_metadata) | Whether this parser produces [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for samples that it parses. | |--------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`label_cls`](#fiftyone.utils.data.LabeledVideoSampleParser.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this parser within the sample-level labels that it produces. | | [`frame_labels_cls`](#fiftyone.utils.data.LabeledVideoSampleParser.frame_labels_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this parser within the frame labels that it produces. | | [`current_sample`](#fiftyone.utils.data.LabeledVideoSampleParser.current_sample) | The current sample. | **Methods:** | [`get_video_path`](#fiftyone.utils.data.LabeledVideoSampleParser.get_video_path)() | Returns the video path for the current sample. | |--------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------| | [`get_video_metadata`](#fiftyone.utils.data.LabeledVideoSampleParser.get_video_metadata)() | Returns the video metadata for the current sample. | | [`get_label`](#fiftyone.utils.data.LabeledVideoSampleParser.get_label)() | Returns the sample-level labels for the current sample. | | [`get_frame_labels`](#fiftyone.utils.data.LabeledVideoSampleParser.get_frame_labels)() | Returns the frame labels for the current sample. | | [`clear_sample`](#fiftyone.utils.data.LabeledVideoSampleParser.clear_sample)() | Clears the current sample. | | [`with_sample`](#fiftyone.utils.data.LabeledVideoSampleParser.with_sample)(sample) | Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. | #### *property* has_video_metadata Whether this parser produces [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for samples that it parses. #### *property* label_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this parser within the sample-level labels that it produces. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class. In this case, the parser is guaranteed to return sample-level labels of this type - a list or tuple of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the parser can produce a single sample-level label field of any of these types - a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the parser 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 parser makes no guarantees about the sample-level labels that it may return #### *property* frame_labels_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this parser within the frame labels that it produces. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class. In this case, the parser is guaranteed to return frame labels of this type - a list or tuple of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the parser can produce a single frame label field of any of these types - a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the parser 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 parser makes no guarantees about the frame labels that it may return #### get_video_path() Returns the video path for the current sample. * **Returns:** the path to the video on disk #### get_video_metadata() Returns the video metadata for the current sample. * **Returns:** a [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instance #### get_label() Returns the sample-level labels for the current sample. * **Returns:** a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instance, or a dictionary mapping field names to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances, or `None` if the sample has no sample-level labels #### get_frame_labels() Returns the frame labels for the current sample. * **Returns:** a dictionary mapping frame numbers to dictionaries that map label fields to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances for each video frame, or `None` if the sample has no frame labels #### clear_sample() Clears the current sample. Also clears any cached sample information stored by the parser. #### *property* current_sample The current sample. * **Raises:** **ValueError** – if there is no current sample #### with_sample(sample) Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. Guaranteed to call [`clear_sample()`](#fiftyone.utils.data.LabeledVideoSampleParser.clear_sample) before setting the current sample. * **Parameters:** **sample** – a sample ### *class* fiftyone.utils.data.LabeledImageTupleSampleParser Bases: [`LabeledImageSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledImageSampleParser) Generic sample parser that parses samples that are `(image_or_path, label)` tuples, where: > - `image_or_path` is either an image that can be converted to numpy > format via `np.asarray()` or the path to an image on disk > - `label` is a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instance This implementation provides a `_current_image()` property that caches the image for the current sample, for efficiency in case multiple getters require access to the image (e.g., to normalize coordinates, compute metadata, etc). See the following subclasses of this parser for implementations that parse labels for common tasks: > - Image classification: [`ImageClassificationSampleParser`](#fiftyone.utils.data.ImageClassificationSampleParser) > - Object detection: [`ImageDetectionSampleParser`](#fiftyone.utils.data.ImageDetectionSampleParser) > - Multitask image prediction: [`ImageLabelsSampleParser`](#fiftyone.utils.data.ImageLabelsSampleParser) **Attributes:** | [`has_image_path`](#fiftyone.utils.data.LabeledImageTupleSampleParser.has_image_path) | Whether this parser produces paths to images on disk for samples that it parses. | |-----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`has_image_metadata`](#fiftyone.utils.data.LabeledImageTupleSampleParser.has_image_metadata) | Whether this parser produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for samples that it parses. | | [`label_cls`](#fiftyone.utils.data.LabeledImageTupleSampleParser.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this parser. | | [`current_sample`](#fiftyone.utils.data.LabeledImageTupleSampleParser.current_sample) | The current sample. | **Methods:** | [`get_image`](#fiftyone.utils.data.LabeledImageTupleSampleParser.get_image)() | Returns the image from the current sample. | |-------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------| | [`get_image_path`](#fiftyone.utils.data.LabeledImageTupleSampleParser.get_image_path)() | Returns the image path for the current sample. | | [`get_label`](#fiftyone.utils.data.LabeledImageTupleSampleParser.get_label)() | Returns the label for the current sample. | | [`clear_sample`](#fiftyone.utils.data.LabeledImageTupleSampleParser.clear_sample)() | Clears the current sample. | | [`get_image_metadata`](#fiftyone.utils.data.LabeledImageTupleSampleParser.get_image_metadata)() | Returns the image metadata for the current sample. | | [`with_sample`](#fiftyone.utils.data.LabeledImageTupleSampleParser.with_sample)(sample) | Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. | #### *property* has_image_path Whether this parser produces paths to images on disk for samples that it parses. #### *property* has_image_metadata Whether this parser produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for samples that it parses. #### *property* label_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this parser. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class. In this case, the parser is guaranteed to return labels of this type - a list or tuple of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the parser can produce a single label field of any of these types - a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the parser 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 parser makes no guarantees about the labels that it may return #### get_image() Returns the image from the current sample. * **Returns:** a numpy image #### get_image_path() Returns the image path for the current sample. * **Returns:** the path to the image on disk #### get_label() Returns the label for the current sample. * **Returns:** a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instance, or a dictionary mapping field names to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances, or `None` if the sample is unlabeled #### clear_sample() Clears the current sample. Also clears any cached sample information stored by the parser. #### *property* current_sample The current sample. * **Raises:** **ValueError** – if there is no current sample #### get_image_metadata() Returns the image metadata for the current sample. * **Returns:** a [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instance #### with_sample(sample) Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. Guaranteed to call [`clear_sample()`](#fiftyone.utils.data.LabeledImageTupleSampleParser.clear_sample) before setting the current sample. * **Parameters:** **sample** – a sample ### *class* fiftyone.utils.data.ImageDetectionSampleParser(label_field='label', bounding_box_field='bounding_box', confidence_field=None, attributes_field=None, classes=None, normalized=True) Bases: [`LabeledImageTupleSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledImageTupleSampleParser) Generic parser for image detection samples whose labels are represented as [`fiftyone.core.labels.Detections`](fiftyone.core.labels.md#fiftyone.core.labels.Detections) instances. This implementation supports samples that are `(image_or_path, detections_or_path)` tuples, where: > - `image_or_path` is either an image that can be converted to numpy > format via `np.asarray()` or the path to an image on disk > - `detections_or_path` can be any of the following: > > - None, for unlabeled images > > - a list of detections in the following format: > > ```default > > [ > > { > > "": , > > "": [ > > , , , > > ], > > "": , > > "": { > > : , > > ... > > } > > }, > > ... > > ] > > ``` > > In the above, `label-or-target` is either a class ID > > (if `classes` is provided) or a label string, and the bounding > > box coordinates can either be relative coordinates in `[0, 1]` > > (if `normalized == True`) or absolute pixels coordinates > > (if `normalized == False`). The confidence and attributes > > fields are optional for each sample. > > The input field names can be configured as necessary when > > instantiating the parser. > > - the path on disk to a file in the above format > > - a [`fiftyone.core.labels.Detections`](fiftyone.core.labels.md#fiftyone.core.labels.Detections) instance * **Parameters:** * **label_field** ( *"label"*) – the name of the object label field in the target dicts * **bounding_box_field** ( *"bounding_box"*) – the name of the bounding box field in the target dicts * **confidence_field** (*None*) – the name of the optional confidence field in the target dicts * **attributes_field** (*None*) – the name of the optional attributes field in the target dicts * **classes** (*None*) – an optional list of class label strings. If provided, it is assumed that the `target` values are class IDs that should be mapped to label strings via `classes[target]` * **normalized** (*True*) – whether the bounding box coordinates are absolute pixel coordinates (`False`) or relative coordinates in [0, 1] (`True`) **Attributes:** | [`label_cls`](#fiftyone.utils.data.ImageDetectionSampleParser.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this parser. | |--------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`current_sample`](#fiftyone.utils.data.ImageDetectionSampleParser.current_sample) | The current sample. | | [`has_image_metadata`](#fiftyone.utils.data.ImageDetectionSampleParser.has_image_metadata) | Whether this parser produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for samples that it parses. | | [`has_image_path`](#fiftyone.utils.data.ImageDetectionSampleParser.has_image_path) | Whether this parser produces paths to images on disk for samples that it parses. | **Methods:** | [`get_label`](#fiftyone.utils.data.ImageDetectionSampleParser.get_label)() | Returns the label for the current sample. | |----------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------| | [`clear_sample`](#fiftyone.utils.data.ImageDetectionSampleParser.clear_sample)() | Clears the current sample. | | [`get_image`](#fiftyone.utils.data.ImageDetectionSampleParser.get_image)() | Returns the image from the current sample. | | [`get_image_metadata`](#fiftyone.utils.data.ImageDetectionSampleParser.get_image_metadata)() | Returns the image metadata for the current sample. | | [`get_image_path`](#fiftyone.utils.data.ImageDetectionSampleParser.get_image_path)() | Returns the image path for the current sample. | | [`with_sample`](#fiftyone.utils.data.ImageDetectionSampleParser.with_sample)(sample) | Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. | #### *property* label_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this parser. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class. In this case, the parser is guaranteed to return labels of this type - a list or tuple of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the parser can produce a single label field of any of these types - a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the parser 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 parser makes no guarantees about the labels that it may return #### get_label() Returns the label for the current sample. * **Returns:** a [`fiftyone.core.labels.Detections`](fiftyone.core.labels.md#fiftyone.core.labels.Detections) instance #### clear_sample() Clears the current sample. Also clears any cached sample information stored by the parser. #### *property* current_sample The current sample. * **Raises:** **ValueError** – if there is no current sample #### get_image() Returns the image from the current sample. * **Returns:** a numpy image #### get_image_metadata() Returns the image metadata for the current sample. * **Returns:** a [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instance #### get_image_path() Returns the image path for the current sample. * **Returns:** the path to the image on disk #### *property* has_image_metadata Whether this parser produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for samples that it parses. #### *property* has_image_path Whether this parser produces paths to images on disk for samples that it parses. #### with_sample(sample) Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. Guaranteed to call [`clear_sample()`](#fiftyone.utils.data.ImageDetectionSampleParser.clear_sample) before setting the current sample. * **Parameters:** **sample** – a sample ### *class* fiftyone.utils.data.ImageLabelsSampleParser(prefix=None, labels_dict=None, multilabel=False, skip_non_categorical=False) Bases: [`LabeledImageTupleSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledImageTupleSampleParser) Generic parser for multitask image prediction samples whose labels are stored in `eta.core.image.ImageLabels` format. This implementation provided by this class supports samples that are `(image_or_path, image_labels_or_path)` tuples, where: > - `image_or_path` is either an image that can be converted to numpy > format via `np.asarray()` or the path to an image on disk > - `image_labels_or_path` is an `eta.core.image.ImageLabels` > instance, an `eta.core.frames.FrameLabels` instance, a serialized > dict representation of either, or the path to either on disk * **Parameters:** * **prefix** (*None*) – a string prefix to prepend to each label name in the expanded label dictionary * **labels_dict** (*None*) – a dictionary mapping names of attributes/objects in the image labels to field names into which to expand them * **multilabel** (*False*) – whether to store attributes in a single [`fiftyone.core.labels.Classifications`](fiftyone.core.labels.md#fiftyone.core.labels.Classifications) instance * **skip_non_categorical** (*False*) – whether to skip non-categorical attributes (True) or cast them to strings (False) **Attributes:** | [`label_cls`](#fiftyone.utils.data.ImageLabelsSampleParser.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this parser. | |-----------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`current_sample`](#fiftyone.utils.data.ImageLabelsSampleParser.current_sample) | The current sample. | | [`has_image_metadata`](#fiftyone.utils.data.ImageLabelsSampleParser.has_image_metadata) | Whether this parser produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for samples that it parses. | | [`has_image_path`](#fiftyone.utils.data.ImageLabelsSampleParser.has_image_path) | Whether this parser produces paths to images on disk for samples that it parses. | **Methods:** | [`get_label`](#fiftyone.utils.data.ImageLabelsSampleParser.get_label)() | Returns the label for the current sample. | |-------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------| | [`clear_sample`](#fiftyone.utils.data.ImageLabelsSampleParser.clear_sample)() | Clears the current sample. | | [`get_image`](#fiftyone.utils.data.ImageLabelsSampleParser.get_image)() | Returns the image from the current sample. | | [`get_image_metadata`](#fiftyone.utils.data.ImageLabelsSampleParser.get_image_metadata)() | Returns the image metadata for the current sample. | | [`get_image_path`](#fiftyone.utils.data.ImageLabelsSampleParser.get_image_path)() | Returns the image path for the current sample. | | [`with_sample`](#fiftyone.utils.data.ImageLabelsSampleParser.with_sample)(sample) | Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. | #### *property* label_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this parser. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class. In this case, the parser is guaranteed to return labels of this type - a list or tuple of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the parser can produce a single label field of any of these types - a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the parser 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 parser makes no guarantees about the labels that it may return #### get_label() Returns the label for the current sample. * **Returns:** a labels dictionary #### clear_sample() Clears the current sample. Also clears any cached sample information stored by the parser. #### *property* current_sample The current sample. * **Raises:** **ValueError** – if there is no current sample #### get_image() Returns the image from the current sample. * **Returns:** a numpy image #### get_image_metadata() Returns the image metadata for the current sample. * **Returns:** a [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instance #### get_image_path() Returns the image path for the current sample. * **Returns:** the path to the image on disk #### *property* has_image_metadata Whether this parser produces [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instances for samples that it parses. #### *property* has_image_path Whether this parser produces paths to images on disk for samples that it parses. #### with_sample(sample) Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. Guaranteed to call [`clear_sample()`](#fiftyone.utils.data.ImageLabelsSampleParser.clear_sample) before setting the current sample. * **Parameters:** **sample** – a sample ### *class* fiftyone.utils.data.VideoLabelsSampleParser(prefix=None, labels_dict=None, frame_labels_dict=None, multilabel=False, skip_non_categorical=False) Bases: [`LabeledVideoSampleParser`](fiftyone.utils.data.parsers.md#fiftyone.utils.data.parsers.LabeledVideoSampleParser) Generic parser for labeled video samples whose labels are represented in `eta.core.video.VideoLabels` format. This implementation provided by this class supports samples that are `(video_path, video_labels_or_path)` tuples, where: > - `video_path` is the path to a video on disk > - `video_labels_or_path` is an `eta.core.video.VideoLabels` > instance, a serialized dict representation of one, or the path to one > on disk * **Parameters:** * **prefix** (*None*) – a string prefix to prepend to each label name in the expanded sample/frame label dictionaries * **labels_dict** (*None*) – a dictionary mapping names of attributes/objects in the sample labels to field names into which to expand them. By default, all sample labels are loaded * **frame_labels_dict** (*None*) – a dictionary mapping names of attributes/objects in the frame labels to field names into which to expand them. By default, all frame labels are loaded * **multilabel** (*False*) – whether to store attributes in a single [`fiftyone.core.labels.Classifications`](fiftyone.core.labels.md#fiftyone.core.labels.Classifications) instance * **skip_non_categorical** (*False*) – whether to skip non-categorical attributes (True) or cast them to strings (False) **Attributes:** | [`has_video_metadata`](#fiftyone.utils.data.VideoLabelsSampleParser.has_video_metadata) | Whether this parser produces [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for samples that it parses. | |-------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`label_cls`](#fiftyone.utils.data.VideoLabelsSampleParser.label_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this parser within the sample-level labels that it produces. | | [`frame_labels_cls`](#fiftyone.utils.data.VideoLabelsSampleParser.frame_labels_cls) | The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this parser within the frame labels that it produces. | | [`current_sample`](#fiftyone.utils.data.VideoLabelsSampleParser.current_sample) | The current sample. | **Methods:** | [`get_video_path`](#fiftyone.utils.data.VideoLabelsSampleParser.get_video_path)() | Returns the video path for the current sample. | |-------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------| | [`get_label`](#fiftyone.utils.data.VideoLabelsSampleParser.get_label)() | Returns the sample-level labels for the current sample. | | [`get_frame_labels`](#fiftyone.utils.data.VideoLabelsSampleParser.get_frame_labels)() | Returns the frame labels for the current sample. | | [`clear_sample`](#fiftyone.utils.data.VideoLabelsSampleParser.clear_sample)() | Clears the current sample. | | [`get_video_metadata`](#fiftyone.utils.data.VideoLabelsSampleParser.get_video_metadata)() | Returns the video metadata for the current sample. | | [`with_sample`](#fiftyone.utils.data.VideoLabelsSampleParser.with_sample)(sample) | Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. | #### *property* has_video_metadata Whether this parser produces [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances for samples that it parses. #### *property* label_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this parser within the sample-level labels that it produces. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class. In this case, the parser is guaranteed to return sample-level labels of this type - a list or tuple of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the parser can produce a single sample-level label field of any of these types - a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the parser 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 parser makes no guarantees about the sample-level labels that it may return #### *property* frame_labels_cls The [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class(es) returned by this parser within the frame labels that it produces. This can be any of the following: - a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) class. In this case, the parser is guaranteed to return frame labels of this type - a list or tuple of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the parser can produce a single frame label field of any of these types - a dict mapping keys to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) classes. In this case, the parser 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 parser makes no guarantees about the frame labels that it may return #### get_video_path() Returns the video path for the current sample. * **Returns:** the path to the video on disk #### get_label() Returns the sample-level labels for the current sample. * **Returns:** a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instance, or a dictionary mapping field names to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances, or `None` if the sample has no sample-level labels #### get_frame_labels() Returns the frame labels for the current sample. * **Returns:** a dictionary mapping frame numbers to dictionaries that map label fields to [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances for each video frame, or `None` if the sample has no frame labels #### clear_sample() Clears the current sample. Also clears any cached sample information stored by the parser. #### *property* current_sample The current sample. * **Raises:** **ValueError** – if there is no current sample #### get_video_metadata() Returns the video metadata for the current sample. * **Returns:** a [`fiftyone.core.metadata.ImageMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.ImageMetadata) instance #### with_sample(sample) Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample. Guaranteed to call [`clear_sample()`](#fiftyone.utils.data.VideoLabelsSampleParser.clear_sample) before setting the current sample. * **Parameters:** **sample** – a sample ### *class* fiftyone.utils.data.ExtractClipsMixin(compute_metadata=False, write_clips=True, clip_dir=None, video_format=None) Bases: `object` Mixin for sample parsers that extract clips from [`fiftyone.core.clips.ClipView`](fiftyone.core.clips.md#fiftyone.core.clips.ClipView) instances. * **Parameters:** * **compute_metadata** (*False*) – whether to compute [`fiftyone.core.metadata.VideoMetadata`](fiftyone.core.metadata.md#fiftyone.core.metadata.VideoMetadata) instances on-the-fly when no pre-computed metadata is available * **write_clips** (*True*) – whether to write clips when their paths are requested * **clip_dir** (*None*) – a directory to write clips. Only applicable when parsing [`fiftyone.core.clips.ClipView`](fiftyone.core.clips.md#fiftyone.core.clips.ClipView) instances * **video_format** (*None*) – the video format to use when writing video clips to disk. By default, `fiftyone.config.default_video_ext` is used