fiftyone.zoo.datasets.base.CityscapesDataset

class documentation

class CityscapesDataset(FiftyOneDataset): (source)

Constructor: CityscapesDataset(source_dir, fine_annos, coarse_annos, person_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.

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:

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 in order to get links to download the data.

Example usage:

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

Parameters
source_dir	a directory containing the manually downloaded Cityscapes files
fine_annos	whether to load the fine annotations (True), or not (False), or only if the ZIP file exists (None)
coarse_annos	whether to load the coarse annotations (True), or not (False), or only if the ZIP file exists (None)
person_annos	whether to load the personn detections (True), or not (False), or only if the ZIP file exists (None)

Method	`__init__`	Undocumented
Instance Variable	`coarse_annos`	Undocumented
Instance Variable	`fine_annos`	Undocumented
Instance Variable	`person_annos`	Undocumented
Instance Variable	`source_dir`	Undocumented
Property	`name`	The name of 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	`supported_splits`	A tuple of supported splits for the dataset, or None if the dataset does not have 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.

Inherited from ZooDataset (via FiftyOneDataset):

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	`supports_partial_downloads`	Whether the dataset supports downloading partial subsets of its splits.
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.

def __init__(self, source_dir=None, fine_annos=None, coarse_annos=None, person_annos=None): (source) ¶

Undocumented

coarse_annos: None = (source) ¶

Undocumented

fine_annos: None = (source) ¶

Undocumented

person_annos: None = (source) ¶

Undocumented

source_dir: None = (source) ¶

Undocumented

@property
name = (source) ¶

overrides fiftyone.zoo.datasets.ZooDataset.name

The name of the dataset.

@property
requires_manual_download = (source) ¶

overrides fiftyone.zoo.datasets.ZooDataset.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 = (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.

@property
tags = (source) ¶

overrides fiftyone.zoo.datasets.ZooDataset.tags

A tuple of tags for the dataset.

def _download_and_prepare(self, dataset_dir, scratch_dir, split): (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
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