verticapy.machine_learning.metrics.r2_score#
- verticapy.machine_learning.metrics.r2_score(y_true: str, y_score: str, input_relation: str | vDataFrame, k: int = 0, adj: bool = True) float #
Computes the R2 score.
Parameters#
- y_true: str
Response column.
- y_score: str
Prediction.
- input_relation: SQLRelation
Relation to use for scoring. This relation can be a view, table, or a customized relation (if an alias is used at the end of the relation). For example: (SELECT … FROM …) x
- k: int, optional
Number of predictors. Only used to compute the adjusted R2.
- adj: bool, optional
If set to True, computes the adjusted R2.
Returns#
- float
score.
Examples#
We should first import verticapy.
import verticapy as vp
Let’s create a small dataset that has:
true value
predicted value
data = vp.vDataFrame( { "y_true": [1, 1.5, 3, 2, 5], "y_pred": [1.1, 1.55, 2.9, 2.01, 4.5], } )
Next, we import the metric:
from verticapy.machine_learning.metrics import r2_score
Now we can conveniently calculate the score:
r2_score( y_true = "y_true", y_score = "y_pred", input_relation = data, ) Out[4]: 0.97274
It is also possible to directly compute the score from the vDataFrame:
data.score( y_true = "y_true", y_score = "y_pred", metric = "r2", ) Out[5]: 0.97274
Note
VerticaPy uses simple SQL queries to compute various metrics. You can use the
set_option()
function with thesql_on
parameter to enable SQL generation and examine the generated queries.See also
vDataFrame.
score()
: Computes the input ML metric.