Input/Output#

Dataset#

A dataset is a unit that consists of data payload and metadata.

Presently, whatif stores a dataset as a directory layout:

dataset_name/
|-- metadata.yaml
`-- data.csv

and loads the dataset into a a2rl.WiDataFrame.

In future, whatif may add additional implementations to support different storage layout.

list_sample_datasets

List the name of sample datasets included in whatif.

read_csv_dataset

Read a dataset directory into a a2rl.WiDataFrame.

sample_dataset_path

Resolve the path to the sample dataset.

Metadata#

The metadata API is primarily intended for whatif developers.

Metadata

Metadata of a Whatif dataframe or dataset.

read_metadata

Load a YAML file into an in-memory metadata object.

save_metadata

Save an in-memory metadata object into a YAML file.