fiftyone.zoo.datasets.DeprecatedZooDataset

class documentation

class DeprecatedZooDataset(ZooDataset): (source)

Class representing a zoo dataset that no longer exists in the FiftyOne Dataset Zoo.

Property	`name`	The name of the dataset.
Property	`supported_splits`	A tuple of supported splits for the dataset, or None if the dataset does not have splits.
Method	`_download_and_prepare`	Internal implementation of downloading the dataset and preparing it for use in the given directory.

Inherited from ZooDataset:

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	`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.
Property	`tags`	A tuple of tags for the dataset.
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.

@property
name = (source) ¶

overrides fiftyone.zoo.datasets.ZooDataset.name

The name of the dataset.

@property
supported_splits = (source) ¶

overrides fiftyone.zoo.datasets.ZooDataset.supported_splits

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

def _download_and_prepare(self, *args, **kwargs): (source) ¶

overrides fiftyone.zoo.datasets.ZooDataset._download_and_prepare

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

Parameters
*args	Undocumented
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
**kwargs	Undocumented
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