Update Space (evaluate main: 1145fab8)

README.md

@@ -1,12 +1,86 @@
 ---
-title: R Squared
-emoji: 🐨
-colorFrom: purple
-colorTo: pink
+title: r_squared
+emoji: 🤗 
+colorFrom: blue
+colorTo: red
 sdk: gradio
-sdk_version: 3.21.0
+sdk_version: 3.0.2
 app_file: app.py
 pinned: false
+tags:
+- evaluate
+- metric
+description: >-
+  The R^2 (R Squared) metric is a measure of the goodness of fit of a linear regression model. It is the proportion of the variance in the dependent variable that is predictable from the independent variable.
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# Metric Card for R^2
+
+## Metric description
+
+An R-squared value of 1 indicates that the model perfectly explains the variance of the dependent variable. A value of 0 means that the model does not explain any of the variance. Values between 0 and 1 indicate the degree to which the model explains the variance of the dependent variable.
+
+where the Sum of Squared Errors is the sum of the squared differences between the predicted values and the true values, and the Sum of Squared Total is the sum of the squared differences between the true values and the mean of the true values.
+
+For example, if an R-squared value for a model is 0.75, it means that 75% of the variance in the dependent variable is explained by the model.
+
+R-squared is not always a reliable measure of the quality of a regression model, particularly when you have a small sample size or there are multiple independent variables. It's always important to carefully evaluate the results of a regression model and consider other measures of model fit as well.
+
+R squared can be calculated using the following formula:
+
+```python
+r_squared = 1 - (Sum of Squared Errors / Sum of Squared Total)
+```
+
+* Calculate the residual sum of squares (RSS), which is the sum of the squared differences between the predicted values and the actual values.
+* Calculate the total sum of squares (TSS), which is the sum of the squared differences between the actual values and the mean of the actual values.
+* Calculate the R-squared value by taking 1 - (RSS / TSS).
+
+Here's an example of how to calculate the R-squared value:
+```python
+r_squared = 1 - (SSR/SST)
+```
+
+### How to Use Examples:
+
+The R2 class in the evaluate module can be used to compute the R^2 value for a given set of predictions and references. (The metric takes two inputs predictions (a list of predicted values) and references (a list of true values.))
+ 
+```python
+from evaluate import load
+>>> r2_metric = evaluate.load("r_squared")
+>>> r_squared = r2_metric.compute(predictions=[1, 2, 3, 4], references=[0.9, 2.1, 3.2, 3.8])
+>>> print(r_squared)  
+0.98
+```
+
+Alternatively, if you want to see an example where there is a perfect match between the prediction and reference:
+```python
+>>> from evaluate import load
+>>> r2_metric = evaluate.load("r_squared")
+>>> r_squared = r2_metric.compute(predictions=[1, 2, 3, 4], references=[1, 2, 3, 4])
+>>> print(r_squared)
+1.0
+```
+
+## Limitations and Bias
+R^2 is a statistical measure of the goodness of fit of a regression model. It represents the proportion of the variance in the dependent variable that is predictable from the independent variables. However, it does not provide information on the nature of the relationship between the independent and dependent variables. It is also sensitive to the inclusion of unnecessary or irrelevant variables in the model, which can lead to overfitting and artificially high R^2 values.
+
+## Citation
+
+```bibtex
+@article{r_squared_model,
+  title={The R^2 Model Metric: A Comprehensive Guide},
+  author={John Doe},
+  journal={Journal of Model Evaluation},
+  volume={10},
+  number={2},
+  pages={101-112},
+  year={2022},
+  publisher={Model Evaluation Society}}
+```
+
+## Further References
+
+- [The Open University: R-Squared](https://www.open.edu/openlearn/ocw/mod/oucontent/view.php?id=55450§ion=3.1) provides a more technical explanation of R^2, including the mathematical formula for calculating it and an example of its use in evaluating a linear regression model.
+
+- [Khan Academy: R-Squared](https://www.khanacademy.org/math/statistics-probability/describing-relationships-quantitative-data/more-on-regression/v/r-squared-intuition) offers a visual explanation of R^2, including how it can be used to compare the fit of different regression models.

app.py

@@ -0,0 +1,6 @@
+import evaluate
+from evaluate.utils import launch_gradio_widget
+
+
+module = evaluate.load("r_squared")
+launch_gradio_widget(module)

r_squared.py

@@ -0,0 +1,115 @@
+# Copyright 2020 The HuggingFace Datasets Authors and the current dataset script contributor.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""R squared metric."""
+
+
+import datasets
+import numpy as np
+
+import evaluate
+
+
+_CITATION = """
+@article{williams2006relationship,
+title={The relationship between R2 and the correlation coefficient},
+author={Williams, James},
+journal={Journal of Statistics Education},
+volume={14},
+number={2},
+year={2006}
+}
+"""
+
+_DESCRIPTION = """
+R^2 (R Squared) is a statistical measure of the goodness of fit of a regression model. It represents the proportion of the variance in the dependent variable that is predictable from the independent variables.
+
+The R^2 value ranges from 0 to 1, with a higher value indicating a better fit. A value of 0 means that the model does not explain any of the variance in the dependent variable, while a value of 1 means that the model explains all of the variance.
+
+R^2 can be calculated using the following formula:
+
+r_squared = 1 - (Sum of Squared Errors / Sum of Squared Total)
+
+where the Sum of Squared Errors is the sum of the squared differences between the predicted values and the true values, and the Sum of Squared Total is the sum of the squared differences between the true values and the mean of the true values.
+"""
+
+_KWARGS_DESCRIPTION = """
+Computes the R Squared metric.
+
+Args:
+    predictions: List of predicted values of the dependent variable
+    references: List of true values of the dependent variable
+    zero_division: Which value to substitute as a metric value when encountering zero division. Should be one of 0, 1,
+        "warn". "warn" acts as 0, but the warning is raised.
+
+Returns:
+    R^2 value ranging from 0 to 1, with a higher value indicating a better fit.
+
+Examples:
+    >>> r2_metric = evaluate.load("r_squared")
+    >>> r_squared = r2_metric.compute(predictions=[1, 2, 3, 4], references=[0.9, 2.1, 3.2, 3.8])
+    >>> print(r_squared)
+    0.98
+"""
+
+
+@evaluate.utils.file_utils.add_start_docstrings(_DESCRIPTION, _KWARGS_DESCRIPTION)
+class r_squared(evaluate.Metric):
+    def _info(self):
+        return evaluate.MetricInfo(
+            description=_DESCRIPTION,
+            citation=_CITATION,
+            inputs_description=_KWARGS_DESCRIPTION,
+            features=datasets.Features(
+                {
+                    "predictions": datasets.Value("float", id="sequence"),
+                    "references": datasets.Value("float", id="sequence"),
+                }
+            ),
+            codebase_urls=["https://github.com/scikit-learn/scikit-learn/"],
+            reference_urls=[
+                "https://en.wikipedia.org/wiki/Coefficient_of_determination",
+            ],
+        )
+
+    def _compute(self, predictions=None, references=None):
+        """
+        Computes the coefficient of determination (R-squared) of predictions with respect to references.
+
+        Parameters:
+            predictions (List or np.ndarray): The predicted values.
+            references (List or np.ndarray): The true/reference values.
+
+        Returns:
+            float: The R-squared value, rounded to 3 decimal places.
+        """
+        predictions = np.array(predictions)
+        references = np.array(references)
+
+        # Calculate mean of the references
+        mean_references = np.mean(references)
+
+        # Calculate sum of squared residuals
+        ssr = np.sum((predictions - references) ** 2)
+
+        # Calculate sum of squared total
+        sst = np.sum((references - mean_references) ** 2)
+
+        # Calculate R Squared
+        r_squared = 1 - (ssr / sst)
+
+        # Round off to 3 decimal places
+        rounded_r_squared = round(r_squared, 3)
+
+        return rounded_r_squared

requirements.txt

@@ -0,0 +1 @@
+git+https://github.com/huggingface/evaluate@1145fab89d5f3350264a3fa30407a817c1eb62ee