twinlab.Dataset#

class twinlab.Dataset(id, project='personal', project_owner=None)[source]#

A twinLab dataset that can be used for training an emulator online.

Note that instantiating a dataset object locally does not create a new dataset on the twinLab cloud. Instead, it can be used either to interact with an existing dataset that has been uploaded to the cloud or as a precursor step to uploading a new dataset.

Parameters:

id (str) – Name of the dataset.

Example

dataset = tl.Dataset("my_dataset")
__init__(id, project='personal', project_owner=None)[source]#

Methods

__init__(id[, project, project_owner])

analyse_input_variance(columns[, verbose])

analyse_output_variance(columns[, verbose])

analyse_variance(columns[, verbose])

Return an analysis of the variance retained per dimension after performing singular value decomposition (SVD) on the dataset.

append(df[, verbose])

Append new data to an existing dataset in the twinLab cloud.

delete([verbose])

Delete a dataset that was previously uploaded to the twinLab cloud.

lock([verbose])

Lock a dataset that was previously uploaded to the twinLab cloud.

summarise([verbose])

Show summary statistics for a dataset that exists on the twinLab cloud.

unlock([verbose])

Unlock a dataset that was previously uploaded to the twinLab cloud.

upload(df[, verbose])

Upload a dataset to the twinLab cloud so that it can be queried and used for training.

view([verbose])

View (and download) a dataset that exists on the twinLab cloud.