From e8fe0fb3b33c93f97a02caea9be0d92474ce337c Mon Sep 17 00:00:00 2001
From: Brian Wylie <briford.wylie@gmail.com>
Date: Sat, 28 Dec 2024 17:44:03 -0700
Subject: [PATCH] adding a feature quality view (not complete)

---
 src/workbench/core/views/fq_view.py | 142 ++++++++++++++++++++++++++++
 1 file changed, 142 insertions(+)
 create mode 100644 src/workbench/core/views/fq_view.py

diff --git a/src/workbench/core/views/fq_view.py b/src/workbench/core/views/fq_view.py
new file mode 100644
index 000000000..530eaefcd
--- /dev/null
+++ b/src/workbench/core/views/fq_view.py
@@ -0,0 +1,142 @@
+"""FQView Class: A View that computes various FeatureSet quality metrics"""
+
+from typing import Union
+import pandas as pd
+
+# Workbench Imports
+from workbench.api import FeatureSet, Model, Endpoint
+from workbench.core.views.view import View
+from workbench.core.views.pandas_to_view import PandasToView
+from workbench.algorithms.dataframe.row_tagger import RowTagger
+from workbench.algorithms.dataframe.residuals_calculator import ResidualsCalculator
+
+
+class FQView:
+    """FQView Class: A View that computes various FeatureSet quality metrics
+
+    Common Usage:
+        ```python
+        # Grab a FeatureSet and an Endpoint
+        fs = FeatureSet("abalone_features")
+        endpoint = Endpoint("abalone-regression-end")
+
+        # Create a ModelDataQuality View
+        mdq_view = FQView.create(fs, endpoint=endpoint, id_column="id")
+        my_df = mdq_view.pull_dataframe(head=True)
+
+        # Query the view
+        df = mdq_view.query(f"SELECT * FROM {mdq_view.table} where residuals > 0.5")
+        ```
+    """
+
+    @classmethod
+    def create(
+        cls,
+        fs: FeatureSet,
+        endpoint: Endpoint,
+        id_column: str,
+        use_reference_model: bool = False,
+    ) -> Union[View, None]:
+        """Create a Model Data Quality View with metrics
+
+        Args:
+            fs (FeatureSet): The FeatureSet object
+            endpoint (Endpoint): The Endpoint object to use for the target and features
+            id_column (str): The name of the id column (must be defined for join logic)
+            use_reference_model (bool): Use the reference model for inference (default: False)
+
+        Returns:
+            Union[View, None]: The created View object (or None if failed)
+        """
+        # Log view creation
+        fs.log.important("Creating Model Data Quality View...")
+
+        # Get the target and feature columns from the endpoints model input
+        model_input = Model(endpoint.get_input())
+        target = model_input.target()
+        features = model_input.features()
+
+        # Pull in data from the source table
+        df = fs.data_source.query(f"SELECT * FROM {fs.data_source.uuid}")
+
+        # Check if the target and features are available in the data source
+        missing_columns = [col for col in [target] + features if col not in df.columns]
+        if missing_columns:
+            fs.log.error(f"Missing columns in data source: {missing_columns}")
+            return None
+
+        # Check if the target is categorical
+        categorical_target = not pd.api.types.is_numeric_dtype(df[target])
+
+        # Compute row tags with RowTagger
+        row_tagger = RowTagger(
+            df,
+            features=features,
+            id_column=id_column,
+            target_column=target,
+            within_dist=0.25,
+            min_target_diff=1.0,
+            outlier_df=fs.data_source.outliers(),
+            categorical_target=categorical_target,
+        )
+        mdq_df = row_tagger.tag_rows()
+
+        # Rename and compute data quality scores based on tags
+        mdq_df.rename(columns={"tags": "data_quality_tags"}, inplace=True)
+
+        # We're going to compute a data_quality score based on the tags.
+        mdq_df["data_quality"] = mdq_df["data_quality_tags"].apply(cls.calculate_data_quality)
+
+        # Compute residuals using ResidualsCalculator
+        if use_reference_model:
+            residuals_calculator = ResidualsCalculator()
+        else:
+            residuals_calculator = ResidualsCalculator(endpoint=endpoint)
+        residuals_df = residuals_calculator.fit_transform(df[features], df[target])
+
+        # Add id_column to the residuals dataframe and merge with mdq_df
+        residuals_df[id_column] = df[id_column]
+
+        # Drop overlapping columns in mdq_df (except for the id_column) to avoid _x and _y suffixes
+        overlap_columns = [col for col in residuals_df.columns if col in mdq_df.columns and col != id_column]
+        mdq_df = mdq_df.drop(columns=overlap_columns)
+
+        # Merge the DataFrames, with the id_column as the join key
+        mdq_df = mdq_df.merge(residuals_df, on=id_column, how="left")
+
+        # Delegate view creation to PandasToView
+        view_name = "mdq_ref" if use_reference_model else "mdq"
+        return PandasToView.create(view_name, fs, df=mdq_df, id_column=id_column)
+
+    @staticmethod
+    def calculate_data_quality(tags):
+        score = 1.0  # Start with the default score
+        if "coincident" in tags:
+            score -= 1.0
+        if "htg" in tags:
+            score -= 0.5
+        if "outlier" in tags:
+            score -= 0.25
+        score = max(0.0, score)
+        return score
+
+
+if __name__ == "__main__":
+    """Exercise the FQView functionality"""
+    from workbench.api import FeatureSet, Endpoint
+
+    # Get the FeatureSet
+    my_fs = FeatureSet("abalone_features")
+
+    # Grab the Endpoint
+    my_endpoint = Endpoint("abalone-regression-end")
+
+    # Create a FQView
+    mdq_view = FQView.create(my_fs, endpoint=my_endpoint, id_column="id")
+
+    # Pull the data quality dataframe
+    my_df = mdq_view.pull_dataframe(head=True)
+    print(my_df)
+
+    # Query the view
+    df = mdq_view.query(f"SELECT * FROM {mdq_view.table} where residuals > 0.5")