ogboost.load_wine_quality

ogboost.load_wine_quality(return_X_y=False, shift_y=True)[source]

Loads the wine quality dataset from the UCI repository. If the datasets are not already downloaded, they will be downloaded automatically.

The function loads both the red and white wine datasets into pandas DataFrames. If shift_y is True (default), the ‘quality’ column is rescaled so that it starts from 0, matching OGBoost’s convention. If False, the original quality values are retained.

Parameters:

  • return_X_y (bool, default=False) – If True, returns separate feature matrices (X) and target vectors (y) for both red and white wine datasets, i.e. (X_red, y_red, X_white, y_white). If False (default), returns the two full DataFrames instead, i.e. (red_wine_df, white_wine_df).

  • shift_y (bool, default=True) – If True, shift the ‘quality’ column such that the minimum quality is 0. If False, the ‘quality’ values are not altered.

Returns:

tuple –

If return_X_y is False, returns:

(red_wine_df, white_wine_df) : Two pandas DataFrames.

If return_X_y is True, returns:

(X_red, y_red, X_white, y_white) : Feature matrices and target vectors.