fiftyone.zoo.datasets#
- fiftyone.zoo.datasets.base
FiftyOneDataset
FiftyOneDataset.download_and_prepare()
FiftyOneDataset.get_info_path()
FiftyOneDataset.get_split_dir()
FiftyOneDataset.has_info()
FiftyOneDataset.has_patches
FiftyOneDataset.has_split()
FiftyOneDataset.has_splits
FiftyOneDataset.has_tag()
FiftyOneDataset.has_tags
FiftyOneDataset.importer_kwargs
FiftyOneDataset.is_remote
FiftyOneDataset.license
FiftyOneDataset.load_info()
FiftyOneDataset.name
FiftyOneDataset.parameters
FiftyOneDataset.requires_manual_download
FiftyOneDataset.supported_splits
FiftyOneDataset.supports_partial_downloads
FiftyOneDataset.tags
ActivityNet100Dataset
ActivityNet100Dataset.name
ActivityNet100Dataset.license
ActivityNet100Dataset.tags
ActivityNet100Dataset.supported_splits
ActivityNet100Dataset.supports_partial_downloads
ActivityNet100Dataset.download_and_prepare()
ActivityNet100Dataset.get_info_path()
ActivityNet100Dataset.get_split_dir()
ActivityNet100Dataset.has_info()
ActivityNet100Dataset.has_patches
ActivityNet100Dataset.has_split()
ActivityNet100Dataset.has_splits
ActivityNet100Dataset.has_tag()
ActivityNet100Dataset.has_tags
ActivityNet100Dataset.importer_kwargs
ActivityNet100Dataset.is_remote
ActivityNet100Dataset.load_info()
ActivityNet100Dataset.parameters
ActivityNet100Dataset.requires_manual_download
ActivityNet200Dataset
ActivityNet200Dataset.name
ActivityNet200Dataset.license
ActivityNet200Dataset.tags
ActivityNet200Dataset.supported_splits
ActivityNet200Dataset.supports_partial_downloads
ActivityNet200Dataset.download_and_prepare()
ActivityNet200Dataset.get_info_path()
ActivityNet200Dataset.get_split_dir()
ActivityNet200Dataset.has_info()
ActivityNet200Dataset.has_patches
ActivityNet200Dataset.has_split()
ActivityNet200Dataset.has_splits
ActivityNet200Dataset.has_tag()
ActivityNet200Dataset.has_tags
ActivityNet200Dataset.importer_kwargs
ActivityNet200Dataset.is_remote
ActivityNet200Dataset.load_info()
ActivityNet200Dataset.parameters
ActivityNet200Dataset.requires_manual_download
BDD100KDataset
BDD100KDataset.name
BDD100KDataset.license
BDD100KDataset.tags
BDD100KDataset.supported_splits
BDD100KDataset.requires_manual_download
BDD100KDataset.download_and_prepare()
BDD100KDataset.get_info_path()
BDD100KDataset.get_split_dir()
BDD100KDataset.has_info()
BDD100KDataset.has_patches
BDD100KDataset.has_split()
BDD100KDataset.has_splits
BDD100KDataset.has_tag()
BDD100KDataset.has_tags
BDD100KDataset.importer_kwargs
BDD100KDataset.is_remote
BDD100KDataset.load_info()
BDD100KDataset.parameters
BDD100KDataset.supports_partial_downloads
Caltech101Dataset
Caltech101Dataset.name
Caltech101Dataset.license
Caltech101Dataset.tags
Caltech101Dataset.supported_splits
Caltech101Dataset.download_and_prepare()
Caltech101Dataset.get_info_path()
Caltech101Dataset.get_split_dir()
Caltech101Dataset.has_info()
Caltech101Dataset.has_patches
Caltech101Dataset.has_split()
Caltech101Dataset.has_splits
Caltech101Dataset.has_tag()
Caltech101Dataset.has_tags
Caltech101Dataset.importer_kwargs
Caltech101Dataset.is_remote
Caltech101Dataset.load_info()
Caltech101Dataset.parameters
Caltech101Dataset.requires_manual_download
Caltech101Dataset.supports_partial_downloads
Caltech256Dataset
Caltech256Dataset.name
Caltech256Dataset.license
Caltech256Dataset.tags
Caltech256Dataset.supported_splits
Caltech256Dataset.download_and_prepare()
Caltech256Dataset.get_info_path()
Caltech256Dataset.get_split_dir()
Caltech256Dataset.has_info()
Caltech256Dataset.has_patches
Caltech256Dataset.has_split()
Caltech256Dataset.has_splits
Caltech256Dataset.has_tag()
Caltech256Dataset.has_tags
Caltech256Dataset.importer_kwargs
Caltech256Dataset.is_remote
Caltech256Dataset.load_info()
Caltech256Dataset.parameters
Caltech256Dataset.requires_manual_download
Caltech256Dataset.supports_partial_downloads
CityscapesDataset
CityscapesDataset.name
CityscapesDataset.license
CityscapesDataset.tags
CityscapesDataset.supported_splits
CityscapesDataset.requires_manual_download
CityscapesDataset.download_and_prepare()
CityscapesDataset.get_info_path()
CityscapesDataset.get_split_dir()
CityscapesDataset.has_info()
CityscapesDataset.has_patches
CityscapesDataset.has_split()
CityscapesDataset.has_splits
CityscapesDataset.has_tag()
CityscapesDataset.has_tags
CityscapesDataset.importer_kwargs
CityscapesDataset.is_remote
CityscapesDataset.load_info()
CityscapesDataset.parameters
CityscapesDataset.supports_partial_downloads
COCO2014Dataset
COCO2014Dataset.name
COCO2014Dataset.license
COCO2014Dataset.tags
COCO2014Dataset.supported_splits
COCO2014Dataset.supports_partial_downloads
COCO2014Dataset.importer_kwargs
COCO2014Dataset.download_and_prepare()
COCO2014Dataset.get_info_path()
COCO2014Dataset.get_split_dir()
COCO2014Dataset.has_info()
COCO2014Dataset.has_patches
COCO2014Dataset.has_split()
COCO2014Dataset.has_splits
COCO2014Dataset.has_tag()
COCO2014Dataset.has_tags
COCO2014Dataset.is_remote
COCO2014Dataset.load_info()
COCO2014Dataset.parameters
COCO2014Dataset.requires_manual_download
COCO2017Dataset
COCO2017Dataset.name
COCO2017Dataset.license
COCO2017Dataset.tags
COCO2017Dataset.supported_splits
COCO2017Dataset.supports_partial_downloads
COCO2017Dataset.importer_kwargs
COCO2017Dataset.download_and_prepare()
COCO2017Dataset.get_info_path()
COCO2017Dataset.get_split_dir()
COCO2017Dataset.has_info()
COCO2017Dataset.has_patches
COCO2017Dataset.has_split()
COCO2017Dataset.has_splits
COCO2017Dataset.has_tag()
COCO2017Dataset.has_tags
COCO2017Dataset.is_remote
COCO2017Dataset.load_info()
COCO2017Dataset.parameters
COCO2017Dataset.requires_manual_download
SamaCOCODataset
SamaCOCODataset.name
SamaCOCODataset.license
SamaCOCODataset.tags
SamaCOCODataset.supported_splits
SamaCOCODataset.supports_partial_downloads
SamaCOCODataset.importer_kwargs
SamaCOCODataset.download_and_prepare()
SamaCOCODataset.get_info_path()
SamaCOCODataset.get_split_dir()
SamaCOCODataset.has_info()
SamaCOCODataset.has_patches
SamaCOCODataset.has_split()
SamaCOCODataset.has_splits
SamaCOCODataset.has_tag()
SamaCOCODataset.has_tags
SamaCOCODataset.is_remote
SamaCOCODataset.load_info()
SamaCOCODataset.parameters
SamaCOCODataset.requires_manual_download
FIWDataset
FIWDataset.name
FIWDataset.license
FIWDataset.tags
FIWDataset.supported_splits
FIWDataset.download_and_prepare()
FIWDataset.get_info_path()
FIWDataset.get_split_dir()
FIWDataset.has_info()
FIWDataset.has_patches
FIWDataset.has_split()
FIWDataset.has_splits
FIWDataset.has_tag()
FIWDataset.has_tags
FIWDataset.importer_kwargs
FIWDataset.is_remote
FIWDataset.load_info()
FIWDataset.parameters
FIWDataset.requires_manual_download
FIWDataset.supports_partial_downloads
HMDB51Dataset
HMDB51Dataset.name
HMDB51Dataset.license
HMDB51Dataset.tags
HMDB51Dataset.parameters
HMDB51Dataset.supported_splits
HMDB51Dataset.download_and_prepare()
HMDB51Dataset.get_info_path()
HMDB51Dataset.get_split_dir()
HMDB51Dataset.has_info()
HMDB51Dataset.has_patches
HMDB51Dataset.has_split()
HMDB51Dataset.has_splits
HMDB51Dataset.has_tag()
HMDB51Dataset.has_tags
HMDB51Dataset.importer_kwargs
HMDB51Dataset.is_remote
HMDB51Dataset.load_info()
HMDB51Dataset.requires_manual_download
HMDB51Dataset.supports_partial_downloads
ImageNetSampleDataset
ImageNetSampleDataset.name
ImageNetSampleDataset.license
ImageNetSampleDataset.tags
ImageNetSampleDataset.supported_splits
ImageNetSampleDataset.download_and_prepare()
ImageNetSampleDataset.get_info_path()
ImageNetSampleDataset.get_split_dir()
ImageNetSampleDataset.has_info()
ImageNetSampleDataset.has_patches
ImageNetSampleDataset.has_split()
ImageNetSampleDataset.has_splits
ImageNetSampleDataset.has_tag()
ImageNetSampleDataset.has_tags
ImageNetSampleDataset.importer_kwargs
ImageNetSampleDataset.is_remote
ImageNetSampleDataset.load_info()
ImageNetSampleDataset.parameters
ImageNetSampleDataset.requires_manual_download
ImageNetSampleDataset.supports_partial_downloads
Kinetics400Dataset
Kinetics400Dataset.name
Kinetics400Dataset.license
Kinetics400Dataset.tags
Kinetics400Dataset.supported_splits
Kinetics400Dataset.supports_partial_downloads
Kinetics400Dataset.download_and_prepare()
Kinetics400Dataset.get_info_path()
Kinetics400Dataset.get_split_dir()
Kinetics400Dataset.has_info()
Kinetics400Dataset.has_patches
Kinetics400Dataset.has_split()
Kinetics400Dataset.has_splits
Kinetics400Dataset.has_tag()
Kinetics400Dataset.has_tags
Kinetics400Dataset.importer_kwargs
Kinetics400Dataset.is_remote
Kinetics400Dataset.load_info()
Kinetics400Dataset.parameters
Kinetics400Dataset.requires_manual_download
Kinetics600Dataset
Kinetics600Dataset.name
Kinetics600Dataset.license
Kinetics600Dataset.tags
Kinetics600Dataset.supported_splits
Kinetics600Dataset.supports_partial_downloads
Kinetics600Dataset.download_and_prepare()
Kinetics600Dataset.get_info_path()
Kinetics600Dataset.get_split_dir()
Kinetics600Dataset.has_info()
Kinetics600Dataset.has_patches
Kinetics600Dataset.has_split()
Kinetics600Dataset.has_splits
Kinetics600Dataset.has_tag()
Kinetics600Dataset.has_tags
Kinetics600Dataset.importer_kwargs
Kinetics600Dataset.is_remote
Kinetics600Dataset.load_info()
Kinetics600Dataset.parameters
Kinetics600Dataset.requires_manual_download
Kinetics700Dataset
Kinetics700Dataset.name
Kinetics700Dataset.license
Kinetics700Dataset.tags
Kinetics700Dataset.supported_splits
Kinetics700Dataset.supports_partial_downloads
Kinetics700Dataset.download_and_prepare()
Kinetics700Dataset.get_info_path()
Kinetics700Dataset.get_split_dir()
Kinetics700Dataset.has_info()
Kinetics700Dataset.has_patches
Kinetics700Dataset.has_split()
Kinetics700Dataset.has_splits
Kinetics700Dataset.has_tag()
Kinetics700Dataset.has_tags
Kinetics700Dataset.importer_kwargs
Kinetics700Dataset.is_remote
Kinetics700Dataset.load_info()
Kinetics700Dataset.parameters
Kinetics700Dataset.requires_manual_download
Kinetics7002020Dataset
Kinetics7002020Dataset.name
Kinetics7002020Dataset.license
Kinetics7002020Dataset.tags
Kinetics7002020Dataset.supported_splits
Kinetics7002020Dataset.supports_partial_downloads
Kinetics7002020Dataset.download_and_prepare()
Kinetics7002020Dataset.get_info_path()
Kinetics7002020Dataset.get_split_dir()
Kinetics7002020Dataset.has_info()
Kinetics7002020Dataset.has_patches
Kinetics7002020Dataset.has_split()
Kinetics7002020Dataset.has_splits
Kinetics7002020Dataset.has_tag()
Kinetics7002020Dataset.has_tags
Kinetics7002020Dataset.importer_kwargs
Kinetics7002020Dataset.is_remote
Kinetics7002020Dataset.load_info()
Kinetics7002020Dataset.parameters
Kinetics7002020Dataset.requires_manual_download
KITTIDataset
KITTIDataset.name
KITTIDataset.license
KITTIDataset.tags
KITTIDataset.supported_splits
KITTIDataset.download_and_prepare()
KITTIDataset.get_info_path()
KITTIDataset.get_split_dir()
KITTIDataset.has_info()
KITTIDataset.has_patches
KITTIDataset.has_split()
KITTIDataset.has_splits
KITTIDataset.has_tag()
KITTIDataset.has_tags
KITTIDataset.importer_kwargs
KITTIDataset.is_remote
KITTIDataset.load_info()
KITTIDataset.parameters
KITTIDataset.requires_manual_download
KITTIDataset.supports_partial_downloads
KITTIMultiviewDataset
KITTIMultiviewDataset.name
KITTIMultiviewDataset.license
KITTIMultiviewDataset.tags
KITTIMultiviewDataset.supported_splits
KITTIMultiviewDataset.supports_partial_downloads
KITTIMultiviewDataset.has_patches
KITTIMultiviewDataset.download_and_prepare()
KITTIMultiviewDataset.get_info_path()
KITTIMultiviewDataset.get_split_dir()
KITTIMultiviewDataset.has_info()
KITTIMultiviewDataset.has_split()
KITTIMultiviewDataset.has_splits
KITTIMultiviewDataset.has_tag()
KITTIMultiviewDataset.has_tags
KITTIMultiviewDataset.importer_kwargs
KITTIMultiviewDataset.is_remote
KITTIMultiviewDataset.load_info()
KITTIMultiviewDataset.parameters
KITTIMultiviewDataset.requires_manual_download
LabeledFacesInTheWildDataset
LabeledFacesInTheWildDataset.name
LabeledFacesInTheWildDataset.license
LabeledFacesInTheWildDataset.tags
LabeledFacesInTheWildDataset.supported_splits
LabeledFacesInTheWildDataset.download_and_prepare()
LabeledFacesInTheWildDataset.get_info_path()
LabeledFacesInTheWildDataset.get_split_dir()
LabeledFacesInTheWildDataset.has_info()
LabeledFacesInTheWildDataset.has_patches
LabeledFacesInTheWildDataset.has_split()
LabeledFacesInTheWildDataset.has_splits
LabeledFacesInTheWildDataset.has_tag()
LabeledFacesInTheWildDataset.has_tags
LabeledFacesInTheWildDataset.importer_kwargs
LabeledFacesInTheWildDataset.is_remote
LabeledFacesInTheWildDataset.load_info()
LabeledFacesInTheWildDataset.parameters
LabeledFacesInTheWildDataset.requires_manual_download
LabeledFacesInTheWildDataset.supports_partial_downloads
OpenImagesV6Dataset
OpenImagesV6Dataset.name
OpenImagesV6Dataset.license
OpenImagesV6Dataset.tags
OpenImagesV6Dataset.supported_splits
OpenImagesV6Dataset.supports_partial_downloads
OpenImagesV6Dataset.download_and_prepare()
OpenImagesV6Dataset.get_info_path()
OpenImagesV6Dataset.get_split_dir()
OpenImagesV6Dataset.has_info()
OpenImagesV6Dataset.has_patches
OpenImagesV6Dataset.has_split()
OpenImagesV6Dataset.has_splits
OpenImagesV6Dataset.has_tag()
OpenImagesV6Dataset.has_tags
OpenImagesV6Dataset.importer_kwargs
OpenImagesV6Dataset.is_remote
OpenImagesV6Dataset.load_info()
OpenImagesV6Dataset.parameters
OpenImagesV6Dataset.requires_manual_download
OpenImagesV7Dataset
OpenImagesV7Dataset.name
OpenImagesV7Dataset.license
OpenImagesV7Dataset.tags
OpenImagesV7Dataset.supported_splits
OpenImagesV7Dataset.supports_partial_downloads
OpenImagesV7Dataset.download_and_prepare()
OpenImagesV7Dataset.get_info_path()
OpenImagesV7Dataset.get_split_dir()
OpenImagesV7Dataset.has_info()
OpenImagesV7Dataset.has_patches
OpenImagesV7Dataset.has_split()
OpenImagesV7Dataset.has_splits
OpenImagesV7Dataset.has_tag()
OpenImagesV7Dataset.has_tags
OpenImagesV7Dataset.importer_kwargs
OpenImagesV7Dataset.is_remote
OpenImagesV7Dataset.load_info()
OpenImagesV7Dataset.parameters
OpenImagesV7Dataset.requires_manual_download
PlacesDataset
PlacesDataset.name
PlacesDataset.license
PlacesDataset.tags
PlacesDataset.supported_splits
PlacesDataset.supports_partial_downloads
PlacesDataset.download_and_prepare()
PlacesDataset.get_info_path()
PlacesDataset.get_split_dir()
PlacesDataset.has_info()
PlacesDataset.has_patches
PlacesDataset.has_split()
PlacesDataset.has_splits
PlacesDataset.has_tag()
PlacesDataset.has_tags
PlacesDataset.importer_kwargs
PlacesDataset.is_remote
PlacesDataset.load_info()
PlacesDataset.parameters
PlacesDataset.requires_manual_download
QuickstartDataset
QuickstartDataset.name
QuickstartDataset.license
QuickstartDataset.tags
QuickstartDataset.supported_splits
QuickstartDataset.download_and_prepare()
QuickstartDataset.get_info_path()
QuickstartDataset.get_split_dir()
QuickstartDataset.has_info()
QuickstartDataset.has_patches
QuickstartDataset.has_split()
QuickstartDataset.has_splits
QuickstartDataset.has_tag()
QuickstartDataset.has_tags
QuickstartDataset.importer_kwargs
QuickstartDataset.is_remote
QuickstartDataset.load_info()
QuickstartDataset.parameters
QuickstartDataset.requires_manual_download
QuickstartDataset.supports_partial_downloads
QuickstartGeoDataset
QuickstartGeoDataset.name
QuickstartGeoDataset.license
QuickstartGeoDataset.tags
QuickstartGeoDataset.supported_splits
QuickstartGeoDataset.download_and_prepare()
QuickstartGeoDataset.get_info_path()
QuickstartGeoDataset.get_split_dir()
QuickstartGeoDataset.has_info()
QuickstartGeoDataset.has_patches
QuickstartGeoDataset.has_split()
QuickstartGeoDataset.has_splits
QuickstartGeoDataset.has_tag()
QuickstartGeoDataset.has_tags
QuickstartGeoDataset.importer_kwargs
QuickstartGeoDataset.is_remote
QuickstartGeoDataset.load_info()
QuickstartGeoDataset.parameters
QuickstartGeoDataset.requires_manual_download
QuickstartGeoDataset.supports_partial_downloads
QuickstartVideoDataset
QuickstartVideoDataset.name
QuickstartVideoDataset.license
QuickstartVideoDataset.tags
QuickstartVideoDataset.supported_splits
QuickstartVideoDataset.download_and_prepare()
QuickstartVideoDataset.get_info_path()
QuickstartVideoDataset.get_split_dir()
QuickstartVideoDataset.has_info()
QuickstartVideoDataset.has_patches
QuickstartVideoDataset.has_split()
QuickstartVideoDataset.has_splits
QuickstartVideoDataset.has_tag()
QuickstartVideoDataset.has_tags
QuickstartVideoDataset.importer_kwargs
QuickstartVideoDataset.is_remote
QuickstartVideoDataset.load_info()
QuickstartVideoDataset.parameters
QuickstartVideoDataset.requires_manual_download
QuickstartVideoDataset.supports_partial_downloads
QuickstartGroupsDataset
QuickstartGroupsDataset.name
QuickstartGroupsDataset.license
QuickstartGroupsDataset.tags
QuickstartGroupsDataset.supported_splits
QuickstartGroupsDataset.has_patches
QuickstartGroupsDataset.download_and_prepare()
QuickstartGroupsDataset.get_info_path()
QuickstartGroupsDataset.get_split_dir()
QuickstartGroupsDataset.has_info()
QuickstartGroupsDataset.has_split()
QuickstartGroupsDataset.has_splits
QuickstartGroupsDataset.has_tag()
QuickstartGroupsDataset.has_tags
QuickstartGroupsDataset.importer_kwargs
QuickstartGroupsDataset.is_remote
QuickstartGroupsDataset.load_info()
QuickstartGroupsDataset.parameters
QuickstartGroupsDataset.requires_manual_download
QuickstartGroupsDataset.supports_partial_downloads
Quickstart3DDataset
Quickstart3DDataset.name
Quickstart3DDataset.license
Quickstart3DDataset.tags
Quickstart3DDataset.supported_splits
Quickstart3DDataset.download_and_prepare()
Quickstart3DDataset.get_info_path()
Quickstart3DDataset.get_split_dir()
Quickstart3DDataset.has_info()
Quickstart3DDataset.has_patches
Quickstart3DDataset.has_split()
Quickstart3DDataset.has_splits
Quickstart3DDataset.has_tag()
Quickstart3DDataset.has_tags
Quickstart3DDataset.importer_kwargs
Quickstart3DDataset.is_remote
Quickstart3DDataset.load_info()
Quickstart3DDataset.parameters
Quickstart3DDataset.requires_manual_download
Quickstart3DDataset.supports_partial_downloads
UCF101Dataset
UCF101Dataset.name
UCF101Dataset.license
UCF101Dataset.tags
UCF101Dataset.parameters
UCF101Dataset.supported_splits
UCF101Dataset.download_and_prepare()
UCF101Dataset.get_info_path()
UCF101Dataset.get_split_dir()
UCF101Dataset.has_info()
UCF101Dataset.has_patches
UCF101Dataset.has_split()
UCF101Dataset.has_splits
UCF101Dataset.has_tag()
UCF101Dataset.has_tags
UCF101Dataset.importer_kwargs
UCF101Dataset.is_remote
UCF101Dataset.load_info()
UCF101Dataset.requires_manual_download
UCF101Dataset.supports_partial_downloads
- fiftyone.zoo.datasets.tf
TFDSDataset
TFDSDataset.download_and_prepare()
TFDSDataset.get_info_path()
TFDSDataset.get_split_dir()
TFDSDataset.has_info()
TFDSDataset.has_patches
TFDSDataset.has_split()
TFDSDataset.has_splits
TFDSDataset.has_tag()
TFDSDataset.has_tags
TFDSDataset.importer_kwargs
TFDSDataset.is_remote
TFDSDataset.license
TFDSDataset.load_info()
TFDSDataset.name
TFDSDataset.parameters
TFDSDataset.requires_manual_download
TFDSDataset.supported_splits
TFDSDataset.supports_partial_downloads
TFDSDataset.tags
MNISTDataset
MNISTDataset.name
MNISTDataset.license
MNISTDataset.tags
MNISTDataset.supported_splits
MNISTDataset.download_and_prepare()
MNISTDataset.get_info_path()
MNISTDataset.get_split_dir()
MNISTDataset.has_info()
MNISTDataset.has_patches
MNISTDataset.has_split()
MNISTDataset.has_splits
MNISTDataset.has_tag()
MNISTDataset.has_tags
MNISTDataset.importer_kwargs
MNISTDataset.is_remote
MNISTDataset.load_info()
MNISTDataset.parameters
MNISTDataset.requires_manual_download
MNISTDataset.supports_partial_downloads
FashionMNISTDataset
FashionMNISTDataset.name
FashionMNISTDataset.license
FashionMNISTDataset.tags
FashionMNISTDataset.supported_splits
FashionMNISTDataset.download_and_prepare()
FashionMNISTDataset.get_info_path()
FashionMNISTDataset.get_split_dir()
FashionMNISTDataset.has_info()
FashionMNISTDataset.has_patches
FashionMNISTDataset.has_split()
FashionMNISTDataset.has_splits
FashionMNISTDataset.has_tag()
FashionMNISTDataset.has_tags
FashionMNISTDataset.importer_kwargs
FashionMNISTDataset.is_remote
FashionMNISTDataset.load_info()
FashionMNISTDataset.parameters
FashionMNISTDataset.requires_manual_download
FashionMNISTDataset.supports_partial_downloads
CIFAR10Dataset
CIFAR10Dataset.name
CIFAR10Dataset.license
CIFAR10Dataset.tags
CIFAR10Dataset.supported_splits
CIFAR10Dataset.download_and_prepare()
CIFAR10Dataset.get_info_path()
CIFAR10Dataset.get_split_dir()
CIFAR10Dataset.has_info()
CIFAR10Dataset.has_patches
CIFAR10Dataset.has_split()
CIFAR10Dataset.has_splits
CIFAR10Dataset.has_tag()
CIFAR10Dataset.has_tags
CIFAR10Dataset.importer_kwargs
CIFAR10Dataset.is_remote
CIFAR10Dataset.load_info()
CIFAR10Dataset.parameters
CIFAR10Dataset.requires_manual_download
CIFAR10Dataset.supports_partial_downloads
CIFAR100Dataset
CIFAR100Dataset.name
CIFAR100Dataset.license
CIFAR100Dataset.tags
CIFAR100Dataset.supported_splits
CIFAR100Dataset.download_and_prepare()
CIFAR100Dataset.get_info_path()
CIFAR100Dataset.get_split_dir()
CIFAR100Dataset.has_info()
CIFAR100Dataset.has_patches
CIFAR100Dataset.has_split()
CIFAR100Dataset.has_splits
CIFAR100Dataset.has_tag()
CIFAR100Dataset.has_tags
CIFAR100Dataset.importer_kwargs
CIFAR100Dataset.is_remote
CIFAR100Dataset.load_info()
CIFAR100Dataset.parameters
CIFAR100Dataset.requires_manual_download
CIFAR100Dataset.supports_partial_downloads
ImageNet2012Dataset
ImageNet2012Dataset.name
ImageNet2012Dataset.license
ImageNet2012Dataset.tags
ImageNet2012Dataset.supported_splits
ImageNet2012Dataset.requires_manual_download
ImageNet2012Dataset.download_and_prepare()
ImageNet2012Dataset.get_info_path()
ImageNet2012Dataset.get_split_dir()
ImageNet2012Dataset.has_info()
ImageNet2012Dataset.has_patches
ImageNet2012Dataset.has_split()
ImageNet2012Dataset.has_splits
ImageNet2012Dataset.has_tag()
ImageNet2012Dataset.has_tags
ImageNet2012Dataset.importer_kwargs
ImageNet2012Dataset.is_remote
ImageNet2012Dataset.load_info()
ImageNet2012Dataset.parameters
ImageNet2012Dataset.supports_partial_downloads
VOC2007Dataset
VOC2007Dataset.name
VOC2007Dataset.license
VOC2007Dataset.tags
VOC2007Dataset.supported_splits
VOC2007Dataset.download_and_prepare()
VOC2007Dataset.get_info_path()
VOC2007Dataset.get_split_dir()
VOC2007Dataset.has_info()
VOC2007Dataset.has_patches
VOC2007Dataset.has_split()
VOC2007Dataset.has_splits
VOC2007Dataset.has_tag()
VOC2007Dataset.has_tags
VOC2007Dataset.importer_kwargs
VOC2007Dataset.is_remote
VOC2007Dataset.load_info()
VOC2007Dataset.parameters
VOC2007Dataset.requires_manual_download
VOC2007Dataset.supports_partial_downloads
VOC2012Dataset
VOC2012Dataset.name
VOC2012Dataset.license
VOC2012Dataset.tags
VOC2012Dataset.supported_splits
VOC2012Dataset.download_and_prepare()
VOC2012Dataset.get_info_path()
VOC2012Dataset.get_split_dir()
VOC2012Dataset.has_info()
VOC2012Dataset.has_patches
VOC2012Dataset.has_split()
VOC2012Dataset.has_splits
VOC2012Dataset.has_tag()
VOC2012Dataset.has_tags
VOC2012Dataset.importer_kwargs
VOC2012Dataset.is_remote
VOC2012Dataset.load_info()
VOC2012Dataset.parameters
VOC2012Dataset.requires_manual_download
VOC2012Dataset.supports_partial_downloads
- fiftyone.zoo.datasets.torch
TorchVisionDataset
TorchVisionDataset.download_and_prepare()
TorchVisionDataset.get_info_path()
TorchVisionDataset.get_split_dir()
TorchVisionDataset.has_info()
TorchVisionDataset.has_patches
TorchVisionDataset.has_split()
TorchVisionDataset.has_splits
TorchVisionDataset.has_tag()
TorchVisionDataset.has_tags
TorchVisionDataset.importer_kwargs
TorchVisionDataset.is_remote
TorchVisionDataset.license
TorchVisionDataset.load_info()
TorchVisionDataset.name
TorchVisionDataset.parameters
TorchVisionDataset.requires_manual_download
TorchVisionDataset.supported_splits
TorchVisionDataset.supports_partial_downloads
TorchVisionDataset.tags
MNISTDataset
MNISTDataset.name
MNISTDataset.license
MNISTDataset.tags
MNISTDataset.supported_splits
MNISTDataset.download_and_prepare()
MNISTDataset.get_info_path()
MNISTDataset.get_split_dir()
MNISTDataset.has_info()
MNISTDataset.has_patches
MNISTDataset.has_split()
MNISTDataset.has_splits
MNISTDataset.has_tag()
MNISTDataset.has_tags
MNISTDataset.importer_kwargs
MNISTDataset.is_remote
MNISTDataset.load_info()
MNISTDataset.parameters
MNISTDataset.requires_manual_download
MNISTDataset.supports_partial_downloads
FashionMNISTDataset
FashionMNISTDataset.name
FashionMNISTDataset.license
FashionMNISTDataset.tags
FashionMNISTDataset.supported_splits
FashionMNISTDataset.download_and_prepare()
FashionMNISTDataset.get_info_path()
FashionMNISTDataset.get_split_dir()
FashionMNISTDataset.has_info()
FashionMNISTDataset.has_patches
FashionMNISTDataset.has_split()
FashionMNISTDataset.has_splits
FashionMNISTDataset.has_tag()
FashionMNISTDataset.has_tags
FashionMNISTDataset.importer_kwargs
FashionMNISTDataset.is_remote
FashionMNISTDataset.load_info()
FashionMNISTDataset.parameters
FashionMNISTDataset.requires_manual_download
FashionMNISTDataset.supports_partial_downloads
CIFAR10Dataset
CIFAR10Dataset.name
CIFAR10Dataset.license
CIFAR10Dataset.tags
CIFAR10Dataset.supported_splits
CIFAR10Dataset.download_and_prepare()
CIFAR10Dataset.get_info_path()
CIFAR10Dataset.get_split_dir()
CIFAR10Dataset.has_info()
CIFAR10Dataset.has_patches
CIFAR10Dataset.has_split()
CIFAR10Dataset.has_splits
CIFAR10Dataset.has_tag()
CIFAR10Dataset.has_tags
CIFAR10Dataset.importer_kwargs
CIFAR10Dataset.is_remote
CIFAR10Dataset.load_info()
CIFAR10Dataset.parameters
CIFAR10Dataset.requires_manual_download
CIFAR10Dataset.supports_partial_downloads
CIFAR100Dataset
CIFAR100Dataset.name
CIFAR100Dataset.license
CIFAR100Dataset.tags
CIFAR100Dataset.supported_splits
CIFAR100Dataset.download_and_prepare()
CIFAR100Dataset.get_info_path()
CIFAR100Dataset.get_split_dir()
CIFAR100Dataset.has_info()
CIFAR100Dataset.has_patches
CIFAR100Dataset.has_split()
CIFAR100Dataset.has_splits
CIFAR100Dataset.has_tag()
CIFAR100Dataset.has_tags
CIFAR100Dataset.importer_kwargs
CIFAR100Dataset.is_remote
CIFAR100Dataset.load_info()
CIFAR100Dataset.parameters
CIFAR100Dataset.requires_manual_download
CIFAR100Dataset.supports_partial_downloads
ImageNet2012Dataset
ImageNet2012Dataset.name
ImageNet2012Dataset.license
ImageNet2012Dataset.tags
ImageNet2012Dataset.supported_splits
ImageNet2012Dataset.requires_manual_download
ImageNet2012Dataset.download_and_prepare()
ImageNet2012Dataset.get_info_path()
ImageNet2012Dataset.get_split_dir()
ImageNet2012Dataset.has_info()
ImageNet2012Dataset.has_patches
ImageNet2012Dataset.has_split()
ImageNet2012Dataset.has_splits
ImageNet2012Dataset.has_tag()
ImageNet2012Dataset.has_tags
ImageNet2012Dataset.importer_kwargs
ImageNet2012Dataset.is_remote
ImageNet2012Dataset.load_info()
ImageNet2012Dataset.parameters
ImageNet2012Dataset.supports_partial_downloads
VOC2007Dataset
VOC2007Dataset.name
VOC2007Dataset.license
VOC2007Dataset.tags
VOC2007Dataset.supported_splits
VOC2007Dataset.download_and_prepare()
VOC2007Dataset.get_info_path()
VOC2007Dataset.get_split_dir()
VOC2007Dataset.has_info()
VOC2007Dataset.has_patches
VOC2007Dataset.has_split()
VOC2007Dataset.has_splits
VOC2007Dataset.has_tag()
VOC2007Dataset.has_tags
VOC2007Dataset.importer_kwargs
VOC2007Dataset.is_remote
VOC2007Dataset.load_info()
VOC2007Dataset.parameters
VOC2007Dataset.requires_manual_download
VOC2007Dataset.supports_partial_downloads
VOC2012Dataset
VOC2012Dataset.name
VOC2012Dataset.license
VOC2012Dataset.tags
VOC2012Dataset.supported_splits
VOC2012Dataset.download_and_prepare()
VOC2012Dataset.get_info_path()
VOC2012Dataset.get_split_dir()
VOC2012Dataset.has_info()
VOC2012Dataset.has_patches
VOC2012Dataset.has_split()
VOC2012Dataset.has_splits
VOC2012Dataset.has_tag()
VOC2012Dataset.has_tags
VOC2012Dataset.importer_kwargs
VOC2012Dataset.is_remote
VOC2012Dataset.load_info()
VOC2012Dataset.parameters
VOC2012Dataset.requires_manual_download
VOC2012Dataset.supports_partial_downloads
Module contents#
The FiftyOne Dataset Zoo.
This package defines a collection of open source datasets made available for download via FiftyOne.
Functions:
|
Lists the available datasets in the FiftyOne Dataset Zoo. |
Returns the list of available zoo dataset sources. |
|
Returns information about the zoo datasets that have been downloaded. |
|
|
Downloads the specified dataset from the FiftyOne Dataset Zoo. |
|
Loads the specified dataset from the FiftyOne Dataset Zoo. |
|
Returns the directory containing the given zoo dataset. |
|
Loads the |
|
Returns the |
|
Deletes the zoo dataset from local disk, if necessary. |
Classes:
|
Class containing info about a dataset in the FiftyOne Dataset Zoo. |
|
Class containing info about a split of a dataset in the FiftyOne Dataset Zoo. |
Base class for datasets made available in the FiftyOne Dataset Zoo. |
|
|
Class for working with remotely-sourced datasets that are compatible with the FiftyOne Dataset Zoo. |
Class representing a zoo dataset that no longer exists in the FiftyOne Dataset Zoo. |
- fiftyone.zoo.datasets.list_zoo_datasets(tags=None, source=None, license=None)#
Lists the available datasets in the FiftyOne Dataset Zoo.
Also includes any remotely-sourced zoo datasets that you’ve downloaded.
Example usage:
import fiftyone as fo import fiftyone.zoo as foz # # List all zoo datasets # names = foz.list_zoo_datasets() print(names) # # List all zoo datasets with (both of) the specified tags # names = foz.list_zoo_datasets(tags=["image", "detection"]) print(names) # # List all zoo datasets available via the given source # names = foz.list_zoo_datasets(source="torch") print(names)
- Parameters:
tags (None) – only include datasets that have the specified tag or list of tags
source (None) – only include datasets available via the given source or list of sources
license (None) – only include datasets that are distributed under the specified license or any of the specified list of licenses. Run
fiftyone zoo datasets list
to see the available licenses
- Returns:
a sorted list of dataset names
- fiftyone.zoo.datasets.list_zoo_dataset_sources()#
Returns the list of available zoo dataset sources.
- Returns:
a list of sources
- fiftyone.zoo.datasets.list_downloaded_zoo_datasets()#
Returns information about the zoo datasets that have been downloaded.
- Returns:
a dict mapping dataset names to (
dataset_dir
,ZooDatasetInfo
) tuples
- fiftyone.zoo.datasets.download_zoo_dataset(name_or_url, split=None, splits=None, overwrite=False, cleanup=True, **kwargs)#
Downloads the specified dataset from the FiftyOne Dataset Zoo.
Any dataset splits that have already been downloaded are not re-downloaded, unless
overwrite == True
is specified.Note
To download from a private GitHub repository that you have access to, provide your GitHub personal access token by setting the
GITHUB_TOKEN
environment variable.- Parameters:
name_or_url –
the name of the zoo dataset to download, or the remote source to download it from, which can be:
a GitHub repo URL like
https://github.com/<user>/<repo>
a GitHub ref like
https://github.com/<user>/<repo>/tree/<branch>
orhttps://github.com/<user>/<repo>/commit/<commit>
a GitHub ref string like
<user>/<repo>[/<ref>]
a publicly accessible URL of an archive (eg zip or tar) file
split (None) –
("train", "validation", "test")
. If neithersplit
norsplits
are provided, all available splits are downloaded. Consult the documentation for theZooDataset
you specified to see the supported splitssplits (None) – a list of splits to download, if applicable. Typical values are
("train", "validation", "test")
. If neithersplit
norsplits
are provided, all available splits are downloaded. Consult the documentation for theZooDataset
you specified to see the supported splitsoverwrite (False) – whether to overwrite any existing files
cleanup (True) – whether to cleanup any temporary files generated during download
**kwargs – optional arguments for the
ZooDataset
constructor or the remote dataset’sdownload_and_prepare()
method
- Returns:
a tuple of
info: the
ZooDatasetInfo
for the datasetdataset_dir: the directory containing the dataset
- fiftyone.zoo.datasets.load_zoo_dataset(name_or_url, split=None, splits=None, label_field=None, dataset_name=None, download_if_necessary=True, drop_existing_dataset=False, persistent=False, overwrite=False, cleanup=True, progress=None, **kwargs)#
Loads the specified dataset from the FiftyOne Dataset Zoo.
By default, the dataset will be downloaded if necessary.
Note
To download from a private GitHub repository that you have access to, provide your GitHub personal access token by setting the
GITHUB_TOKEN
environment variable.If you do not specify a custom
dataset_name
and you have previously loaded the same zoo dataset and split(s) into FiftyOne, the existing dataset will be returned.- Parameters:
name_or_url –
the name of the zoo dataset to load, or the remote source to load it from, which can be:
a GitHub repo URL like
https://github.com/<user>/<repo>
a GitHub ref like
https://github.com/<user>/<repo>/tree/<branch>
orhttps://github.com/<user>/<repo>/commit/<commit>
a GitHub ref string like
<user>/<repo>[/<ref>]
a publicly accessible URL of an archive (eg zip or tar) file
split (None) –
("train", "validation", "test")
. If neithersplit
norsplits
are provided, all available splits are loaded. Consult the documentation for theZooDataset
you specified to see the supported splitssplits (None) – a list of splits to load, if applicable. Typical values are
("train", "validation", "test")
. If neithersplit
norsplits
are provided, all available splits are loaded. Consult the documentation for theZooDataset
you specified to see the supported splitslabel_field (None) – the label field (or prefix, if the dataset contains multiple label fields) in which to store the dataset’s labels. By default, this is
"ground_truth"
if the dataset contains a single label field. If the dataset contains multiple label fields and this value is not provided, the labels will be stored under dataset-specific field namesdataset_name (None) – an optional name to give the returned
fiftyone.core.dataset.Dataset
. By default, a name will be constructed based on the dataset and split(s) you are loadingdownload_if_necessary (True) – whether to download the dataset if it is not found in the specified dataset directory
drop_existing_dataset (False) – whether to drop an existing dataset with the same name if it exists
persistent (False) – whether the dataset should persist in the database after the session terminates
overwrite (False) – whether to overwrite any existing files if the dataset is to be downloaded
cleanup (True) – whether to cleanup any temporary files generated during download
progress (None) – whether to render a progress bar (True/False), use the default value
fiftyone.config.show_progress_bars
(None), or a progress callback function to invoke instead**kwargs – optional arguments to pass to the
fiftyone.utils.data.importers.DatasetImporter
constructor or the remote dataset’sload_dataset()` method. If ``download_if_necessary == True
, thenkwargs
can also contain arguments fordownload_zoo_dataset()
- Returns:
- fiftyone.zoo.datasets.find_zoo_dataset(name_or_url, split=None)#
Returns the directory containing the given zoo dataset.
If a
split
is provided, the path to the dataset split is returned; otherwise, the path to the root directory is returned.The dataset must be downloaded. Use
download_zoo_dataset()
to download datasets.- Parameters:
name_or_url –
the name of the zoo dataset or its remote source, which can be:
a GitHub repo URL like
https://github.com/<user>/<repo>
a GitHub ref like
https://github.com/<user>/<repo>/tree/<branch>
orhttps://github.com/<user>/<repo>/commit/<commit>
a GitHub ref string like
<user>/<repo>[/<ref>]
a publicly accessible URL of an archive (eg zip or tar) file
split (None) – a specific split to locate
- Returns:
the directory containing the dataset or split
- Raises:
ValueError – if the dataset or split does not exist or has not been downloaded
- fiftyone.zoo.datasets.load_zoo_dataset_info(name_or_url)#
Loads the
ZooDatasetInfo
for the specified zoo dataset.The dataset must be downloaded. Use
download_zoo_dataset()
to download datasets.- Parameters:
name_or_url –
the name of the zoo dataset or its remote source, which can be:
a GitHub repo URL like
https://github.com/<user>/<repo>
a GitHub ref like
https://github.com/<user>/<repo>/tree/<branch>
orhttps://github.com/<user>/<repo>/commit/<commit>
a GitHub ref string like
<user>/<repo>[/<ref>]
a publicly accessible URL of an archive (eg zip or tar) file
- Returns:
the
ZooDatasetInfo
for the dataset- Raises:
ValueError – if the dataset has not been downloaded
- fiftyone.zoo.datasets.get_zoo_dataset(name_or_url, overwrite=False, **kwargs)#
Returns the
ZooDataset
instance for the given dataset.If the dataset is available from multiple sources, the default source is used.
- Parameters:
name_or_url –
the name of the zoo dataset, or its remote source, which can be:
a GitHub repo URL like
https://github.com/<user>/<repo>
a GitHub ref like
https://github.com/<user>/<repo>/tree/<branch>
orhttps://github.com/<user>/<repo>/commit/<commit>
a GitHub ref string like
<user>/<repo>[/<ref>]
a publicly accessible URL of an archive (eg zip or tar) file
overwrite (False) – whether to overwrite existing metadata if it has already been downloaded. Only applicable when
name_or_url
is a remote source**kwargs – optional arguments for
ZooDataset
- Returns:
the
ZooDataset
instance
- fiftyone.zoo.datasets.delete_zoo_dataset(name_or_url, split=None)#
Deletes the zoo dataset from local disk, if necessary.
If a
split
is provided, only that split is deleted.- Parameters:
name_or_url –
the name of the zoo dataset, or its remote source, which can be:
a GitHub repo URL like
https://github.com/<user>/<repo>
a GitHub ref like
https://github.com/<user>/<repo>/tree/<branch>
orhttps://github.com/<user>/<repo>/commit/<commit>
a GitHub ref string like
<user>/<repo>[/<ref>]
a publicly accessible URL of an archive (eg zip or tar) file
split (None)
- class fiftyone.zoo.datasets.ZooDatasetInfo(zoo_dataset, dataset_type, num_samples, downloaded_splits=None, parameters=None, classes=None)#
Bases:
Serializable
Class containing info about a dataset in the FiftyOne Dataset Zoo.
- Parameters:
zoo_dataset – the
ZooDataset
instance for the datasetdataset_type – the
fiftyone.types.Dataset
type of the datasetnum_samples – the total number of samples in all downloaded splits of the dataset
downloaded_splits (None) – a dict of
ZooDatasetSplitInfo
instances describing the downloaded splits of the dataset, if applicableparameters (None) – a dict of parameters for the dataset
classes (None) – a list of class label strings
Attributes:
The name of the dataset.
The fully-qualified class string for the
ZooDataset
of the dataset.The fully-qualified class string of the
fiftyone.types.Dataset
type, if any.A tuple of supported splits for the dataset, or None if the dataset does not have splits.
The dataset's URL, or None if it is not remotely-sourced.
Methods:
Returns the
ZooDataset
instance for the dataset.Returns the
fiftyone.types.Dataset
type instance for the dataset.is_split_downloaded
(split)Whether the given dataset split is downloaded.
add_split
(split_info)Adds the split to the dataset.
remove_split
(split)Removes the split from the dataset.
Returns a list of class attributes to be serialized.
from_dict
(d)Loads a
ZooDatasetInfo
from a JSON dictionary.from_json
(json_path[, zoo_dataset, upgrade, ...])Loads a
ZooDatasetInfo
from a JSON file on disk.copy
()Returns a deep copy of the object.
custom_attributes
([dynamic, private])Returns a customizable list of class attributes.
from_str
(s, *args, **kwargs)Constructs a Serializable object from a JSON string.
Returns the fully-qualified class name string of this object.
serialize
([reflective])Serializes the object into a dictionary.
to_str
([pretty_print])Returns a string representation of this object.
write_json
(path[, pretty_print])Serializes the object and writes it to disk.
- property name#
The name of the dataset.
- property zoo_dataset#
The fully-qualified class string for the
ZooDataset
of the dataset.
- property dataset_type#
The fully-qualified class string of the
fiftyone.types.Dataset
type, if any.
- property supported_splits#
A tuple of supported splits for the dataset, or None if the dataset does not have splits.
- property url#
The dataset’s URL, or None if it is not remotely-sourced.
- get_zoo_dataset()#
Returns the
ZooDataset
instance for the dataset.- Returns:
a
ZooDataset
instance
- get_dataset_type()#
Returns the
fiftyone.types.Dataset
type instance for the dataset.- Returns:
a
fiftyone.types.Dataset
instance
- is_split_downloaded(split)#
Whether the given dataset split is downloaded.
- Parameters:
split – the dataset split
- Returns:
True/False
- add_split(split_info)#
Adds the split to the dataset.
- Parameters:
split_info – a
ZooDatasetSplitInfo
- remove_split(split)#
Removes the split from the dataset.
- Parameters:
split – the name of the split
- attributes()#
Returns a list of class attributes to be serialized.
- Returns:
a list of class attributes
- classmethod from_dict(d)#
Loads a
ZooDatasetInfo
from a JSON dictionary.- Parameters:
d – a JSON dictionary
- Returns:
- classmethod from_json(json_path, zoo_dataset=None, upgrade=False, warn_deprecated=False)#
Loads a
ZooDatasetInfo
from a JSON file on disk.- Parameters:
json_path – path to JSON file
zoo_dataset (None) – an existing
ZooDataset
instanceupgrade (False) – 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:
- copy()#
Returns a deep copy of the object.
- Returns:
a Serializable instance
- custom_attributes(dynamic=False, private=False)#
Returns a customizable list of class attributes.
By default, all attributes in vars(self) are returned, minus private attributes (those starting with “_”).
- Parameters:
dynamic – whether to include dynamic properties, e.g., those defined by getter/setter methods or the @property decorator. By default, this is False
private – whether to include private properties, i.e., those starting with “_”. By default, this is False
- Returns:
a list of class attributes
- classmethod from_str(s, *args, **kwargs)#
Constructs a Serializable object from a JSON string.
Subclasses may override this method, but, by default, this method simply parses the string and calls from_dict(), which subclasses must implement.
- Parameters:
s – a JSON string representation of a Serializable object
*args – optional positional arguments for self.from_dict()
**kwargs – optional keyword arguments for self.from_dict()
- Returns:
an instance of the Serializable class
- classmethod get_class_name()#
Returns the fully-qualified class name string of this object.
- serialize(reflective=False)#
Serializes the object into a dictionary.
Serialization is applied recursively to all attributes in the object, including element-wise serialization of lists and dictionary values.
- Parameters:
reflective – whether to include reflective attributes when serializing the object. By default, this is False
- Returns:
a JSON dictionary representation of the object
- to_str(pretty_print=True, **kwargs)#
Returns a string representation of this object.
- Parameters:
pretty_print – whether to render the JSON in human readable format with newlines and indentations. By default, this is True
**kwargs – optional keyword arguments for self.serialize()
- Returns:
a string representation of the object
- write_json(path, pretty_print=False, **kwargs)#
Serializes the object and writes it to disk.
- Parameters:
path – the output path
pretty_print – whether to render the JSON in human readable format with newlines and indentations. By default, this is False
**kwargs – optional keyword arguments for self.serialize()
- class fiftyone.zoo.datasets.ZooDatasetSplitInfo(split, num_samples)#
Bases:
Serializable
Class containing info about a split of a dataset in the FiftyOne Dataset Zoo.
- Parameters:
split – the name of the split
num_samples – the number of samples in the split
Methods:
Returns a list of class attributes to be serialized.
from_dict
(d)Loads a
ZooDatasetSplitInfo
from a JSON dictionary.copy
()Returns a deep copy of the object.
custom_attributes
([dynamic, private])Returns a customizable list of class attributes.
from_json
(path, *args, **kwargs)Constructs a Serializable object from a JSON file.
from_str
(s, *args, **kwargs)Constructs a Serializable object from a JSON string.
Returns the fully-qualified class name string of this object.
serialize
([reflective])Serializes the object into a dictionary.
to_str
([pretty_print])Returns a string representation of this object.
write_json
(path[, pretty_print])Serializes the object and writes it to disk.
- attributes()#
Returns a list of class attributes to be serialized.
- Returns:
a list of class attributes
- classmethod from_dict(d)#
Loads a
ZooDatasetSplitInfo
from a JSON dictionary.- Parameters:
d – a JSON dictionary
- Returns:
- copy()#
Returns a deep copy of the object.
- Returns:
a Serializable instance
- custom_attributes(dynamic=False, private=False)#
Returns a customizable list of class attributes.
By default, all attributes in vars(self) are returned, minus private attributes (those starting with “_”).
- Parameters:
dynamic – whether to include dynamic properties, e.g., those defined by getter/setter methods or the @property decorator. By default, this is False
private – whether to include private properties, i.e., those starting with “_”. By default, this is False
- Returns:
a list of class attributes
- classmethod from_json(path, *args, **kwargs)#
Constructs a Serializable object from a JSON file.
Subclasses may override this method, but, by default, this method simply reads the JSON and calls from_dict(), which subclasses must implement.
- Parameters:
path – the path to the JSON file on disk
*args – optional positional arguments for self.from_dict()
**kwargs – optional keyword arguments for self.from_dict()
- Returns:
an instance of the Serializable class
- classmethod from_str(s, *args, **kwargs)#
Constructs a Serializable object from a JSON string.
Subclasses may override this method, but, by default, this method simply parses the string and calls from_dict(), which subclasses must implement.
- Parameters:
s – a JSON string representation of a Serializable object
*args – optional positional arguments for self.from_dict()
**kwargs – optional keyword arguments for self.from_dict()
- Returns:
an instance of the Serializable class
- classmethod get_class_name()#
Returns the fully-qualified class name string of this object.
- serialize(reflective=False)#
Serializes the object into a dictionary.
Serialization is applied recursively to all attributes in the object, including element-wise serialization of lists and dictionary values.
- Parameters:
reflective – whether to include reflective attributes when serializing the object. By default, this is False
- Returns:
a JSON dictionary representation of the object
- to_str(pretty_print=True, **kwargs)#
Returns a string representation of this object.
- Parameters:
pretty_print – whether to render the JSON in human readable format with newlines and indentations. By default, this is True
**kwargs – optional keyword arguments for self.serialize()
- Returns:
a string representation of the object
- write_json(path, pretty_print=False, **kwargs)#
Serializes the object and writes it to disk.
- Parameters:
path – the output path
pretty_print – whether to render the JSON in human readable format with newlines and indentations. By default, this is False
**kwargs – optional keyword arguments for self.serialize()
- class fiftyone.zoo.datasets.ZooDataset#
Bases:
object
Base class for datasets made available in the FiftyOne Dataset Zoo.
Attributes:
The name of the dataset.
Whether the dataset is remotely-sourced.
The license or list,of,licenses under which the dataset is distributed, or None if unknown.
A tuple of tags for the dataset.
Whether the dataset has tags.
An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded.
A tuple of supported splits for the dataset, or None if the dataset does not have splits.
Whether the dataset has splits.
Whether the dataset has patches that may need to be applied to already downloaded files.
Whether the dataset supports downloading partial subsets of its splits.
Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded.
A dict of default kwargs to pass to this dataset's
fiftyone.utils.data.importers.DatasetImporter
.Methods:
has_tag
(tag)Whether the dataset has the given tag.
has_split
(split)Whether the dataset has the given split.
get_split_dir
(dataset_dir, split)Returns the directory for the given split of the dataset.
has_info
(dataset_dir)Determines whether the directory contains
ZooDatasetInfo
.load_info
(dataset_dir[, upgrade, ...])Loads the
ZooDatasetInfo
from the given dataset directory.get_info_path
(dataset_dir)Returns the path to the
ZooDatasetInfo
for the dataset.download_and_prepare
(dataset_dir[, split, ...])Downloads the dataset and prepares it for use.
- property name#
The name of the dataset.
- 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.
- property tags#
A tuple of tags for the dataset.
- property has_tags#
Whether the dataset has tags.
- 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.
- property has_splits#
Whether the dataset has splits.
- property has_patches#
Whether the dataset has patches that may need to be applied to already downloaded files.
- property supports_partial_downloads#
Whether the dataset supports downloading partial subsets of its splits.
- property requires_manual_download#
Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded.
- property importer_kwargs#
A dict of default kwargs to pass to this dataset’s
fiftyone.utils.data.importers.DatasetImporter
.
- has_tag(tag)#
Whether the dataset has the given tag.
- Parameters:
tag – the tag
- Returns:
True/False
- has_split(split)#
Whether the dataset has the given split.
- Parameters:
split – the dataset split
- Returns:
True/False
- 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
- 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
- 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
- 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
norsplits
are provided, the full dataset is downloadedsplits (None) – a list of splits to download, if applicable. If neither
split
norsplits
are provided, the full dataset is downloadedcleanup (True) – whether to cleanup any temporary files generated during download
- Returns:
the
ZooDatasetInfo
for the dataset
- class fiftyone.zoo.datasets.RemoteZooDataset(dataset_dir, url=None, **kwargs)#
Bases:
ZooDataset
Class for working with remotely-sourced datasets that are compatible with the FiftyOne Dataset Zoo.
- Parameters:
dataset_dir – the dataset’s local directory, which must contain a valid dataset YAML file
url (None) –
the dataset’s remote source, which can be:
a GitHub repo URL like
https://github.com/<user>/<repo>
a GitHub ref like
https://github.com/<user>/<repo>/tree/<branch>
orhttps://github.com/<user>/<repo>/commit/<commit>
a GitHub ref string like
<user>/<repo>[/<ref>]
a publicly accessible URL of an archive (eg zip or tar) file
This is explicitly provided rather than relying on the YAML file’s
url
property in case the caller has specified a particular branch or commit**kwargs – optional keyword arguments for the dataset’s download_and_prepare() and/or load_dataset() methods
Attributes:
The name of the dataset.
Whether the dataset is remotely-sourced.
The license or list,of,licenses under which the dataset is distributed, or None if unknown.
A tuple of tags for the dataset.
A tuple of supported splits for the dataset, or None if the dataset does not have splits.
Whether the dataset supports downloading partial subsets of its splits.
Whether the dataset has patches that may need to be applied to already downloaded files.
Whether the dataset has splits.
Whether the dataset has tags.
A dict of default kwargs to pass to this dataset's
fiftyone.utils.data.importers.DatasetImporter
.An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded.
Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded.
Methods:
download_and_prepare
(dataset_dir[, split, ...])Downloads the dataset and prepares it for use.
get_info_path
(dataset_dir)Returns the path to the
ZooDatasetInfo
for the dataset.get_split_dir
(dataset_dir, split)Returns the directory for the given split of the dataset.
has_info
(dataset_dir)Determines whether the directory contains
ZooDatasetInfo
.has_split
(split)Whether the dataset has the given split.
has_tag
(tag)Whether the dataset has the given tag.
load_info
(dataset_dir[, upgrade, ...])Loads the
ZooDatasetInfo
from the given dataset directory.- property metadata#
- property name#
The name of the dataset.
- property url#
- property is_remote#
Whether the dataset is remotely-sourced.
- property author#
- property version#
- property source#
- property license#
The license or list,of,licenses under which the dataset is distributed, or None if unknown.
- property description#
- property fiftyone_version#
- 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 size_samples#
- 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
norsplits
are provided, the full dataset is downloadedsplits (None) – a list of splits to download, if applicable. If neither
split
norsplits
are provided, the full dataset is downloadedcleanup (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
.
- 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.DeprecatedZooDataset#
Bases:
ZooDataset
Class representing a zoo dataset that no longer exists in the FiftyOne Dataset Zoo.
Attributes:
The name of the dataset.
A tuple of supported splits for the dataset, or None if the dataset does not have splits.
Whether the dataset has patches that may need to be applied to already downloaded files.
Whether the dataset has splits.
Whether the dataset has tags.
A dict of default kwargs to pass to this dataset's
fiftyone.utils.data.importers.DatasetImporter
.Whether the dataset is remotely-sourced.
The license or list,of,licenses under which the dataset is distributed, or None if unknown.
An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded.
Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded.
Whether the dataset supports downloading partial subsets of its splits.
A tuple of tags for the dataset.
Methods:
download_and_prepare
(dataset_dir[, split, ...])Downloads the dataset and prepares it for use.
get_info_path
(dataset_dir)Returns the path to the
ZooDatasetInfo
for the dataset.get_split_dir
(dataset_dir, split)Returns the directory for the given split of the dataset.
has_info
(dataset_dir)Determines whether the directory contains
ZooDatasetInfo
.has_split
(split)Whether the dataset has the given split.
has_tag
(tag)Whether the dataset has the given tag.
load_info
(dataset_dir[, upgrade, ...])Loads the
ZooDatasetInfo
from the given dataset directory.- 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.
- 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
norsplits
are provided, the full dataset is downloadedsplits (None) – a list of splits to download, if applicable. If neither
split
norsplits
are provided, the full dataset is downloadedcleanup (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
.
- 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 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.