fiftyone.zoo.datasets.ZooDataset

class documentation

class ZooDataset(object): (source)

Known subclasses: fiftyone.zoo.datasets.base.FiftyOneDataset, fiftyone.zoo.datasets.DeprecatedZooDataset, fiftyone.zoo.datasets.RemoteZooDataset, fiftyone.zoo.datasets.tf.TFDSDataset, fiftyone.zoo.datasets.torch.TorchVisionDataset

View In Hierarchy

Base class for datasets made available in the FiftyOne Dataset Zoo.

Static Method	`get_info_path`	Returns the path to the `ZooDatasetInfo` for the dataset.
Static Method	`has_info`	Determines whether the directory contains `ZooDatasetInfo`.
Static Method	`load_info`	Loads the `ZooDatasetInfo` from the given dataset directory.
Method	`download_and_prepare`	Downloads the dataset and prepares it for use.
Method	`get_split_dir`	Returns the directory for the given split of the dataset.
Method	`has_split`	Whether the dataset has the given split.
Method	`has_tag`	Whether the dataset has the given tag.
Property	`has_patches`	Whether the dataset has patches that may need to be applied to already downloaded files.
Property	`has_splits`	Whether the dataset has splits.
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`.
Property	`is_remote`	Whether the dataset is remotely-sourced.
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.
Method	`_download_and_prepare`	Internal implementation of downloading the dataset and preparing it for use in the given directory.
Method	`_get_splits_to_download`	Undocumented
Method	`_is_dataset_ready`	Undocumented
Method	`_is_split_ready`	Undocumented
Method	`_patch_if_necessary`	Internal method called when an already downloaded dataset may need to be patched.

@staticmethod
def get_info_path(dataset_dir): (source) ¶

Returns the path to the ZooDatasetInfo for the dataset.

Parameters
dataset_dir	the dataset directory
Returns
the path to the `ZooDatasetInfo`

@staticmethod
def has_info(dataset_dir): (source) ¶

Determines whether the directory contains ZooDatasetInfo.

Parameters
dataset_dir	the dataset directory
Returns
True/False

@staticmethod
def load_info(dataset_dir, upgrade=True, warn_deprecated=False): (source) ¶

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

def download_and_prepare(self, dataset_dir, split=None, splits=None, cleanup=True): (source) ¶

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

def get_split_dir(self, dataset_dir, split): (source) ¶

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

def has_split(self, split): (source) ¶

Whether the dataset has the given split.

Parameters
split	the dataset split
Returns
True/False

def has_tag(self, tag): (source) ¶

Whether the dataset has the given tag.

Parameters
tag	the tag
Returns
True/False

@property
has_patches = (source) ¶

overridden in fiftyone.zoo.datasets.base.KITTIMultiviewDataset, fiftyone.zoo.datasets.base.QuickstartGroupsDataset

Whether the dataset has patches that may need to be applied to already downloaded files.

@property
has_splits = (source) ¶

Whether the dataset has splits.

@property
has_tags = (source) ¶

Whether the dataset has tags.

@property
importer_kwargs = (source) ¶

overridden in fiftyone.zoo.datasets.base.COCO2014Dataset, fiftyone.zoo.datasets.base.COCO2017Dataset, fiftyone.zoo.datasets.base.SamaCOCODataset

A dict of default kwargs to pass to this dataset's fiftyone.utils.data.importers.DatasetImporter.

@property
is_remote = (source) ¶

overridden in fiftyone.zoo.datasets.RemoteZooDataset

Whether the dataset is remotely-sourced.

@property
name = (source) ¶

overridden in fiftyone.zoo.datasets.base.ActivityNet100Dataset, fiftyone.zoo.datasets.base.ActivityNet200Dataset, fiftyone.zoo.datasets.base.BDD100KDataset, fiftyone.zoo.datasets.base.Caltech101Dataset, fiftyone.zoo.datasets.base.Caltech256Dataset, fiftyone.zoo.datasets.base.CityscapesDataset, fiftyone.zoo.datasets.base.COCO2014Dataset, fiftyone.zoo.datasets.base.COCO2017Dataset, fiftyone.zoo.datasets.base.FIWDataset, fiftyone.zoo.datasets.base.HMDB51Dataset, fiftyone.zoo.datasets.base.ImageNetSampleDataset, fiftyone.zoo.datasets.base.Kinetics400Dataset, fiftyone.zoo.datasets.base.Kinetics600Dataset, fiftyone.zoo.datasets.base.Kinetics7002020Dataset, fiftyone.zoo.datasets.base.Kinetics700Dataset, fiftyone.zoo.datasets.base.KITTIDataset, fiftyone.zoo.datasets.base.KITTIMultiviewDataset, fiftyone.zoo.datasets.base.LabeledFacesInTheWildDataset, fiftyone.zoo.datasets.base.OpenImagesV6Dataset, fiftyone.zoo.datasets.base.OpenImagesV7Dataset, fiftyone.zoo.datasets.base.PlacesDataset, fiftyone.zoo.datasets.base.Quickstart3DDataset, fiftyone.zoo.datasets.base.QuickstartDataset, fiftyone.zoo.datasets.base.QuickstartGeoDataset, fiftyone.zoo.datasets.base.QuickstartGroupsDataset, fiftyone.zoo.datasets.base.QuickstartVideoDataset, fiftyone.zoo.datasets.base.SamaCOCODataset, fiftyone.zoo.datasets.base.UCF101Dataset, fiftyone.zoo.datasets.DeprecatedZooDataset, fiftyone.zoo.datasets.RemoteZooDataset, fiftyone.zoo.datasets.tf.CIFAR100Dataset, fiftyone.zoo.datasets.tf.CIFAR10Dataset, fiftyone.zoo.datasets.tf.FashionMNISTDataset, fiftyone.zoo.datasets.tf.ImageNet2012Dataset, fiftyone.zoo.datasets.tf.MNISTDataset, fiftyone.zoo.datasets.tf.VOC2007Dataset, fiftyone.zoo.datasets.tf.VOC2012Dataset, fiftyone.zoo.datasets.torch.CIFAR100Dataset, fiftyone.zoo.datasets.torch.CIFAR10Dataset, fiftyone.zoo.datasets.torch.FashionMNISTDataset, fiftyone.zoo.datasets.torch.ImageNet2012Dataset, fiftyone.zoo.datasets.torch.MNISTDataset, fiftyone.zoo.datasets.torch.VOC2007Dataset, fiftyone.zoo.datasets.torch.VOC2012Dataset

The name of the dataset.

@property
parameters = (source) ¶

overridden in fiftyone.zoo.datasets.base.HMDB51Dataset, fiftyone.zoo.datasets.base.UCF101Dataset

An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded.

@property
requires_manual_download = (source) ¶

overridden in fiftyone.zoo.datasets.base.BDD100KDataset, fiftyone.zoo.datasets.base.CityscapesDataset, fiftyone.zoo.datasets.tf.ImageNet2012Dataset, fiftyone.zoo.datasets.torch.ImageNet2012Dataset

Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded.

@property
supported_splits = (source) ¶

A tuple of supported splits for the dataset, or None if the dataset does not have splits.

@property
supports_partial_downloads = (source) ¶

overridden in fiftyone.zoo.datasets.base.ActivityNet100Dataset, fiftyone.zoo.datasets.base.ActivityNet200Dataset, fiftyone.zoo.datasets.base.COCO2014Dataset, fiftyone.zoo.datasets.base.COCO2017Dataset, fiftyone.zoo.datasets.base.Kinetics400Dataset, fiftyone.zoo.datasets.base.Kinetics600Dataset, fiftyone.zoo.datasets.base.Kinetics7002020Dataset, fiftyone.zoo.datasets.base.Kinetics700Dataset, fiftyone.zoo.datasets.base.KITTIMultiviewDataset, fiftyone.zoo.datasets.base.OpenImagesV6Dataset, fiftyone.zoo.datasets.base.OpenImagesV7Dataset, fiftyone.zoo.datasets.base.PlacesDataset, fiftyone.zoo.datasets.base.SamaCOCODataset, fiftyone.zoo.datasets.RemoteZooDataset

Whether the dataset supports downloading partial subsets of its splits.

@property
tags = (source) ¶

overridden in fiftyone.zoo.datasets.base.ActivityNet100Dataset, fiftyone.zoo.datasets.base.ActivityNet200Dataset, fiftyone.zoo.datasets.base.BDD100KDataset, fiftyone.zoo.datasets.base.Caltech101Dataset, fiftyone.zoo.datasets.base.Caltech256Dataset, fiftyone.zoo.datasets.base.CityscapesDataset, fiftyone.zoo.datasets.base.COCO2014Dataset, fiftyone.zoo.datasets.base.COCO2017Dataset, fiftyone.zoo.datasets.base.FIWDataset, fiftyone.zoo.datasets.base.HMDB51Dataset, fiftyone.zoo.datasets.base.ImageNetSampleDataset, fiftyone.zoo.datasets.base.Kinetics400Dataset, fiftyone.zoo.datasets.base.Kinetics600Dataset, fiftyone.zoo.datasets.base.Kinetics7002020Dataset, fiftyone.zoo.datasets.base.Kinetics700Dataset, fiftyone.zoo.datasets.base.KITTIDataset, fiftyone.zoo.datasets.base.KITTIMultiviewDataset, fiftyone.zoo.datasets.base.LabeledFacesInTheWildDataset, fiftyone.zoo.datasets.base.OpenImagesV6Dataset, fiftyone.zoo.datasets.base.OpenImagesV7Dataset, fiftyone.zoo.datasets.base.PlacesDataset, fiftyone.zoo.datasets.base.Quickstart3DDataset, fiftyone.zoo.datasets.base.QuickstartDataset, fiftyone.zoo.datasets.base.QuickstartGeoDataset, fiftyone.zoo.datasets.base.QuickstartGroupsDataset, fiftyone.zoo.datasets.base.QuickstartVideoDataset, fiftyone.zoo.datasets.base.SamaCOCODataset, fiftyone.zoo.datasets.base.UCF101Dataset, fiftyone.zoo.datasets.RemoteZooDataset, fiftyone.zoo.datasets.tf.CIFAR100Dataset, fiftyone.zoo.datasets.tf.CIFAR10Dataset, fiftyone.zoo.datasets.tf.FashionMNISTDataset, fiftyone.zoo.datasets.tf.ImageNet2012Dataset, fiftyone.zoo.datasets.tf.MNISTDataset, fiftyone.zoo.datasets.tf.VOC2007Dataset, fiftyone.zoo.datasets.tf.VOC2012Dataset, fiftyone.zoo.datasets.torch.CIFAR100Dataset, fiftyone.zoo.datasets.torch.CIFAR10Dataset, fiftyone.zoo.datasets.torch.FashionMNISTDataset, fiftyone.zoo.datasets.torch.ImageNet2012Dataset, fiftyone.zoo.datasets.torch.MNISTDataset, fiftyone.zoo.datasets.torch.VOC2007Dataset, fiftyone.zoo.datasets.torch.VOC2012Dataset

A tuple of tags for the dataset.

def _download_and_prepare(self, dataset_dir, scratch_dir, split): (source) ¶

Internal implementation of downloading the dataset and preparing it for use in the given directory.

Parameters
dataset_dir	the directory in which to construct the dataset. If a `split` is provided, this is the directory for the split
scratch_dir	a scratch directory to use to download and prepare any required intermediate files
split	the split to download, or None if the dataset does not have splits
Returns
tuple of	dataset_type: the `fiftyone.types.Dataset` type of the dataset num_samples: the number of samples in the split. For datasets that support partial downloads, this can be `None`, which indicates that all content was already downloaded classes: an optional list of class label strings

def _get_splits_to_download(self, splits, dataset_dir, info): (source) ¶

Undocumented

def _is_dataset_ready(self, dataset_dir, info): (source) ¶

Undocumented

def _is_split_ready(self, dataset_dir, split, info): (source) ¶

Undocumented

def _patch_if_necessary(self, dataset_dir, split): (source) ¶

overridden in fiftyone.zoo.datasets.base.KITTIMultiviewDataset, fiftyone.zoo.datasets.base.QuickstartGroupsDataset

Internal method called when an already downloaded dataset may need to be patched.

Parameters
dataset_dir	the directory containing the dataset
split	the split to patch, or None if the dataset does not have splits