nilmtk.dataset_converters.ukdale package


nilmtk.dataset_converters.ukdale.convert_ukdale module

nilmtk.dataset_converters.ukdale.convert_ukdale.convert_ukdale(ukdale_path, output_filename, format='HDF')[source]

Converts the UK-DALE dataset to NILMTK HDF5 format.

For more information about the UK-DALE dataset, and to download it, please see


ukdale_path : str

The root path of the UK-DALE dataset. It is assumed that the YAML metadata is in ‘ukdale_path/metadata’.

output_filename : str

The destination filename (including path and suffix).

format : str

format of output. Either ‘HDF’ or ‘CSV’. Defaults to ‘HDF’

Module contents