shap.datasets.rank

shap.datasets.rank() → tuple[ssp.csr_matrix, np.ndarray, ssp.csr_matrix, np.ndarray, np.ndarray, np.ndarray]

Return ranking datasets from the LightGBM repository.

Used in ranking tasks.

Returns:

x_trainscipy.sparse.csr_matrix

Training feature matrix.

y_trainnumpy.ndarray

Training labels.

x_testscipy.sparse.csr_matrix

Testing feature matrix.

y_testnumpy.ndarray

Testing labels.

q_trainnumpy.ndarray

Training query information.

q_testnumpy.ndarray

Testing query information.

Notes

Data Source: LightGBM repository https://github.com/lightgbm-org/LightGBM/tree/master/examples/lambdarank

Examples

x_train, y_train, x_test, y_test, q_train, q_test = shap.datasets.rank()