# fiftyone.zoo.datasets.base FiftyOne Zoo Datasets provided natively by the library. Copyright 2017-2026, Voxel51, Inc.
[voxel51.com](https://voxel51.com/)

**Classes:** | [`FiftyOneDataset`](#fiftyone.zoo.datasets.base.FiftyOneDataset)() | Base class for zoo datasets that are provided natively by FiftyOne. | |----------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`ActivityNet100Dataset`](#fiftyone.zoo.datasets.base.ActivityNet100Dataset)([source_dir, classes, ...]) | ActivityNet is a large-scale video dataset for human activity understanding supporting the tasks of global video classification, trimmed activity classification, and temporal activity detection. | | [`ActivityNet200Dataset`](#fiftyone.zoo.datasets.base.ActivityNet200Dataset)([source_dir, classes, ...]) | ActivityNet is a large-scale video dataset for human activity understanding supporting the tasks of global video classification, trimmed activity classification, and temporal activity detection. | | [`BDD100KDataset`](#fiftyone.zoo.datasets.base.BDD100KDataset)([source_dir, copy_files]) | The Berkeley Deep Drive (BDD) dataset is one of the largest and most diverse video datasets for autonomous vehicles. | | [`Caltech101Dataset`](#fiftyone.zoo.datasets.base.Caltech101Dataset)() | The Caltech-101 dataset of images. | | [`Caltech256Dataset`](#fiftyone.zoo.datasets.base.Caltech256Dataset)() | The Caltech-256 dataset of images. | | [`CityscapesDataset`](#fiftyone.zoo.datasets.base.CityscapesDataset)([source_dir, fine_annos, ...]) | Cityscapes is a large-scale dataset that contains a diverse set of stereo video sequences recorded in street scenes from 50 different cities, with high quality pixel-level annotations of 5,000 frames in addition to a larger set of 20,000 weakly annotated frames. | | [`COCO2014Dataset`](#fiftyone.zoo.datasets.base.COCO2014Dataset)([label_types, classes, ...]) | COCO is a large-scale object detection, segmentation, and captioning dataset. | | [`COCO2017Dataset`](#fiftyone.zoo.datasets.base.COCO2017Dataset)([label_types, classes, ...]) | COCO is a large-scale object detection, segmentation, and captioning dataset. | | [`SamaCOCODataset`](#fiftyone.zoo.datasets.base.SamaCOCODataset)([label_types, classes, ...]) | Sama-COCO is a large-scale object detection, segmentation, and captioning dataset based on COCO2017. | | [`FIWDataset`](#fiftyone.zoo.datasets.base.FIWDataset)() | Families in the Wild is a public benchmark for recognizing families via facial images. | | [`HMDB51Dataset`](#fiftyone.zoo.datasets.base.HMDB51Dataset)([fold]) | HMDB51 is an action recognition dataset containing a total of 6,766 clips distributed across 51 action classes. | | [`ImageNetSampleDataset`](#fiftyone.zoo.datasets.base.ImageNetSampleDataset)() | A small sample of images from the ImageNet 2012 dataset. | | [`Kinetics400Dataset`](#fiftyone.zoo.datasets.base.Kinetics400Dataset)([classes, num_workers, ...]) | Kinetics is a collection of large-scale, high-quality datasets of URL links of up to 650,000 video clips that cover 400/600/700 human action classes, depending on the dataset version. | | [`Kinetics600Dataset`](#fiftyone.zoo.datasets.base.Kinetics600Dataset)([classes, num_workers, ...]) | Kinetics is a collection of large-scale, high-quality datasets of URL links of up to 650,000 video clips that cover 400/600/700 human action classes, depending on the dataset version. | | [`Kinetics700Dataset`](#fiftyone.zoo.datasets.base.Kinetics700Dataset)([classes, num_workers, ...]) | Kinetics is a collection of large-scale, high-quality datasets of URL links of up to 650,000 video clips that cover 400/600/700 human action classes, depending on the dataset version. | | [`Kinetics7002020Dataset`](#fiftyone.zoo.datasets.base.Kinetics7002020Dataset)([classes, ...]) | Kinetics is a collection of large-scale, high-quality datasets of URL links of up to 650,000 video clips that cover 400/600/700 human action classes, depending on the dataset version. | | [`KITTIDataset`](#fiftyone.zoo.datasets.base.KITTIDataset)() | KITTI contains a suite of vision tasks built using an autonomous driving platform. | | [`KITTIMultiviewDataset`](#fiftyone.zoo.datasets.base.KITTIMultiviewDataset)() | KITTI contains a suite of vision tasks built using an autonomous driving platform. | | [`LabeledFacesInTheWildDataset`](#fiftyone.zoo.datasets.base.LabeledFacesInTheWildDataset)() | Labeled Faces in the Wild is a public benchmark for face verification, also known as pair matching. | | [`OpenImagesV6Dataset`](#fiftyone.zoo.datasets.base.OpenImagesV6Dataset)([label_types, classes, ...]) | Open Images V6 is a dataset of ~9 million images, roughly 2 million of which are annotated and available via this zoo dataset. | | [`OpenImagesV7Dataset`](#fiftyone.zoo.datasets.base.OpenImagesV7Dataset)([label_types, classes, ...]) | Open Images V7 is a dataset of ~9 million images, roughly 2 million of which are annotated and available via this zoo dataset. | | [`PlacesDataset`](#fiftyone.zoo.datasets.base.PlacesDataset)() | Places is a scene recognition dataset of 10 million images comprising ~400 unique scene categories. | | [`QuickstartDataset`](#fiftyone.zoo.datasets.base.QuickstartDataset)() | A small dataset with ground truth bounding boxes and predictions. | | [`QuickstartGeoDataset`](#fiftyone.zoo.datasets.base.QuickstartGeoDataset)() | A small dataset with geolocation data. | | [`QuickstartVideoDataset`](#fiftyone.zoo.datasets.base.QuickstartVideoDataset)() | A small video dataset with dense annotations. | | [`QuickstartTrajectoriesDataset`](#fiftyone.zoo.datasets.base.QuickstartTrajectoriesDataset)() | A small video dataset for trajectory annotation. | | [`QuickstartGroupsDataset`](#fiftyone.zoo.datasets.base.QuickstartGroupsDataset)() | A small dataset with grouped image and point cloud data. | | [`Quickstart3DDataset`](#fiftyone.zoo.datasets.base.Quickstart3DDataset)() | A small 3D dataset with meshes, point clouds, and oriented bounding boxes. | | [`UCF101Dataset`](#fiftyone.zoo.datasets.base.UCF101Dataset)([fold]) | UCF101 is an action recognition data set of realistic action videos, collected from YouTube, having 101 action categories. | | [`RTKSLAMAbsoluteAccuracyDataset`](#fiftyone.zoo.datasets.base.RTKSLAMAbsoluteAccuracyDataset)() | Handheld LiDAR, camera, IMU and GNSS sequences measured against surveyed checkpoints, as native `.mcap` episodes. | | [`TIIRATMDroneRacingDataset`](#fiftyone.zoo.datasets.base.TIIRATMDroneRacingDataset)() | Indoor drone racing flights pairing onboard visual-inertial odometry with motion capture ground truth, as native `.mcap` episodes. | | [`EgocentricEMGForceDataset`](#fiftyone.zoo.datasets.base.EgocentricEMGForceDataset)() | First-person household task recordings pairing RGB-D video with wrist EMG and per-finger contact force, as native `.mcap` episodes. | | [`RoboLabDataset`](#fiftyone.zoo.datasets.base.RoboLabDataset)() | Policy rollouts recorded on NVIDIA's RoboLab manipulation benchmark, as native `.mcap` episodes. | ### *class* fiftyone.zoo.datasets.base.FiftyOneDataset Bases: [`ZooDataset`](fiftyone.zoo.datasets.md#fiftyone.zoo.datasets.ZooDataset) Base class for zoo datasets that are provided natively by FiftyOne. **Methods:** | [`download_and_prepare`](#fiftyone.zoo.datasets.base.FiftyOneDataset.download_and_prepare)(dataset_dir[, split, ...]) | Downloads the dataset and prepares it for use. | |-------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| | [`get_info_path`](#fiftyone.zoo.datasets.base.FiftyOneDataset.get_info_path)(dataset_dir) | Returns the path to the `ZooDatasetInfo` for the dataset. | | [`get_split_dir`](#fiftyone.zoo.datasets.base.FiftyOneDataset.get_split_dir)(dataset_dir, split) | Returns the directory for the given split of the dataset. | | [`has_info`](#fiftyone.zoo.datasets.base.FiftyOneDataset.has_info)(dataset_dir) | Determines whether the directory contains `ZooDatasetInfo`. | | [`has_split`](#fiftyone.zoo.datasets.base.FiftyOneDataset.has_split)(split) | Whether the dataset has the given split. | | [`has_tag`](#fiftyone.zoo.datasets.base.FiftyOneDataset.has_tag)(tag) | Whether the dataset has the given tag. | | [`load_info`](#fiftyone.zoo.datasets.base.FiftyOneDataset.load_info)(dataset_dir[, upgrade, ...]) | Loads the `ZooDatasetInfo` from the given dataset directory. | **Attributes:** | [`has_patches`](#fiftyone.zoo.datasets.base.FiftyOneDataset.has_patches) | Whether the dataset has patches that may need to be applied to already downloaded files. | |--------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`has_splits`](#fiftyone.zoo.datasets.base.FiftyOneDataset.has_splits) | Whether the dataset has splits. | | [`has_tags`](#fiftyone.zoo.datasets.base.FiftyOneDataset.has_tags) | Whether the dataset has tags. | | [`importer_kwargs`](#fiftyone.zoo.datasets.base.FiftyOneDataset.importer_kwargs) | A dict of default kwargs to pass to this dataset's [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). | | [`is_remote`](#fiftyone.zoo.datasets.base.FiftyOneDataset.is_remote) | Whether the dataset is remotely-sourced. | | [`license`](#fiftyone.zoo.datasets.base.FiftyOneDataset.license) | The license or list,of,licenses under which the dataset is distributed, or None if unknown. | | [`name`](#fiftyone.zoo.datasets.base.FiftyOneDataset.name) | The name of the dataset. | | [`parameters`](#fiftyone.zoo.datasets.base.FiftyOneDataset.parameters) | An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. | | [`requires_manual_download`](#fiftyone.zoo.datasets.base.FiftyOneDataset.requires_manual_download) | Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. | | [`supported_splits`](#fiftyone.zoo.datasets.base.FiftyOneDataset.supported_splits) | A tuple of supported splits for the dataset, or None if the dataset does not have splits. | | [`supports_partial_downloads`](#fiftyone.zoo.datasets.base.FiftyOneDataset.supports_partial_downloads) | Whether the dataset supports downloading partial subsets of its splits. | | [`tags`](#fiftyone.zoo.datasets.base.FiftyOneDataset.tags) | A tuple of tags for the dataset. | #### download_and_prepare(dataset_dir, split=None, splits=None, cleanup=True) Downloads the dataset and prepares it for use. If the requested splits have already been downloaded, they are not re-downloaded. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **split** (*None*) – `split` nor `splits` are provided, the full dataset is downloaded * **splits** (*None*) – a list of splits to download, if applicable. If neither `split` nor `splits` are provided, the full dataset is downloaded * **cleanup** (*True*) – whether to cleanup any temporary files generated during download * **Returns:** the `ZooDatasetInfo` for the dataset #### *static* get_info_path(dataset_dir) Returns the path to the `ZooDatasetInfo` for the dataset. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** the path to the `ZooDatasetInfo` #### get_split_dir(dataset_dir, split) Returns the directory for the given split of the dataset. * **Parameters:** * **dataset_dir** – the dataset directory * **split** – the dataset split * **Returns:** the directory that will/does hold the specified split #### *static* has_info(dataset_dir) Determines whether the directory contains `ZooDatasetInfo`. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** True/False #### *property* has_patches Whether the dataset has patches that may need to be applied to already downloaded files. #### has_split(split) Whether the dataset has the given split. * **Parameters:** **split** – the dataset split * **Returns:** True/False #### *property* has_splits Whether the dataset has splits. #### has_tag(tag) Whether the dataset has the given tag. * **Parameters:** **tag** – the tag * **Returns:** True/False #### *property* has_tags Whether the dataset has tags. #### *property* importer_kwargs A dict of default kwargs to pass to this dataset’s [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). #### *property* is_remote Whether the dataset is remotely-sourced. #### *property* license The license or list,of,licenses under which the dataset is distributed, or None if unknown. #### *static* load_info(dataset_dir, upgrade=True, warn_deprecated=False) Loads the `ZooDatasetInfo` from the given dataset directory. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **upgrade** (*True*) – whether to upgrade the JSON file on disk if any migrations were necessary * **warn_deprecated** (*False*) – whether to issue a warning if the dataset has a deprecated format * **Returns:** the `ZooDatasetInfo` for the dataset #### *property* name The name of the dataset. #### *property* parameters An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. #### *property* requires_manual_download Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. #### *property* supported_splits A tuple of supported splits for the dataset, or None if the dataset does not have splits. #### *property* supports_partial_downloads Whether the dataset supports downloading partial subsets of its splits. #### *property* tags A tuple of tags for the dataset. ### *class* fiftyone.zoo.datasets.base.ActivityNet100Dataset(source_dir=None, classes=None, max_duration=None, copy_files=True, num_workers=None, shuffle=None, seed=None, max_samples=None) Bases: [`FiftyOneDataset`](#fiftyone.zoo.datasets.base.FiftyOneDataset) ActivityNet is a large-scale video dataset for human activity understanding supporting the tasks of global video classification, trimmed activity classification, and temporal activity detection. This version contains videos and temporal activity detections for the 100 class version of the dataset. Notes: - ActivityNet 100 and 200 differ in the number of activity classes and videos per split - Partial downloads will download videos (if still available) from YouTube - Full splits can be loaded by first downloading the official source files from the [ActivityNet maintainers](https://docs.google.com/forms/d/e/1FAIpQLSeKaFq9ZfcmZ7W0B0PbEhfbTHY41GeEgwsa7WobJgGUhn4DTQ/viewform) - The test set does not have annotations Full split stats: - Train split: 4,819 videos (7,151 instances) - Test split: 2,480 videos (labels withheld) - Validation split: 2,383 videos (3,582 instances) Partial downloads: - You can specify subsets of data to download via the `max_duration`, `classes`, and `max_samples` parameters Full split downloads: Many videos have been removed from YouTube since the creation of ActivityNet. As a result, if you do not specify any partial download parameters described below, you must first download the official source files from the ActivityNet maintainers in order to load a full split into FiftyOne. To download the source files, you must fill out [this form](https://docs.google.com/forms/d/e/1FAIpQLSeKaFq9ZfcmZ7W0B0PbEhfbTHY41GeEgwsa7WobJgGUhn4DTQ/viewform). Refer to [this page](../integrations/activitynet.md#activitynet-full-split-downloads) to see how to load full splits by passing the `source_dir` parameter to [`load_zoo_dataset()`](fiftyone.zoo.datasets.md#fiftyone.zoo.datasets.load_zoo_dataset). Example usage: ```default import fiftyone as fo import fiftyone.zoo as foz # # Load 10 random samples from the validation split # # Only the required videos will be downloaded (if necessary) # dataset = foz.load_zoo_dataset( "activitynet-100", split="validation", max_samples=10, shuffle=True, ) session = fo.launch_app(dataset) # # Load 10 samples from the validation split that # contain the actions "Bathing dog" and "Walking the dog" # # Videos that contain all `classes` will be prioritized first, followed # by videos that contain at least one of the required `classes`. If # there are not enough videos matching `classes` in the split to meet # `max_samples`, only the available videos will be loaded. # # Videos will only be downloaded if necessary # # Subsequent partial loads of the validation split will never require # downloading any videos # dataset = foz.load_zoo_dataset( "activitynet-100", split="validation", classes=["Bathing dog", "Walking the dog"], max_samples=10, ) session.dataset = dataset ``` Dataset size : 223 GB Source : [http://activity-net.org/index.html](http://activity-net.org/index.html) * **Parameters:** * **source_dir** (*None*) – the directory containing the manually downloaded ActivityNet files used to avoid downloading videos from YouTube * **classes** (*None*) – a string or list of strings specifying required classes to load. If provided, only samples containing at least one instance of a specified class will be loaded * **max_duration** (*None*) – only videos with a duration in seconds that is less than or equal to the `max_duration` will be downloaded. By default, all videos are downloaded * **copy_files** (*True*) – whether to move (False) or create copies (True) of the source files when populating `dataset_dir`. This is only relevant when a `source_dir` is provided * **num_workers** (*None*) – a suggested number of threads to use when downloading individual images * **shuffle** (*False*) – whether to randomly shuffle the order in which samples are chosen for partial downloads * **seed** (*None*) – a random seed to use when shuffling * **max_samples** (*None*) – a maximum number of samples to load per split. If `classes` are also specified, only up to the number of samples that contain at least one specified class will be loaded. By default, all matching samples are loaded **Attributes:** | [`name`](#fiftyone.zoo.datasets.base.ActivityNet100Dataset.name) | The name of the dataset. | |--------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`license`](#fiftyone.zoo.datasets.base.ActivityNet100Dataset.license) | The license or list,of,licenses under which the dataset is distributed, or None if unknown. | | [`tags`](#fiftyone.zoo.datasets.base.ActivityNet100Dataset.tags) | A tuple of tags for the dataset. | | [`supported_splits`](#fiftyone.zoo.datasets.base.ActivityNet100Dataset.supported_splits) | A tuple of supported splits for the dataset, or None if the dataset does not have splits. | | [`supports_partial_downloads`](#fiftyone.zoo.datasets.base.ActivityNet100Dataset.supports_partial_downloads) | Whether the dataset supports downloading partial subsets of its splits. | | [`has_patches`](#fiftyone.zoo.datasets.base.ActivityNet100Dataset.has_patches) | Whether the dataset has patches that may need to be applied to already downloaded files. | | [`has_splits`](#fiftyone.zoo.datasets.base.ActivityNet100Dataset.has_splits) | Whether the dataset has splits. | | [`has_tags`](#fiftyone.zoo.datasets.base.ActivityNet100Dataset.has_tags) | Whether the dataset has tags. | | [`importer_kwargs`](#fiftyone.zoo.datasets.base.ActivityNet100Dataset.importer_kwargs) | A dict of default kwargs to pass to this dataset's [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). | | [`is_remote`](#fiftyone.zoo.datasets.base.ActivityNet100Dataset.is_remote) | Whether the dataset is remotely-sourced. | | [`parameters`](#fiftyone.zoo.datasets.base.ActivityNet100Dataset.parameters) | An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. | | [`requires_manual_download`](#fiftyone.zoo.datasets.base.ActivityNet100Dataset.requires_manual_download) | Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. | **Methods:** | [`download_and_prepare`](#fiftyone.zoo.datasets.base.ActivityNet100Dataset.download_and_prepare)(dataset_dir[, split, ...]) | Downloads the dataset and prepares it for use. | |-------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| | [`get_info_path`](#fiftyone.zoo.datasets.base.ActivityNet100Dataset.get_info_path)(dataset_dir) | Returns the path to the `ZooDatasetInfo` for the dataset. | | [`get_split_dir`](#fiftyone.zoo.datasets.base.ActivityNet100Dataset.get_split_dir)(dataset_dir, split) | Returns the directory for the given split of the dataset. | | [`has_info`](#fiftyone.zoo.datasets.base.ActivityNet100Dataset.has_info)(dataset_dir) | Determines whether the directory contains `ZooDatasetInfo`. | | [`has_split`](#fiftyone.zoo.datasets.base.ActivityNet100Dataset.has_split)(split) | Whether the dataset has the given split. | | [`has_tag`](#fiftyone.zoo.datasets.base.ActivityNet100Dataset.has_tag)(tag) | Whether the dataset has the given tag. | | [`load_info`](#fiftyone.zoo.datasets.base.ActivityNet100Dataset.load_info)(dataset_dir[, upgrade, ...]) | Loads the `ZooDatasetInfo` from the given dataset directory. | #### *property* name The name of the dataset. #### *property* license The license or list,of,licenses under which the dataset is distributed, or None if unknown. #### *property* tags A tuple of tags for the dataset. #### *property* supported_splits A tuple of supported splits for the dataset, or None if the dataset does not have splits. #### *property* supports_partial_downloads Whether the dataset supports downloading partial subsets of its splits. #### download_and_prepare(dataset_dir, split=None, splits=None, cleanup=True) Downloads the dataset and prepares it for use. If the requested splits have already been downloaded, they are not re-downloaded. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **split** (*None*) – `split` nor `splits` are provided, the full dataset is downloaded * **splits** (*None*) – a list of splits to download, if applicable. If neither `split` nor `splits` are provided, the full dataset is downloaded * **cleanup** (*True*) – whether to cleanup any temporary files generated during download * **Returns:** the `ZooDatasetInfo` for the dataset #### *static* get_info_path(dataset_dir) Returns the path to the `ZooDatasetInfo` for the dataset. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** the path to the `ZooDatasetInfo` #### get_split_dir(dataset_dir, split) Returns the directory for the given split of the dataset. * **Parameters:** * **dataset_dir** – the dataset directory * **split** – the dataset split * **Returns:** the directory that will/does hold the specified split #### *static* has_info(dataset_dir) Determines whether the directory contains `ZooDatasetInfo`. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** True/False #### *property* has_patches Whether the dataset has patches that may need to be applied to already downloaded files. #### has_split(split) Whether the dataset has the given split. * **Parameters:** **split** – the dataset split * **Returns:** True/False #### *property* has_splits Whether the dataset has splits. #### has_tag(tag) Whether the dataset has the given tag. * **Parameters:** **tag** – the tag * **Returns:** True/False #### *property* has_tags Whether the dataset has tags. #### *property* importer_kwargs A dict of default kwargs to pass to this dataset’s [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). #### *property* is_remote Whether the dataset is remotely-sourced. #### *static* load_info(dataset_dir, upgrade=True, warn_deprecated=False) Loads the `ZooDatasetInfo` from the given dataset directory. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **upgrade** (*True*) – whether to upgrade the JSON file on disk if any migrations were necessary * **warn_deprecated** (*False*) – whether to issue a warning if the dataset has a deprecated format * **Returns:** the `ZooDatasetInfo` for the dataset #### *property* parameters An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. #### *property* requires_manual_download Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. ### *class* fiftyone.zoo.datasets.base.ActivityNet200Dataset(source_dir=None, classes=None, max_duration=None, copy_files=True, num_workers=None, shuffle=None, seed=None, max_samples=None) Bases: [`FiftyOneDataset`](#fiftyone.zoo.datasets.base.FiftyOneDataset) ActivityNet is a large-scale video dataset for human activity understanding supporting the tasks of global video classification, trimmed activity classification, and temporal activity detection. This version contains videos and temporal activity detections for the 200 class version of the dataset. Notes: - ActivityNet 200 is a superset of ActivityNet 100 - ActivityNet 100 and 200 differ in the number of activity classes and videos per split - Partial downloads will download videos (if still available) from YouTube - Full splits can be loaded by first downloading the official source files from the [ActivityNet maintainers](https://docs.google.com/forms/d/e/1FAIpQLSeKaFq9ZfcmZ7W0B0PbEhfbTHY41GeEgwsa7WobJgGUhn4DTQ/viewform) - The test set does not have annotations Full split stats: - Train split: 10,024 videos (15,410 instances) - Test split: 5,044 videos (labels withheld) - Validation split: 4,926 videos (7,654 instances) Partial downloads: - You can specify subsets of data to download via the `max_duration`, `classes`, and `max_samples` parameters Full split downloads: Many videos have been removed from YouTube since the creation of ActivityNet. As a result, if you do not specify any partial download parameters described below, you must first download the official source files from the ActivityNet maintainers in order to load a full split into FiftyOne. To download the source files, you must fill out [this form](https://docs.google.com/forms/d/e/1FAIpQLSeKaFq9ZfcmZ7W0B0PbEhfbTHY41GeEgwsa7WobJgGUhn4DTQ/viewform). Refer to [this page](../integrations/activitynet.md#activitynet-full-split-downloads) to see how to load full splits by passing the `source_dir` parameter to [`load_zoo_dataset()`](fiftyone.zoo.datasets.md#fiftyone.zoo.datasets.load_zoo_dataset). Example usage: ```default import fiftyone as fo import fiftyone.zoo as foz # # Load 10 random samples from the validation split # # Only the required videos will be downloaded (if necessary) # dataset = foz.load_zoo_dataset( "activitynet-200", split="validation", max_samples=10, shuffle=True, ) session = fo.launch_app(dataset) # # Load 10 samples from the validation split that # contain the actions "Bathing dog" and "Walking the dog" # # Videos that contain all `classes` will be prioritized first, followed # by videos that contain at least one of the required `classes`. If # there are not enough videos matching `classes` in the split to meet # `max_samples`, only the available videos will be loaded. # # Videos will only be downloaded if necessary # # Subsequent partial loads of the validation split will never require # downloading any videos # dataset = foz.load_zoo_dataset( "activitynet-200", split="validation", classes=["Bathing dog", "Walking the dog"], max_samples=10, ) session.dataset = dataset ``` Dataset size : 500 GB Source : [http://activity-net.org/index.html](http://activity-net.org/index.html) * **Parameters:** * **source_dir** (*None*) – the directory containing the manually downloaded ActivityNet files used to avoid downloading videos from YouTube * **classes** (*None*) – a string or list of strings specifying required classes to load. If provided, only samples containing at least one instance of a specified class will be loaded * **max_duration** (*None*) – only videos with a duration in seconds that is less than or equal to the `max_duration` will be downloaded. By default, all videos are downloaded * **copy_files** (*True*) – whether to move (False) or create copies (True) of the source files when populating `dataset_dir`. This is only relevant when a `source_dir` is provided * **num_workers** (*None*) – a suggested number of threads to use when downloading individual images * **shuffle** (*False*) – whether to randomly shuffle the order in which samples are chosen for partial downloads * **seed** (*None*) – a random seed to use when shuffling * **max_samples** (*None*) – a maximum number of samples to load per split. If `classes` are also specified, only up to the number of samples that contain at least one specified class will be loaded. By default, all matching samples are loaded **Attributes:** | [`name`](#fiftyone.zoo.datasets.base.ActivityNet200Dataset.name) | The name of the dataset. | |--------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`license`](#fiftyone.zoo.datasets.base.ActivityNet200Dataset.license) | The license or list,of,licenses under which the dataset is distributed, or None if unknown. | | [`tags`](#fiftyone.zoo.datasets.base.ActivityNet200Dataset.tags) | A tuple of tags for the dataset. | | [`supported_splits`](#fiftyone.zoo.datasets.base.ActivityNet200Dataset.supported_splits) | A tuple of supported splits for the dataset, or None if the dataset does not have splits. | | [`supports_partial_downloads`](#fiftyone.zoo.datasets.base.ActivityNet200Dataset.supports_partial_downloads) | Whether the dataset supports downloading partial subsets of its splits. | | [`has_patches`](#fiftyone.zoo.datasets.base.ActivityNet200Dataset.has_patches) | Whether the dataset has patches that may need to be applied to already downloaded files. | | [`has_splits`](#fiftyone.zoo.datasets.base.ActivityNet200Dataset.has_splits) | Whether the dataset has splits. | | [`has_tags`](#fiftyone.zoo.datasets.base.ActivityNet200Dataset.has_tags) | Whether the dataset has tags. | | [`importer_kwargs`](#fiftyone.zoo.datasets.base.ActivityNet200Dataset.importer_kwargs) | A dict of default kwargs to pass to this dataset's [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). | | [`is_remote`](#fiftyone.zoo.datasets.base.ActivityNet200Dataset.is_remote) | Whether the dataset is remotely-sourced. | | [`parameters`](#fiftyone.zoo.datasets.base.ActivityNet200Dataset.parameters) | An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. | | [`requires_manual_download`](#fiftyone.zoo.datasets.base.ActivityNet200Dataset.requires_manual_download) | Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. | **Methods:** | [`download_and_prepare`](#fiftyone.zoo.datasets.base.ActivityNet200Dataset.download_and_prepare)(dataset_dir[, split, ...]) | Downloads the dataset and prepares it for use. | |-------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| | [`get_info_path`](#fiftyone.zoo.datasets.base.ActivityNet200Dataset.get_info_path)(dataset_dir) | Returns the path to the `ZooDatasetInfo` for the dataset. | | [`get_split_dir`](#fiftyone.zoo.datasets.base.ActivityNet200Dataset.get_split_dir)(dataset_dir, split) | Returns the directory for the given split of the dataset. | | [`has_info`](#fiftyone.zoo.datasets.base.ActivityNet200Dataset.has_info)(dataset_dir) | Determines whether the directory contains `ZooDatasetInfo`. | | [`has_split`](#fiftyone.zoo.datasets.base.ActivityNet200Dataset.has_split)(split) | Whether the dataset has the given split. | | [`has_tag`](#fiftyone.zoo.datasets.base.ActivityNet200Dataset.has_tag)(tag) | Whether the dataset has the given tag. | | [`load_info`](#fiftyone.zoo.datasets.base.ActivityNet200Dataset.load_info)(dataset_dir[, upgrade, ...]) | Loads the `ZooDatasetInfo` from the given dataset directory. | #### *property* name The name of the dataset. #### *property* license The license or list,of,licenses under which the dataset is distributed, or None if unknown. #### *property* tags A tuple of tags for the dataset. #### *property* supported_splits A tuple of supported splits for the dataset, or None if the dataset does not have splits. #### *property* supports_partial_downloads Whether the dataset supports downloading partial subsets of its splits. #### download_and_prepare(dataset_dir, split=None, splits=None, cleanup=True) Downloads the dataset and prepares it for use. If the requested splits have already been downloaded, they are not re-downloaded. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **split** (*None*) – `split` nor `splits` are provided, the full dataset is downloaded * **splits** (*None*) – a list of splits to download, if applicable. If neither `split` nor `splits` are provided, the full dataset is downloaded * **cleanup** (*True*) – whether to cleanup any temporary files generated during download * **Returns:** the `ZooDatasetInfo` for the dataset #### *static* get_info_path(dataset_dir) Returns the path to the `ZooDatasetInfo` for the dataset. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** the path to the `ZooDatasetInfo` #### get_split_dir(dataset_dir, split) Returns the directory for the given split of the dataset. * **Parameters:** * **dataset_dir** – the dataset directory * **split** – the dataset split * **Returns:** the directory that will/does hold the specified split #### *static* has_info(dataset_dir) Determines whether the directory contains `ZooDatasetInfo`. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** True/False #### *property* has_patches Whether the dataset has patches that may need to be applied to already downloaded files. #### has_split(split) Whether the dataset has the given split. * **Parameters:** **split** – the dataset split * **Returns:** True/False #### *property* has_splits Whether the dataset has splits. #### has_tag(tag) Whether the dataset has the given tag. * **Parameters:** **tag** – the tag * **Returns:** True/False #### *property* has_tags Whether the dataset has tags. #### *property* importer_kwargs A dict of default kwargs to pass to this dataset’s [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). #### *property* is_remote Whether the dataset is remotely-sourced. #### *static* load_info(dataset_dir, upgrade=True, warn_deprecated=False) Loads the `ZooDatasetInfo` from the given dataset directory. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **upgrade** (*True*) – whether to upgrade the JSON file on disk if any migrations were necessary * **warn_deprecated** (*False*) – whether to issue a warning if the dataset has a deprecated format * **Returns:** the `ZooDatasetInfo` for the dataset #### *property* parameters An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. #### *property* requires_manual_download Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. ### *class* fiftyone.zoo.datasets.base.BDD100KDataset(source_dir=None, copy_files=True) Bases: [`FiftyOneDataset`](#fiftyone.zoo.datasets.base.FiftyOneDataset) The Berkeley Deep Drive (BDD) dataset is one of the largest and most diverse video datasets for autonomous vehicles. The BDD100K dataset contains 100,000 video clips collected from more than 50,000 rides covering New York, San Francisco Bay Area, and other regions. The dataset contains diverse scene types such as city streets, residential areas, and highways. Furthermore, the videos were recorded in diverse weather conditions at different times of the day. The videos are split into training (70K), validation (10K) and testing (20K) sets. Each video is 40 seconds long with 720p resolution and a frame rate of 30fps. The frame at the 10th second of each video is annotated for image classification, detection, and segmentation tasks. This version of the dataset contains only the 100K images extracted from the videos as described above, together with the image classification, detection, and segmentation labels. In order to load the BDD100K dataset, you must download the source data manually. The directory should be organized in the following format: ```default source_dir/ labels/ bdd100k_labels_images_train.json bdd100k_labels_images_val.json images/ 100k/ train/ test/ val/ ``` You can register at [http://bdd-data.berkeley.edu](http://bdd-data.berkeley.edu) in order to get links to download the data. Example usage: ```default import fiftyone as fo import fiftyone.zoo as foz # The path to the source files that you manually downloaded source_dir = "/path/to/dir-with-bdd100k-files" dataset = foz.load_zoo_dataset( "bdd100k", split="validation", source_dir=source_dir, ) session = fo.launch_app(dataset) ``` Dataset size : 7.10 GB Source : [http://bdd-data.berkeley.edu](http://bdd-data.berkeley.edu) * **Parameters:** * **source_dir** (*None*) – the directory containing the manually downloaded BDD100K files * **copy_files** (*True*) – whether to move (False) or create copies (True) of the source files when populating the dataset directory **Attributes:** | [`name`](#fiftyone.zoo.datasets.base.BDD100KDataset.name) | The name of the dataset. | |-------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`license`](#fiftyone.zoo.datasets.base.BDD100KDataset.license) | The license or list,of,licenses under which the dataset is distributed, or None if unknown. | | [`tags`](#fiftyone.zoo.datasets.base.BDD100KDataset.tags) | A tuple of tags for the dataset. | | [`supported_splits`](#fiftyone.zoo.datasets.base.BDD100KDataset.supported_splits) | A tuple of supported splits for the dataset, or None if the dataset does not have splits. | | [`requires_manual_download`](#fiftyone.zoo.datasets.base.BDD100KDataset.requires_manual_download) | Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. | | [`has_patches`](#fiftyone.zoo.datasets.base.BDD100KDataset.has_patches) | Whether the dataset has patches that may need to be applied to already downloaded files. | | [`has_splits`](#fiftyone.zoo.datasets.base.BDD100KDataset.has_splits) | Whether the dataset has splits. | | [`has_tags`](#fiftyone.zoo.datasets.base.BDD100KDataset.has_tags) | Whether the dataset has tags. | | [`importer_kwargs`](#fiftyone.zoo.datasets.base.BDD100KDataset.importer_kwargs) | A dict of default kwargs to pass to this dataset's [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). | | [`is_remote`](#fiftyone.zoo.datasets.base.BDD100KDataset.is_remote) | Whether the dataset is remotely-sourced. | | [`parameters`](#fiftyone.zoo.datasets.base.BDD100KDataset.parameters) | An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. | | [`supports_partial_downloads`](#fiftyone.zoo.datasets.base.BDD100KDataset.supports_partial_downloads) | Whether the dataset supports downloading partial subsets of its splits. | **Methods:** | [`download_and_prepare`](#fiftyone.zoo.datasets.base.BDD100KDataset.download_and_prepare)(dataset_dir[, split, ...]) | Downloads the dataset and prepares it for use. | |------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| | [`get_info_path`](#fiftyone.zoo.datasets.base.BDD100KDataset.get_info_path)(dataset_dir) | Returns the path to the `ZooDatasetInfo` for the dataset. | | [`get_split_dir`](#fiftyone.zoo.datasets.base.BDD100KDataset.get_split_dir)(dataset_dir, split) | Returns the directory for the given split of the dataset. | | [`has_info`](#fiftyone.zoo.datasets.base.BDD100KDataset.has_info)(dataset_dir) | Determines whether the directory contains `ZooDatasetInfo`. | | [`has_split`](#fiftyone.zoo.datasets.base.BDD100KDataset.has_split)(split) | Whether the dataset has the given split. | | [`has_tag`](#fiftyone.zoo.datasets.base.BDD100KDataset.has_tag)(tag) | Whether the dataset has the given tag. | | [`load_info`](#fiftyone.zoo.datasets.base.BDD100KDataset.load_info)(dataset_dir[, upgrade, ...]) | Loads the `ZooDatasetInfo` from the given dataset directory. | #### *property* name The name of the dataset. #### *property* license The license or list,of,licenses under which the dataset is distributed, or None if unknown. #### *property* tags A tuple of tags for the dataset. #### *property* supported_splits A tuple of supported splits for the dataset, or None if the dataset does not have splits. #### *property* requires_manual_download Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. #### download_and_prepare(dataset_dir, split=None, splits=None, cleanup=True) Downloads the dataset and prepares it for use. If the requested splits have already been downloaded, they are not re-downloaded. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **split** (*None*) – `split` nor `splits` are provided, the full dataset is downloaded * **splits** (*None*) – a list of splits to download, if applicable. If neither `split` nor `splits` are provided, the full dataset is downloaded * **cleanup** (*True*) – whether to cleanup any temporary files generated during download * **Returns:** the `ZooDatasetInfo` for the dataset #### *static* get_info_path(dataset_dir) Returns the path to the `ZooDatasetInfo` for the dataset. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** the path to the `ZooDatasetInfo` #### get_split_dir(dataset_dir, split) Returns the directory for the given split of the dataset. * **Parameters:** * **dataset_dir** – the dataset directory * **split** – the dataset split * **Returns:** the directory that will/does hold the specified split #### *static* has_info(dataset_dir) Determines whether the directory contains `ZooDatasetInfo`. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** True/False #### *property* has_patches Whether the dataset has patches that may need to be applied to already downloaded files. #### has_split(split) Whether the dataset has the given split. * **Parameters:** **split** – the dataset split * **Returns:** True/False #### *property* has_splits Whether the dataset has splits. #### has_tag(tag) Whether the dataset has the given tag. * **Parameters:** **tag** – the tag * **Returns:** True/False #### *property* has_tags Whether the dataset has tags. #### *property* importer_kwargs A dict of default kwargs to pass to this dataset’s [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). #### *property* is_remote Whether the dataset is remotely-sourced. #### *static* load_info(dataset_dir, upgrade=True, warn_deprecated=False) Loads the `ZooDatasetInfo` from the given dataset directory. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **upgrade** (*True*) – whether to upgrade the JSON file on disk if any migrations were necessary * **warn_deprecated** (*False*) – whether to issue a warning if the dataset has a deprecated format * **Returns:** the `ZooDatasetInfo` for the dataset #### *property* parameters An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. #### *property* supports_partial_downloads Whether the dataset supports downloading partial subsets of its splits. ### *class* fiftyone.zoo.datasets.base.Caltech101Dataset Bases: [`FiftyOneDataset`](#fiftyone.zoo.datasets.base.FiftyOneDataset) The Caltech-101 dataset of images. The dataset consists of pictures of objects belonging to 101 classes, plus one background clutter class (`BACKGROUND_Google`). Each image is labelled with a single object. Each class contains roughly 40 to 800 images, totalling 9,144 images. Images are of variable sizes, with typical edge lengths of 200-300 pixels. This version contains image-level labels only. Example usage: ```default import fiftyone as fo import fiftyone.zoo as foz dataset = foz.load_zoo_dataset("caltech101") session = fo.launch_app(dataset) ``` Dataset size : 138.60 MB Source : [https://data.caltech.edu/records/mzrjq-6wc02](https://data.caltech.edu/records/mzrjq-6wc02) **Attributes:** | [`name`](#fiftyone.zoo.datasets.base.Caltech101Dataset.name) | The name of the dataset. | |----------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`license`](#fiftyone.zoo.datasets.base.Caltech101Dataset.license) | The license or list,of,licenses under which the dataset is distributed, or None if unknown. | | [`tags`](#fiftyone.zoo.datasets.base.Caltech101Dataset.tags) | A tuple of tags for the dataset. | | [`supported_splits`](#fiftyone.zoo.datasets.base.Caltech101Dataset.supported_splits) | A tuple of supported splits for the dataset, or None if the dataset does not have splits. | | [`has_patches`](#fiftyone.zoo.datasets.base.Caltech101Dataset.has_patches) | Whether the dataset has patches that may need to be applied to already downloaded files. | | [`has_splits`](#fiftyone.zoo.datasets.base.Caltech101Dataset.has_splits) | Whether the dataset has splits. | | [`has_tags`](#fiftyone.zoo.datasets.base.Caltech101Dataset.has_tags) | Whether the dataset has tags. | | [`importer_kwargs`](#fiftyone.zoo.datasets.base.Caltech101Dataset.importer_kwargs) | A dict of default kwargs to pass to this dataset's [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). | | [`is_remote`](#fiftyone.zoo.datasets.base.Caltech101Dataset.is_remote) | Whether the dataset is remotely-sourced. | | [`parameters`](#fiftyone.zoo.datasets.base.Caltech101Dataset.parameters) | An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. | | [`requires_manual_download`](#fiftyone.zoo.datasets.base.Caltech101Dataset.requires_manual_download) | Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. | | [`supports_partial_downloads`](#fiftyone.zoo.datasets.base.Caltech101Dataset.supports_partial_downloads) | Whether the dataset supports downloading partial subsets of its splits. | **Methods:** | [`download_and_prepare`](#fiftyone.zoo.datasets.base.Caltech101Dataset.download_and_prepare)(dataset_dir[, split, ...]) | Downloads the dataset and prepares it for use. | |---------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| | [`get_info_path`](#fiftyone.zoo.datasets.base.Caltech101Dataset.get_info_path)(dataset_dir) | Returns the path to the `ZooDatasetInfo` for the dataset. | | [`get_split_dir`](#fiftyone.zoo.datasets.base.Caltech101Dataset.get_split_dir)(dataset_dir, split) | Returns the directory for the given split of the dataset. | | [`has_info`](#fiftyone.zoo.datasets.base.Caltech101Dataset.has_info)(dataset_dir) | Determines whether the directory contains `ZooDatasetInfo`. | | [`has_split`](#fiftyone.zoo.datasets.base.Caltech101Dataset.has_split)(split) | Whether the dataset has the given split. | | [`has_tag`](#fiftyone.zoo.datasets.base.Caltech101Dataset.has_tag)(tag) | Whether the dataset has the given tag. | | [`load_info`](#fiftyone.zoo.datasets.base.Caltech101Dataset.load_info)(dataset_dir[, upgrade, ...]) | Loads the `ZooDatasetInfo` from the given dataset directory. | #### *property* name The name of the dataset. #### *property* license The license or list,of,licenses under which the dataset is distributed, or None if unknown. #### *property* tags A tuple of tags for the dataset. #### *property* supported_splits A tuple of supported splits for the dataset, or None if the dataset does not have splits. #### download_and_prepare(dataset_dir, split=None, splits=None, cleanup=True) Downloads the dataset and prepares it for use. If the requested splits have already been downloaded, they are not re-downloaded. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **split** (*None*) – `split` nor `splits` are provided, the full dataset is downloaded * **splits** (*None*) – a list of splits to download, if applicable. If neither `split` nor `splits` are provided, the full dataset is downloaded * **cleanup** (*True*) – whether to cleanup any temporary files generated during download * **Returns:** the `ZooDatasetInfo` for the dataset #### *static* get_info_path(dataset_dir) Returns the path to the `ZooDatasetInfo` for the dataset. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** the path to the `ZooDatasetInfo` #### get_split_dir(dataset_dir, split) Returns the directory for the given split of the dataset. * **Parameters:** * **dataset_dir** – the dataset directory * **split** – the dataset split * **Returns:** the directory that will/does hold the specified split #### *static* has_info(dataset_dir) Determines whether the directory contains `ZooDatasetInfo`. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** True/False #### *property* has_patches Whether the dataset has patches that may need to be applied to already downloaded files. #### has_split(split) Whether the dataset has the given split. * **Parameters:** **split** – the dataset split * **Returns:** True/False #### *property* has_splits Whether the dataset has splits. #### has_tag(tag) Whether the dataset has the given tag. * **Parameters:** **tag** – the tag * **Returns:** True/False #### *property* has_tags Whether the dataset has tags. #### *property* importer_kwargs A dict of default kwargs to pass to this dataset’s [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). #### *property* is_remote Whether the dataset is remotely-sourced. #### *static* load_info(dataset_dir, upgrade=True, warn_deprecated=False) Loads the `ZooDatasetInfo` from the given dataset directory. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **upgrade** (*True*) – whether to upgrade the JSON file on disk if any migrations were necessary * **warn_deprecated** (*False*) – whether to issue a warning if the dataset has a deprecated format * **Returns:** the `ZooDatasetInfo` for the dataset #### *property* parameters An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. #### *property* requires_manual_download Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. #### *property* supports_partial_downloads Whether the dataset supports downloading partial subsets of its splits. ### *class* fiftyone.zoo.datasets.base.Caltech256Dataset Bases: [`FiftyOneDataset`](#fiftyone.zoo.datasets.base.FiftyOneDataset) The Caltech-256 dataset of images. The dataset consists of pictures of objects belonging to 256 classes, plus one background clutter class (`clutter`). Each image is labelled with a single object. Each class contains between 80 and 827 images, totalling 30,607 images. Images are of variable sizes, with typical edge lengths of 80-800 pixels. Example usage: ```default import fiftyone as fo import fiftyone.zoo as foz dataset = foz.load_zoo_dataset("caltech256") session = fo.launch_app(dataset) ``` Dataset size : 1.16 GB Source : [https://data.caltech.edu/records/nyy15-4j048](https://data.caltech.edu/records/nyy15-4j048) **Attributes:** | [`name`](#fiftyone.zoo.datasets.base.Caltech256Dataset.name) | The name of the dataset. | |----------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`license`](#fiftyone.zoo.datasets.base.Caltech256Dataset.license) | The license or list,of,licenses under which the dataset is distributed, or None if unknown. | | [`tags`](#fiftyone.zoo.datasets.base.Caltech256Dataset.tags) | A tuple of tags for the dataset. | | [`supported_splits`](#fiftyone.zoo.datasets.base.Caltech256Dataset.supported_splits) | A tuple of supported splits for the dataset, or None if the dataset does not have splits. | | [`has_patches`](#fiftyone.zoo.datasets.base.Caltech256Dataset.has_patches) | Whether the dataset has patches that may need to be applied to already downloaded files. | | [`has_splits`](#fiftyone.zoo.datasets.base.Caltech256Dataset.has_splits) | Whether the dataset has splits. | | [`has_tags`](#fiftyone.zoo.datasets.base.Caltech256Dataset.has_tags) | Whether the dataset has tags. | | [`importer_kwargs`](#fiftyone.zoo.datasets.base.Caltech256Dataset.importer_kwargs) | A dict of default kwargs to pass to this dataset's [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). | | [`is_remote`](#fiftyone.zoo.datasets.base.Caltech256Dataset.is_remote) | Whether the dataset is remotely-sourced. | | [`parameters`](#fiftyone.zoo.datasets.base.Caltech256Dataset.parameters) | An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. | | [`requires_manual_download`](#fiftyone.zoo.datasets.base.Caltech256Dataset.requires_manual_download) | Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. | | [`supports_partial_downloads`](#fiftyone.zoo.datasets.base.Caltech256Dataset.supports_partial_downloads) | Whether the dataset supports downloading partial subsets of its splits. | **Methods:** | [`download_and_prepare`](#fiftyone.zoo.datasets.base.Caltech256Dataset.download_and_prepare)(dataset_dir[, split, ...]) | Downloads the dataset and prepares it for use. | |---------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| | [`get_info_path`](#fiftyone.zoo.datasets.base.Caltech256Dataset.get_info_path)(dataset_dir) | Returns the path to the `ZooDatasetInfo` for the dataset. | | [`get_split_dir`](#fiftyone.zoo.datasets.base.Caltech256Dataset.get_split_dir)(dataset_dir, split) | Returns the directory for the given split of the dataset. | | [`has_info`](#fiftyone.zoo.datasets.base.Caltech256Dataset.has_info)(dataset_dir) | Determines whether the directory contains `ZooDatasetInfo`. | | [`has_split`](#fiftyone.zoo.datasets.base.Caltech256Dataset.has_split)(split) | Whether the dataset has the given split. | | [`has_tag`](#fiftyone.zoo.datasets.base.Caltech256Dataset.has_tag)(tag) | Whether the dataset has the given tag. | | [`load_info`](#fiftyone.zoo.datasets.base.Caltech256Dataset.load_info)(dataset_dir[, upgrade, ...]) | Loads the `ZooDatasetInfo` from the given dataset directory. | #### *property* name The name of the dataset. #### *property* license The license or list,of,licenses under which the dataset is distributed, or None if unknown. #### *property* tags A tuple of tags for the dataset. #### *property* supported_splits A tuple of supported splits for the dataset, or None if the dataset does not have splits. #### download_and_prepare(dataset_dir, split=None, splits=None, cleanup=True) Downloads the dataset and prepares it for use. If the requested splits have already been downloaded, they are not re-downloaded. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **split** (*None*) – `split` nor `splits` are provided, the full dataset is downloaded * **splits** (*None*) – a list of splits to download, if applicable. If neither `split` nor `splits` are provided, the full dataset is downloaded * **cleanup** (*True*) – whether to cleanup any temporary files generated during download * **Returns:** the `ZooDatasetInfo` for the dataset #### *static* get_info_path(dataset_dir) Returns the path to the `ZooDatasetInfo` for the dataset. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** the path to the `ZooDatasetInfo` #### get_split_dir(dataset_dir, split) Returns the directory for the given split of the dataset. * **Parameters:** * **dataset_dir** – the dataset directory * **split** – the dataset split * **Returns:** the directory that will/does hold the specified split #### *static* has_info(dataset_dir) Determines whether the directory contains `ZooDatasetInfo`. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** True/False #### *property* has_patches Whether the dataset has patches that may need to be applied to already downloaded files. #### has_split(split) Whether the dataset has the given split. * **Parameters:** **split** – the dataset split * **Returns:** True/False #### *property* has_splits Whether the dataset has splits. #### has_tag(tag) Whether the dataset has the given tag. * **Parameters:** **tag** – the tag * **Returns:** True/False #### *property* has_tags Whether the dataset has tags. #### *property* importer_kwargs A dict of default kwargs to pass to this dataset’s [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). #### *property* is_remote Whether the dataset is remotely-sourced. #### *static* load_info(dataset_dir, upgrade=True, warn_deprecated=False) Loads the `ZooDatasetInfo` from the given dataset directory. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **upgrade** (*True*) – whether to upgrade the JSON file on disk if any migrations were necessary * **warn_deprecated** (*False*) – whether to issue a warning if the dataset has a deprecated format * **Returns:** the `ZooDatasetInfo` for the dataset #### *property* parameters An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. #### *property* requires_manual_download Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. #### *property* supports_partial_downloads Whether the dataset supports downloading partial subsets of its splits. ### *class* fiftyone.zoo.datasets.base.CityscapesDataset(source_dir=None, fine_annos=None, coarse_annos=None, person_annos=None) Bases: [`FiftyOneDataset`](#fiftyone.zoo.datasets.base.FiftyOneDataset) Cityscapes is a large-scale dataset that contains a diverse set of stereo video sequences recorded in street scenes from 50 different cities, with high quality pixel-level annotations of 5,000 frames in addition to a larger set of 20,000 weakly annotated frames. The dataset is intended for: - Assessing the performance of vision algorithms for major tasks of semantic urban scene understanding: pixel-level, instance-level, and panoptic semantic labeling - Supporting research that aims to exploit large volumes of (weakly) annotated data, e.g. for training deep neural networks In order to load the Cityscapes dataset, you must download the source data manually. The directory should be organized in the following format: ```default source_dir/ leftImg8bit_trainvaltest.zip gtFine_trainvaltest.zip # optional gtCoarse.zip # optional gtBbox_cityPersons_trainval.zip # optional ``` You can register at [https://www.cityscapes-dataset.com/register](https://www.cityscapes-dataset.com/register) in order to get links to download the data. Example usage: ```default import fiftyone as fo import fiftyone.zoo as foz # The path to the source files that you manually downloaded source_dir = "/path/to/dir-with-cityscapes-files" dataset = foz.load_zoo_dataset( "cityscapes", split="validation", source_dir=source_dir, ) session = fo.launch_app(dataset) ``` Dataset size : 11.80 GB Source : [https://www.cityscapes-dataset.com](https://www.cityscapes-dataset.com) * **Parameters:** * **source_dir** (*None*) – a directory containing the manually downloaded Cityscapes files * **fine_annos** (*None*) – whether to load the fine annotations (True), or not (False), or only if the ZIP file exists (None) * **coarse_annos** (*None*) – whether to load the coarse annotations (True), or not (False), or only if the ZIP file exists (None) * **person_annos** (*None*) – whether to load the personn detections (True), or not (False), or only if the ZIP file exists (None) **Attributes:** | [`name`](#fiftyone.zoo.datasets.base.CityscapesDataset.name) | The name of the dataset. | |----------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`license`](#fiftyone.zoo.datasets.base.CityscapesDataset.license) | The license or list,of,licenses under which the dataset is distributed, or None if unknown. | | [`tags`](#fiftyone.zoo.datasets.base.CityscapesDataset.tags) | A tuple of tags for the dataset. | | [`supported_splits`](#fiftyone.zoo.datasets.base.CityscapesDataset.supported_splits) | A tuple of supported splits for the dataset, or None if the dataset does not have splits. | | [`requires_manual_download`](#fiftyone.zoo.datasets.base.CityscapesDataset.requires_manual_download) | Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. | | [`has_patches`](#fiftyone.zoo.datasets.base.CityscapesDataset.has_patches) | Whether the dataset has patches that may need to be applied to already downloaded files. | | [`has_splits`](#fiftyone.zoo.datasets.base.CityscapesDataset.has_splits) | Whether the dataset has splits. | | [`has_tags`](#fiftyone.zoo.datasets.base.CityscapesDataset.has_tags) | Whether the dataset has tags. | | [`importer_kwargs`](#fiftyone.zoo.datasets.base.CityscapesDataset.importer_kwargs) | A dict of default kwargs to pass to this dataset's [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). | | [`is_remote`](#fiftyone.zoo.datasets.base.CityscapesDataset.is_remote) | Whether the dataset is remotely-sourced. | | [`parameters`](#fiftyone.zoo.datasets.base.CityscapesDataset.parameters) | An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. | | [`supports_partial_downloads`](#fiftyone.zoo.datasets.base.CityscapesDataset.supports_partial_downloads) | Whether the dataset supports downloading partial subsets of its splits. | **Methods:** | [`download_and_prepare`](#fiftyone.zoo.datasets.base.CityscapesDataset.download_and_prepare)(dataset_dir[, split, ...]) | Downloads the dataset and prepares it for use. | |---------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| | [`get_info_path`](#fiftyone.zoo.datasets.base.CityscapesDataset.get_info_path)(dataset_dir) | Returns the path to the `ZooDatasetInfo` for the dataset. | | [`get_split_dir`](#fiftyone.zoo.datasets.base.CityscapesDataset.get_split_dir)(dataset_dir, split) | Returns the directory for the given split of the dataset. | | [`has_info`](#fiftyone.zoo.datasets.base.CityscapesDataset.has_info)(dataset_dir) | Determines whether the directory contains `ZooDatasetInfo`. | | [`has_split`](#fiftyone.zoo.datasets.base.CityscapesDataset.has_split)(split) | Whether the dataset has the given split. | | [`has_tag`](#fiftyone.zoo.datasets.base.CityscapesDataset.has_tag)(tag) | Whether the dataset has the given tag. | | [`load_info`](#fiftyone.zoo.datasets.base.CityscapesDataset.load_info)(dataset_dir[, upgrade, ...]) | Loads the `ZooDatasetInfo` from the given dataset directory. | #### *property* name The name of the dataset. #### *property* license The license or list,of,licenses under which the dataset is distributed, or None if unknown. #### *property* tags A tuple of tags for the dataset. #### *property* supported_splits A tuple of supported splits for the dataset, or None if the dataset does not have splits. #### *property* requires_manual_download Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. #### download_and_prepare(dataset_dir, split=None, splits=None, cleanup=True) Downloads the dataset and prepares it for use. If the requested splits have already been downloaded, they are not re-downloaded. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **split** (*None*) – `split` nor `splits` are provided, the full dataset is downloaded * **splits** (*None*) – a list of splits to download, if applicable. If neither `split` nor `splits` are provided, the full dataset is downloaded * **cleanup** (*True*) – whether to cleanup any temporary files generated during download * **Returns:** the `ZooDatasetInfo` for the dataset #### *static* get_info_path(dataset_dir) Returns the path to the `ZooDatasetInfo` for the dataset. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** the path to the `ZooDatasetInfo` #### get_split_dir(dataset_dir, split) Returns the directory for the given split of the dataset. * **Parameters:** * **dataset_dir** – the dataset directory * **split** – the dataset split * **Returns:** the directory that will/does hold the specified split #### *static* has_info(dataset_dir) Determines whether the directory contains `ZooDatasetInfo`. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** True/False #### *property* has_patches Whether the dataset has patches that may need to be applied to already downloaded files. #### has_split(split) Whether the dataset has the given split. * **Parameters:** **split** – the dataset split * **Returns:** True/False #### *property* has_splits Whether the dataset has splits. #### has_tag(tag) Whether the dataset has the given tag. * **Parameters:** **tag** – the tag * **Returns:** True/False #### *property* has_tags Whether the dataset has tags. #### *property* importer_kwargs A dict of default kwargs to pass to this dataset’s [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). #### *property* is_remote Whether the dataset is remotely-sourced. #### *static* load_info(dataset_dir, upgrade=True, warn_deprecated=False) Loads the `ZooDatasetInfo` from the given dataset directory. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **upgrade** (*True*) – whether to upgrade the JSON file on disk if any migrations were necessary * **warn_deprecated** (*False*) – whether to issue a warning if the dataset has a deprecated format * **Returns:** the `ZooDatasetInfo` for the dataset #### *property* parameters An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. #### *property* supports_partial_downloads Whether the dataset supports downloading partial subsets of its splits. ### *class* fiftyone.zoo.datasets.base.COCO2014Dataset(label_types=None, classes=None, image_ids=None, num_workers=None, shuffle=None, seed=None, max_samples=None) Bases: [`FiftyOneDataset`](#fiftyone.zoo.datasets.base.FiftyOneDataset) COCO is a large-scale object detection, segmentation, and captioning dataset. This version contains images, bounding boxes, and segmentations for the 2014 version of the dataset. This dataset supports partial downloads: - You can specify subsets of data to download via the `label_types`, `classes`, and `max_samples` parameters - You can specify specific images to load via the `image_ids` parameter See [this page](../dataset_zoo/datasets/coco_2014.md#dataset-zoo-coco-2014) for more information about partial downloads of this dataset. Full split stats: - Train split: 82,783 images - Test split: 40,775 images - Validation split: 40,504 images Notes: - COCO defines 91 classes but the data only uses 80 classes - Some images from the train and validation sets don’t have annotations - The test set does not have annotations - COCO 2014 and 2017 use the same images, but the splits are different Example usage: ```default import fiftyone as fo import fiftyone.zoo as foz # # Load 50 random samples from the validation split # # By default, only detections are loaded # dataset = foz.load_zoo_dataset( "coco-2014", split="validation", max_samples=50, shuffle=True, ) session = fo.launch_app(dataset) # # Load segmentations for 25 samples from the validation split that # contain cats and dogs # # Images that contain all `classes` will be prioritized first, followed # by images that contain at least one of the required `classes`. If # there are not enough images matching `classes` in the split to meet # `max_samples`, only the available images will be loaded. # # Images will only be downloaded if necessary # dataset = foz.load_zoo_dataset( "coco-2014", split="validation", label_types=["segmentations"], classes=["cat", "dog"], max_samples=25, ) session.dataset = dataset # # Download the entire validation split and load both detections and # segmentations # # Subsequent partial loads of the validation split will never require # downloading any images # dataset = foz.load_zoo_dataset( "coco-2014", split="validation", label_types=["detections", "segmentations"], ) session.dataset = dataset ``` Dataset size : 37.57 GB Source : [http://cocodataset.org/#home](http://cocodataset.org/#home) * **Parameters:** * **label_types** (*None*) – a label type or list of label types to load. The supported values are `("detections", "segmentations")`. By default, only “detections” are loaded * **classes** (*None*) – a string or list of strings specifying required classes to load. If provided, only samples containing at least one instance of a specified class will be loaded * **image_ids** (*None*) – an optional list of specific image IDs to load. Can be provided in any of the following formats: - a list of `` ints or strings - a list of `/` strings - the path to a text (newline-separated), JSON, or CSV file containing the list of image IDs to load in either of the first two formats * **num_workers** (*None*) – a suggested number of threads to use when downloading individual images * **shuffle** (*False*) – whether to randomly shuffle the order in which samples are chosen for partial downloads * **seed** (*None*) – a random seed to use when shuffling * **max_samples** (*None*) – a maximum number of samples to load per split. If `label_types` and/or `classes` are also specified, first priority will be given to samples that contain all of the specified label types and/or classes, followed by samples that contain at least one of the specified labels types or classes. The actual number of samples loaded may be less than this maximum value if the dataset does not contain sufficient samples matching your requirements. By default, all matching samples are loaded **Attributes:** | [`name`](#fiftyone.zoo.datasets.base.COCO2014Dataset.name) | The name of the dataset. | |--------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`license`](#fiftyone.zoo.datasets.base.COCO2014Dataset.license) | The license or list,of,licenses under which the dataset is distributed, or None if unknown. | | [`tags`](#fiftyone.zoo.datasets.base.COCO2014Dataset.tags) | A tuple of tags for the dataset. | | [`supported_splits`](#fiftyone.zoo.datasets.base.COCO2014Dataset.supported_splits) | A tuple of supported splits for the dataset, or None if the dataset does not have splits. | | [`supports_partial_downloads`](#fiftyone.zoo.datasets.base.COCO2014Dataset.supports_partial_downloads) | Whether the dataset supports downloading partial subsets of its splits. | | [`importer_kwargs`](#fiftyone.zoo.datasets.base.COCO2014Dataset.importer_kwargs) | A dict of default kwargs to pass to this dataset's [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). | | [`has_patches`](#fiftyone.zoo.datasets.base.COCO2014Dataset.has_patches) | Whether the dataset has patches that may need to be applied to already downloaded files. | | [`has_splits`](#fiftyone.zoo.datasets.base.COCO2014Dataset.has_splits) | Whether the dataset has splits. | | [`has_tags`](#fiftyone.zoo.datasets.base.COCO2014Dataset.has_tags) | Whether the dataset has tags. | | [`is_remote`](#fiftyone.zoo.datasets.base.COCO2014Dataset.is_remote) | Whether the dataset is remotely-sourced. | | [`parameters`](#fiftyone.zoo.datasets.base.COCO2014Dataset.parameters) | An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. | | [`requires_manual_download`](#fiftyone.zoo.datasets.base.COCO2014Dataset.requires_manual_download) | Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. | **Methods:** | [`download_and_prepare`](#fiftyone.zoo.datasets.base.COCO2014Dataset.download_and_prepare)(dataset_dir[, split, ...]) | Downloads the dataset and prepares it for use. | |-------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| | [`get_info_path`](#fiftyone.zoo.datasets.base.COCO2014Dataset.get_info_path)(dataset_dir) | Returns the path to the `ZooDatasetInfo` for the dataset. | | [`get_split_dir`](#fiftyone.zoo.datasets.base.COCO2014Dataset.get_split_dir)(dataset_dir, split) | Returns the directory for the given split of the dataset. | | [`has_info`](#fiftyone.zoo.datasets.base.COCO2014Dataset.has_info)(dataset_dir) | Determines whether the directory contains `ZooDatasetInfo`. | | [`has_split`](#fiftyone.zoo.datasets.base.COCO2014Dataset.has_split)(split) | Whether the dataset has the given split. | | [`has_tag`](#fiftyone.zoo.datasets.base.COCO2014Dataset.has_tag)(tag) | Whether the dataset has the given tag. | | [`load_info`](#fiftyone.zoo.datasets.base.COCO2014Dataset.load_info)(dataset_dir[, upgrade, ...]) | Loads the `ZooDatasetInfo` from the given dataset directory. | #### *property* name The name of the dataset. #### *property* license The license or list,of,licenses under which the dataset is distributed, or None if unknown. #### *property* tags A tuple of tags for the dataset. #### *property* supported_splits A tuple of supported splits for the dataset, or None if the dataset does not have splits. #### *property* supports_partial_downloads Whether the dataset supports downloading partial subsets of its splits. #### *property* importer_kwargs A dict of default kwargs to pass to this dataset’s [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). #### download_and_prepare(dataset_dir, split=None, splits=None, cleanup=True) Downloads the dataset and prepares it for use. If the requested splits have already been downloaded, they are not re-downloaded. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **split** (*None*) – `split` nor `splits` are provided, the full dataset is downloaded * **splits** (*None*) – a list of splits to download, if applicable. If neither `split` nor `splits` are provided, the full dataset is downloaded * **cleanup** (*True*) – whether to cleanup any temporary files generated during download * **Returns:** the `ZooDatasetInfo` for the dataset #### *static* get_info_path(dataset_dir) Returns the path to the `ZooDatasetInfo` for the dataset. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** the path to the `ZooDatasetInfo` #### get_split_dir(dataset_dir, split) Returns the directory for the given split of the dataset. * **Parameters:** * **dataset_dir** – the dataset directory * **split** – the dataset split * **Returns:** the directory that will/does hold the specified split #### *static* has_info(dataset_dir) Determines whether the directory contains `ZooDatasetInfo`. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** True/False #### *property* has_patches Whether the dataset has patches that may need to be applied to already downloaded files. #### has_split(split) Whether the dataset has the given split. * **Parameters:** **split** – the dataset split * **Returns:** True/False #### *property* has_splits Whether the dataset has splits. #### has_tag(tag) Whether the dataset has the given tag. * **Parameters:** **tag** – the tag * **Returns:** True/False #### *property* has_tags Whether the dataset has tags. #### *property* is_remote Whether the dataset is remotely-sourced. #### *static* load_info(dataset_dir, upgrade=True, warn_deprecated=False) Loads the `ZooDatasetInfo` from the given dataset directory. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **upgrade** (*True*) – whether to upgrade the JSON file on disk if any migrations were necessary * **warn_deprecated** (*False*) – whether to issue a warning if the dataset has a deprecated format * **Returns:** the `ZooDatasetInfo` for the dataset #### *property* parameters An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. #### *property* requires_manual_download Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. ### *class* fiftyone.zoo.datasets.base.COCO2017Dataset(label_types=None, classes=None, image_ids=None, num_workers=None, shuffle=None, seed=None, max_samples=None) Bases: [`FiftyOneDataset`](#fiftyone.zoo.datasets.base.FiftyOneDataset) COCO is a large-scale object detection, segmentation, and captioning dataset. This version contains images, bounding boxes, segmentations, and keypoints for the 2017 version of the dataset. This dataset supports partial downloads: - You can specify subsets of data to download via the `label_types`, `classes`, and `max_samples` parameters - You can specify specific images to load via the `image_ids` parameter See [this page](../dataset_zoo/datasets/coco_2017.md#dataset-zoo-coco-2017) for more information about partial downloads of this dataset. Full split stats: - Train split: 118,287 images - Test split: 40,670 images - Validation split: 5,000 images Notes: - COCO defines 91 classes but the data only uses 80 classes - Some images from the train and validation sets don’t have annotations - The test set does not have annotations - COCO 2014 and 2017 use the same images, but the splits are different Example usage: ```default import fiftyone as fo import fiftyone.zoo as foz # # Load 50 random samples from the validation split # # By default, only detections are loaded # dataset = foz.load_zoo_dataset( "coco-2017", split="validation", max_samples=50, shuffle=True, ) session = fo.launch_app(dataset) # # Load segmentations for 25 samples from the validation split that # contain cats and dogs # # Images that contain all `classes` will be prioritized first, followed # by images that contain at least one of the required `classes`. If # there are not enough images matching `classes` in the split to meet # `max_samples`, only the available images will be loaded. # # Images will only be downloaded if necessary # dataset = foz.load_zoo_dataset( "coco-2017", split="validation", label_types=["segmentations"], classes=["cat", "dog"], max_samples=25, ) session.dataset = dataset # # Download the entire validation split and load both detections and # segmentations # # Subsequent partial loads of the validation split will never require # downloading any images # dataset = foz.load_zoo_dataset( "coco-2017", split="validation", label_types=["detections", "segmentations"], ) session.dataset = dataset ``` Dataset size : 25.20 GB Source : [http://cocodataset.org/#home](http://cocodataset.org/#home) * **Parameters:** * **label_types** (*None*) – a label type or list of label types to load. The supported values are `("detections", "segmentations")`. By default, only “detections” are loaded * **classes** (*None*) – a string or list of strings specifying required classes to load. If provided, only samples containing at least one instance of a specified class will be loaded * **image_ids** (*None*) – an optional list of specific image IDs to load. Can be provided in any of the following formats: - a list of `` ints or strings - a list of `/` strings - the path to a text (newline-separated), JSON, or CSV file containing the list of image IDs to load in either of the first two formats * **num_workers** (*None*) – a suggested number of threads to use when downloading individual images * **shuffle** (*False*) – whether to randomly shuffle the order in which samples are chosen for partial downloads * **seed** (*None*) – a random seed to use when shuffling * **max_samples** (*None*) – a maximum number of samples to load per split. If `label_types` and/or `classes` are also specified, first priority will be given to samples that contain all of the specified label types and/or classes, followed by samples that contain at least one of the specified labels types or classes. The actual number of samples loaded may be less than this maximum value if the dataset does not contain sufficient samples matching your requirements. By default, all matching samples are loaded **Attributes:** | [`name`](#fiftyone.zoo.datasets.base.COCO2017Dataset.name) | The name of the dataset. | |--------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`license`](#fiftyone.zoo.datasets.base.COCO2017Dataset.license) | The license or list,of,licenses under which the dataset is distributed, or None if unknown. | | [`tags`](#fiftyone.zoo.datasets.base.COCO2017Dataset.tags) | A tuple of tags for the dataset. | | [`supported_splits`](#fiftyone.zoo.datasets.base.COCO2017Dataset.supported_splits) | A tuple of supported splits for the dataset, or None if the dataset does not have splits. | | [`supports_partial_downloads`](#fiftyone.zoo.datasets.base.COCO2017Dataset.supports_partial_downloads) | Whether the dataset supports downloading partial subsets of its splits. | | [`importer_kwargs`](#fiftyone.zoo.datasets.base.COCO2017Dataset.importer_kwargs) | A dict of default kwargs to pass to this dataset's [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). | | [`has_patches`](#fiftyone.zoo.datasets.base.COCO2017Dataset.has_patches) | Whether the dataset has patches that may need to be applied to already downloaded files. | | [`has_splits`](#fiftyone.zoo.datasets.base.COCO2017Dataset.has_splits) | Whether the dataset has splits. | | [`has_tags`](#fiftyone.zoo.datasets.base.COCO2017Dataset.has_tags) | Whether the dataset has tags. | | [`is_remote`](#fiftyone.zoo.datasets.base.COCO2017Dataset.is_remote) | Whether the dataset is remotely-sourced. | | [`parameters`](#fiftyone.zoo.datasets.base.COCO2017Dataset.parameters) | An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. | | [`requires_manual_download`](#fiftyone.zoo.datasets.base.COCO2017Dataset.requires_manual_download) | Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. | **Methods:** | [`download_and_prepare`](#fiftyone.zoo.datasets.base.COCO2017Dataset.download_and_prepare)(dataset_dir[, split, ...]) | Downloads the dataset and prepares it for use. | |-------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| | [`get_info_path`](#fiftyone.zoo.datasets.base.COCO2017Dataset.get_info_path)(dataset_dir) | Returns the path to the `ZooDatasetInfo` for the dataset. | | [`get_split_dir`](#fiftyone.zoo.datasets.base.COCO2017Dataset.get_split_dir)(dataset_dir, split) | Returns the directory for the given split of the dataset. | | [`has_info`](#fiftyone.zoo.datasets.base.COCO2017Dataset.has_info)(dataset_dir) | Determines whether the directory contains `ZooDatasetInfo`. | | [`has_split`](#fiftyone.zoo.datasets.base.COCO2017Dataset.has_split)(split) | Whether the dataset has the given split. | | [`has_tag`](#fiftyone.zoo.datasets.base.COCO2017Dataset.has_tag)(tag) | Whether the dataset has the given tag. | | [`load_info`](#fiftyone.zoo.datasets.base.COCO2017Dataset.load_info)(dataset_dir[, upgrade, ...]) | Loads the `ZooDatasetInfo` from the given dataset directory. | #### *property* name The name of the dataset. #### *property* license The license or list,of,licenses under which the dataset is distributed, or None if unknown. #### *property* tags A tuple of tags for the dataset. #### *property* supported_splits A tuple of supported splits for the dataset, or None if the dataset does not have splits. #### *property* supports_partial_downloads Whether the dataset supports downloading partial subsets of its splits. #### *property* importer_kwargs A dict of default kwargs to pass to this dataset’s [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). #### download_and_prepare(dataset_dir, split=None, splits=None, cleanup=True) Downloads the dataset and prepares it for use. If the requested splits have already been downloaded, they are not re-downloaded. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **split** (*None*) – `split` nor `splits` are provided, the full dataset is downloaded * **splits** (*None*) – a list of splits to download, if applicable. If neither `split` nor `splits` are provided, the full dataset is downloaded * **cleanup** (*True*) – whether to cleanup any temporary files generated during download * **Returns:** the `ZooDatasetInfo` for the dataset #### *static* get_info_path(dataset_dir) Returns the path to the `ZooDatasetInfo` for the dataset. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** the path to the `ZooDatasetInfo` #### get_split_dir(dataset_dir, split) Returns the directory for the given split of the dataset. * **Parameters:** * **dataset_dir** – the dataset directory * **split** – the dataset split * **Returns:** the directory that will/does hold the specified split #### *static* has_info(dataset_dir) Determines whether the directory contains `ZooDatasetInfo`. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** True/False #### *property* has_patches Whether the dataset has patches that may need to be applied to already downloaded files. #### has_split(split) Whether the dataset has the given split. * **Parameters:** **split** – the dataset split * **Returns:** True/False #### *property* has_splits Whether the dataset has splits. #### has_tag(tag) Whether the dataset has the given tag. * **Parameters:** **tag** – the tag * **Returns:** True/False #### *property* has_tags Whether the dataset has tags. #### *property* is_remote Whether the dataset is remotely-sourced. #### *static* load_info(dataset_dir, upgrade=True, warn_deprecated=False) Loads the `ZooDatasetInfo` from the given dataset directory. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **upgrade** (*True*) – whether to upgrade the JSON file on disk if any migrations were necessary * **warn_deprecated** (*False*) – whether to issue a warning if the dataset has a deprecated format * **Returns:** the `ZooDatasetInfo` for the dataset #### *property* parameters An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. #### *property* requires_manual_download Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. ### *class* fiftyone.zoo.datasets.base.SamaCOCODataset(label_types=None, classes=None, image_ids=None, num_workers=None, shuffle=None, seed=None, max_samples=None) Bases: [`FiftyOneDataset`](#fiftyone.zoo.datasets.base.FiftyOneDataset) Sama-COCO is a large-scale object detection, segmentation, and captioning dataset based on COCO2017. It is a relabeling of the original training and validation sets with tighter polygons and more individually annotated crowds. This version contains images, bounding boxes and segmentations for Sama’s version of the 2017 version of the dataset. This dataset supports partial downloads: - You can specify subsets of data to download via the `label_types`, `classes`, and `max_samples` parameters - You can specify specific images to load via the `image_ids` parameter See [this page](../dataset_zoo/datasets/sama_coco.md#dataset-zoo-sama-coco) for more information about partial downloads of this dataset. Full split stats: - Train split: 118,287 images - Test split: 40,670 images - Validation split: 5,000 images Notes: - COCO defines 91 classes but the data only uses 80 classes - Some images from the train and validation sets don’t have annotations - The test set does not have annotations - Sama-COCO may have some discrepancies with COCO-2017 in terms of the instances labeled Example usage: ```default import fiftyone as fo import fiftyone.zoo as foz # # Load 50 random samples from the validation split # # By default, only detections are loaded # dataset = foz.load_zoo_dataset( "sama-coco", split="validation", max_samples=50, shuffle=True, ) session = fo.launch_app(dataset) # # Load segmentations for 25 samples from the validation split that # contain cats and dogs # # Images that contain all `classes` will be prioritized first, followed # by images that contain at least one of the required `classes`. If # there are not enough images matching `classes` in the split to meet # `max_samples`, only the available images will be loaded. # # Images will only be downloaded if necessary # dataset = foz.load_zoo_dataset( "sama-coco", split="validation", label_types=["segmentations"], classes=["cat", "dog"], max_samples=25, ) session.dataset = dataset # # Download the entire validation split and load both detections and # segmentations # # Subsequent partial loads of the validation split will never require # downloading any images # dataset = foz.load_zoo_dataset( "sama-coco", split="validation", label_types=["detections", "segmentations"], ) session.dataset = dataset ``` Dataset size : 25.67 GB Source : [https://www.sama.com/sama-coco-dataset/](https://www.sama.com/sama-coco-dataset/) * **Parameters:** * **label_types** (*None*) – a label type or list of label types to load. The supported values are `("detections", "segmentations")`. By default, only “detections” are loaded * **classes** (*None*) – a string or list of strings specifying required classes to load. If provided, only samples containing at least one instance of a specified class will be loaded * **image_ids** (*None*) – an optional list of specific image IDs to load. Can be provided in any of the following formats: - a list of `` ints or strings - a list of `/` strings - the path to a text (newline-separated), JSON, or CSV file containing the list of image IDs to load in either of the first two formats * **num_workers** (*None*) – a suggested number of threads to use when downloading individual images * **shuffle** (*False*) – whether to randomly shuffle the order in which samples are chosen for partial downloads * **seed** (*None*) – a random seed to use when shuffling * **max_samples** (*None*) – a maximum number of samples to load per split. If `label_types` and/or `classes` are also specified, first priority will be given to samples that contain all of the specified label types and/or classes, followed by samples that contain at least one of the specified labels types or classes. The actual number of samples loaded may be less than this maximum value if the dataset does not contain sufficient samples matching your requirements. By default, all matching samples are loaded **Attributes:** | [`name`](#fiftyone.zoo.datasets.base.SamaCOCODataset.name) | The name of the dataset. | |--------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`license`](#fiftyone.zoo.datasets.base.SamaCOCODataset.license) | The license or list,of,licenses under which the dataset is distributed, or None if unknown. | | [`tags`](#fiftyone.zoo.datasets.base.SamaCOCODataset.tags) | A tuple of tags for the dataset. | | [`supported_splits`](#fiftyone.zoo.datasets.base.SamaCOCODataset.supported_splits) | A tuple of supported splits for the dataset, or None if the dataset does not have splits. | | [`supports_partial_downloads`](#fiftyone.zoo.datasets.base.SamaCOCODataset.supports_partial_downloads) | Whether the dataset supports downloading partial subsets of its splits. | | [`importer_kwargs`](#fiftyone.zoo.datasets.base.SamaCOCODataset.importer_kwargs) | A dict of default kwargs to pass to this dataset's [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). | | [`has_patches`](#fiftyone.zoo.datasets.base.SamaCOCODataset.has_patches) | Whether the dataset has patches that may need to be applied to already downloaded files. | | [`has_splits`](#fiftyone.zoo.datasets.base.SamaCOCODataset.has_splits) | Whether the dataset has splits. | | [`has_tags`](#fiftyone.zoo.datasets.base.SamaCOCODataset.has_tags) | Whether the dataset has tags. | | [`is_remote`](#fiftyone.zoo.datasets.base.SamaCOCODataset.is_remote) | Whether the dataset is remotely-sourced. | | [`parameters`](#fiftyone.zoo.datasets.base.SamaCOCODataset.parameters) | An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. | | [`requires_manual_download`](#fiftyone.zoo.datasets.base.SamaCOCODataset.requires_manual_download) | Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. | **Methods:** | [`download_and_prepare`](#fiftyone.zoo.datasets.base.SamaCOCODataset.download_and_prepare)(dataset_dir[, split, ...]) | Downloads the dataset and prepares it for use. | |-------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| | [`get_info_path`](#fiftyone.zoo.datasets.base.SamaCOCODataset.get_info_path)(dataset_dir) | Returns the path to the `ZooDatasetInfo` for the dataset. | | [`get_split_dir`](#fiftyone.zoo.datasets.base.SamaCOCODataset.get_split_dir)(dataset_dir, split) | Returns the directory for the given split of the dataset. | | [`has_info`](#fiftyone.zoo.datasets.base.SamaCOCODataset.has_info)(dataset_dir) | Determines whether the directory contains `ZooDatasetInfo`. | | [`has_split`](#fiftyone.zoo.datasets.base.SamaCOCODataset.has_split)(split) | Whether the dataset has the given split. | | [`has_tag`](#fiftyone.zoo.datasets.base.SamaCOCODataset.has_tag)(tag) | Whether the dataset has the given tag. | | [`load_info`](#fiftyone.zoo.datasets.base.SamaCOCODataset.load_info)(dataset_dir[, upgrade, ...]) | Loads the `ZooDatasetInfo` from the given dataset directory. | #### *property* name The name of the dataset. #### *property* license The license or list,of,licenses under which the dataset is distributed, or None if unknown. #### *property* tags A tuple of tags for the dataset. #### *property* supported_splits A tuple of supported splits for the dataset, or None if the dataset does not have splits. #### *property* supports_partial_downloads Whether the dataset supports downloading partial subsets of its splits. #### *property* importer_kwargs A dict of default kwargs to pass to this dataset’s [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). #### download_and_prepare(dataset_dir, split=None, splits=None, cleanup=True) Downloads the dataset and prepares it for use. If the requested splits have already been downloaded, they are not re-downloaded. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **split** (*None*) – `split` nor `splits` are provided, the full dataset is downloaded * **splits** (*None*) – a list of splits to download, if applicable. If neither `split` nor `splits` are provided, the full dataset is downloaded * **cleanup** (*True*) – whether to cleanup any temporary files generated during download * **Returns:** the `ZooDatasetInfo` for the dataset #### *static* get_info_path(dataset_dir) Returns the path to the `ZooDatasetInfo` for the dataset. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** the path to the `ZooDatasetInfo` #### get_split_dir(dataset_dir, split) Returns the directory for the given split of the dataset. * **Parameters:** * **dataset_dir** – the dataset directory * **split** – the dataset split * **Returns:** the directory that will/does hold the specified split #### *static* has_info(dataset_dir) Determines whether the directory contains `ZooDatasetInfo`. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** True/False #### *property* has_patches Whether the dataset has patches that may need to be applied to already downloaded files. #### has_split(split) Whether the dataset has the given split. * **Parameters:** **split** – the dataset split * **Returns:** True/False #### *property* has_splits Whether the dataset has splits. #### has_tag(tag) Whether the dataset has the given tag. * **Parameters:** **tag** – the tag * **Returns:** True/False #### *property* has_tags Whether the dataset has tags. #### *property* is_remote Whether the dataset is remotely-sourced. #### *static* load_info(dataset_dir, upgrade=True, warn_deprecated=False) Loads the `ZooDatasetInfo` from the given dataset directory. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **upgrade** (*True*) – whether to upgrade the JSON file on disk if any migrations were necessary * **warn_deprecated** (*False*) – whether to issue a warning if the dataset has a deprecated format * **Returns:** the `ZooDatasetInfo` for the dataset #### *property* parameters An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. #### *property* requires_manual_download Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. ### *class* fiftyone.zoo.datasets.base.FIWDataset Bases: [`FiftyOneDataset`](#fiftyone.zoo.datasets.base.FiftyOneDataset) Families in the Wild is a public benchmark for recognizing families via facial images. The dataset contains over 26,642 images of 5,037 faces collected from 978 families. A unique Family ID (FID) is assigned per family, ranging from F0001-F1018 (i.e., some families were merged or removed since its first release in 2016). The dataset is a continued work in progress. Any contributions are both welcome and appreciated! Faces were cropped from imagery using the five-point face detector MTCNN from various phototypes (i.e., mostly family photos, along with several profile pics of individuals (facial shots). The number of members per family varies from 3-to-26, with the number of faces per subject ranging from 1 to >10. Various levels and types of labels are associated with samples in this dataset. Family-level labels contain a list of members, each assigned a member ID (MID) unique to that respective family (e.g., F0011.MID2 refers to member 2 of family 11). Each member has annotations specifying gender and relationship to all other members in that respective family. The relationships in FIW are: > | ID | Type | > |------|---------------------| > | 0 | not related or self | > | 1 | child | > | 2 | sibling | > | 3 | grandchild | > | 4 | parent | > | 5 | spouse | > | 6 | grandparent | > | 7 | great grandchild | > | 8 | great grandparent | > | 9 | TBD | Within FiftyOne, each sample corresponds to a single face image and contains primitive labels of the Family ID, Member ID, etc. The relationship labels are stored as [multi-label classifications](../user_guide/using_datasets.md#multilabel-classification), where each classification represents one relationship that the member has with another member in the family. The number of relationships will differ from one person to the next, but all faces of one person will have the same relationship labels. Additionally, the labels for the [Kinship Verification task](https://competitions.codalab.org/competitions/21843) are also loaded into this dataset through FiftyOne. These labels are stored as classifications just like relationships, but the labels of kinship differ from those defined above. For example, rather than Parent, the label might be `fd` representing a Father-Daughter kinship or `md` for Mother-Daughter. In order to make it easier to browse the dataset in the FiftyOne App, each sample also contains a `face_id` field containing a unique integer for each face of a member, always starting at 0. This allows you to filter the `face_id` field to 0 in the App to show only a single image of each person. For your reference, the relationship labels are stored in disk in a matrix that provides the relationship of each member with other members of the family as well as names and genders. The i-th rows represent the i-th family member’s relationship to the j-th other members. For example, `FID0001.csv` contains: > MID 1 2 3 Name Gender > : 1 0 4 5 name1 f > 2 1 0 1 name2 f > 3 5 4 0 name3 m Here we have three family members, as listed under the MID column (far-left). Each MID reads across its row. We can see that MID1 is related to MID2 by 4 -> 1 (Parent -> Child), which of course can be viewed as the inverse, i.e., MID2 -> MID1 is 1 -> 4. It can also be seen that MID1 and MID3 are spouses of one another, i.e., 5 -> 5. #### NOTE The spouse label will likely be removed in future version of this dataset. It serves no value to the problem of kinship. For more information on the data (e.g., statistics, task evaluations, benchmarks, and more), see the recent journal: > Robinson, JP, M. Shao, and Y. Fu. “Survey on the Analysis and Modeling > of Visual Kinship: A Decade in the Making.” IEEE Transactions on > Pattern Analysis and Machine Intelligence (PAMI), 2021. #### NOTE For your convenience, FiftyOne provides [`get_pairwise_labels()`](fiftyone.utils.fiw.md#fiftyone.utils.fiw.get_pairwise_labels) and [`get_identifier_filepaths_map()`](fiftyone.utils.fiw.md#fiftyone.utils.fiw.get_identifier_filepaths_map) utilities for FIW. Example usage: ```default import fiftyone as fo import fiftyone.zoo as foz dataset = foz.load_zoo_dataset("fiw", split="test") session = fo.launch_app(dataset) ``` Dataset size : 173.00 MB Source : [https://web.northeastern.edu/smilelab/fiw](https://web.northeastern.edu/smilelab/fiw) **Attributes:** | [`name`](#fiftyone.zoo.datasets.base.FIWDataset.name) | The name of the dataset. | |---------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`license`](#fiftyone.zoo.datasets.base.FIWDataset.license) | The license or list,of,licenses under which the dataset is distributed, or None if unknown. | | [`tags`](#fiftyone.zoo.datasets.base.FIWDataset.tags) | A tuple of tags for the dataset. | | [`supported_splits`](#fiftyone.zoo.datasets.base.FIWDataset.supported_splits) | A tuple of supported splits for the dataset, or None if the dataset does not have splits. | | [`has_patches`](#fiftyone.zoo.datasets.base.FIWDataset.has_patches) | Whether the dataset has patches that may need to be applied to already downloaded files. | | [`has_splits`](#fiftyone.zoo.datasets.base.FIWDataset.has_splits) | Whether the dataset has splits. | | [`has_tags`](#fiftyone.zoo.datasets.base.FIWDataset.has_tags) | Whether the dataset has tags. | | [`importer_kwargs`](#fiftyone.zoo.datasets.base.FIWDataset.importer_kwargs) | A dict of default kwargs to pass to this dataset's [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). | | [`is_remote`](#fiftyone.zoo.datasets.base.FIWDataset.is_remote) | Whether the dataset is remotely-sourced. | | [`parameters`](#fiftyone.zoo.datasets.base.FIWDataset.parameters) | An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. | | [`requires_manual_download`](#fiftyone.zoo.datasets.base.FIWDataset.requires_manual_download) | Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. | | [`supports_partial_downloads`](#fiftyone.zoo.datasets.base.FIWDataset.supports_partial_downloads) | Whether the dataset supports downloading partial subsets of its splits. | **Methods:** | [`download_and_prepare`](#fiftyone.zoo.datasets.base.FIWDataset.download_and_prepare)(dataset_dir[, split, ...]) | Downloads the dataset and prepares it for use. | |--------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| | [`get_info_path`](#fiftyone.zoo.datasets.base.FIWDataset.get_info_path)(dataset_dir) | Returns the path to the `ZooDatasetInfo` for the dataset. | | [`get_split_dir`](#fiftyone.zoo.datasets.base.FIWDataset.get_split_dir)(dataset_dir, split) | Returns the directory for the given split of the dataset. | | [`has_info`](#fiftyone.zoo.datasets.base.FIWDataset.has_info)(dataset_dir) | Determines whether the directory contains `ZooDatasetInfo`. | | [`has_split`](#fiftyone.zoo.datasets.base.FIWDataset.has_split)(split) | Whether the dataset has the given split. | | [`has_tag`](#fiftyone.zoo.datasets.base.FIWDataset.has_tag)(tag) | Whether the dataset has the given tag. | | [`load_info`](#fiftyone.zoo.datasets.base.FIWDataset.load_info)(dataset_dir[, upgrade, ...]) | Loads the `ZooDatasetInfo` from the given dataset directory. | #### *property* name The name of the dataset. #### *property* license The license or list,of,licenses under which the dataset is distributed, or None if unknown. #### *property* tags A tuple of tags for the dataset. #### *property* supported_splits A tuple of supported splits for the dataset, or None if the dataset does not have splits. #### download_and_prepare(dataset_dir, split=None, splits=None, cleanup=True) Downloads the dataset and prepares it for use. If the requested splits have already been downloaded, they are not re-downloaded. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **split** (*None*) – `split` nor `splits` are provided, the full dataset is downloaded * **splits** (*None*) – a list of splits to download, if applicable. If neither `split` nor `splits` are provided, the full dataset is downloaded * **cleanup** (*True*) – whether to cleanup any temporary files generated during download * **Returns:** the `ZooDatasetInfo` for the dataset #### *static* get_info_path(dataset_dir) Returns the path to the `ZooDatasetInfo` for the dataset. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** the path to the `ZooDatasetInfo` #### get_split_dir(dataset_dir, split) Returns the directory for the given split of the dataset. * **Parameters:** * **dataset_dir** – the dataset directory * **split** – the dataset split * **Returns:** the directory that will/does hold the specified split #### *static* has_info(dataset_dir) Determines whether the directory contains `ZooDatasetInfo`. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** True/False #### *property* has_patches Whether the dataset has patches that may need to be applied to already downloaded files. #### has_split(split) Whether the dataset has the given split. * **Parameters:** **split** – the dataset split * **Returns:** True/False #### *property* has_splits Whether the dataset has splits. #### has_tag(tag) Whether the dataset has the given tag. * **Parameters:** **tag** – the tag * **Returns:** True/False #### *property* has_tags Whether the dataset has tags. #### *property* importer_kwargs A dict of default kwargs to pass to this dataset’s [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). #### *property* is_remote Whether the dataset is remotely-sourced. #### *static* load_info(dataset_dir, upgrade=True, warn_deprecated=False) Loads the `ZooDatasetInfo` from the given dataset directory. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **upgrade** (*True*) – whether to upgrade the JSON file on disk if any migrations were necessary * **warn_deprecated** (*False*) – whether to issue a warning if the dataset has a deprecated format * **Returns:** the `ZooDatasetInfo` for the dataset #### *property* parameters An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. #### *property* requires_manual_download Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. #### *property* supports_partial_downloads Whether the dataset supports downloading partial subsets of its splits. ### *class* fiftyone.zoo.datasets.base.HMDB51Dataset(fold=1) Bases: [`FiftyOneDataset`](#fiftyone.zoo.datasets.base.FiftyOneDataset) HMDB51 is an action recognition dataset containing a total of 6,766 clips distributed across 51 action classes. Example usage: ```default import fiftyone as fo import fiftyone.zoo as foz dataset = foz.load_zoo_dataset("hmdb51", split="test") session = fo.launch_app(dataset) ``` Dataset size : 2.16 GB Source : [https://serre-lab.clps.brown.edu/resource/hmdb-a-large-human-motion-database](https://serre-lab.clps.brown.edu/resource/hmdb-a-large-human-motion-database) * **Parameters:** **fold** (*1*) – the test/train fold to use to arrange the files on disk. The supported values are `(1, 2, 3)` **Attributes:** | [`name`](#fiftyone.zoo.datasets.base.HMDB51Dataset.name) | The name of the dataset. | |------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`license`](#fiftyone.zoo.datasets.base.HMDB51Dataset.license) | The license or list,of,licenses under which the dataset is distributed, or None if unknown. | | [`tags`](#fiftyone.zoo.datasets.base.HMDB51Dataset.tags) | A tuple of tags for the dataset. | | [`parameters`](#fiftyone.zoo.datasets.base.HMDB51Dataset.parameters) | An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. | | [`supported_splits`](#fiftyone.zoo.datasets.base.HMDB51Dataset.supported_splits) | A tuple of supported splits for the dataset, or None if the dataset does not have splits. | | [`has_patches`](#fiftyone.zoo.datasets.base.HMDB51Dataset.has_patches) | Whether the dataset has patches that may need to be applied to already downloaded files. | | [`has_splits`](#fiftyone.zoo.datasets.base.HMDB51Dataset.has_splits) | Whether the dataset has splits. | | [`has_tags`](#fiftyone.zoo.datasets.base.HMDB51Dataset.has_tags) | Whether the dataset has tags. | | [`importer_kwargs`](#fiftyone.zoo.datasets.base.HMDB51Dataset.importer_kwargs) | A dict of default kwargs to pass to this dataset's [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). | | [`is_remote`](#fiftyone.zoo.datasets.base.HMDB51Dataset.is_remote) | Whether the dataset is remotely-sourced. | | [`requires_manual_download`](#fiftyone.zoo.datasets.base.HMDB51Dataset.requires_manual_download) | Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. | | [`supports_partial_downloads`](#fiftyone.zoo.datasets.base.HMDB51Dataset.supports_partial_downloads) | Whether the dataset supports downloading partial subsets of its splits. | **Methods:** | [`download_and_prepare`](#fiftyone.zoo.datasets.base.HMDB51Dataset.download_and_prepare)(dataset_dir[, split, ...]) | Downloads the dataset and prepares it for use. | |-----------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| | [`get_info_path`](#fiftyone.zoo.datasets.base.HMDB51Dataset.get_info_path)(dataset_dir) | Returns the path to the `ZooDatasetInfo` for the dataset. | | [`get_split_dir`](#fiftyone.zoo.datasets.base.HMDB51Dataset.get_split_dir)(dataset_dir, split) | Returns the directory for the given split of the dataset. | | [`has_info`](#fiftyone.zoo.datasets.base.HMDB51Dataset.has_info)(dataset_dir) | Determines whether the directory contains `ZooDatasetInfo`. | | [`has_split`](#fiftyone.zoo.datasets.base.HMDB51Dataset.has_split)(split) | Whether the dataset has the given split. | | [`has_tag`](#fiftyone.zoo.datasets.base.HMDB51Dataset.has_tag)(tag) | Whether the dataset has the given tag. | | [`load_info`](#fiftyone.zoo.datasets.base.HMDB51Dataset.load_info)(dataset_dir[, upgrade, ...]) | Loads the `ZooDatasetInfo` from the given dataset directory. | #### *property* name The name of the dataset. #### *property* license The license or list,of,licenses under which the dataset is distributed, or None if unknown. #### *property* tags A tuple of tags for the dataset. #### *property* parameters An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. #### *property* supported_splits A tuple of supported splits for the dataset, or None if the dataset does not have splits. #### download_and_prepare(dataset_dir, split=None, splits=None, cleanup=True) Downloads the dataset and prepares it for use. If the requested splits have already been downloaded, they are not re-downloaded. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **split** (*None*) – `split` nor `splits` are provided, the full dataset is downloaded * **splits** (*None*) – a list of splits to download, if applicable. If neither `split` nor `splits` are provided, the full dataset is downloaded * **cleanup** (*True*) – whether to cleanup any temporary files generated during download * **Returns:** the `ZooDatasetInfo` for the dataset #### *static* get_info_path(dataset_dir) Returns the path to the `ZooDatasetInfo` for the dataset. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** the path to the `ZooDatasetInfo` #### get_split_dir(dataset_dir, split) Returns the directory for the given split of the dataset. * **Parameters:** * **dataset_dir** – the dataset directory * **split** – the dataset split * **Returns:** the directory that will/does hold the specified split #### *static* has_info(dataset_dir) Determines whether the directory contains `ZooDatasetInfo`. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** True/False #### *property* has_patches Whether the dataset has patches that may need to be applied to already downloaded files. #### has_split(split) Whether the dataset has the given split. * **Parameters:** **split** – the dataset split * **Returns:** True/False #### *property* has_splits Whether the dataset has splits. #### has_tag(tag) Whether the dataset has the given tag. * **Parameters:** **tag** – the tag * **Returns:** True/False #### *property* has_tags Whether the dataset has tags. #### *property* importer_kwargs A dict of default kwargs to pass to this dataset’s [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). #### *property* is_remote Whether the dataset is remotely-sourced. #### *static* load_info(dataset_dir, upgrade=True, warn_deprecated=False) Loads the `ZooDatasetInfo` from the given dataset directory. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **upgrade** (*True*) – whether to upgrade the JSON file on disk if any migrations were necessary * **warn_deprecated** (*False*) – whether to issue a warning if the dataset has a deprecated format * **Returns:** the `ZooDatasetInfo` for the dataset #### *property* requires_manual_download Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. #### *property* supports_partial_downloads Whether the dataset supports downloading partial subsets of its splits. ### *class* fiftyone.zoo.datasets.base.ImageNetSampleDataset Bases: [`FiftyOneDataset`](#fiftyone.zoo.datasets.base.FiftyOneDataset) A small sample of images from the ImageNet 2012 dataset. The dataset contains 1,000 images, one randomly chosen from each class of the validation split of the ImageNet 2012 dataset. These images are provided according to the terms below: ```text You have been granted access for non-commercial research/educational use. By accessing the data, you have agreed to the following terms. You (the "Researcher") have requested permission to use the ImageNet database (the "Database") at Princeton University and Stanford University. In exchange for such permission, Researcher hereby agrees to the following terms and conditions: 1. Researcher shall use the Database only for non-commercial research and educational purposes. 2. Princeton University and Stanford University make no representations or warranties regarding the Database, including but not limited to warranties of non-infringement or fitness for a particular purpose. 3. Researcher accepts full responsibility for his or her use of the Database and shall defend and indemnify Princeton University and Stanford University, including their employees, Trustees, officers and agents, against any and all claims arising from Researcher's use of the Database, including but not limited to Researcher's use of any copies of copyrighted images that he or she may create from the Database. 4. Researcher may provide research associates and colleagues with access to the Database provided that they first agree to be bound by these terms and conditions. 5. Princeton University and Stanford University reserve the right to terminate Researcher's access to the Database at any time. 6. If Researcher is employed by a for-profit, commercial entity, Researcher's employer shall also be bound by these terms and conditions, and Researcher hereby represents that he or she is fully authorized to enter into this agreement on behalf of such employer. 7. The law of the State of New Jersey shall apply to all disputes under this agreement. ``` Example usage: ```default import fiftyone as fo import fiftyone.zoo as foz dataset = foz.load_zoo_dataset("imagenet-sample") session = fo.launch_app(dataset) ``` Dataset size : 98.26 MB Source : [http://image-net.org](http://image-net.org) **Attributes:** | [`name`](#fiftyone.zoo.datasets.base.ImageNetSampleDataset.name) | The name of the dataset. | |--------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`license`](#fiftyone.zoo.datasets.base.ImageNetSampleDataset.license) | The license or list,of,licenses under which the dataset is distributed, or None if unknown. | | [`tags`](#fiftyone.zoo.datasets.base.ImageNetSampleDataset.tags) | A tuple of tags for the dataset. | | [`supported_splits`](#fiftyone.zoo.datasets.base.ImageNetSampleDataset.supported_splits) | A tuple of supported splits for the dataset, or None if the dataset does not have splits. | | [`has_patches`](#fiftyone.zoo.datasets.base.ImageNetSampleDataset.has_patches) | Whether the dataset has patches that may need to be applied to already downloaded files. | | [`has_splits`](#fiftyone.zoo.datasets.base.ImageNetSampleDataset.has_splits) | Whether the dataset has splits. | | [`has_tags`](#fiftyone.zoo.datasets.base.ImageNetSampleDataset.has_tags) | Whether the dataset has tags. | | [`importer_kwargs`](#fiftyone.zoo.datasets.base.ImageNetSampleDataset.importer_kwargs) | A dict of default kwargs to pass to this dataset's [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). | | [`is_remote`](#fiftyone.zoo.datasets.base.ImageNetSampleDataset.is_remote) | Whether the dataset is remotely-sourced. | | [`parameters`](#fiftyone.zoo.datasets.base.ImageNetSampleDataset.parameters) | An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. | | [`requires_manual_download`](#fiftyone.zoo.datasets.base.ImageNetSampleDataset.requires_manual_download) | Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. | | [`supports_partial_downloads`](#fiftyone.zoo.datasets.base.ImageNetSampleDataset.supports_partial_downloads) | Whether the dataset supports downloading partial subsets of its splits. | **Methods:** | [`download_and_prepare`](#fiftyone.zoo.datasets.base.ImageNetSampleDataset.download_and_prepare)(dataset_dir[, split, ...]) | Downloads the dataset and prepares it for use. | |-------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| | [`get_info_path`](#fiftyone.zoo.datasets.base.ImageNetSampleDataset.get_info_path)(dataset_dir) | Returns the path to the `ZooDatasetInfo` for the dataset. | | [`get_split_dir`](#fiftyone.zoo.datasets.base.ImageNetSampleDataset.get_split_dir)(dataset_dir, split) | Returns the directory for the given split of the dataset. | | [`has_info`](#fiftyone.zoo.datasets.base.ImageNetSampleDataset.has_info)(dataset_dir) | Determines whether the directory contains `ZooDatasetInfo`. | | [`has_split`](#fiftyone.zoo.datasets.base.ImageNetSampleDataset.has_split)(split) | Whether the dataset has the given split. | | [`has_tag`](#fiftyone.zoo.datasets.base.ImageNetSampleDataset.has_tag)(tag) | Whether the dataset has the given tag. | | [`load_info`](#fiftyone.zoo.datasets.base.ImageNetSampleDataset.load_info)(dataset_dir[, upgrade, ...]) | Loads the `ZooDatasetInfo` from the given dataset directory. | #### *property* name The name of the dataset. #### *property* license The license or list,of,licenses under which the dataset is distributed, or None if unknown. #### *property* tags A tuple of tags for the dataset. #### *property* supported_splits A tuple of supported splits for the dataset, or None if the dataset does not have splits. #### download_and_prepare(dataset_dir, split=None, splits=None, cleanup=True) Downloads the dataset and prepares it for use. If the requested splits have already been downloaded, they are not re-downloaded. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **split** (*None*) – `split` nor `splits` are provided, the full dataset is downloaded * **splits** (*None*) – a list of splits to download, if applicable. If neither `split` nor `splits` are provided, the full dataset is downloaded * **cleanup** (*True*) – whether to cleanup any temporary files generated during download * **Returns:** the `ZooDatasetInfo` for the dataset #### *static* get_info_path(dataset_dir) Returns the path to the `ZooDatasetInfo` for the dataset. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** the path to the `ZooDatasetInfo` #### get_split_dir(dataset_dir, split) Returns the directory for the given split of the dataset. * **Parameters:** * **dataset_dir** – the dataset directory * **split** – the dataset split * **Returns:** the directory that will/does hold the specified split #### *static* has_info(dataset_dir) Determines whether the directory contains `ZooDatasetInfo`. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** True/False #### *property* has_patches Whether the dataset has patches that may need to be applied to already downloaded files. #### has_split(split) Whether the dataset has the given split. * **Parameters:** **split** – the dataset split * **Returns:** True/False #### *property* has_splits Whether the dataset has splits. #### has_tag(tag) Whether the dataset has the given tag. * **Parameters:** **tag** – the tag * **Returns:** True/False #### *property* has_tags Whether the dataset has tags. #### *property* importer_kwargs A dict of default kwargs to pass to this dataset’s [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). #### *property* is_remote Whether the dataset is remotely-sourced. #### *static* load_info(dataset_dir, upgrade=True, warn_deprecated=False) Loads the `ZooDatasetInfo` from the given dataset directory. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **upgrade** (*True*) – whether to upgrade the JSON file on disk if any migrations were necessary * **warn_deprecated** (*False*) – whether to issue a warning if the dataset has a deprecated format * **Returns:** the `ZooDatasetInfo` for the dataset #### *property* parameters An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. #### *property* requires_manual_download Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. #### *property* supports_partial_downloads Whether the dataset supports downloading partial subsets of its splits. ### *class* fiftyone.zoo.datasets.base.Kinetics400Dataset(classes=None, num_workers=None, shuffle=None, seed=None, max_samples=None) Bases: [`FiftyOneDataset`](#fiftyone.zoo.datasets.base.FiftyOneDataset) Kinetics is a collection of large-scale, high-quality datasets of URL links of up to 650,000 video clips that cover 400/600/700 human action classes, depending on the dataset version. The videos include human-object interactions such as playing instruments, as well as human-human interactions such as shaking hands and hugging. Each action class has at least 400/600/700 video clips. Each clip is human annotated with a single action class and lasts around 10 seconds. This dataset contains videos and action classifications for the 400 class version of the dataset. This dataset supports partial downloads: - You can specify subsets of data to download via the `classes` and `max_samples` parameters See [this page](../dataset_zoo/datasets/kinetics_400.md#dataset-zoo-kinetics-400) for more information about partial downloads of this dataset. Original split stats: - Train split: 219,782 videos - Test split: 35,357 videos - Validation split: 18,035 videos CVDF split stats: - Train split: 246,534 videos - Test split: 39,805 videos - Validation split: 19,906 videos Example usage: ```default import fiftyone as fo import fiftyone.zoo as foz # # Load 10 random samples from the validation split # # Only the required videos will be downloaded (if necessary). # dataset = foz.load_zoo_dataset( "kinetics-400", split="validation", max_samples=10, shuffle=True, ) session = fo.launch_app(dataset) # # Load 10 samples from the validation split that # contain the actions "springboard diving" and "surfing water" # # Videos that contain all `classes` will be prioritized first, followed # by videos that contain at least one of the required `classes`. If # there are not enough videos matching `classes` in the split to meet # `max_samples`, only the available videos will be loaded. # # Videos will only be downloaded if necessary # # Subsequent partial loads of the validation split will never require # downloading any videos # dataset = foz.load_zoo_dataset( "kinetics-400", split="validation", classes=["springboard diving", "surfing water"], max_samples=10, ) session.dataset = dataset ``` Dataset size - Train split: 370 GB - Test split: 56 GB - Validation split: 30 GB Source : [https://deepmind.com/research/open-source/kinetics](https://deepmind.com/research/open-source/kinetics) * **Parameters:** * **classes** (*None*) – a string or list of strings specifying required classes to load. If provided, only samples containing at least one instance of a specified class will be loaded * **num_workers** (*None*) – a suggested number of threads to use when downloading individual images * **shuffle** (*False*) – whether to randomly shuffle the order in which samples are chosen for partial downloads * **seed** (*None*) – a random seed to use when shuffling * **max_samples** (*None*) – a maximum number of samples to load per split. If `classes` are also specified, only up to the number of samples that contain at least one specified class will be loaded. By default, all matching samples are loaded **Attributes:** | [`name`](#fiftyone.zoo.datasets.base.Kinetics400Dataset.name) | The name of the dataset. | |-----------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`license`](#fiftyone.zoo.datasets.base.Kinetics400Dataset.license) | The license or list,of,licenses under which the dataset is distributed, or None if unknown. | | [`tags`](#fiftyone.zoo.datasets.base.Kinetics400Dataset.tags) | A tuple of tags for the dataset. | | [`supported_splits`](#fiftyone.zoo.datasets.base.Kinetics400Dataset.supported_splits) | A tuple of supported splits for the dataset, or None if the dataset does not have splits. | | [`supports_partial_downloads`](#fiftyone.zoo.datasets.base.Kinetics400Dataset.supports_partial_downloads) | Whether the dataset supports downloading partial subsets of its splits. | | [`has_patches`](#fiftyone.zoo.datasets.base.Kinetics400Dataset.has_patches) | Whether the dataset has patches that may need to be applied to already downloaded files. | | [`has_splits`](#fiftyone.zoo.datasets.base.Kinetics400Dataset.has_splits) | Whether the dataset has splits. | | [`has_tags`](#fiftyone.zoo.datasets.base.Kinetics400Dataset.has_tags) | Whether the dataset has tags. | | [`importer_kwargs`](#fiftyone.zoo.datasets.base.Kinetics400Dataset.importer_kwargs) | A dict of default kwargs to pass to this dataset's [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). | | [`is_remote`](#fiftyone.zoo.datasets.base.Kinetics400Dataset.is_remote) | Whether the dataset is remotely-sourced. | | [`parameters`](#fiftyone.zoo.datasets.base.Kinetics400Dataset.parameters) | An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. | | [`requires_manual_download`](#fiftyone.zoo.datasets.base.Kinetics400Dataset.requires_manual_download) | Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. | **Methods:** | [`download_and_prepare`](#fiftyone.zoo.datasets.base.Kinetics400Dataset.download_and_prepare)(dataset_dir[, split, ...]) | Downloads the dataset and prepares it for use. | |----------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| | [`get_info_path`](#fiftyone.zoo.datasets.base.Kinetics400Dataset.get_info_path)(dataset_dir) | Returns the path to the `ZooDatasetInfo` for the dataset. | | [`get_split_dir`](#fiftyone.zoo.datasets.base.Kinetics400Dataset.get_split_dir)(dataset_dir, split) | Returns the directory for the given split of the dataset. | | [`has_info`](#fiftyone.zoo.datasets.base.Kinetics400Dataset.has_info)(dataset_dir) | Determines whether the directory contains `ZooDatasetInfo`. | | [`has_split`](#fiftyone.zoo.datasets.base.Kinetics400Dataset.has_split)(split) | Whether the dataset has the given split. | | [`has_tag`](#fiftyone.zoo.datasets.base.Kinetics400Dataset.has_tag)(tag) | Whether the dataset has the given tag. | | [`load_info`](#fiftyone.zoo.datasets.base.Kinetics400Dataset.load_info)(dataset_dir[, upgrade, ...]) | Loads the `ZooDatasetInfo` from the given dataset directory. | #### *property* name The name of the dataset. #### *property* license The license or list,of,licenses under which the dataset is distributed, or None if unknown. #### *property* tags A tuple of tags for the dataset. #### *property* supported_splits A tuple of supported splits for the dataset, or None if the dataset does not have splits. #### *property* supports_partial_downloads Whether the dataset supports downloading partial subsets of its splits. #### download_and_prepare(dataset_dir, split=None, splits=None, cleanup=True) Downloads the dataset and prepares it for use. If the requested splits have already been downloaded, they are not re-downloaded. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **split** (*None*) – `split` nor `splits` are provided, the full dataset is downloaded * **splits** (*None*) – a list of splits to download, if applicable. If neither `split` nor `splits` are provided, the full dataset is downloaded * **cleanup** (*True*) – whether to cleanup any temporary files generated during download * **Returns:** the `ZooDatasetInfo` for the dataset #### *static* get_info_path(dataset_dir) Returns the path to the `ZooDatasetInfo` for the dataset. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** the path to the `ZooDatasetInfo` #### get_split_dir(dataset_dir, split) Returns the directory for the given split of the dataset. * **Parameters:** * **dataset_dir** – the dataset directory * **split** – the dataset split * **Returns:** the directory that will/does hold the specified split #### *static* has_info(dataset_dir) Determines whether the directory contains `ZooDatasetInfo`. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** True/False #### *property* has_patches Whether the dataset has patches that may need to be applied to already downloaded files. #### has_split(split) Whether the dataset has the given split. * **Parameters:** **split** – the dataset split * **Returns:** True/False #### *property* has_splits Whether the dataset has splits. #### has_tag(tag) Whether the dataset has the given tag. * **Parameters:** **tag** – the tag * **Returns:** True/False #### *property* has_tags Whether the dataset has tags. #### *property* importer_kwargs A dict of default kwargs to pass to this dataset’s [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). #### *property* is_remote Whether the dataset is remotely-sourced. #### *static* load_info(dataset_dir, upgrade=True, warn_deprecated=False) Loads the `ZooDatasetInfo` from the given dataset directory. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **upgrade** (*True*) – whether to upgrade the JSON file on disk if any migrations were necessary * **warn_deprecated** (*False*) – whether to issue a warning if the dataset has a deprecated format * **Returns:** the `ZooDatasetInfo` for the dataset #### *property* parameters An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. #### *property* requires_manual_download Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. ### *class* fiftyone.zoo.datasets.base.Kinetics600Dataset(classes=None, num_workers=None, shuffle=None, seed=None, max_samples=None) Bases: [`FiftyOneDataset`](#fiftyone.zoo.datasets.base.FiftyOneDataset) Kinetics is a collection of large-scale, high-quality datasets of URL links of up to 650,000 video clips that cover 400/600/700 human action classes, depending on the dataset version. The videos include human-object interactions such as playing instruments, as well as human-human interactions such as shaking hands and hugging. Each action class has at least 400/600/700 video clips. Each clip is human annotated with a single action class and lasts around 10 seconds. This dataset contains videos and action classifications for the 600 class version of the dataset. This dataset supports partial downloads: - You can specify subsets of data to download via the `classes` and `max_samples` parameters See [this page](../dataset_zoo/datasets/kinetics_600.md#dataset-zoo-kinetics-600) for more information about partial downloads of this dataset. Original split stats: - Train split: 370,582 videos - Test split: 56,618 videos - Validation split: 28,313 videos CVDF split stats: - Train split: 427,549 videos - Test split: 72,924 videos - Validation split: 29,793 videos Example usage: ```default import fiftyone as fo import fiftyone.zoo as foz # # Load 10 random samples from the validation split # # Only the required videos will be downloaded (if necessary). # dataset = foz.load_zoo_dataset( "kinetics-600", split="validation", max_samples=10, shuffle=True, ) session = fo.launch_app(dataset) # # Load 10 samples from the validation split that # contain the actions "springboard diving" and "surfing water" # # Videos that contain all `classes` will be prioritized first, followed # by videos that contain at least one of the required `classes`. If # there are not enough videos matching `classes` in the split to meet # `max_samples`, only the available videos will be loaded. # # Videos will only be downloaded if necessary # # Subsequent partial loads of the validation split will never require # downloading any videos # dataset = foz.load_zoo_dataset( "kinetics-600", split="validation", classes=["springboard diving", "surfing water"], max_samples=10, ) session.dataset = dataset ``` Dataset size - Train split: 648 GB - Test split: 88 GB - Validation split: 43 GB Source : [https://deepmind.com/research/open-source/kinetics](https://deepmind.com/research/open-source/kinetics) * **Parameters:** * **classes** (*None*) – a string or list of strings specifying required classes to load. If provided, only samples containing at least one instance of a specified class will be loaded * **num_workers** (*None*) – a suggested number of threads to use when downloading individual images * **shuffle** (*False*) – whether to randomly shuffle the order in which samples are chosen for partial downloads * **seed** (*None*) – a random seed to use when shuffling * **max_samples** (*None*) – a maximum number of samples to load per split. If `classes` are also specified, only up to the number of samples that contain at least one specified class will be loaded. By default, all matching samples are loaded **Attributes:** | [`name`](#fiftyone.zoo.datasets.base.Kinetics600Dataset.name) | The name of the dataset. | |-----------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`license`](#fiftyone.zoo.datasets.base.Kinetics600Dataset.license) | The license or list,of,licenses under which the dataset is distributed, or None if unknown. | | [`tags`](#fiftyone.zoo.datasets.base.Kinetics600Dataset.tags) | A tuple of tags for the dataset. | | [`supported_splits`](#fiftyone.zoo.datasets.base.Kinetics600Dataset.supported_splits) | A tuple of supported splits for the dataset, or None if the dataset does not have splits. | | [`supports_partial_downloads`](#fiftyone.zoo.datasets.base.Kinetics600Dataset.supports_partial_downloads) | Whether the dataset supports downloading partial subsets of its splits. | | [`has_patches`](#fiftyone.zoo.datasets.base.Kinetics600Dataset.has_patches) | Whether the dataset has patches that may need to be applied to already downloaded files. | | [`has_splits`](#fiftyone.zoo.datasets.base.Kinetics600Dataset.has_splits) | Whether the dataset has splits. | | [`has_tags`](#fiftyone.zoo.datasets.base.Kinetics600Dataset.has_tags) | Whether the dataset has tags. | | [`importer_kwargs`](#fiftyone.zoo.datasets.base.Kinetics600Dataset.importer_kwargs) | A dict of default kwargs to pass to this dataset's [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). | | [`is_remote`](#fiftyone.zoo.datasets.base.Kinetics600Dataset.is_remote) | Whether the dataset is remotely-sourced. | | [`parameters`](#fiftyone.zoo.datasets.base.Kinetics600Dataset.parameters) | An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. | | [`requires_manual_download`](#fiftyone.zoo.datasets.base.Kinetics600Dataset.requires_manual_download) | Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. | **Methods:** | [`download_and_prepare`](#fiftyone.zoo.datasets.base.Kinetics600Dataset.download_and_prepare)(dataset_dir[, split, ...]) | Downloads the dataset and prepares it for use. | |----------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| | [`get_info_path`](#fiftyone.zoo.datasets.base.Kinetics600Dataset.get_info_path)(dataset_dir) | Returns the path to the `ZooDatasetInfo` for the dataset. | | [`get_split_dir`](#fiftyone.zoo.datasets.base.Kinetics600Dataset.get_split_dir)(dataset_dir, split) | Returns the directory for the given split of the dataset. | | [`has_info`](#fiftyone.zoo.datasets.base.Kinetics600Dataset.has_info)(dataset_dir) | Determines whether the directory contains `ZooDatasetInfo`. | | [`has_split`](#fiftyone.zoo.datasets.base.Kinetics600Dataset.has_split)(split) | Whether the dataset has the given split. | | [`has_tag`](#fiftyone.zoo.datasets.base.Kinetics600Dataset.has_tag)(tag) | Whether the dataset has the given tag. | | [`load_info`](#fiftyone.zoo.datasets.base.Kinetics600Dataset.load_info)(dataset_dir[, upgrade, ...]) | Loads the `ZooDatasetInfo` from the given dataset directory. | #### *property* name The name of the dataset. #### *property* license The license or list,of,licenses under which the dataset is distributed, or None if unknown. #### *property* tags A tuple of tags for the dataset. #### *property* supported_splits A tuple of supported splits for the dataset, or None if the dataset does not have splits. #### *property* supports_partial_downloads Whether the dataset supports downloading partial subsets of its splits. #### download_and_prepare(dataset_dir, split=None, splits=None, cleanup=True) Downloads the dataset and prepares it for use. If the requested splits have already been downloaded, they are not re-downloaded. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **split** (*None*) – `split` nor `splits` are provided, the full dataset is downloaded * **splits** (*None*) – a list of splits to download, if applicable. If neither `split` nor `splits` are provided, the full dataset is downloaded * **cleanup** (*True*) – whether to cleanup any temporary files generated during download * **Returns:** the `ZooDatasetInfo` for the dataset #### *static* get_info_path(dataset_dir) Returns the path to the `ZooDatasetInfo` for the dataset. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** the path to the `ZooDatasetInfo` #### get_split_dir(dataset_dir, split) Returns the directory for the given split of the dataset. * **Parameters:** * **dataset_dir** – the dataset directory * **split** – the dataset split * **Returns:** the directory that will/does hold the specified split #### *static* has_info(dataset_dir) Determines whether the directory contains `ZooDatasetInfo`. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** True/False #### *property* has_patches Whether the dataset has patches that may need to be applied to already downloaded files. #### has_split(split) Whether the dataset has the given split. * **Parameters:** **split** – the dataset split * **Returns:** True/False #### *property* has_splits Whether the dataset has splits. #### has_tag(tag) Whether the dataset has the given tag. * **Parameters:** **tag** – the tag * **Returns:** True/False #### *property* has_tags Whether the dataset has tags. #### *property* importer_kwargs A dict of default kwargs to pass to this dataset’s [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). #### *property* is_remote Whether the dataset is remotely-sourced. #### *static* load_info(dataset_dir, upgrade=True, warn_deprecated=False) Loads the `ZooDatasetInfo` from the given dataset directory. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **upgrade** (*True*) – whether to upgrade the JSON file on disk if any migrations were necessary * **warn_deprecated** (*False*) – whether to issue a warning if the dataset has a deprecated format * **Returns:** the `ZooDatasetInfo` for the dataset #### *property* parameters An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. #### *property* requires_manual_download Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. ### *class* fiftyone.zoo.datasets.base.Kinetics700Dataset(classes=None, num_workers=None, shuffle=None, seed=None, max_samples=None) Bases: [`FiftyOneDataset`](#fiftyone.zoo.datasets.base.FiftyOneDataset) Kinetics is a collection of large-scale, high-quality datasets of URL links of up to 650,000 video clips that cover 400/600/700 human action classes, depending on the dataset version. The videos include human-object interactions such as playing instruments, as well as human-human interactions such as shaking hands and hugging. Each action class has at least 400/600/700 video clips. Each clip is human annotated with a single action class and lasts around 10 seconds. This dataset contains videos and action classifications for the 700 class version of the dataset. This dataset supports partial downloads: - You can specify subsets of data to download via the `classes` and `max_samples` parameters See [this page](../dataset_zoo/datasets/kinetics_700.md#dataset-zoo-kinetics-700) for more information about partial downloads of this dataset. Original split stats: - Train split: 529,046 videos - Test split: 67,446 videos - Validation split: 33,925 videos Example usage: ```default import fiftyone as fo import fiftyone.zoo as foz # # Load 10 random samples from the validation split # # Only the required videos will be downloaded (if necessary). # dataset = foz.load_zoo_dataset( "kinetics-700", split="validation", max_samples=10, shuffle=True, ) session = fo.launch_app(dataset) # # Load 10 samples from the validation split that # contain the actions "springboard diving" and "surfing water" # # Videos that contain all `classes` will be prioritized first, followed # by videos that contain at least one of the required `classes`. If # there are not enough videos matching `classes` in the split to meet # `max_samples`, only the available videos will be loaded. # # Videos will only be downloaded if necessary # # Subsequent partial loads of the validation split will never require # downloading any videos # dataset = foz.load_zoo_dataset( "kinetics-700", split="validation", classes=["springboard diving", "surfing water"], max_samples=10, ) session.dataset = dataset ``` Dataset size - Train split: 603 GB - Test split: 59 GB - Validation split: 48 GB Source : [https://deepmind.com/research/open-source/kinetics](https://deepmind.com/research/open-source/kinetics) * **Parameters:** * **classes** (*None*) – a string or list of strings specifying required classes to load. If provided, only samples containing at least one instance of a specified class will be loaded * **num_workers** (*None*) – a suggested number of threads to use when downloading individual images * **shuffle** (*False*) – whether to randomly shuffle the order in which samples are chosen for partial downloads * **seed** (*None*) – a random seed to use when shuffling * **max_samples** (*None*) – a maximum number of samples to load per split. If `classes` are also specified, only up to the number of samples that contain at least one specified class will be loaded. By default, all matching samples are loaded **Attributes:** | [`name`](#fiftyone.zoo.datasets.base.Kinetics700Dataset.name) | The name of the dataset. | |-----------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`license`](#fiftyone.zoo.datasets.base.Kinetics700Dataset.license) | The license or list,of,licenses under which the dataset is distributed, or None if unknown. | | [`tags`](#fiftyone.zoo.datasets.base.Kinetics700Dataset.tags) | A tuple of tags for the dataset. | | [`supported_splits`](#fiftyone.zoo.datasets.base.Kinetics700Dataset.supported_splits) | A tuple of supported splits for the dataset, or None if the dataset does not have splits. | | [`supports_partial_downloads`](#fiftyone.zoo.datasets.base.Kinetics700Dataset.supports_partial_downloads) | Whether the dataset supports downloading partial subsets of its splits. | | [`has_patches`](#fiftyone.zoo.datasets.base.Kinetics700Dataset.has_patches) | Whether the dataset has patches that may need to be applied to already downloaded files. | | [`has_splits`](#fiftyone.zoo.datasets.base.Kinetics700Dataset.has_splits) | Whether the dataset has splits. | | [`has_tags`](#fiftyone.zoo.datasets.base.Kinetics700Dataset.has_tags) | Whether the dataset has tags. | | [`importer_kwargs`](#fiftyone.zoo.datasets.base.Kinetics700Dataset.importer_kwargs) | A dict of default kwargs to pass to this dataset's [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). | | [`is_remote`](#fiftyone.zoo.datasets.base.Kinetics700Dataset.is_remote) | Whether the dataset is remotely-sourced. | | [`parameters`](#fiftyone.zoo.datasets.base.Kinetics700Dataset.parameters) | An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. | | [`requires_manual_download`](#fiftyone.zoo.datasets.base.Kinetics700Dataset.requires_manual_download) | Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. | **Methods:** | [`download_and_prepare`](#fiftyone.zoo.datasets.base.Kinetics700Dataset.download_and_prepare)(dataset_dir[, split, ...]) | Downloads the dataset and prepares it for use. | |----------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| | [`get_info_path`](#fiftyone.zoo.datasets.base.Kinetics700Dataset.get_info_path)(dataset_dir) | Returns the path to the `ZooDatasetInfo` for the dataset. | | [`get_split_dir`](#fiftyone.zoo.datasets.base.Kinetics700Dataset.get_split_dir)(dataset_dir, split) | Returns the directory for the given split of the dataset. | | [`has_info`](#fiftyone.zoo.datasets.base.Kinetics700Dataset.has_info)(dataset_dir) | Determines whether the directory contains `ZooDatasetInfo`. | | [`has_split`](#fiftyone.zoo.datasets.base.Kinetics700Dataset.has_split)(split) | Whether the dataset has the given split. | | [`has_tag`](#fiftyone.zoo.datasets.base.Kinetics700Dataset.has_tag)(tag) | Whether the dataset has the given tag. | | [`load_info`](#fiftyone.zoo.datasets.base.Kinetics700Dataset.load_info)(dataset_dir[, upgrade, ...]) | Loads the `ZooDatasetInfo` from the given dataset directory. | #### *property* name The name of the dataset. #### *property* license The license or list,of,licenses under which the dataset is distributed, or None if unknown. #### *property* tags A tuple of tags for the dataset. #### *property* supported_splits A tuple of supported splits for the dataset, or None if the dataset does not have splits. #### *property* supports_partial_downloads Whether the dataset supports downloading partial subsets of its splits. #### download_and_prepare(dataset_dir, split=None, splits=None, cleanup=True) Downloads the dataset and prepares it for use. If the requested splits have already been downloaded, they are not re-downloaded. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **split** (*None*) – `split` nor `splits` are provided, the full dataset is downloaded * **splits** (*None*) – a list of splits to download, if applicable. If neither `split` nor `splits` are provided, the full dataset is downloaded * **cleanup** (*True*) – whether to cleanup any temporary files generated during download * **Returns:** the `ZooDatasetInfo` for the dataset #### *static* get_info_path(dataset_dir) Returns the path to the `ZooDatasetInfo` for the dataset. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** the path to the `ZooDatasetInfo` #### get_split_dir(dataset_dir, split) Returns the directory for the given split of the dataset. * **Parameters:** * **dataset_dir** – the dataset directory * **split** – the dataset split * **Returns:** the directory that will/does hold the specified split #### *static* has_info(dataset_dir) Determines whether the directory contains `ZooDatasetInfo`. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** True/False #### *property* has_patches Whether the dataset has patches that may need to be applied to already downloaded files. #### has_split(split) Whether the dataset has the given split. * **Parameters:** **split** – the dataset split * **Returns:** True/False #### *property* has_splits Whether the dataset has splits. #### has_tag(tag) Whether the dataset has the given tag. * **Parameters:** **tag** – the tag * **Returns:** True/False #### *property* has_tags Whether the dataset has tags. #### *property* importer_kwargs A dict of default kwargs to pass to this dataset’s [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). #### *property* is_remote Whether the dataset is remotely-sourced. #### *static* load_info(dataset_dir, upgrade=True, warn_deprecated=False) Loads the `ZooDatasetInfo` from the given dataset directory. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **upgrade** (*True*) – whether to upgrade the JSON file on disk if any migrations were necessary * **warn_deprecated** (*False*) – whether to issue a warning if the dataset has a deprecated format * **Returns:** the `ZooDatasetInfo` for the dataset #### *property* parameters An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. #### *property* requires_manual_download Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. ### *class* fiftyone.zoo.datasets.base.Kinetics7002020Dataset(classes=None, num_workers=None, shuffle=None, seed=None, max_samples=None) Bases: [`FiftyOneDataset`](#fiftyone.zoo.datasets.base.FiftyOneDataset) Kinetics is a collection of large-scale, high-quality datasets of URL links of up to 650,000 video clips that cover 400/600/700 human action classes, depending on the dataset version. The videos include human-object interactions such as playing instruments, as well as human-human interactions such as shaking hands and hugging. Each action class has at least 400/600/700 video clips. Each clip is human annotated with a single action class and lasts around 10 seconds. This version contains videos and action classifications for the 700 class version of the dataset that was updated with new videos in 2020. This dataset is a superset of Kinetics 700. This dataset supports partial downloads: - You can specify subsets of data to download via the `classes` and `max_samples` parameters See [this page](../dataset_zoo/datasets/kinetics_700_2020.md#dataset-zoo-kinetics-700-2020) for more information about partial downloads of this dataset. Original split stats: - Train split: 542,352 videos - Test split: 67,433 videos - Validation split: 34,125 videos CVDF split stats: - Train split: 534,073 videos - Test split: 64,260 videos - Validation split: 33,914 videos Example usage: ```default import fiftyone as fo import fiftyone.zoo as foz # # Load 10 random samples from the validation split # # Only the required videos will be downloaded (if necessary). # dataset = foz.load_zoo_dataset( "kinetics-700-2020", split="validation", max_samples=10, shuffle=True, ) session = fo.launch_app(dataset) # # Load 10 samples from the validation split that # contain the actions "springboard diving" and "surfing water" # # Videos that contain all `classes` will be prioritized first, followed # by videos that contain at least one of the required `classes`. If # there are not enough videos matching `classes` in the split to meet # `max_samples`, only the available videos will be loaded. # # Videos will only be downloaded if necessary # # Subsequent partial loads of the validation split will never require # downloading any videos # dataset = foz.load_zoo_dataset( "kinetics-700-2020", split="validation", classes=["springboard diving", "surfing water"], max_samples=10, ) session.dataset = dataset ``` Dataset size - Train split: 603 GB - Test split: 59 GB - Validation split: 48 GB Source : [https://deepmind.com/research/open-source/kinetics](https://deepmind.com/research/open-source/kinetics) * **Parameters:** * **classes** (*None*) – a string or list of strings specifying required classes to load. If provided, only samples containing at least one instance of a specified class will be loaded * **num_workers** (*None*) – a suggested number of threads to use when downloading individual images * **shuffle** (*False*) – whether to randomly shuffle the order in which samples are chosen for partial downloads * **seed** (*None*) – a random seed to use when shuffling * **max_samples** (*None*) – a maximum number of samples to load per split. If `classes` are also specified, only up to the number of samples that contain at least one specified class will be loaded. By default, all matching samples are loaded **Attributes:** | [`name`](#fiftyone.zoo.datasets.base.Kinetics7002020Dataset.name) | The name of the dataset. | |---------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`license`](#fiftyone.zoo.datasets.base.Kinetics7002020Dataset.license) | The license or list,of,licenses under which the dataset is distributed, or None if unknown. | | [`tags`](#fiftyone.zoo.datasets.base.Kinetics7002020Dataset.tags) | A tuple of tags for the dataset. | | [`supported_splits`](#fiftyone.zoo.datasets.base.Kinetics7002020Dataset.supported_splits) | A tuple of supported splits for the dataset, or None if the dataset does not have splits. | | [`supports_partial_downloads`](#fiftyone.zoo.datasets.base.Kinetics7002020Dataset.supports_partial_downloads) | Whether the dataset supports downloading partial subsets of its splits. | | [`has_patches`](#fiftyone.zoo.datasets.base.Kinetics7002020Dataset.has_patches) | Whether the dataset has patches that may need to be applied to already downloaded files. | | [`has_splits`](#fiftyone.zoo.datasets.base.Kinetics7002020Dataset.has_splits) | Whether the dataset has splits. | | [`has_tags`](#fiftyone.zoo.datasets.base.Kinetics7002020Dataset.has_tags) | Whether the dataset has tags. | | [`importer_kwargs`](#fiftyone.zoo.datasets.base.Kinetics7002020Dataset.importer_kwargs) | A dict of default kwargs to pass to this dataset's [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). | | [`is_remote`](#fiftyone.zoo.datasets.base.Kinetics7002020Dataset.is_remote) | Whether the dataset is remotely-sourced. | | [`parameters`](#fiftyone.zoo.datasets.base.Kinetics7002020Dataset.parameters) | An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. | | [`requires_manual_download`](#fiftyone.zoo.datasets.base.Kinetics7002020Dataset.requires_manual_download) | Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. | **Methods:** | [`download_and_prepare`](#fiftyone.zoo.datasets.base.Kinetics7002020Dataset.download_and_prepare)(dataset_dir[, split, ...]) | Downloads the dataset and prepares it for use. | |--------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| | [`get_info_path`](#fiftyone.zoo.datasets.base.Kinetics7002020Dataset.get_info_path)(dataset_dir) | Returns the path to the `ZooDatasetInfo` for the dataset. | | [`get_split_dir`](#fiftyone.zoo.datasets.base.Kinetics7002020Dataset.get_split_dir)(dataset_dir, split) | Returns the directory for the given split of the dataset. | | [`has_info`](#fiftyone.zoo.datasets.base.Kinetics7002020Dataset.has_info)(dataset_dir) | Determines whether the directory contains `ZooDatasetInfo`. | | [`has_split`](#fiftyone.zoo.datasets.base.Kinetics7002020Dataset.has_split)(split) | Whether the dataset has the given split. | | [`has_tag`](#fiftyone.zoo.datasets.base.Kinetics7002020Dataset.has_tag)(tag) | Whether the dataset has the given tag. | | [`load_info`](#fiftyone.zoo.datasets.base.Kinetics7002020Dataset.load_info)(dataset_dir[, upgrade, ...]) | Loads the `ZooDatasetInfo` from the given dataset directory. | #### *property* name The name of the dataset. #### *property* license The license or list,of,licenses under which the dataset is distributed, or None if unknown. #### *property* tags A tuple of tags for the dataset. #### *property* supported_splits A tuple of supported splits for the dataset, or None if the dataset does not have splits. #### *property* supports_partial_downloads Whether the dataset supports downloading partial subsets of its splits. #### download_and_prepare(dataset_dir, split=None, splits=None, cleanup=True) Downloads the dataset and prepares it for use. If the requested splits have already been downloaded, they are not re-downloaded. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **split** (*None*) – `split` nor `splits` are provided, the full dataset is downloaded * **splits** (*None*) – a list of splits to download, if applicable. If neither `split` nor `splits` are provided, the full dataset is downloaded * **cleanup** (*True*) – whether to cleanup any temporary files generated during download * **Returns:** the `ZooDatasetInfo` for the dataset #### *static* get_info_path(dataset_dir) Returns the path to the `ZooDatasetInfo` for the dataset. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** the path to the `ZooDatasetInfo` #### get_split_dir(dataset_dir, split) Returns the directory for the given split of the dataset. * **Parameters:** * **dataset_dir** – the dataset directory * **split** – the dataset split * **Returns:** the directory that will/does hold the specified split #### *static* has_info(dataset_dir) Determines whether the directory contains `ZooDatasetInfo`. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** True/False #### *property* has_patches Whether the dataset has patches that may need to be applied to already downloaded files. #### has_split(split) Whether the dataset has the given split. * **Parameters:** **split** – the dataset split * **Returns:** True/False #### *property* has_splits Whether the dataset has splits. #### has_tag(tag) Whether the dataset has the given tag. * **Parameters:** **tag** – the tag * **Returns:** True/False #### *property* has_tags Whether the dataset has tags. #### *property* importer_kwargs A dict of default kwargs to pass to this dataset’s [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). #### *property* is_remote Whether the dataset is remotely-sourced. #### *static* load_info(dataset_dir, upgrade=True, warn_deprecated=False) Loads the `ZooDatasetInfo` from the given dataset directory. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **upgrade** (*True*) – whether to upgrade the JSON file on disk if any migrations were necessary * **warn_deprecated** (*False*) – whether to issue a warning if the dataset has a deprecated format * **Returns:** the `ZooDatasetInfo` for the dataset #### *property* parameters An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. #### *property* requires_manual_download Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. ### *class* fiftyone.zoo.datasets.base.KITTIDataset Bases: [`FiftyOneDataset`](#fiftyone.zoo.datasets.base.FiftyOneDataset) KITTI contains a suite of vision tasks built using an autonomous driving platform. This dataset contains the left camera images and the associated 2D object detections. The training split contains 7,481 annotated images, and the test split contains 7,518 unlabeled images. A full description of the annotations can be found in the README of the object development kit on the KITTI homepage. Example usage: ```default import fiftyone as fo import fiftyone.zoo as foz dataset = foz.load_zoo_dataset("kitti", split="train") session = fo.launch_app(dataset) ``` Dataset size : 12.57 GB Source : [http://www.cvlibs.net/datasets/kitti](http://www.cvlibs.net/datasets/kitti) **Attributes:** | [`name`](#fiftyone.zoo.datasets.base.KITTIDataset.name) | The name of the dataset. | |-----------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`license`](#fiftyone.zoo.datasets.base.KITTIDataset.license) | The license or list,of,licenses under which the dataset is distributed, or None if unknown. | | [`tags`](#fiftyone.zoo.datasets.base.KITTIDataset.tags) | A tuple of tags for the dataset. | | [`supported_splits`](#fiftyone.zoo.datasets.base.KITTIDataset.supported_splits) | A tuple of supported splits for the dataset, or None if the dataset does not have splits. | | [`has_patches`](#fiftyone.zoo.datasets.base.KITTIDataset.has_patches) | Whether the dataset has patches that may need to be applied to already downloaded files. | | [`has_splits`](#fiftyone.zoo.datasets.base.KITTIDataset.has_splits) | Whether the dataset has splits. | | [`has_tags`](#fiftyone.zoo.datasets.base.KITTIDataset.has_tags) | Whether the dataset has tags. | | [`importer_kwargs`](#fiftyone.zoo.datasets.base.KITTIDataset.importer_kwargs) | A dict of default kwargs to pass to this dataset's [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). | | [`is_remote`](#fiftyone.zoo.datasets.base.KITTIDataset.is_remote) | Whether the dataset is remotely-sourced. | | [`parameters`](#fiftyone.zoo.datasets.base.KITTIDataset.parameters) | An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. | | [`requires_manual_download`](#fiftyone.zoo.datasets.base.KITTIDataset.requires_manual_download) | Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. | | [`supports_partial_downloads`](#fiftyone.zoo.datasets.base.KITTIDataset.supports_partial_downloads) | Whether the dataset supports downloading partial subsets of its splits. | **Methods:** | [`download_and_prepare`](#fiftyone.zoo.datasets.base.KITTIDataset.download_and_prepare)(dataset_dir[, split, ...]) | Downloads the dataset and prepares it for use. | |----------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| | [`get_info_path`](#fiftyone.zoo.datasets.base.KITTIDataset.get_info_path)(dataset_dir) | Returns the path to the `ZooDatasetInfo` for the dataset. | | [`get_split_dir`](#fiftyone.zoo.datasets.base.KITTIDataset.get_split_dir)(dataset_dir, split) | Returns the directory for the given split of the dataset. | | [`has_info`](#fiftyone.zoo.datasets.base.KITTIDataset.has_info)(dataset_dir) | Determines whether the directory contains `ZooDatasetInfo`. | | [`has_split`](#fiftyone.zoo.datasets.base.KITTIDataset.has_split)(split) | Whether the dataset has the given split. | | [`has_tag`](#fiftyone.zoo.datasets.base.KITTIDataset.has_tag)(tag) | Whether the dataset has the given tag. | | [`load_info`](#fiftyone.zoo.datasets.base.KITTIDataset.load_info)(dataset_dir[, upgrade, ...]) | Loads the `ZooDatasetInfo` from the given dataset directory. | #### *property* name The name of the dataset. #### *property* license The license or list,of,licenses under which the dataset is distributed, or None if unknown. #### *property* tags A tuple of tags for the dataset. #### *property* supported_splits A tuple of supported splits for the dataset, or None if the dataset does not have splits. #### download_and_prepare(dataset_dir, split=None, splits=None, cleanup=True) Downloads the dataset and prepares it for use. If the requested splits have already been downloaded, they are not re-downloaded. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **split** (*None*) – `split` nor `splits` are provided, the full dataset is downloaded * **splits** (*None*) – a list of splits to download, if applicable. If neither `split` nor `splits` are provided, the full dataset is downloaded * **cleanup** (*True*) – whether to cleanup any temporary files generated during download * **Returns:** the `ZooDatasetInfo` for the dataset #### *static* get_info_path(dataset_dir) Returns the path to the `ZooDatasetInfo` for the dataset. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** the path to the `ZooDatasetInfo` #### get_split_dir(dataset_dir, split) Returns the directory for the given split of the dataset. * **Parameters:** * **dataset_dir** – the dataset directory * **split** – the dataset split * **Returns:** the directory that will/does hold the specified split #### *static* has_info(dataset_dir) Determines whether the directory contains `ZooDatasetInfo`. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** True/False #### *property* has_patches Whether the dataset has patches that may need to be applied to already downloaded files. #### has_split(split) Whether the dataset has the given split. * **Parameters:** **split** – the dataset split * **Returns:** True/False #### *property* has_splits Whether the dataset has splits. #### has_tag(tag) Whether the dataset has the given tag. * **Parameters:** **tag** – the tag * **Returns:** True/False #### *property* has_tags Whether the dataset has tags. #### *property* importer_kwargs A dict of default kwargs to pass to this dataset’s [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). #### *property* is_remote Whether the dataset is remotely-sourced. #### *static* load_info(dataset_dir, upgrade=True, warn_deprecated=False) Loads the `ZooDatasetInfo` from the given dataset directory. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **upgrade** (*True*) – whether to upgrade the JSON file on disk if any migrations were necessary * **warn_deprecated** (*False*) – whether to issue a warning if the dataset has a deprecated format * **Returns:** the `ZooDatasetInfo` for the dataset #### *property* parameters An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. #### *property* requires_manual_download Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. #### *property* supports_partial_downloads Whether the dataset supports downloading partial subsets of its splits. ### *class* fiftyone.zoo.datasets.base.KITTIMultiviewDataset Bases: [`FiftyOneDataset`](#fiftyone.zoo.datasets.base.FiftyOneDataset) KITTI contains a suite of vision tasks built using an autonomous driving platform. This dataset contains the following multiview data for each scene: - Left camera images annotated with 2D object detections - Right camera images annotated with 2D object detections - Velodyne LIDAR point clouds annotated with 3D object detections The training split contains 7,481 annotated scenes, and the test split contains 7,518 unlabeled scenes. A full description of the annotations can be found in the README of the object development kit on the KITTI homepage. Example usage: ```default import fiftyone as fo import fiftyone.zoo as foz dataset = foz.load_zoo_dataset("kitti-multiview", split="train") session = fo.launch_app(dataset) ``` Dataset size : 53.34 GB Source : [http://www.cvlibs.net/datasets/kitti](http://www.cvlibs.net/datasets/kitti) **Attributes:** | [`name`](#fiftyone.zoo.datasets.base.KITTIMultiviewDataset.name) | The name of the dataset. | |--------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`license`](#fiftyone.zoo.datasets.base.KITTIMultiviewDataset.license) | The license or list,of,licenses under which the dataset is distributed, or None if unknown. | | [`tags`](#fiftyone.zoo.datasets.base.KITTIMultiviewDataset.tags) | A tuple of tags for the dataset. | | [`supported_splits`](#fiftyone.zoo.datasets.base.KITTIMultiviewDataset.supported_splits) | A tuple of supported splits for the dataset, or None if the dataset does not have splits. | | [`supports_partial_downloads`](#fiftyone.zoo.datasets.base.KITTIMultiviewDataset.supports_partial_downloads) | Whether the dataset supports downloading partial subsets of its splits. | | [`has_patches`](#fiftyone.zoo.datasets.base.KITTIMultiviewDataset.has_patches) | Whether the dataset has patches that may need to be applied to already downloaded files. | | [`has_splits`](#fiftyone.zoo.datasets.base.KITTIMultiviewDataset.has_splits) | Whether the dataset has splits. | | [`has_tags`](#fiftyone.zoo.datasets.base.KITTIMultiviewDataset.has_tags) | Whether the dataset has tags. | | [`importer_kwargs`](#fiftyone.zoo.datasets.base.KITTIMultiviewDataset.importer_kwargs) | A dict of default kwargs to pass to this dataset's [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). | | [`is_remote`](#fiftyone.zoo.datasets.base.KITTIMultiviewDataset.is_remote) | Whether the dataset is remotely-sourced. | | [`parameters`](#fiftyone.zoo.datasets.base.KITTIMultiviewDataset.parameters) | An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. | | [`requires_manual_download`](#fiftyone.zoo.datasets.base.KITTIMultiviewDataset.requires_manual_download) | Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. | **Methods:** | [`download_and_prepare`](#fiftyone.zoo.datasets.base.KITTIMultiviewDataset.download_and_prepare)(dataset_dir[, split, ...]) | Downloads the dataset and prepares it for use. | |-------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| | [`get_info_path`](#fiftyone.zoo.datasets.base.KITTIMultiviewDataset.get_info_path)(dataset_dir) | Returns the path to the `ZooDatasetInfo` for the dataset. | | [`get_split_dir`](#fiftyone.zoo.datasets.base.KITTIMultiviewDataset.get_split_dir)(dataset_dir, split) | Returns the directory for the given split of the dataset. | | [`has_info`](#fiftyone.zoo.datasets.base.KITTIMultiviewDataset.has_info)(dataset_dir) | Determines whether the directory contains `ZooDatasetInfo`. | | [`has_split`](#fiftyone.zoo.datasets.base.KITTIMultiviewDataset.has_split)(split) | Whether the dataset has the given split. | | [`has_tag`](#fiftyone.zoo.datasets.base.KITTIMultiviewDataset.has_tag)(tag) | Whether the dataset has the given tag. | | [`load_info`](#fiftyone.zoo.datasets.base.KITTIMultiviewDataset.load_info)(dataset_dir[, upgrade, ...]) | Loads the `ZooDatasetInfo` from the given dataset directory. | #### *property* name The name of the dataset. #### *property* license The license or list,of,licenses under which the dataset is distributed, or None if unknown. #### *property* tags A tuple of tags for the dataset. #### *property* supported_splits A tuple of supported splits for the dataset, or None if the dataset does not have splits. #### *property* supports_partial_downloads Whether the dataset supports downloading partial subsets of its splits. #### *property* has_patches Whether the dataset has patches that may need to be applied to already downloaded files. #### download_and_prepare(dataset_dir, split=None, splits=None, cleanup=True) Downloads the dataset and prepares it for use. If the requested splits have already been downloaded, they are not re-downloaded. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **split** (*None*) – `split` nor `splits` are provided, the full dataset is downloaded * **splits** (*None*) – a list of splits to download, if applicable. If neither `split` nor `splits` are provided, the full dataset is downloaded * **cleanup** (*True*) – whether to cleanup any temporary files generated during download * **Returns:** the `ZooDatasetInfo` for the dataset #### *static* get_info_path(dataset_dir) Returns the path to the `ZooDatasetInfo` for the dataset. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** the path to the `ZooDatasetInfo` #### get_split_dir(dataset_dir, split) Returns the directory for the given split of the dataset. * **Parameters:** * **dataset_dir** – the dataset directory * **split** – the dataset split * **Returns:** the directory that will/does hold the specified split #### *static* has_info(dataset_dir) Determines whether the directory contains `ZooDatasetInfo`. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** True/False #### has_split(split) Whether the dataset has the given split. * **Parameters:** **split** – the dataset split * **Returns:** True/False #### *property* has_splits Whether the dataset has splits. #### has_tag(tag) Whether the dataset has the given tag. * **Parameters:** **tag** – the tag * **Returns:** True/False #### *property* has_tags Whether the dataset has tags. #### *property* importer_kwargs A dict of default kwargs to pass to this dataset’s [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). #### *property* is_remote Whether the dataset is remotely-sourced. #### *static* load_info(dataset_dir, upgrade=True, warn_deprecated=False) Loads the `ZooDatasetInfo` from the given dataset directory. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **upgrade** (*True*) – whether to upgrade the JSON file on disk if any migrations were necessary * **warn_deprecated** (*False*) – whether to issue a warning if the dataset has a deprecated format * **Returns:** the `ZooDatasetInfo` for the dataset #### *property* parameters An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. #### *property* requires_manual_download Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. ### *class* fiftyone.zoo.datasets.base.LabeledFacesInTheWildDataset Bases: [`FiftyOneDataset`](#fiftyone.zoo.datasets.base.FiftyOneDataset) Labeled Faces in the Wild is a public benchmark for face verification, also known as pair matching. The dataset contains 13,233 images of 5,749 people’s faces collected from the web. Each face has been labeled with the name of the person pictured. 1,680 of the people pictured have two or more distinct photos in the data set. The only constraint on these faces is that they were detected by the Viola-Jones face detector. Example usage: ```default import fiftyone as fo import fiftyone.zoo as foz dataset = foz.load_zoo_dataset("lfw", split="test") session = fo.launch_app(dataset) ``` Dataset size : 173.00 MB Source : [http://vis-www.cs.umass.edu/lfw](http://vis-www.cs.umass.edu/lfw) **Attributes:** | [`name`](#fiftyone.zoo.datasets.base.LabeledFacesInTheWildDataset.name) | The name of the dataset. | |---------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`license`](#fiftyone.zoo.datasets.base.LabeledFacesInTheWildDataset.license) | The license or list,of,licenses under which the dataset is distributed, or None if unknown. | | [`tags`](#fiftyone.zoo.datasets.base.LabeledFacesInTheWildDataset.tags) | A tuple of tags for the dataset. | | [`supported_splits`](#fiftyone.zoo.datasets.base.LabeledFacesInTheWildDataset.supported_splits) | A tuple of supported splits for the dataset, or None if the dataset does not have splits. | | [`has_patches`](#fiftyone.zoo.datasets.base.LabeledFacesInTheWildDataset.has_patches) | Whether the dataset has patches that may need to be applied to already downloaded files. | | [`has_splits`](#fiftyone.zoo.datasets.base.LabeledFacesInTheWildDataset.has_splits) | Whether the dataset has splits. | | [`has_tags`](#fiftyone.zoo.datasets.base.LabeledFacesInTheWildDataset.has_tags) | Whether the dataset has tags. | | [`importer_kwargs`](#fiftyone.zoo.datasets.base.LabeledFacesInTheWildDataset.importer_kwargs) | A dict of default kwargs to pass to this dataset's [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). | | [`is_remote`](#fiftyone.zoo.datasets.base.LabeledFacesInTheWildDataset.is_remote) | Whether the dataset is remotely-sourced. | | [`parameters`](#fiftyone.zoo.datasets.base.LabeledFacesInTheWildDataset.parameters) | An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. | | [`requires_manual_download`](#fiftyone.zoo.datasets.base.LabeledFacesInTheWildDataset.requires_manual_download) | Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. | | [`supports_partial_downloads`](#fiftyone.zoo.datasets.base.LabeledFacesInTheWildDataset.supports_partial_downloads) | Whether the dataset supports downloading partial subsets of its splits. | **Methods:** | [`download_and_prepare`](#fiftyone.zoo.datasets.base.LabeledFacesInTheWildDataset.download_and_prepare)(dataset_dir[, split, ...]) | Downloads the dataset and prepares it for use. | |--------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| | [`get_info_path`](#fiftyone.zoo.datasets.base.LabeledFacesInTheWildDataset.get_info_path)(dataset_dir) | Returns the path to the `ZooDatasetInfo` for the dataset. | | [`get_split_dir`](#fiftyone.zoo.datasets.base.LabeledFacesInTheWildDataset.get_split_dir)(dataset_dir, split) | Returns the directory for the given split of the dataset. | | [`has_info`](#fiftyone.zoo.datasets.base.LabeledFacesInTheWildDataset.has_info)(dataset_dir) | Determines whether the directory contains `ZooDatasetInfo`. | | [`has_split`](#fiftyone.zoo.datasets.base.LabeledFacesInTheWildDataset.has_split)(split) | Whether the dataset has the given split. | | [`has_tag`](#fiftyone.zoo.datasets.base.LabeledFacesInTheWildDataset.has_tag)(tag) | Whether the dataset has the given tag. | | [`load_info`](#fiftyone.zoo.datasets.base.LabeledFacesInTheWildDataset.load_info)(dataset_dir[, upgrade, ...]) | Loads the `ZooDatasetInfo` from the given dataset directory. | #### *property* name The name of the dataset. #### *property* license The license or list,of,licenses under which the dataset is distributed, or None if unknown. #### *property* tags A tuple of tags for the dataset. #### *property* supported_splits A tuple of supported splits for the dataset, or None if the dataset does not have splits. #### download_and_prepare(dataset_dir, split=None, splits=None, cleanup=True) Downloads the dataset and prepares it for use. If the requested splits have already been downloaded, they are not re-downloaded. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **split** (*None*) – `split` nor `splits` are provided, the full dataset is downloaded * **splits** (*None*) – a list of splits to download, if applicable. If neither `split` nor `splits` are provided, the full dataset is downloaded * **cleanup** (*True*) – whether to cleanup any temporary files generated during download * **Returns:** the `ZooDatasetInfo` for the dataset #### *static* get_info_path(dataset_dir) Returns the path to the `ZooDatasetInfo` for the dataset. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** the path to the `ZooDatasetInfo` #### get_split_dir(dataset_dir, split) Returns the directory for the given split of the dataset. * **Parameters:** * **dataset_dir** – the dataset directory * **split** – the dataset split * **Returns:** the directory that will/does hold the specified split #### *static* has_info(dataset_dir) Determines whether the directory contains `ZooDatasetInfo`. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** True/False #### *property* has_patches Whether the dataset has patches that may need to be applied to already downloaded files. #### has_split(split) Whether the dataset has the given split. * **Parameters:** **split** – the dataset split * **Returns:** True/False #### *property* has_splits Whether the dataset has splits. #### has_tag(tag) Whether the dataset has the given tag. * **Parameters:** **tag** – the tag * **Returns:** True/False #### *property* has_tags Whether the dataset has tags. #### *property* importer_kwargs A dict of default kwargs to pass to this dataset’s [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). #### *property* is_remote Whether the dataset is remotely-sourced. #### *static* load_info(dataset_dir, upgrade=True, warn_deprecated=False) Loads the `ZooDatasetInfo` from the given dataset directory. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **upgrade** (*True*) – whether to upgrade the JSON file on disk if any migrations were necessary * **warn_deprecated** (*False*) – whether to issue a warning if the dataset has a deprecated format * **Returns:** the `ZooDatasetInfo` for the dataset #### *property* parameters An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. #### *property* requires_manual_download Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. #### *property* supports_partial_downloads Whether the dataset supports downloading partial subsets of its splits. ### *class* fiftyone.zoo.datasets.base.OpenImagesV6Dataset(label_types=None, classes=None, attrs=None, image_ids=None, num_workers=None, shuffle=None, seed=None, max_samples=None) Bases: [`FiftyOneDataset`](#fiftyone.zoo.datasets.base.FiftyOneDataset) Open Images V6 is a dataset of ~9 million images, roughly 2 million of which are annotated and available via this zoo dataset. The dataset contains annotations for classification, detection, segmentation, and visual relationship tasks for the 600 boxable object classes. This dataset supports partial downloads: - You can specify subsets of data to download via the\`\`label_types\`\`, `classes`, `attrs`, and `max_samples` parameters - You can specify specific images to load via the `image_ids` parameter See [this page](../dataset_zoo/datasets/open_images_v6.md#dataset-zoo-open-images-v6) for more information about partial downloads of this dataset. Full split stats: - Train split: 1,743,042 images (513 GB) - Test split: 125,436 images (36 GB) - Validation split: 41,620 images (12 GB) Notes: - Not all images contain all types of labels - All images have been rescaled so that their largest dimension is at most 1024 pixels Example usage: ```default # # Load 50 random samples from the validation split # # By default, all label types are loaded # dataset = foz.load_zoo_dataset( "open-images-v6", split="validation", max_samples=50, shuffle=True, ) session = fo.launch_app(dataset) # # Load detections and classifications for 25 samples from the # validation split that contain fedoras and pianos # # Images that contain all `label_types` and `classes` will be # prioritized first, followed by images that contain at least one of # the required `classes`. If there are not enough images matching # `classes` in the split to meet `max_samples`, only the available # images will be loaded. # # Images will only be downloaded if necessary # dataset = foz.load_zoo_dataset( "open-images-v6", split="validation", label_types=["detections", "classifications"], classes=["Fedora", "Piano"], max_samples=25, ) session.dataset = dataset # # Download the entire validation split and load detections # # Subsequent partial loads of the validation split will never require # downloading any images # dataset = foz.load_zoo_dataset( "open-images-v6", split="validation", label_types=["detections"], ) session.dataset = dataset ``` Dataset size : 561 GB Source : [https://storage.googleapis.com/openimages/web/index.html](https://storage.googleapis.com/openimages/web/index.html) * **Parameters:** * **label_types** (*None*) – a label type or list of label types to load. The supported values are `("detections", "classifications", "relationships", "segmentations")`. By default, all label types are loaded * **classes** (*None*) – a string or list of strings specifying required classes to load. If provided, only samples containing at least one instance of a specified class will be loaded * **attrs** (*None*) – a string or list of strings specifying required relationship attributes to load. Only applicable when `label_types` includes “relationships”. If provided, only samples containing at least one instance of a specified attribute will be loaded * **image_ids** (*None*) – an optional list of specific image IDs to load. Can be provided in any of the following formats: - a list of `` strings - a list of `/` strings - the path to a text (newline-separated), JSON, or CSV file containing the list of image IDs to load in either of the first two formats * **num_workers** (*None*) – a suggested number of threads to use when downloading individual images * **shuffle** (*False*) – whether to randomly shuffle the order in which samples are chosen for partial downloads * **seed** (*None*) – a random seed to use when shuffling * **max_samples** (*None*) – a maximum number of samples to load per split. If `label_types`, `classes`, and/or `attrs` are also specified, first priority will be given to samples that contain all of the specified label types, classes, and/or attributes, followed by samples that contain at least one of the specified labels types or classes. The actual number of samples loaded may be less than this maximum value if the dataset does not contain sufficient samples matching your requirements. By default, all matching samples are loaded **Attributes:** | [`name`](#fiftyone.zoo.datasets.base.OpenImagesV6Dataset.name) | The name of the dataset. | |------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`license`](#fiftyone.zoo.datasets.base.OpenImagesV6Dataset.license) | The license or list,of,licenses under which the dataset is distributed, or None if unknown. | | [`tags`](#fiftyone.zoo.datasets.base.OpenImagesV6Dataset.tags) | A tuple of tags for the dataset. | | [`supported_splits`](#fiftyone.zoo.datasets.base.OpenImagesV6Dataset.supported_splits) | A tuple of supported splits for the dataset, or None if the dataset does not have splits. | | [`supports_partial_downloads`](#fiftyone.zoo.datasets.base.OpenImagesV6Dataset.supports_partial_downloads) | Whether the dataset supports downloading partial subsets of its splits. | | [`has_patches`](#fiftyone.zoo.datasets.base.OpenImagesV6Dataset.has_patches) | Whether the dataset has patches that may need to be applied to already downloaded files. | | [`has_splits`](#fiftyone.zoo.datasets.base.OpenImagesV6Dataset.has_splits) | Whether the dataset has splits. | | [`has_tags`](#fiftyone.zoo.datasets.base.OpenImagesV6Dataset.has_tags) | Whether the dataset has tags. | | [`importer_kwargs`](#fiftyone.zoo.datasets.base.OpenImagesV6Dataset.importer_kwargs) | A dict of default kwargs to pass to this dataset's [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). | | [`is_remote`](#fiftyone.zoo.datasets.base.OpenImagesV6Dataset.is_remote) | Whether the dataset is remotely-sourced. | | [`parameters`](#fiftyone.zoo.datasets.base.OpenImagesV6Dataset.parameters) | An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. | | [`requires_manual_download`](#fiftyone.zoo.datasets.base.OpenImagesV6Dataset.requires_manual_download) | Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. | **Methods:** | [`download_and_prepare`](#fiftyone.zoo.datasets.base.OpenImagesV6Dataset.download_and_prepare)(dataset_dir[, split, ...]) | Downloads the dataset and prepares it for use. | |-----------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| | [`get_info_path`](#fiftyone.zoo.datasets.base.OpenImagesV6Dataset.get_info_path)(dataset_dir) | Returns the path to the `ZooDatasetInfo` for the dataset. | | [`get_split_dir`](#fiftyone.zoo.datasets.base.OpenImagesV6Dataset.get_split_dir)(dataset_dir, split) | Returns the directory for the given split of the dataset. | | [`has_info`](#fiftyone.zoo.datasets.base.OpenImagesV6Dataset.has_info)(dataset_dir) | Determines whether the directory contains `ZooDatasetInfo`. | | [`has_split`](#fiftyone.zoo.datasets.base.OpenImagesV6Dataset.has_split)(split) | Whether the dataset has the given split. | | [`has_tag`](#fiftyone.zoo.datasets.base.OpenImagesV6Dataset.has_tag)(tag) | Whether the dataset has the given tag. | | [`load_info`](#fiftyone.zoo.datasets.base.OpenImagesV6Dataset.load_info)(dataset_dir[, upgrade, ...]) | Loads the `ZooDatasetInfo` from the given dataset directory. | #### *property* name The name of the dataset. #### *property* license The license or list,of,licenses under which the dataset is distributed, or None if unknown. #### *property* tags A tuple of tags for the dataset. #### *property* supported_splits A tuple of supported splits for the dataset, or None if the dataset does not have splits. #### *property* supports_partial_downloads Whether the dataset supports downloading partial subsets of its splits. #### download_and_prepare(dataset_dir, split=None, splits=None, cleanup=True) Downloads the dataset and prepares it for use. If the requested splits have already been downloaded, they are not re-downloaded. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **split** (*None*) – `split` nor `splits` are provided, the full dataset is downloaded * **splits** (*None*) – a list of splits to download, if applicable. If neither `split` nor `splits` are provided, the full dataset is downloaded * **cleanup** (*True*) – whether to cleanup any temporary files generated during download * **Returns:** the `ZooDatasetInfo` for the dataset #### *static* get_info_path(dataset_dir) Returns the path to the `ZooDatasetInfo` for the dataset. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** the path to the `ZooDatasetInfo` #### get_split_dir(dataset_dir, split) Returns the directory for the given split of the dataset. * **Parameters:** * **dataset_dir** – the dataset directory * **split** – the dataset split * **Returns:** the directory that will/does hold the specified split #### *static* has_info(dataset_dir) Determines whether the directory contains `ZooDatasetInfo`. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** True/False #### *property* has_patches Whether the dataset has patches that may need to be applied to already downloaded files. #### has_split(split) Whether the dataset has the given split. * **Parameters:** **split** – the dataset split * **Returns:** True/False #### *property* has_splits Whether the dataset has splits. #### has_tag(tag) Whether the dataset has the given tag. * **Parameters:** **tag** – the tag * **Returns:** True/False #### *property* has_tags Whether the dataset has tags. #### *property* importer_kwargs A dict of default kwargs to pass to this dataset’s [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). #### *property* is_remote Whether the dataset is remotely-sourced. #### *static* load_info(dataset_dir, upgrade=True, warn_deprecated=False) Loads the `ZooDatasetInfo` from the given dataset directory. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **upgrade** (*True*) – whether to upgrade the JSON file on disk if any migrations were necessary * **warn_deprecated** (*False*) – whether to issue a warning if the dataset has a deprecated format * **Returns:** the `ZooDatasetInfo` for the dataset #### *property* parameters An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. #### *property* requires_manual_download Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. ### *class* fiftyone.zoo.datasets.base.OpenImagesV7Dataset(label_types=None, classes=None, attrs=None, image_ids=None, num_workers=None, shuffle=None, seed=None, max_samples=None) Bases: [`FiftyOneDataset`](#fiftyone.zoo.datasets.base.FiftyOneDataset) Open Images V7 is a dataset of ~9 million images, roughly 2 million of which are annotated and available via this zoo dataset. The dataset contains annotations for classification, detection, segmentation, point labels, and visual relationship tasks for the 600 boxable object classes. This dataset supports partial downloads: - You can specify subsets of data to download via the\`\`label_types\`\`, `classes`, `attrs`, and `max_samples` parameters - You can specify specific images to load via the `image_ids` parameter See [this page](../dataset_zoo/datasets/open_images_v6.md#dataset-zoo-open-images-v6) for more information about partial downloads of this dataset. Full split stats: - Train split: 1,743,042 images (513 GB) - Test split: 125,436 images (36 GB) - Validation split: 41,620 images (12 GB) Notes: - Not all images contain all types of labels - All images have been rescaled so that their largest dimension is at most 1024 pixels Example usage: ```default # # Load 50 random samples from the validation split # # By default, all label types are loaded, including "points" # dataset = foz.load_zoo_dataset( "open-images-v7", split="validation", max_samples=50, shuffle=True, ) session = fo.launch_app(dataset) # # Load detections, classifications, and points for 25 samples from the # validation split that contain fedoras and pianos # # Images that contain all `label_types` and `classes` will be # prioritized first, followed by images that contain at least one of # the required `classes`. If there are not enough images matching # `classes` in the split to meet `max_samples`, only the available # images will be loaded. # # Images will only be downloaded if necessary # dataset = foz.load_zoo_dataset( "open-images-v7", split="validation", label_types=["detections", "classifications", "points"], classes=["Fedora", "Piano"], max_samples=25, ) session.dataset = dataset # # Download the entire validation split and load detections # # Subsequent partial loads of the validation split will never require # downloading any images # dataset = foz.load_zoo_dataset( "open-images-v7", split="validation", label_types=["detections"], ) session.dataset = dataset ``` Dataset size : 561 GB Source : [https://storage.googleapis.com/openimages/web/index.html](https://storage.googleapis.com/openimages/web/index.html) * **Parameters:** * **label_types** (*None*) – a label type or list of label types to load. The supported values are `("detections", "classifications", "points", "relationships", "segmentations")`. By default, all label types are loaded * **classes** (*None*) – a string or list of strings specifying required classes to load. If provided, only samples containing at least one instance of a specified class will be loaded * **attrs** (*None*) – a string or list of strings specifying required relationship attributes to load. Only applicable when `label_types` includes “relationships”. If provided, only samples containing at least one instance of a specified attribute will be loaded * **image_ids** (*None*) – an optional list of specific image IDs to load. Can be provided in any of the following formats: - a list of `` strings - a list of `/` strings - the path to a text (newline-separated), JSON, or CSV file containing the list of image IDs to load in either of the first two formats * **num_workers** (*None*) – a suggested number of threads to use when downloading individual images * **shuffle** (*False*) – whether to randomly shuffle the order in which samples are chosen for partial downloads * **seed** (*None*) – a random seed to use when shuffling * **max_samples** (*None*) – a maximum number of samples to load per split. If `label_types`, `classes`, and/or `attrs` are also specified, first priority will be given to samples that contain all of the specified label types, classes, and/or attributes, followed by samples that contain at least one of the specified labels types or classes. The actual number of samples loaded may be less than this maximum value if the dataset does not contain sufficient samples matching your requirements. By default, all matching samples are loaded **Attributes:** | [`name`](#fiftyone.zoo.datasets.base.OpenImagesV7Dataset.name) | The name of the dataset. | |------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`license`](#fiftyone.zoo.datasets.base.OpenImagesV7Dataset.license) | The license or list,of,licenses under which the dataset is distributed, or None if unknown. | | [`tags`](#fiftyone.zoo.datasets.base.OpenImagesV7Dataset.tags) | A tuple of tags for the dataset. | | [`supported_splits`](#fiftyone.zoo.datasets.base.OpenImagesV7Dataset.supported_splits) | A tuple of supported splits for the dataset, or None if the dataset does not have splits. | | [`supports_partial_downloads`](#fiftyone.zoo.datasets.base.OpenImagesV7Dataset.supports_partial_downloads) | Whether the dataset supports downloading partial subsets of its splits. | | [`has_patches`](#fiftyone.zoo.datasets.base.OpenImagesV7Dataset.has_patches) | Whether the dataset has patches that may need to be applied to already downloaded files. | | [`has_splits`](#fiftyone.zoo.datasets.base.OpenImagesV7Dataset.has_splits) | Whether the dataset has splits. | | [`has_tags`](#fiftyone.zoo.datasets.base.OpenImagesV7Dataset.has_tags) | Whether the dataset has tags. | | [`importer_kwargs`](#fiftyone.zoo.datasets.base.OpenImagesV7Dataset.importer_kwargs) | A dict of default kwargs to pass to this dataset's [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). | | [`is_remote`](#fiftyone.zoo.datasets.base.OpenImagesV7Dataset.is_remote) | Whether the dataset is remotely-sourced. | | [`parameters`](#fiftyone.zoo.datasets.base.OpenImagesV7Dataset.parameters) | An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. | | [`requires_manual_download`](#fiftyone.zoo.datasets.base.OpenImagesV7Dataset.requires_manual_download) | Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. | **Methods:** | [`download_and_prepare`](#fiftyone.zoo.datasets.base.OpenImagesV7Dataset.download_and_prepare)(dataset_dir[, split, ...]) | Downloads the dataset and prepares it for use. | |-----------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| | [`get_info_path`](#fiftyone.zoo.datasets.base.OpenImagesV7Dataset.get_info_path)(dataset_dir) | Returns the path to the `ZooDatasetInfo` for the dataset. | | [`get_split_dir`](#fiftyone.zoo.datasets.base.OpenImagesV7Dataset.get_split_dir)(dataset_dir, split) | Returns the directory for the given split of the dataset. | | [`has_info`](#fiftyone.zoo.datasets.base.OpenImagesV7Dataset.has_info)(dataset_dir) | Determines whether the directory contains `ZooDatasetInfo`. | | [`has_split`](#fiftyone.zoo.datasets.base.OpenImagesV7Dataset.has_split)(split) | Whether the dataset has the given split. | | [`has_tag`](#fiftyone.zoo.datasets.base.OpenImagesV7Dataset.has_tag)(tag) | Whether the dataset has the given tag. | | [`load_info`](#fiftyone.zoo.datasets.base.OpenImagesV7Dataset.load_info)(dataset_dir[, upgrade, ...]) | Loads the `ZooDatasetInfo` from the given dataset directory. | #### *property* name The name of the dataset. #### *property* license The license or list,of,licenses under which the dataset is distributed, or None if unknown. #### *property* tags A tuple of tags for the dataset. #### *property* supported_splits A tuple of supported splits for the dataset, or None if the dataset does not have splits. #### *property* supports_partial_downloads Whether the dataset supports downloading partial subsets of its splits. #### download_and_prepare(dataset_dir, split=None, splits=None, cleanup=True) Downloads the dataset and prepares it for use. If the requested splits have already been downloaded, they are not re-downloaded. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **split** (*None*) – `split` nor `splits` are provided, the full dataset is downloaded * **splits** (*None*) – a list of splits to download, if applicable. If neither `split` nor `splits` are provided, the full dataset is downloaded * **cleanup** (*True*) – whether to cleanup any temporary files generated during download * **Returns:** the `ZooDatasetInfo` for the dataset #### *static* get_info_path(dataset_dir) Returns the path to the `ZooDatasetInfo` for the dataset. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** the path to the `ZooDatasetInfo` #### get_split_dir(dataset_dir, split) Returns the directory for the given split of the dataset. * **Parameters:** * **dataset_dir** – the dataset directory * **split** – the dataset split * **Returns:** the directory that will/does hold the specified split #### *static* has_info(dataset_dir) Determines whether the directory contains `ZooDatasetInfo`. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** True/False #### *property* has_patches Whether the dataset has patches that may need to be applied to already downloaded files. #### has_split(split) Whether the dataset has the given split. * **Parameters:** **split** – the dataset split * **Returns:** True/False #### *property* has_splits Whether the dataset has splits. #### has_tag(tag) Whether the dataset has the given tag. * **Parameters:** **tag** – the tag * **Returns:** True/False #### *property* has_tags Whether the dataset has tags. #### *property* importer_kwargs A dict of default kwargs to pass to this dataset’s [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). #### *property* is_remote Whether the dataset is remotely-sourced. #### *static* load_info(dataset_dir, upgrade=True, warn_deprecated=False) Loads the `ZooDatasetInfo` from the given dataset directory. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **upgrade** (*True*) – whether to upgrade the JSON file on disk if any migrations were necessary * **warn_deprecated** (*False*) – whether to issue a warning if the dataset has a deprecated format * **Returns:** the `ZooDatasetInfo` for the dataset #### *property* parameters An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. #### *property* requires_manual_download Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. ### *class* fiftyone.zoo.datasets.base.PlacesDataset Bases: [`FiftyOneDataset`](#fiftyone.zoo.datasets.base.FiftyOneDataset) Places is a scene recognition dataset of 10 million images comprising ~400 unique scene categories. The images are labeled with scene semantic categories, comprising a large and diverse list of the types of environments encountered in the world. Full split stats: - Train split: 1,803,460 images, with between 3,068 and 5,000 per category - Test split: 328,500 images, with 900 images per category - Validation split: 36,500 images, with 100 images per category Example usage: ```default import fiftyone as fo import fiftyone.zoo as foz dataset = foz.load_zoo_dataset("places", split="validation") session = fo.launch_app(dataset) ``` Dataset size : 29 GB Source : [http://places2.csail.mit.edu/download-private.html](http://places2.csail.mit.edu/download-private.html) **Attributes:** | [`name`](#fiftyone.zoo.datasets.base.PlacesDataset.name) | The name of the dataset. | |------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`license`](#fiftyone.zoo.datasets.base.PlacesDataset.license) | The license or list,of,licenses under which the dataset is distributed, or None if unknown. | | [`tags`](#fiftyone.zoo.datasets.base.PlacesDataset.tags) | A tuple of tags for the dataset. | | [`supported_splits`](#fiftyone.zoo.datasets.base.PlacesDataset.supported_splits) | A tuple of supported splits for the dataset, or None if the dataset does not have splits. | | [`supports_partial_downloads`](#fiftyone.zoo.datasets.base.PlacesDataset.supports_partial_downloads) | Whether the dataset supports downloading partial subsets of its splits. | | [`has_patches`](#fiftyone.zoo.datasets.base.PlacesDataset.has_patches) | Whether the dataset has patches that may need to be applied to already downloaded files. | | [`has_splits`](#fiftyone.zoo.datasets.base.PlacesDataset.has_splits) | Whether the dataset has splits. | | [`has_tags`](#fiftyone.zoo.datasets.base.PlacesDataset.has_tags) | Whether the dataset has tags. | | [`importer_kwargs`](#fiftyone.zoo.datasets.base.PlacesDataset.importer_kwargs) | A dict of default kwargs to pass to this dataset's [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). | | [`is_remote`](#fiftyone.zoo.datasets.base.PlacesDataset.is_remote) | Whether the dataset is remotely-sourced. | | [`parameters`](#fiftyone.zoo.datasets.base.PlacesDataset.parameters) | An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. | | [`requires_manual_download`](#fiftyone.zoo.datasets.base.PlacesDataset.requires_manual_download) | Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. | **Methods:** | [`download_and_prepare`](#fiftyone.zoo.datasets.base.PlacesDataset.download_and_prepare)(dataset_dir[, split, ...]) | Downloads the dataset and prepares it for use. | |-----------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| | [`get_info_path`](#fiftyone.zoo.datasets.base.PlacesDataset.get_info_path)(dataset_dir) | Returns the path to the `ZooDatasetInfo` for the dataset. | | [`get_split_dir`](#fiftyone.zoo.datasets.base.PlacesDataset.get_split_dir)(dataset_dir, split) | Returns the directory for the given split of the dataset. | | [`has_info`](#fiftyone.zoo.datasets.base.PlacesDataset.has_info)(dataset_dir) | Determines whether the directory contains `ZooDatasetInfo`. | | [`has_split`](#fiftyone.zoo.datasets.base.PlacesDataset.has_split)(split) | Whether the dataset has the given split. | | [`has_tag`](#fiftyone.zoo.datasets.base.PlacesDataset.has_tag)(tag) | Whether the dataset has the given tag. | | [`load_info`](#fiftyone.zoo.datasets.base.PlacesDataset.load_info)(dataset_dir[, upgrade, ...]) | Loads the `ZooDatasetInfo` from the given dataset directory. | #### *property* name The name of the dataset. #### *property* license The license or list,of,licenses under which the dataset is distributed, or None if unknown. #### *property* tags A tuple of tags for the dataset. #### *property* supported_splits A tuple of supported splits for the dataset, or None if the dataset does not have splits. #### *property* supports_partial_downloads Whether the dataset supports downloading partial subsets of its splits. #### download_and_prepare(dataset_dir, split=None, splits=None, cleanup=True) Downloads the dataset and prepares it for use. If the requested splits have already been downloaded, they are not re-downloaded. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **split** (*None*) – `split` nor `splits` are provided, the full dataset is downloaded * **splits** (*None*) – a list of splits to download, if applicable. If neither `split` nor `splits` are provided, the full dataset is downloaded * **cleanup** (*True*) – whether to cleanup any temporary files generated during download * **Returns:** the `ZooDatasetInfo` for the dataset #### *static* get_info_path(dataset_dir) Returns the path to the `ZooDatasetInfo` for the dataset. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** the path to the `ZooDatasetInfo` #### get_split_dir(dataset_dir, split) Returns the directory for the given split of the dataset. * **Parameters:** * **dataset_dir** – the dataset directory * **split** – the dataset split * **Returns:** the directory that will/does hold the specified split #### *static* has_info(dataset_dir) Determines whether the directory contains `ZooDatasetInfo`. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** True/False #### *property* has_patches Whether the dataset has patches that may need to be applied to already downloaded files. #### has_split(split) Whether the dataset has the given split. * **Parameters:** **split** – the dataset split * **Returns:** True/False #### *property* has_splits Whether the dataset has splits. #### has_tag(tag) Whether the dataset has the given tag. * **Parameters:** **tag** – the tag * **Returns:** True/False #### *property* has_tags Whether the dataset has tags. #### *property* importer_kwargs A dict of default kwargs to pass to this dataset’s [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). #### *property* is_remote Whether the dataset is remotely-sourced. #### *static* load_info(dataset_dir, upgrade=True, warn_deprecated=False) Loads the `ZooDatasetInfo` from the given dataset directory. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **upgrade** (*True*) – whether to upgrade the JSON file on disk if any migrations were necessary * **warn_deprecated** (*False*) – whether to issue a warning if the dataset has a deprecated format * **Returns:** the `ZooDatasetInfo` for the dataset #### *property* parameters An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. #### *property* requires_manual_download Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. ### *class* fiftyone.zoo.datasets.base.QuickstartDataset Bases: [`FiftyOneDataset`](#fiftyone.zoo.datasets.base.FiftyOneDataset) A small dataset with ground truth bounding boxes and predictions. The dataset consists of 200 images from the validation split of COCO-2017, with model predictions generated by an out-of-the-box Faster R-CNN model from [torchvision.models](https://pytorch.org/docs/stable/torchvision/models.html). Example usage: ```default import fiftyone as fo import fiftyone.zoo as foz dataset = foz.load_zoo_dataset("quickstart") session = fo.launch_app(dataset) ``` Dataset size : 23.40 MB **Attributes:** | [`name`](#fiftyone.zoo.datasets.base.QuickstartDataset.name) | The name of the dataset. | |----------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`license`](#fiftyone.zoo.datasets.base.QuickstartDataset.license) | The license or list,of,licenses under which the dataset is distributed, or None if unknown. | | [`tags`](#fiftyone.zoo.datasets.base.QuickstartDataset.tags) | A tuple of tags for the dataset. | | [`supported_splits`](#fiftyone.zoo.datasets.base.QuickstartDataset.supported_splits) | A tuple of supported splits for the dataset, or None if the dataset does not have splits. | | [`has_patches`](#fiftyone.zoo.datasets.base.QuickstartDataset.has_patches) | Whether the dataset has patches that may need to be applied to already downloaded files. | | [`has_splits`](#fiftyone.zoo.datasets.base.QuickstartDataset.has_splits) | Whether the dataset has splits. | | [`has_tags`](#fiftyone.zoo.datasets.base.QuickstartDataset.has_tags) | Whether the dataset has tags. | | [`importer_kwargs`](#fiftyone.zoo.datasets.base.QuickstartDataset.importer_kwargs) | A dict of default kwargs to pass to this dataset's [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). | | [`is_remote`](#fiftyone.zoo.datasets.base.QuickstartDataset.is_remote) | Whether the dataset is remotely-sourced. | | [`parameters`](#fiftyone.zoo.datasets.base.QuickstartDataset.parameters) | An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. | | [`requires_manual_download`](#fiftyone.zoo.datasets.base.QuickstartDataset.requires_manual_download) | Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. | | [`supports_partial_downloads`](#fiftyone.zoo.datasets.base.QuickstartDataset.supports_partial_downloads) | Whether the dataset supports downloading partial subsets of its splits. | **Methods:** | [`download_and_prepare`](#fiftyone.zoo.datasets.base.QuickstartDataset.download_and_prepare)(dataset_dir[, split, ...]) | Downloads the dataset and prepares it for use. | |---------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| | [`get_info_path`](#fiftyone.zoo.datasets.base.QuickstartDataset.get_info_path)(dataset_dir) | Returns the path to the `ZooDatasetInfo` for the dataset. | | [`get_split_dir`](#fiftyone.zoo.datasets.base.QuickstartDataset.get_split_dir)(dataset_dir, split) | Returns the directory for the given split of the dataset. | | [`has_info`](#fiftyone.zoo.datasets.base.QuickstartDataset.has_info)(dataset_dir) | Determines whether the directory contains `ZooDatasetInfo`. | | [`has_split`](#fiftyone.zoo.datasets.base.QuickstartDataset.has_split)(split) | Whether the dataset has the given split. | | [`has_tag`](#fiftyone.zoo.datasets.base.QuickstartDataset.has_tag)(tag) | Whether the dataset has the given tag. | | [`load_info`](#fiftyone.zoo.datasets.base.QuickstartDataset.load_info)(dataset_dir[, upgrade, ...]) | Loads the `ZooDatasetInfo` from the given dataset directory. | #### *property* name The name of the dataset. #### *property* license The license or list,of,licenses under which the dataset is distributed, or None if unknown. #### *property* tags A tuple of tags for the dataset. #### *property* supported_splits A tuple of supported splits for the dataset, or None if the dataset does not have splits. #### download_and_prepare(dataset_dir, split=None, splits=None, cleanup=True) Downloads the dataset and prepares it for use. If the requested splits have already been downloaded, they are not re-downloaded. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **split** (*None*) – `split` nor `splits` are provided, the full dataset is downloaded * **splits** (*None*) – a list of splits to download, if applicable. If neither `split` nor `splits` are provided, the full dataset is downloaded * **cleanup** (*True*) – whether to cleanup any temporary files generated during download * **Returns:** the `ZooDatasetInfo` for the dataset #### *static* get_info_path(dataset_dir) Returns the path to the `ZooDatasetInfo` for the dataset. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** the path to the `ZooDatasetInfo` #### get_split_dir(dataset_dir, split) Returns the directory for the given split of the dataset. * **Parameters:** * **dataset_dir** – the dataset directory * **split** – the dataset split * **Returns:** the directory that will/does hold the specified split #### *static* has_info(dataset_dir) Determines whether the directory contains `ZooDatasetInfo`. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** True/False #### *property* has_patches Whether the dataset has patches that may need to be applied to already downloaded files. #### has_split(split) Whether the dataset has the given split. * **Parameters:** **split** – the dataset split * **Returns:** True/False #### *property* has_splits Whether the dataset has splits. #### has_tag(tag) Whether the dataset has the given tag. * **Parameters:** **tag** – the tag * **Returns:** True/False #### *property* has_tags Whether the dataset has tags. #### *property* importer_kwargs A dict of default kwargs to pass to this dataset’s [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). #### *property* is_remote Whether the dataset is remotely-sourced. #### *static* load_info(dataset_dir, upgrade=True, warn_deprecated=False) Loads the `ZooDatasetInfo` from the given dataset directory. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **upgrade** (*True*) – whether to upgrade the JSON file on disk if any migrations were necessary * **warn_deprecated** (*False*) – whether to issue a warning if the dataset has a deprecated format * **Returns:** the `ZooDatasetInfo` for the dataset #### *property* parameters An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. #### *property* requires_manual_download Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. #### *property* supports_partial_downloads Whether the dataset supports downloading partial subsets of its splits. ### *class* fiftyone.zoo.datasets.base.QuickstartGeoDataset Bases: [`FiftyOneDataset`](#fiftyone.zoo.datasets.base.FiftyOneDataset) A small dataset with geolocation data. The dataset consists of 500 images from the validation split of the BDD100K dataset in the New York City area with object detections and GPS timestamps. Example usage: ```default import fiftyone as fo import fiftyone.zoo as foz dataset = foz.load_zoo_dataset("quickstart-geo") session = fo.launch_app(dataset) ``` Dataset size : 33.50 MB **Attributes:** | [`name`](#fiftyone.zoo.datasets.base.QuickstartGeoDataset.name) | The name of the dataset. | |-------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`license`](#fiftyone.zoo.datasets.base.QuickstartGeoDataset.license) | The license or list,of,licenses under which the dataset is distributed, or None if unknown. | | [`tags`](#fiftyone.zoo.datasets.base.QuickstartGeoDataset.tags) | A tuple of tags for the dataset. | | [`supported_splits`](#fiftyone.zoo.datasets.base.QuickstartGeoDataset.supported_splits) | A tuple of supported splits for the dataset, or None if the dataset does not have splits. | | [`has_patches`](#fiftyone.zoo.datasets.base.QuickstartGeoDataset.has_patches) | Whether the dataset has patches that may need to be applied to already downloaded files. | | [`has_splits`](#fiftyone.zoo.datasets.base.QuickstartGeoDataset.has_splits) | Whether the dataset has splits. | | [`has_tags`](#fiftyone.zoo.datasets.base.QuickstartGeoDataset.has_tags) | Whether the dataset has tags. | | [`importer_kwargs`](#fiftyone.zoo.datasets.base.QuickstartGeoDataset.importer_kwargs) | A dict of default kwargs to pass to this dataset's [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). | | [`is_remote`](#fiftyone.zoo.datasets.base.QuickstartGeoDataset.is_remote) | Whether the dataset is remotely-sourced. | | [`parameters`](#fiftyone.zoo.datasets.base.QuickstartGeoDataset.parameters) | An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. | | [`requires_manual_download`](#fiftyone.zoo.datasets.base.QuickstartGeoDataset.requires_manual_download) | Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. | | [`supports_partial_downloads`](#fiftyone.zoo.datasets.base.QuickstartGeoDataset.supports_partial_downloads) | Whether the dataset supports downloading partial subsets of its splits. | **Methods:** | [`download_and_prepare`](#fiftyone.zoo.datasets.base.QuickstartGeoDataset.download_and_prepare)(dataset_dir[, split, ...]) | Downloads the dataset and prepares it for use. | |------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| | [`get_info_path`](#fiftyone.zoo.datasets.base.QuickstartGeoDataset.get_info_path)(dataset_dir) | Returns the path to the `ZooDatasetInfo` for the dataset. | | [`get_split_dir`](#fiftyone.zoo.datasets.base.QuickstartGeoDataset.get_split_dir)(dataset_dir, split) | Returns the directory for the given split of the dataset. | | [`has_info`](#fiftyone.zoo.datasets.base.QuickstartGeoDataset.has_info)(dataset_dir) | Determines whether the directory contains `ZooDatasetInfo`. | | [`has_split`](#fiftyone.zoo.datasets.base.QuickstartGeoDataset.has_split)(split) | Whether the dataset has the given split. | | [`has_tag`](#fiftyone.zoo.datasets.base.QuickstartGeoDataset.has_tag)(tag) | Whether the dataset has the given tag. | | [`load_info`](#fiftyone.zoo.datasets.base.QuickstartGeoDataset.load_info)(dataset_dir[, upgrade, ...]) | Loads the `ZooDatasetInfo` from the given dataset directory. | #### *property* name The name of the dataset. #### *property* license The license or list,of,licenses under which the dataset is distributed, or None if unknown. #### *property* tags A tuple of tags for the dataset. #### *property* supported_splits A tuple of supported splits for the dataset, or None if the dataset does not have splits. #### download_and_prepare(dataset_dir, split=None, splits=None, cleanup=True) Downloads the dataset and prepares it for use. If the requested splits have already been downloaded, they are not re-downloaded. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **split** (*None*) – `split` nor `splits` are provided, the full dataset is downloaded * **splits** (*None*) – a list of splits to download, if applicable. If neither `split` nor `splits` are provided, the full dataset is downloaded * **cleanup** (*True*) – whether to cleanup any temporary files generated during download * **Returns:** the `ZooDatasetInfo` for the dataset #### *static* get_info_path(dataset_dir) Returns the path to the `ZooDatasetInfo` for the dataset. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** the path to the `ZooDatasetInfo` #### get_split_dir(dataset_dir, split) Returns the directory for the given split of the dataset. * **Parameters:** * **dataset_dir** – the dataset directory * **split** – the dataset split * **Returns:** the directory that will/does hold the specified split #### *static* has_info(dataset_dir) Determines whether the directory contains `ZooDatasetInfo`. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** True/False #### *property* has_patches Whether the dataset has patches that may need to be applied to already downloaded files. #### has_split(split) Whether the dataset has the given split. * **Parameters:** **split** – the dataset split * **Returns:** True/False #### *property* has_splits Whether the dataset has splits. #### has_tag(tag) Whether the dataset has the given tag. * **Parameters:** **tag** – the tag * **Returns:** True/False #### *property* has_tags Whether the dataset has tags. #### *property* importer_kwargs A dict of default kwargs to pass to this dataset’s [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). #### *property* is_remote Whether the dataset is remotely-sourced. #### *static* load_info(dataset_dir, upgrade=True, warn_deprecated=False) Loads the `ZooDatasetInfo` from the given dataset directory. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **upgrade** (*True*) – whether to upgrade the JSON file on disk if any migrations were necessary * **warn_deprecated** (*False*) – whether to issue a warning if the dataset has a deprecated format * **Returns:** the `ZooDatasetInfo` for the dataset #### *property* parameters An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. #### *property* requires_manual_download Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. #### *property* supports_partial_downloads Whether the dataset supports downloading partial subsets of its splits. ### *class* fiftyone.zoo.datasets.base.QuickstartVideoDataset Bases: [`FiftyOneDataset`](#fiftyone.zoo.datasets.base.FiftyOneDataset) A small video dataset with dense annotations. The dataset consists of 10 video segments with dense object detections generated by human annotators. Example usage: ```default import fiftyone as fo import fiftyone.zoo as foz dataset = foz.load_zoo_dataset("quickstart-video") session = fo.launch_app(dataset) ``` Dataset size : 35.20 MB **Attributes:** | [`name`](#fiftyone.zoo.datasets.base.QuickstartVideoDataset.name) | The name of the dataset. | |---------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`license`](#fiftyone.zoo.datasets.base.QuickstartVideoDataset.license) | The license or list,of,licenses under which the dataset is distributed, or None if unknown. | | [`tags`](#fiftyone.zoo.datasets.base.QuickstartVideoDataset.tags) | A tuple of tags for the dataset. | | [`supported_splits`](#fiftyone.zoo.datasets.base.QuickstartVideoDataset.supported_splits) | A tuple of supported splits for the dataset, or None if the dataset does not have splits. | | [`has_patches`](#fiftyone.zoo.datasets.base.QuickstartVideoDataset.has_patches) | Whether the dataset has patches that may need to be applied to already downloaded files. | | [`has_splits`](#fiftyone.zoo.datasets.base.QuickstartVideoDataset.has_splits) | Whether the dataset has splits. | | [`has_tags`](#fiftyone.zoo.datasets.base.QuickstartVideoDataset.has_tags) | Whether the dataset has tags. | | [`importer_kwargs`](#fiftyone.zoo.datasets.base.QuickstartVideoDataset.importer_kwargs) | A dict of default kwargs to pass to this dataset's [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). | | [`is_remote`](#fiftyone.zoo.datasets.base.QuickstartVideoDataset.is_remote) | Whether the dataset is remotely-sourced. | | [`parameters`](#fiftyone.zoo.datasets.base.QuickstartVideoDataset.parameters) | An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. | | [`requires_manual_download`](#fiftyone.zoo.datasets.base.QuickstartVideoDataset.requires_manual_download) | Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. | | [`supports_partial_downloads`](#fiftyone.zoo.datasets.base.QuickstartVideoDataset.supports_partial_downloads) | Whether the dataset supports downloading partial subsets of its splits. | **Methods:** | [`download_and_prepare`](#fiftyone.zoo.datasets.base.QuickstartVideoDataset.download_and_prepare)(dataset_dir[, split, ...]) | Downloads the dataset and prepares it for use. | |--------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| | [`get_info_path`](#fiftyone.zoo.datasets.base.QuickstartVideoDataset.get_info_path)(dataset_dir) | Returns the path to the `ZooDatasetInfo` for the dataset. | | [`get_split_dir`](#fiftyone.zoo.datasets.base.QuickstartVideoDataset.get_split_dir)(dataset_dir, split) | Returns the directory for the given split of the dataset. | | [`has_info`](#fiftyone.zoo.datasets.base.QuickstartVideoDataset.has_info)(dataset_dir) | Determines whether the directory contains `ZooDatasetInfo`. | | [`has_split`](#fiftyone.zoo.datasets.base.QuickstartVideoDataset.has_split)(split) | Whether the dataset has the given split. | | [`has_tag`](#fiftyone.zoo.datasets.base.QuickstartVideoDataset.has_tag)(tag) | Whether the dataset has the given tag. | | [`load_info`](#fiftyone.zoo.datasets.base.QuickstartVideoDataset.load_info)(dataset_dir[, upgrade, ...]) | Loads the `ZooDatasetInfo` from the given dataset directory. | #### *property* name The name of the dataset. #### *property* license The license or list,of,licenses under which the dataset is distributed, or None if unknown. #### *property* tags A tuple of tags for the dataset. #### *property* supported_splits A tuple of supported splits for the dataset, or None if the dataset does not have splits. #### download_and_prepare(dataset_dir, split=None, splits=None, cleanup=True) Downloads the dataset and prepares it for use. If the requested splits have already been downloaded, they are not re-downloaded. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **split** (*None*) – `split` nor `splits` are provided, the full dataset is downloaded * **splits** (*None*) – a list of splits to download, if applicable. If neither `split` nor `splits` are provided, the full dataset is downloaded * **cleanup** (*True*) – whether to cleanup any temporary files generated during download * **Returns:** the `ZooDatasetInfo` for the dataset #### *static* get_info_path(dataset_dir) Returns the path to the `ZooDatasetInfo` for the dataset. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** the path to the `ZooDatasetInfo` #### get_split_dir(dataset_dir, split) Returns the directory for the given split of the dataset. * **Parameters:** * **dataset_dir** – the dataset directory * **split** – the dataset split * **Returns:** the directory that will/does hold the specified split #### *static* has_info(dataset_dir) Determines whether the directory contains `ZooDatasetInfo`. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** True/False #### *property* has_patches Whether the dataset has patches that may need to be applied to already downloaded files. #### has_split(split) Whether the dataset has the given split. * **Parameters:** **split** – the dataset split * **Returns:** True/False #### *property* has_splits Whether the dataset has splits. #### has_tag(tag) Whether the dataset has the given tag. * **Parameters:** **tag** – the tag * **Returns:** True/False #### *property* has_tags Whether the dataset has tags. #### *property* importer_kwargs A dict of default kwargs to pass to this dataset’s [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). #### *property* is_remote Whether the dataset is remotely-sourced. #### *static* load_info(dataset_dir, upgrade=True, warn_deprecated=False) Loads the `ZooDatasetInfo` from the given dataset directory. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **upgrade** (*True*) – whether to upgrade the JSON file on disk if any migrations were necessary * **warn_deprecated** (*False*) – whether to issue a warning if the dataset has a deprecated format * **Returns:** the `ZooDatasetInfo` for the dataset #### *property* parameters An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. #### *property* requires_manual_download Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. #### *property* supports_partial_downloads Whether the dataset supports downloading partial subsets of its splits. ### *class* fiftyone.zoo.datasets.base.QuickstartTrajectoriesDataset Bases: [`FiftyOneDataset`](#fiftyone.zoo.datasets.base.FiftyOneDataset) A small video dataset for trajectory annotation. The dataset consists of the same 10 video segments as [`QuickstartVideoDataset`](#fiftyone.zoo.datasets.base.QuickstartVideoDataset), but the per-frame object detections are linked across frames into object trajectories via the [`fiftyone.core.labels.Instance`](fiftyone.core.labels.md#fiftyone.core.labels.Instance) values in their `instance` attributes (the legacy `index` attribute has been removed). #### NOTE Before annotating trajectories, you must compute video metadata and sample the videos into frames: ```default dataset.compute_metadata() dataset.to_frames(sample_frames=True) ``` Example usage: ```default import fiftyone as fo import fiftyone.zoo as foz dataset = foz.load_zoo_dataset("quickstart-trajectories") session = fo.launch_app(dataset) ``` Dataset size : 35.20 MB **Attributes:** | [`name`](#fiftyone.zoo.datasets.base.QuickstartTrajectoriesDataset.name) | The name of the dataset. | |----------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`license`](#fiftyone.zoo.datasets.base.QuickstartTrajectoriesDataset.license) | The license or list,of,licenses under which the dataset is distributed, or None if unknown. | | [`tags`](#fiftyone.zoo.datasets.base.QuickstartTrajectoriesDataset.tags) | A tuple of tags for the dataset. | | [`supported_splits`](#fiftyone.zoo.datasets.base.QuickstartTrajectoriesDataset.supported_splits) | A tuple of supported splits for the dataset, or None if the dataset does not have splits. | | [`has_patches`](#fiftyone.zoo.datasets.base.QuickstartTrajectoriesDataset.has_patches) | Whether the dataset has patches that may need to be applied to already downloaded files. | | [`has_splits`](#fiftyone.zoo.datasets.base.QuickstartTrajectoriesDataset.has_splits) | Whether the dataset has splits. | | [`has_tags`](#fiftyone.zoo.datasets.base.QuickstartTrajectoriesDataset.has_tags) | Whether the dataset has tags. | | [`importer_kwargs`](#fiftyone.zoo.datasets.base.QuickstartTrajectoriesDataset.importer_kwargs) | A dict of default kwargs to pass to this dataset's [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). | | [`is_remote`](#fiftyone.zoo.datasets.base.QuickstartTrajectoriesDataset.is_remote) | Whether the dataset is remotely-sourced. | | [`parameters`](#fiftyone.zoo.datasets.base.QuickstartTrajectoriesDataset.parameters) | An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. | | [`requires_manual_download`](#fiftyone.zoo.datasets.base.QuickstartTrajectoriesDataset.requires_manual_download) | Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. | | [`supports_partial_downloads`](#fiftyone.zoo.datasets.base.QuickstartTrajectoriesDataset.supports_partial_downloads) | Whether the dataset supports downloading partial subsets of its splits. | **Methods:** | [`download_and_prepare`](#fiftyone.zoo.datasets.base.QuickstartTrajectoriesDataset.download_and_prepare)(dataset_dir[, split, ...]) | Downloads the dataset and prepares it for use. | |---------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| | [`get_info_path`](#fiftyone.zoo.datasets.base.QuickstartTrajectoriesDataset.get_info_path)(dataset_dir) | Returns the path to the `ZooDatasetInfo` for the dataset. | | [`get_split_dir`](#fiftyone.zoo.datasets.base.QuickstartTrajectoriesDataset.get_split_dir)(dataset_dir, split) | Returns the directory for the given split of the dataset. | | [`has_info`](#fiftyone.zoo.datasets.base.QuickstartTrajectoriesDataset.has_info)(dataset_dir) | Determines whether the directory contains `ZooDatasetInfo`. | | [`has_split`](#fiftyone.zoo.datasets.base.QuickstartTrajectoriesDataset.has_split)(split) | Whether the dataset has the given split. | | [`has_tag`](#fiftyone.zoo.datasets.base.QuickstartTrajectoriesDataset.has_tag)(tag) | Whether the dataset has the given tag. | | [`load_info`](#fiftyone.zoo.datasets.base.QuickstartTrajectoriesDataset.load_info)(dataset_dir[, upgrade, ...]) | Loads the `ZooDatasetInfo` from the given dataset directory. | #### *property* name The name of the dataset. #### *property* license The license or list,of,licenses under which the dataset is distributed, or None if unknown. #### *property* tags A tuple of tags for the dataset. #### *property* supported_splits A tuple of supported splits for the dataset, or None if the dataset does not have splits. #### download_and_prepare(dataset_dir, split=None, splits=None, cleanup=True) Downloads the dataset and prepares it for use. If the requested splits have already been downloaded, they are not re-downloaded. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **split** (*None*) – `split` nor `splits` are provided, the full dataset is downloaded * **splits** (*None*) – a list of splits to download, if applicable. If neither `split` nor `splits` are provided, the full dataset is downloaded * **cleanup** (*True*) – whether to cleanup any temporary files generated during download * **Returns:** the `ZooDatasetInfo` for the dataset #### *static* get_info_path(dataset_dir) Returns the path to the `ZooDatasetInfo` for the dataset. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** the path to the `ZooDatasetInfo` #### get_split_dir(dataset_dir, split) Returns the directory for the given split of the dataset. * **Parameters:** * **dataset_dir** – the dataset directory * **split** – the dataset split * **Returns:** the directory that will/does hold the specified split #### *static* has_info(dataset_dir) Determines whether the directory contains `ZooDatasetInfo`. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** True/False #### *property* has_patches Whether the dataset has patches that may need to be applied to already downloaded files. #### has_split(split) Whether the dataset has the given split. * **Parameters:** **split** – the dataset split * **Returns:** True/False #### *property* has_splits Whether the dataset has splits. #### has_tag(tag) Whether the dataset has the given tag. * **Parameters:** **tag** – the tag * **Returns:** True/False #### *property* has_tags Whether the dataset has tags. #### *property* importer_kwargs A dict of default kwargs to pass to this dataset’s [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). #### *property* is_remote Whether the dataset is remotely-sourced. #### *static* load_info(dataset_dir, upgrade=True, warn_deprecated=False) Loads the `ZooDatasetInfo` from the given dataset directory. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **upgrade** (*True*) – whether to upgrade the JSON file on disk if any migrations were necessary * **warn_deprecated** (*False*) – whether to issue a warning if the dataset has a deprecated format * **Returns:** the `ZooDatasetInfo` for the dataset #### *property* parameters An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. #### *property* requires_manual_download Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. #### *property* supports_partial_downloads Whether the dataset supports downloading partial subsets of its splits. ### *class* fiftyone.zoo.datasets.base.QuickstartGroupsDataset Bases: [`FiftyOneDataset`](#fiftyone.zoo.datasets.base.FiftyOneDataset) A small dataset with grouped image and point cloud data. The dataset consists of 200 scenes from the train split of the KITTI dataset, each containing left camera, right camera, point cloud, and 2D/3D object annotation data. Example usage: ```default import fiftyone as fo import fiftyone.zoo as foz dataset = foz.load_zoo_dataset("quickstart-groups") session = fo.launch_app(dataset) ``` Dataset size : 576 MB **Attributes:** | [`name`](#fiftyone.zoo.datasets.base.QuickstartGroupsDataset.name) | The name of the dataset. | |----------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`license`](#fiftyone.zoo.datasets.base.QuickstartGroupsDataset.license) | The license or list,of,licenses under which the dataset is distributed, or None if unknown. | | [`tags`](#fiftyone.zoo.datasets.base.QuickstartGroupsDataset.tags) | A tuple of tags for the dataset. | | [`supported_splits`](#fiftyone.zoo.datasets.base.QuickstartGroupsDataset.supported_splits) | A tuple of supported splits for the dataset, or None if the dataset does not have splits. | | [`has_patches`](#fiftyone.zoo.datasets.base.QuickstartGroupsDataset.has_patches) | Whether the dataset has patches that may need to be applied to already downloaded files. | | [`has_splits`](#fiftyone.zoo.datasets.base.QuickstartGroupsDataset.has_splits) | Whether the dataset has splits. | | [`has_tags`](#fiftyone.zoo.datasets.base.QuickstartGroupsDataset.has_tags) | Whether the dataset has tags. | | [`importer_kwargs`](#fiftyone.zoo.datasets.base.QuickstartGroupsDataset.importer_kwargs) | A dict of default kwargs to pass to this dataset's [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). | | [`is_remote`](#fiftyone.zoo.datasets.base.QuickstartGroupsDataset.is_remote) | Whether the dataset is remotely-sourced. | | [`parameters`](#fiftyone.zoo.datasets.base.QuickstartGroupsDataset.parameters) | An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. | | [`requires_manual_download`](#fiftyone.zoo.datasets.base.QuickstartGroupsDataset.requires_manual_download) | Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. | | [`supports_partial_downloads`](#fiftyone.zoo.datasets.base.QuickstartGroupsDataset.supports_partial_downloads) | Whether the dataset supports downloading partial subsets of its splits. | **Methods:** | [`download_and_prepare`](#fiftyone.zoo.datasets.base.QuickstartGroupsDataset.download_and_prepare)(dataset_dir[, split, ...]) | Downloads the dataset and prepares it for use. | |---------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| | [`get_info_path`](#fiftyone.zoo.datasets.base.QuickstartGroupsDataset.get_info_path)(dataset_dir) | Returns the path to the `ZooDatasetInfo` for the dataset. | | [`get_split_dir`](#fiftyone.zoo.datasets.base.QuickstartGroupsDataset.get_split_dir)(dataset_dir, split) | Returns the directory for the given split of the dataset. | | [`has_info`](#fiftyone.zoo.datasets.base.QuickstartGroupsDataset.has_info)(dataset_dir) | Determines whether the directory contains `ZooDatasetInfo`. | | [`has_split`](#fiftyone.zoo.datasets.base.QuickstartGroupsDataset.has_split)(split) | Whether the dataset has the given split. | | [`has_tag`](#fiftyone.zoo.datasets.base.QuickstartGroupsDataset.has_tag)(tag) | Whether the dataset has the given tag. | | [`load_info`](#fiftyone.zoo.datasets.base.QuickstartGroupsDataset.load_info)(dataset_dir[, upgrade, ...]) | Loads the `ZooDatasetInfo` from the given dataset directory. | #### *property* name The name of the dataset. #### *property* license The license or list,of,licenses under which the dataset is distributed, or None if unknown. #### *property* tags A tuple of tags for the dataset. #### *property* supported_splits A tuple of supported splits for the dataset, or None if the dataset does not have splits. #### *property* has_patches Whether the dataset has patches that may need to be applied to already downloaded files. #### download_and_prepare(dataset_dir, split=None, splits=None, cleanup=True) Downloads the dataset and prepares it for use. If the requested splits have already been downloaded, they are not re-downloaded. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **split** (*None*) – `split` nor `splits` are provided, the full dataset is downloaded * **splits** (*None*) – a list of splits to download, if applicable. If neither `split` nor `splits` are provided, the full dataset is downloaded * **cleanup** (*True*) – whether to cleanup any temporary files generated during download * **Returns:** the `ZooDatasetInfo` for the dataset #### *static* get_info_path(dataset_dir) Returns the path to the `ZooDatasetInfo` for the dataset. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** the path to the `ZooDatasetInfo` #### get_split_dir(dataset_dir, split) Returns the directory for the given split of the dataset. * **Parameters:** * **dataset_dir** – the dataset directory * **split** – the dataset split * **Returns:** the directory that will/does hold the specified split #### *static* has_info(dataset_dir) Determines whether the directory contains `ZooDatasetInfo`. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** True/False #### has_split(split) Whether the dataset has the given split. * **Parameters:** **split** – the dataset split * **Returns:** True/False #### *property* has_splits Whether the dataset has splits. #### has_tag(tag) Whether the dataset has the given tag. * **Parameters:** **tag** – the tag * **Returns:** True/False #### *property* has_tags Whether the dataset has tags. #### *property* importer_kwargs A dict of default kwargs to pass to this dataset’s [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). #### *property* is_remote Whether the dataset is remotely-sourced. #### *static* load_info(dataset_dir, upgrade=True, warn_deprecated=False) Loads the `ZooDatasetInfo` from the given dataset directory. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **upgrade** (*True*) – whether to upgrade the JSON file on disk if any migrations were necessary * **warn_deprecated** (*False*) – whether to issue a warning if the dataset has a deprecated format * **Returns:** the `ZooDatasetInfo` for the dataset #### *property* parameters An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. #### *property* requires_manual_download Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. #### *property* supports_partial_downloads Whether the dataset supports downloading partial subsets of its splits. ### *class* fiftyone.zoo.datasets.base.Quickstart3DDataset Bases: [`FiftyOneDataset`](#fiftyone.zoo.datasets.base.FiftyOneDataset) A small 3D dataset with meshes, point clouds, and oriented bounding boxes. The dataset consists of 200 3D mesh samples from the test split of the [ModelNet40](https://modelnet.cs.princeton.edu) dataset, with point clouds generated using a Poisson disk sampling method, and oriented bounding boxes generated based on the convex hull. Objects have been rescaled and recentered from the original dataset. Example usage: ```default import fiftyone as fo import fiftyone.zoo as foz dataset = foz.load_zoo_dataset("quickstart-3d") session = fo.launch_app(dataset) ``` Dataset size : 215.7 MB **Attributes:** | [`name`](#fiftyone.zoo.datasets.base.Quickstart3DDataset.name) | The name of the dataset. | |------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`license`](#fiftyone.zoo.datasets.base.Quickstart3DDataset.license) | The license or list,of,licenses under which the dataset is distributed, or None if unknown. | | [`tags`](#fiftyone.zoo.datasets.base.Quickstart3DDataset.tags) | A tuple of tags for the dataset. | | [`supported_splits`](#fiftyone.zoo.datasets.base.Quickstart3DDataset.supported_splits) | A tuple of supported splits for the dataset, or None if the dataset does not have splits. | | [`has_patches`](#fiftyone.zoo.datasets.base.Quickstart3DDataset.has_patches) | Whether the dataset has patches that may need to be applied to already downloaded files. | | [`has_splits`](#fiftyone.zoo.datasets.base.Quickstart3DDataset.has_splits) | Whether the dataset has splits. | | [`has_tags`](#fiftyone.zoo.datasets.base.Quickstart3DDataset.has_tags) | Whether the dataset has tags. | | [`importer_kwargs`](#fiftyone.zoo.datasets.base.Quickstart3DDataset.importer_kwargs) | A dict of default kwargs to pass to this dataset's [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). | | [`is_remote`](#fiftyone.zoo.datasets.base.Quickstart3DDataset.is_remote) | Whether the dataset is remotely-sourced. | | [`parameters`](#fiftyone.zoo.datasets.base.Quickstart3DDataset.parameters) | An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. | | [`requires_manual_download`](#fiftyone.zoo.datasets.base.Quickstart3DDataset.requires_manual_download) | Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. | | [`supports_partial_downloads`](#fiftyone.zoo.datasets.base.Quickstart3DDataset.supports_partial_downloads) | Whether the dataset supports downloading partial subsets of its splits. | **Methods:** | [`download_and_prepare`](#fiftyone.zoo.datasets.base.Quickstart3DDataset.download_and_prepare)(dataset_dir[, split, ...]) | Downloads the dataset and prepares it for use. | |-----------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| | [`get_info_path`](#fiftyone.zoo.datasets.base.Quickstart3DDataset.get_info_path)(dataset_dir) | Returns the path to the `ZooDatasetInfo` for the dataset. | | [`get_split_dir`](#fiftyone.zoo.datasets.base.Quickstart3DDataset.get_split_dir)(dataset_dir, split) | Returns the directory for the given split of the dataset. | | [`has_info`](#fiftyone.zoo.datasets.base.Quickstart3DDataset.has_info)(dataset_dir) | Determines whether the directory contains `ZooDatasetInfo`. | | [`has_split`](#fiftyone.zoo.datasets.base.Quickstart3DDataset.has_split)(split) | Whether the dataset has the given split. | | [`has_tag`](#fiftyone.zoo.datasets.base.Quickstart3DDataset.has_tag)(tag) | Whether the dataset has the given tag. | | [`load_info`](#fiftyone.zoo.datasets.base.Quickstart3DDataset.load_info)(dataset_dir[, upgrade, ...]) | Loads the `ZooDatasetInfo` from the given dataset directory. | #### *property* name The name of the dataset. #### *property* license The license or list,of,licenses under which the dataset is distributed, or None if unknown. #### *property* tags A tuple of tags for the dataset. #### *property* supported_splits A tuple of supported splits for the dataset, or None if the dataset does not have splits. #### download_and_prepare(dataset_dir, split=None, splits=None, cleanup=True) Downloads the dataset and prepares it for use. If the requested splits have already been downloaded, they are not re-downloaded. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **split** (*None*) – `split` nor `splits` are provided, the full dataset is downloaded * **splits** (*None*) – a list of splits to download, if applicable. If neither `split` nor `splits` are provided, the full dataset is downloaded * **cleanup** (*True*) – whether to cleanup any temporary files generated during download * **Returns:** the `ZooDatasetInfo` for the dataset #### *static* get_info_path(dataset_dir) Returns the path to the `ZooDatasetInfo` for the dataset. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** the path to the `ZooDatasetInfo` #### get_split_dir(dataset_dir, split) Returns the directory for the given split of the dataset. * **Parameters:** * **dataset_dir** – the dataset directory * **split** – the dataset split * **Returns:** the directory that will/does hold the specified split #### *static* has_info(dataset_dir) Determines whether the directory contains `ZooDatasetInfo`. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** True/False #### *property* has_patches Whether the dataset has patches that may need to be applied to already downloaded files. #### has_split(split) Whether the dataset has the given split. * **Parameters:** **split** – the dataset split * **Returns:** True/False #### *property* has_splits Whether the dataset has splits. #### has_tag(tag) Whether the dataset has the given tag. * **Parameters:** **tag** – the tag * **Returns:** True/False #### *property* has_tags Whether the dataset has tags. #### *property* importer_kwargs A dict of default kwargs to pass to this dataset’s [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). #### *property* is_remote Whether the dataset is remotely-sourced. #### *static* load_info(dataset_dir, upgrade=True, warn_deprecated=False) Loads the `ZooDatasetInfo` from the given dataset directory. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **upgrade** (*True*) – whether to upgrade the JSON file on disk if any migrations were necessary * **warn_deprecated** (*False*) – whether to issue a warning if the dataset has a deprecated format * **Returns:** the `ZooDatasetInfo` for the dataset #### *property* parameters An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. #### *property* requires_manual_download Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. #### *property* supports_partial_downloads Whether the dataset supports downloading partial subsets of its splits. ### *class* fiftyone.zoo.datasets.base.UCF101Dataset(fold=1) Bases: [`FiftyOneDataset`](#fiftyone.zoo.datasets.base.FiftyOneDataset) UCF101 is an action recognition data set of realistic action videos, collected from YouTube, having 101 action categories. This data set is an extension of UCF50 data set which has 50 action categories. With 13,320 videos from 101 action categories, UCF101 gives the largest diversity in terms of actions and with the presence of large variations in camera motion, object appearance and pose, object scale, viewpoint, cluttered background, illumination conditions, etc, it is the most challenging data set to date. As most of the available action recognition data sets are not realistic and are staged by actors, UCF101 aims to encourage further research into action recognition by learning and exploring new realistic action categories. The videos in 101 action categories are grouped into 25 groups, where each group can consist of 4-7 videos of an action. The videos from the same group may share some common features, such as similar background, similar viewpoint, etc. Example usage: ```default import fiftyone as fo import fiftyone.zoo as foz dataset = foz.load_zoo_dataset("ucf101", split="test") session = fo.launch_app(dataset) ``` Dataset size : 6.48 GB Source : [https://www.crcv.ucf.edu/research/data-sets/ucf101](https://www.crcv.ucf.edu/research/data-sets/ucf101) * **Parameters:** **fold** (*1*) – the test/train fold to use to arrange the files on disk. The supported values are `(1, 2, 3)` **Attributes:** | [`name`](#fiftyone.zoo.datasets.base.UCF101Dataset.name) | The name of the dataset. | |------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`license`](#fiftyone.zoo.datasets.base.UCF101Dataset.license) | The license or list,of,licenses under which the dataset is distributed, or None if unknown. | | [`tags`](#fiftyone.zoo.datasets.base.UCF101Dataset.tags) | A tuple of tags for the dataset. | | [`parameters`](#fiftyone.zoo.datasets.base.UCF101Dataset.parameters) | An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. | | [`supported_splits`](#fiftyone.zoo.datasets.base.UCF101Dataset.supported_splits) | A tuple of supported splits for the dataset, or None if the dataset does not have splits. | | [`has_patches`](#fiftyone.zoo.datasets.base.UCF101Dataset.has_patches) | Whether the dataset has patches that may need to be applied to already downloaded files. | | [`has_splits`](#fiftyone.zoo.datasets.base.UCF101Dataset.has_splits) | Whether the dataset has splits. | | [`has_tags`](#fiftyone.zoo.datasets.base.UCF101Dataset.has_tags) | Whether the dataset has tags. | | [`importer_kwargs`](#fiftyone.zoo.datasets.base.UCF101Dataset.importer_kwargs) | A dict of default kwargs to pass to this dataset's [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). | | [`is_remote`](#fiftyone.zoo.datasets.base.UCF101Dataset.is_remote) | Whether the dataset is remotely-sourced. | | [`requires_manual_download`](#fiftyone.zoo.datasets.base.UCF101Dataset.requires_manual_download) | Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. | | [`supports_partial_downloads`](#fiftyone.zoo.datasets.base.UCF101Dataset.supports_partial_downloads) | Whether the dataset supports downloading partial subsets of its splits. | **Methods:** | [`download_and_prepare`](#fiftyone.zoo.datasets.base.UCF101Dataset.download_and_prepare)(dataset_dir[, split, ...]) | Downloads the dataset and prepares it for use. | |-----------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| | [`get_info_path`](#fiftyone.zoo.datasets.base.UCF101Dataset.get_info_path)(dataset_dir) | Returns the path to the `ZooDatasetInfo` for the dataset. | | [`get_split_dir`](#fiftyone.zoo.datasets.base.UCF101Dataset.get_split_dir)(dataset_dir, split) | Returns the directory for the given split of the dataset. | | [`has_info`](#fiftyone.zoo.datasets.base.UCF101Dataset.has_info)(dataset_dir) | Determines whether the directory contains `ZooDatasetInfo`. | | [`has_split`](#fiftyone.zoo.datasets.base.UCF101Dataset.has_split)(split) | Whether the dataset has the given split. | | [`has_tag`](#fiftyone.zoo.datasets.base.UCF101Dataset.has_tag)(tag) | Whether the dataset has the given tag. | | [`load_info`](#fiftyone.zoo.datasets.base.UCF101Dataset.load_info)(dataset_dir[, upgrade, ...]) | Loads the `ZooDatasetInfo` from the given dataset directory. | #### *property* name The name of the dataset. #### *property* license The license or list,of,licenses under which the dataset is distributed, or None if unknown. #### *property* tags A tuple of tags for the dataset. #### *property* parameters An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. #### *property* supported_splits A tuple of supported splits for the dataset, or None if the dataset does not have splits. #### download_and_prepare(dataset_dir, split=None, splits=None, cleanup=True) Downloads the dataset and prepares it for use. If the requested splits have already been downloaded, they are not re-downloaded. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **split** (*None*) – `split` nor `splits` are provided, the full dataset is downloaded * **splits** (*None*) – a list of splits to download, if applicable. If neither `split` nor `splits` are provided, the full dataset is downloaded * **cleanup** (*True*) – whether to cleanup any temporary files generated during download * **Returns:** the `ZooDatasetInfo` for the dataset #### *static* get_info_path(dataset_dir) Returns the path to the `ZooDatasetInfo` for the dataset. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** the path to the `ZooDatasetInfo` #### get_split_dir(dataset_dir, split) Returns the directory for the given split of the dataset. * **Parameters:** * **dataset_dir** – the dataset directory * **split** – the dataset split * **Returns:** the directory that will/does hold the specified split #### *static* has_info(dataset_dir) Determines whether the directory contains `ZooDatasetInfo`. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** True/False #### *property* has_patches Whether the dataset has patches that may need to be applied to already downloaded files. #### has_split(split) Whether the dataset has the given split. * **Parameters:** **split** – the dataset split * **Returns:** True/False #### *property* has_splits Whether the dataset has splits. #### has_tag(tag) Whether the dataset has the given tag. * **Parameters:** **tag** – the tag * **Returns:** True/False #### *property* has_tags Whether the dataset has tags. #### *property* importer_kwargs A dict of default kwargs to pass to this dataset’s [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). #### *property* is_remote Whether the dataset is remotely-sourced. #### *static* load_info(dataset_dir, upgrade=True, warn_deprecated=False) Loads the `ZooDatasetInfo` from the given dataset directory. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **upgrade** (*True*) – whether to upgrade the JSON file on disk if any migrations were necessary * **warn_deprecated** (*False*) – whether to issue a warning if the dataset has a deprecated format * **Returns:** the `ZooDatasetInfo` for the dataset #### *property* requires_manual_download Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. #### *property* supports_partial_downloads Whether the dataset supports downloading partial subsets of its splits. ### *class* fiftyone.zoo.datasets.base.RTKSLAMAbsoluteAccuracyDataset Bases: [`FiftyOneDataset`](#fiftyone.zoo.datasets.base.FiftyOneDataset) Handheld LiDAR, camera, IMU and GNSS sequences measured against surveyed checkpoints, as native `.mcap` episodes. A handheld rig carrying a Livox MID360, a global shutter camera and a GNSS receiver is walked through a public park and a construction hall, both of which block the sky in places, including a 30 m underpass and an indoor hall spanning more than 400 seconds of the route. The reference is not the GNSS. A geodetic total station surveyed 87 checkpoints along the routes independently, so absolute error can be measured without first fitting the estimate onto the reference. Three published trajectories are carried alongside the sensors, together with each one’s distance to every checkpoint. Four sequences and 64.6 minutes of walking. Example usage: ```default import fiftyone as fo import fiftyone.zoo as foz dataset = foz.load_zoo_dataset("rtk-slam-absolute-accuracy") # Where the sky was hardest to see view = dataset.sort_by("gnss_fix_rate") session = fo.launch_app(dataset) ``` Dataset size : 10.85 GB **Attributes:** | [`name`](#fiftyone.zoo.datasets.base.RTKSLAMAbsoluteAccuracyDataset.name) | The name of the dataset. | |-----------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`license`](#fiftyone.zoo.datasets.base.RTKSLAMAbsoluteAccuracyDataset.license) | The license or list,of,licenses under which the dataset is distributed, or None if unknown. | | [`tags`](#fiftyone.zoo.datasets.base.RTKSLAMAbsoluteAccuracyDataset.tags) | A tuple of tags for the dataset. | | [`supported_splits`](#fiftyone.zoo.datasets.base.RTKSLAMAbsoluteAccuracyDataset.supported_splits) | A tuple of supported splits for the dataset, or None if the dataset does not have splits. | | [`has_patches`](#fiftyone.zoo.datasets.base.RTKSLAMAbsoluteAccuracyDataset.has_patches) | Whether the dataset has patches that may need to be applied to already downloaded files. | | [`has_splits`](#fiftyone.zoo.datasets.base.RTKSLAMAbsoluteAccuracyDataset.has_splits) | Whether the dataset has splits. | | [`has_tags`](#fiftyone.zoo.datasets.base.RTKSLAMAbsoluteAccuracyDataset.has_tags) | Whether the dataset has tags. | | [`importer_kwargs`](#fiftyone.zoo.datasets.base.RTKSLAMAbsoluteAccuracyDataset.importer_kwargs) | A dict of default kwargs to pass to this dataset's [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). | | [`is_remote`](#fiftyone.zoo.datasets.base.RTKSLAMAbsoluteAccuracyDataset.is_remote) | Whether the dataset is remotely-sourced. | | [`parameters`](#fiftyone.zoo.datasets.base.RTKSLAMAbsoluteAccuracyDataset.parameters) | An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. | | [`requires_manual_download`](#fiftyone.zoo.datasets.base.RTKSLAMAbsoluteAccuracyDataset.requires_manual_download) | Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. | | [`supports_partial_downloads`](#fiftyone.zoo.datasets.base.RTKSLAMAbsoluteAccuracyDataset.supports_partial_downloads) | Whether the dataset supports downloading partial subsets of its splits. | **Methods:** | [`download_and_prepare`](#fiftyone.zoo.datasets.base.RTKSLAMAbsoluteAccuracyDataset.download_and_prepare)(dataset_dir[, split, ...]) | Downloads the dataset and prepares it for use. | |----------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| | [`get_info_path`](#fiftyone.zoo.datasets.base.RTKSLAMAbsoluteAccuracyDataset.get_info_path)(dataset_dir) | Returns the path to the `ZooDatasetInfo` for the dataset. | | [`get_split_dir`](#fiftyone.zoo.datasets.base.RTKSLAMAbsoluteAccuracyDataset.get_split_dir)(dataset_dir, split) | Returns the directory for the given split of the dataset. | | [`has_info`](#fiftyone.zoo.datasets.base.RTKSLAMAbsoluteAccuracyDataset.has_info)(dataset_dir) | Determines whether the directory contains `ZooDatasetInfo`. | | [`has_split`](#fiftyone.zoo.datasets.base.RTKSLAMAbsoluteAccuracyDataset.has_split)(split) | Whether the dataset has the given split. | | [`has_tag`](#fiftyone.zoo.datasets.base.RTKSLAMAbsoluteAccuracyDataset.has_tag)(tag) | Whether the dataset has the given tag. | | [`load_info`](#fiftyone.zoo.datasets.base.RTKSLAMAbsoluteAccuracyDataset.load_info)(dataset_dir[, upgrade, ...]) | Loads the `ZooDatasetInfo` from the given dataset directory. | #### *property* name The name of the dataset. #### *property* license The license or list,of,licenses under which the dataset is distributed, or None if unknown. #### *property* tags A tuple of tags for the dataset. #### *property* supported_splits A tuple of supported splits for the dataset, or None if the dataset does not have splits. #### download_and_prepare(dataset_dir, split=None, splits=None, cleanup=True) Downloads the dataset and prepares it for use. If the requested splits have already been downloaded, they are not re-downloaded. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **split** (*None*) – `split` nor `splits` are provided, the full dataset is downloaded * **splits** (*None*) – a list of splits to download, if applicable. If neither `split` nor `splits` are provided, the full dataset is downloaded * **cleanup** (*True*) – whether to cleanup any temporary files generated during download * **Returns:** the `ZooDatasetInfo` for the dataset #### *static* get_info_path(dataset_dir) Returns the path to the `ZooDatasetInfo` for the dataset. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** the path to the `ZooDatasetInfo` #### get_split_dir(dataset_dir, split) Returns the directory for the given split of the dataset. * **Parameters:** * **dataset_dir** – the dataset directory * **split** – the dataset split * **Returns:** the directory that will/does hold the specified split #### *static* has_info(dataset_dir) Determines whether the directory contains `ZooDatasetInfo`. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** True/False #### *property* has_patches Whether the dataset has patches that may need to be applied to already downloaded files. #### has_split(split) Whether the dataset has the given split. * **Parameters:** **split** – the dataset split * **Returns:** True/False #### *property* has_splits Whether the dataset has splits. #### has_tag(tag) Whether the dataset has the given tag. * **Parameters:** **tag** – the tag * **Returns:** True/False #### *property* has_tags Whether the dataset has tags. #### *property* importer_kwargs A dict of default kwargs to pass to this dataset’s [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). #### *property* is_remote Whether the dataset is remotely-sourced. #### *static* load_info(dataset_dir, upgrade=True, warn_deprecated=False) Loads the `ZooDatasetInfo` from the given dataset directory. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **upgrade** (*True*) – whether to upgrade the JSON file on disk if any migrations were necessary * **warn_deprecated** (*False*) – whether to issue a warning if the dataset has a deprecated format * **Returns:** the `ZooDatasetInfo` for the dataset #### *property* parameters An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. #### *property* requires_manual_download Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. #### *property* supports_partial_downloads Whether the dataset supports downloading partial subsets of its splits. ### *class* fiftyone.zoo.datasets.base.TIIRATMDroneRacingDataset Bases: [`FiftyOneDataset`](#fiftyone.zoo.datasets.base.FiftyOneDataset) Indoor drone racing flights pairing onboard visual-inertial odometry with motion capture ground truth, as native `.mcap` episodes. A quadrotor flies laps of a four-gate track, three on an ellipse and three on a lemniscate, carrying a fisheye camera and a 500 Hz IMU while a motion capture system watches the room. Each episode carries both the estimate the drone computed for itself and the reference measured at the same instant, along with the distance between them. Six flights, 10.9 minutes and 2,563 metres flown. Tracking error ranges from 0.61 m to 1.66 m RMSE across the six. Example usage: ```default import fiftyone as fo import fiftyone.zoo as foz dataset = foz.load_zoo_dataset("tii-ratm-drone-racing") # The flights the odometry found hardest view = dataset.sort_by("tracking_error_rmse_m", reverse=True) session = fo.launch_app(dataset) ``` Dataset size : 0.58 GB **Attributes:** | [`name`](#fiftyone.zoo.datasets.base.TIIRATMDroneRacingDataset.name) | The name of the dataset. | |------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`license`](#fiftyone.zoo.datasets.base.TIIRATMDroneRacingDataset.license) | The license or list,of,licenses under which the dataset is distributed, or None if unknown. | | [`tags`](#fiftyone.zoo.datasets.base.TIIRATMDroneRacingDataset.tags) | A tuple of tags for the dataset. | | [`supported_splits`](#fiftyone.zoo.datasets.base.TIIRATMDroneRacingDataset.supported_splits) | A tuple of supported splits for the dataset, or None if the dataset does not have splits. | | [`has_patches`](#fiftyone.zoo.datasets.base.TIIRATMDroneRacingDataset.has_patches) | Whether the dataset has patches that may need to be applied to already downloaded files. | | [`has_splits`](#fiftyone.zoo.datasets.base.TIIRATMDroneRacingDataset.has_splits) | Whether the dataset has splits. | | [`has_tags`](#fiftyone.zoo.datasets.base.TIIRATMDroneRacingDataset.has_tags) | Whether the dataset has tags. | | [`importer_kwargs`](#fiftyone.zoo.datasets.base.TIIRATMDroneRacingDataset.importer_kwargs) | A dict of default kwargs to pass to this dataset's [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). | | [`is_remote`](#fiftyone.zoo.datasets.base.TIIRATMDroneRacingDataset.is_remote) | Whether the dataset is remotely-sourced. | | [`parameters`](#fiftyone.zoo.datasets.base.TIIRATMDroneRacingDataset.parameters) | An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. | | [`requires_manual_download`](#fiftyone.zoo.datasets.base.TIIRATMDroneRacingDataset.requires_manual_download) | Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. | | [`supports_partial_downloads`](#fiftyone.zoo.datasets.base.TIIRATMDroneRacingDataset.supports_partial_downloads) | Whether the dataset supports downloading partial subsets of its splits. | **Methods:** | [`download_and_prepare`](#fiftyone.zoo.datasets.base.TIIRATMDroneRacingDataset.download_and_prepare)(dataset_dir[, split, ...]) | Downloads the dataset and prepares it for use. | |-----------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| | [`get_info_path`](#fiftyone.zoo.datasets.base.TIIRATMDroneRacingDataset.get_info_path)(dataset_dir) | Returns the path to the `ZooDatasetInfo` for the dataset. | | [`get_split_dir`](#fiftyone.zoo.datasets.base.TIIRATMDroneRacingDataset.get_split_dir)(dataset_dir, split) | Returns the directory for the given split of the dataset. | | [`has_info`](#fiftyone.zoo.datasets.base.TIIRATMDroneRacingDataset.has_info)(dataset_dir) | Determines whether the directory contains `ZooDatasetInfo`. | | [`has_split`](#fiftyone.zoo.datasets.base.TIIRATMDroneRacingDataset.has_split)(split) | Whether the dataset has the given split. | | [`has_tag`](#fiftyone.zoo.datasets.base.TIIRATMDroneRacingDataset.has_tag)(tag) | Whether the dataset has the given tag. | | [`load_info`](#fiftyone.zoo.datasets.base.TIIRATMDroneRacingDataset.load_info)(dataset_dir[, upgrade, ...]) | Loads the `ZooDatasetInfo` from the given dataset directory. | #### *property* name The name of the dataset. #### *property* license The license or list,of,licenses under which the dataset is distributed, or None if unknown. #### *property* tags A tuple of tags for the dataset. #### *property* supported_splits A tuple of supported splits for the dataset, or None if the dataset does not have splits. #### download_and_prepare(dataset_dir, split=None, splits=None, cleanup=True) Downloads the dataset and prepares it for use. If the requested splits have already been downloaded, they are not re-downloaded. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **split** (*None*) – `split` nor `splits` are provided, the full dataset is downloaded * **splits** (*None*) – a list of splits to download, if applicable. If neither `split` nor `splits` are provided, the full dataset is downloaded * **cleanup** (*True*) – whether to cleanup any temporary files generated during download * **Returns:** the `ZooDatasetInfo` for the dataset #### *static* get_info_path(dataset_dir) Returns the path to the `ZooDatasetInfo` for the dataset. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** the path to the `ZooDatasetInfo` #### get_split_dir(dataset_dir, split) Returns the directory for the given split of the dataset. * **Parameters:** * **dataset_dir** – the dataset directory * **split** – the dataset split * **Returns:** the directory that will/does hold the specified split #### *static* has_info(dataset_dir) Determines whether the directory contains `ZooDatasetInfo`. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** True/False #### *property* has_patches Whether the dataset has patches that may need to be applied to already downloaded files. #### has_split(split) Whether the dataset has the given split. * **Parameters:** **split** – the dataset split * **Returns:** True/False #### *property* has_splits Whether the dataset has splits. #### has_tag(tag) Whether the dataset has the given tag. * **Parameters:** **tag** – the tag * **Returns:** True/False #### *property* has_tags Whether the dataset has tags. #### *property* importer_kwargs A dict of default kwargs to pass to this dataset’s [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). #### *property* is_remote Whether the dataset is remotely-sourced. #### *static* load_info(dataset_dir, upgrade=True, warn_deprecated=False) Loads the `ZooDatasetInfo` from the given dataset directory. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **upgrade** (*True*) – whether to upgrade the JSON file on disk if any migrations were necessary * **warn_deprecated** (*False*) – whether to issue a warning if the dataset has a deprecated format * **Returns:** the `ZooDatasetInfo` for the dataset #### *property* parameters An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. #### *property* requires_manual_download Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. #### *property* supports_partial_downloads Whether the dataset supports downloading partial subsets of its splits. ### *class* fiftyone.zoo.datasets.base.EgocentricEMGForceDataset Bases: [`FiftyOneDataset`](#fiftyone.zoo.datasets.base.FiftyOneDataset) First-person household task recordings pairing RGB-D video with wrist EMG and per-finger contact force, as native `.mcap` episodes. Someone wearing a depth camera and an eight-channel EMG band on each wrist works through eight household tasks. Alongside the video each episode carries the muscle signal from both forearms at roughly 550 Hz, a 21-point hand skeleton per frame, an estimate of how hard each finger is pressing, and wrist IMU. Every episode is cut into subtasks a reviewer described in English, so the 122 segments read as instructions rather than indices. 38.2 minutes of recording: 67,185 camera and depth frames, 2,539,493 EMG samples, 60,254 hand skeletons and 133,721 per-finger force readings. Contact force is an estimate derived from hand pose and depth rather than a reading from an instrumented glove, and it saturates at 45 N. Example usage: ```default import fiftyone as fo import fiftyone.zoo as foz dataset = foz.load_zoo_dataset("egocentric-emg-force") # The tasks with the firmest contact view = dataset.match({"peak_finger_force": {"$gt": 40}}) session = fo.launch_app(dataset) ``` Dataset size : 8.43 GB **Attributes:** | [`name`](#fiftyone.zoo.datasets.base.EgocentricEMGForceDataset.name) | The name of the dataset. | |------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`license`](#fiftyone.zoo.datasets.base.EgocentricEMGForceDataset.license) | The license or list,of,licenses under which the dataset is distributed, or None if unknown. | | [`tags`](#fiftyone.zoo.datasets.base.EgocentricEMGForceDataset.tags) | A tuple of tags for the dataset. | | [`supported_splits`](#fiftyone.zoo.datasets.base.EgocentricEMGForceDataset.supported_splits) | A tuple of supported splits for the dataset, or None if the dataset does not have splits. | | [`has_patches`](#fiftyone.zoo.datasets.base.EgocentricEMGForceDataset.has_patches) | Whether the dataset has patches that may need to be applied to already downloaded files. | | [`has_splits`](#fiftyone.zoo.datasets.base.EgocentricEMGForceDataset.has_splits) | Whether the dataset has splits. | | [`has_tags`](#fiftyone.zoo.datasets.base.EgocentricEMGForceDataset.has_tags) | Whether the dataset has tags. | | [`importer_kwargs`](#fiftyone.zoo.datasets.base.EgocentricEMGForceDataset.importer_kwargs) | A dict of default kwargs to pass to this dataset's [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). | | [`is_remote`](#fiftyone.zoo.datasets.base.EgocentricEMGForceDataset.is_remote) | Whether the dataset is remotely-sourced. | | [`parameters`](#fiftyone.zoo.datasets.base.EgocentricEMGForceDataset.parameters) | An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. | | [`requires_manual_download`](#fiftyone.zoo.datasets.base.EgocentricEMGForceDataset.requires_manual_download) | Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. | | [`supports_partial_downloads`](#fiftyone.zoo.datasets.base.EgocentricEMGForceDataset.supports_partial_downloads) | Whether the dataset supports downloading partial subsets of its splits. | **Methods:** | [`download_and_prepare`](#fiftyone.zoo.datasets.base.EgocentricEMGForceDataset.download_and_prepare)(dataset_dir[, split, ...]) | Downloads the dataset and prepares it for use. | |-----------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| | [`get_info_path`](#fiftyone.zoo.datasets.base.EgocentricEMGForceDataset.get_info_path)(dataset_dir) | Returns the path to the `ZooDatasetInfo` for the dataset. | | [`get_split_dir`](#fiftyone.zoo.datasets.base.EgocentricEMGForceDataset.get_split_dir)(dataset_dir, split) | Returns the directory for the given split of the dataset. | | [`has_info`](#fiftyone.zoo.datasets.base.EgocentricEMGForceDataset.has_info)(dataset_dir) | Determines whether the directory contains `ZooDatasetInfo`. | | [`has_split`](#fiftyone.zoo.datasets.base.EgocentricEMGForceDataset.has_split)(split) | Whether the dataset has the given split. | | [`has_tag`](#fiftyone.zoo.datasets.base.EgocentricEMGForceDataset.has_tag)(tag) | Whether the dataset has the given tag. | | [`load_info`](#fiftyone.zoo.datasets.base.EgocentricEMGForceDataset.load_info)(dataset_dir[, upgrade, ...]) | Loads the `ZooDatasetInfo` from the given dataset directory. | #### *property* name The name of the dataset. #### *property* license The license or list,of,licenses under which the dataset is distributed, or None if unknown. #### *property* tags A tuple of tags for the dataset. #### *property* supported_splits A tuple of supported splits for the dataset, or None if the dataset does not have splits. #### download_and_prepare(dataset_dir, split=None, splits=None, cleanup=True) Downloads the dataset and prepares it for use. If the requested splits have already been downloaded, they are not re-downloaded. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **split** (*None*) – `split` nor `splits` are provided, the full dataset is downloaded * **splits** (*None*) – a list of splits to download, if applicable. If neither `split` nor `splits` are provided, the full dataset is downloaded * **cleanup** (*True*) – whether to cleanup any temporary files generated during download * **Returns:** the `ZooDatasetInfo` for the dataset #### *static* get_info_path(dataset_dir) Returns the path to the `ZooDatasetInfo` for the dataset. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** the path to the `ZooDatasetInfo` #### get_split_dir(dataset_dir, split) Returns the directory for the given split of the dataset. * **Parameters:** * **dataset_dir** – the dataset directory * **split** – the dataset split * **Returns:** the directory that will/does hold the specified split #### *static* has_info(dataset_dir) Determines whether the directory contains `ZooDatasetInfo`. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** True/False #### *property* has_patches Whether the dataset has patches that may need to be applied to already downloaded files. #### has_split(split) Whether the dataset has the given split. * **Parameters:** **split** – the dataset split * **Returns:** True/False #### *property* has_splits Whether the dataset has splits. #### has_tag(tag) Whether the dataset has the given tag. * **Parameters:** **tag** – the tag * **Returns:** True/False #### *property* has_tags Whether the dataset has tags. #### *property* importer_kwargs A dict of default kwargs to pass to this dataset’s [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). #### *property* is_remote Whether the dataset is remotely-sourced. #### *static* load_info(dataset_dir, upgrade=True, warn_deprecated=False) Loads the `ZooDatasetInfo` from the given dataset directory. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **upgrade** (*True*) – whether to upgrade the JSON file on disk if any migrations were necessary * **warn_deprecated** (*False*) – whether to issue a warning if the dataset has a deprecated format * **Returns:** the `ZooDatasetInfo` for the dataset #### *property* parameters An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. #### *property* requires_manual_download Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. #### *property* supports_partial_downloads Whether the dataset supports downloading partial subsets of its splits. ### *class* fiftyone.zoo.datasets.base.RoboLabDataset Bases: [`FiftyOneDataset`](#fiftyone.zoo.datasets.base.FiftyOneDataset) Policy rollouts recorded on NVIDIA’s RoboLab manipulation benchmark, as native `.mcap` episodes. Each take carries three synchronized camera views with a matching 16-bit depth stream, per-camera intrinsics, joint positions, actions, end-effector pose, and the task instruction. Takes keep the benchmark’s own success label, so failed rollouts sit alongside successful ones. In 153 of the 4,000 takes the camera streams carry 80 frames while depth and telemetry carry 81, so align streams by timestamp rather than by index. Example usage: ```default import fiftyone as fo import fiftyone.zoo as foz dataset = foz.load_zoo_dataset("robolab") # Rollouts the policy got right view = dataset.match({"success": True}) session = fo.launch_app(dataset) ``` Dataset size : 21.85 GB **Attributes:** | [`name`](#fiftyone.zoo.datasets.base.RoboLabDataset.name) | The name of the dataset. | |-------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`license`](#fiftyone.zoo.datasets.base.RoboLabDataset.license) | The license or list,of,licenses under which the dataset is distributed, or None if unknown. | | [`tags`](#fiftyone.zoo.datasets.base.RoboLabDataset.tags) | A tuple of tags for the dataset. | | [`supported_splits`](#fiftyone.zoo.datasets.base.RoboLabDataset.supported_splits) | A tuple of supported splits for the dataset, or None if the dataset does not have splits. | | [`has_patches`](#fiftyone.zoo.datasets.base.RoboLabDataset.has_patches) | Whether the dataset has patches that may need to be applied to already downloaded files. | | [`has_splits`](#fiftyone.zoo.datasets.base.RoboLabDataset.has_splits) | Whether the dataset has splits. | | [`has_tags`](#fiftyone.zoo.datasets.base.RoboLabDataset.has_tags) | Whether the dataset has tags. | | [`importer_kwargs`](#fiftyone.zoo.datasets.base.RoboLabDataset.importer_kwargs) | A dict of default kwargs to pass to this dataset's [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). | | [`is_remote`](#fiftyone.zoo.datasets.base.RoboLabDataset.is_remote) | Whether the dataset is remotely-sourced. | | [`parameters`](#fiftyone.zoo.datasets.base.RoboLabDataset.parameters) | An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. | | [`requires_manual_download`](#fiftyone.zoo.datasets.base.RoboLabDataset.requires_manual_download) | Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. | | [`supports_partial_downloads`](#fiftyone.zoo.datasets.base.RoboLabDataset.supports_partial_downloads) | Whether the dataset supports downloading partial subsets of its splits. | **Methods:** | [`download_and_prepare`](#fiftyone.zoo.datasets.base.RoboLabDataset.download_and_prepare)(dataset_dir[, split, ...]) | Downloads the dataset and prepares it for use. | |------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| | [`get_info_path`](#fiftyone.zoo.datasets.base.RoboLabDataset.get_info_path)(dataset_dir) | Returns the path to the `ZooDatasetInfo` for the dataset. | | [`get_split_dir`](#fiftyone.zoo.datasets.base.RoboLabDataset.get_split_dir)(dataset_dir, split) | Returns the directory for the given split of the dataset. | | [`has_info`](#fiftyone.zoo.datasets.base.RoboLabDataset.has_info)(dataset_dir) | Determines whether the directory contains `ZooDatasetInfo`. | | [`has_split`](#fiftyone.zoo.datasets.base.RoboLabDataset.has_split)(split) | Whether the dataset has the given split. | | [`has_tag`](#fiftyone.zoo.datasets.base.RoboLabDataset.has_tag)(tag) | Whether the dataset has the given tag. | | [`load_info`](#fiftyone.zoo.datasets.base.RoboLabDataset.load_info)(dataset_dir[, upgrade, ...]) | Loads the `ZooDatasetInfo` from the given dataset directory. | #### *property* name The name of the dataset. #### *property* license The license or list,of,licenses under which the dataset is distributed, or None if unknown. #### *property* tags A tuple of tags for the dataset. #### *property* supported_splits A tuple of supported splits for the dataset, or None if the dataset does not have splits. #### download_and_prepare(dataset_dir, split=None, splits=None, cleanup=True) Downloads the dataset and prepares it for use. If the requested splits have already been downloaded, they are not re-downloaded. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **split** (*None*) – `split` nor `splits` are provided, the full dataset is downloaded * **splits** (*None*) – a list of splits to download, if applicable. If neither `split` nor `splits` are provided, the full dataset is downloaded * **cleanup** (*True*) – whether to cleanup any temporary files generated during download * **Returns:** the `ZooDatasetInfo` for the dataset #### *static* get_info_path(dataset_dir) Returns the path to the `ZooDatasetInfo` for the dataset. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** the path to the `ZooDatasetInfo` #### get_split_dir(dataset_dir, split) Returns the directory for the given split of the dataset. * **Parameters:** * **dataset_dir** – the dataset directory * **split** – the dataset split * **Returns:** the directory that will/does hold the specified split #### *static* has_info(dataset_dir) Determines whether the directory contains `ZooDatasetInfo`. * **Parameters:** **dataset_dir** – the dataset directory * **Returns:** True/False #### *property* has_patches Whether the dataset has patches that may need to be applied to already downloaded files. #### has_split(split) Whether the dataset has the given split. * **Parameters:** **split** – the dataset split * **Returns:** True/False #### *property* has_splits Whether the dataset has splits. #### has_tag(tag) Whether the dataset has the given tag. * **Parameters:** **tag** – the tag * **Returns:** True/False #### *property* has_tags Whether the dataset has tags. #### *property* importer_kwargs A dict of default kwargs to pass to this dataset’s [`fiftyone.utils.data.importers.DatasetImporter`](fiftyone.utils.data.importers.md#fiftyone.utils.data.importers.DatasetImporter). #### *property* is_remote Whether the dataset is remotely-sourced. #### *static* load_info(dataset_dir, upgrade=True, warn_deprecated=False) Loads the `ZooDatasetInfo` from the given dataset directory. * **Parameters:** * **dataset_dir** – the directory in which to construct the dataset * **upgrade** (*True*) – whether to upgrade the JSON file on disk if any migrations were necessary * **warn_deprecated** (*False*) – whether to issue a warning if the dataset has a deprecated format * **Returns:** the `ZooDatasetInfo` for the dataset #### *property* parameters An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded. #### *property* requires_manual_download Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded. #### *property* supports_partial_downloads Whether the dataset supports downloading partial subsets of its splits.