Base Datasets¶
Base datasets for Vanguard.
For the ease of the user, Vanguard contains a number of datasets commonly referenced in examples, and used in tests. The dataset instances allow for easy access to the training and testing data through attributes.
- class vanguard.datasets.basedataset.Dataset(train_x, train_x_std, train_y, train_y_std, test_x, test_x_std, test_y, test_y_std, significance)[source]¶
Represents an experimental dataset used by Vanguard.
- Parameters:
train_x (
Union[ndarray[tuple[Any,...],dtype[floating]],Tensor]) – The training inputs.train_x_std (
Union[float,ndarray[tuple[Any,...],dtype[floating]],Tensor]) – The standard deviation(s) of the training inputs.train_y (
Union[ndarray[tuple[Any,...],dtype[floating]],ndarray[tuple[Any,...],dtype[integer]],Tensor]) – The training outputs.train_y_std (
Union[float,ndarray[tuple[Any,...],dtype[floating]],Tensor]) – The standard deviation(s) of the training outputs.test_x (
Union[ndarray[tuple[Any,...],dtype[floating]],Tensor]) – The test inputs.test_x_std (
Union[float,ndarray[tuple[Any,...],dtype[floating]],Tensor]) – The standard deviation(s) of the test inputs.test_y (
Union[ndarray[tuple[Any,...],dtype[floating]],ndarray[tuple[Any,...],dtype[integer]],Tensor]) – The test outputs.test_y_std (
Union[float,ndarray[tuple[Any,...],dtype[floating]],Tensor]) – The standard deviation(s) of the test outputs.significance (
float) – The recommended significance value to be used for confidence intervals. Note that this value does not necessarily have any bearing on the data.
- __init__(train_x, train_x_std, train_y, train_y_std, test_x, test_x_std, test_y, test_y_std, significance)[source]¶
Initialise self.
- Parameters:
train_x (
Union[ndarray[tuple[Any,...],dtype[floating]],Tensor])train_x_std (
Union[float,ndarray[tuple[Any,...],dtype[floating]],Tensor])train_y (
Union[ndarray[tuple[Any,...],dtype[floating]],ndarray[tuple[Any,...],dtype[integer]],Tensor])train_y_std (
Union[float,ndarray[tuple[Any,...],dtype[floating]],Tensor])test_x (
Union[ndarray[tuple[Any,...],dtype[floating]],Tensor])test_x_std (
Union[float,ndarray[tuple[Any,...],dtype[floating]],Tensor])test_y (
Union[ndarray[tuple[Any,...],dtype[floating]],ndarray[tuple[Any,...],dtype[integer]],Tensor])test_y_std (
Union[float,ndarray[tuple[Any,...],dtype[floating]],Tensor])significance (
float)