gw.training.train_builders.build_dataset
gw.training.train_builders.build_dataset(
data_settings,
leave_waveforms_on_disk=False,
)Build a dataset based on a settings dictionary. This should contain the path of a saved waveform dataset.
This function also truncates the dataset as necessary.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| data_settings | dict | required | |
| leave_waveforms_on_disk | Optional[bool] | If provided, the values associated with the waveforms will not be loaded into memory during initialization. Instead, they will be loaded from disk when the dataset is accessed. This is useful for reducing the memory load of large datasets, but can slow down data preprocessing. | False |
Returns
| Name | Type | Description |
|---|---|---|
| WaveformDataset |