twinlab.Dataset.analyse_variance#

Dataset.analyse_variance(columns, verbose=False)[source]#

Return an analysis of the variance retained per dimension.

Parameters:
  • columns (list[str]) – List of columns to evaluate. This would usually be either the set of input or output columns.

  • verbose (bool, optional) – Display information about the operation while running.

Return type:

DataFrame

Returns:

pandas.Dataframe containing the variance analysis.

Example

dataset = tl.Dataset("quickstart")
dataset.analyse_variance(columns=["x", "y"]) # Usually the columns would be either input or output
   Number of Dimensions  Cumulative Variance
0                     0             0.000000
1                     1             0.925741
2                     2             1.000000