Skip to content

dataset_description

Definition:

The metadata file 'dataset_description.json' is a JSON file describing the dataset.

Properties:

Property Value Description
baseDir / Name of the directory under which the file object is expected to appear.
stem dataset_description Portion of the filename which excludes the extension.
arbitraryNesting False Indicator for whether a given file object is allowed to be nested within an arbitrary number of subdirectories.
extensions ['.json'] Extension of current file including initial dot

If object not found:

Property Value
code MISSING_DATASET_DESCRIPTION
level error
reason It is required to include a 'dataset_description.json' in the base directory