r_square

improvelib.metrics.r_square(y_true, y_pred)

Compute R2 Coefficient. Uses sklearn.metrics.r2_score().

Used in compute_metrics and can be used directly.

Parameters:

y_truenp.ndarray

Ground truth.

y_prednp.ndarray

Predictions made by the model.

Returns:

r2float

The computed R2.

Example

This function is called by compute_metrics which is called by compute_performance_scores, which also saves the scores.

You can use this function directly, for example during model training like so:

import improvelib.metrics as metr
r2_to_monitor = metr.r_square(y_true, y_pred)