Dataset

class Dataset(owner, dataset_id, creation_time, expiration_time, dataset_name, verbose, data=None)

A dataset should not be constructed directly. It is constructed by the hub client through qai_hub.upload_dataset(), qai_hub.get_dataset() or qai_hub.get_datasets().

dataset_id

The dataset ID.

Type:

str

creation_time

The time this dataset was created.

Type:

datetime

dataset_name

Name of this dataset

Type:

str

expiration_time

The time this dataset will expire.

Type:

datetime

download(filename=None)

Downloads the dataset entries either to memory or to an h5py (.h5) file.

Parameters:

filename (Optional[str]) – If filename is specified the dataset is downloaded to file, otherwise to memory. If the filename doesn’t end with the correct file extension, the appropriate file extension is added to the name.

Returns:

Loaded data instance or file name.

Return type:

DatasetEntries | str