Skip to content

ModelDataQuality View

Experimental

The SageWorks View classes are currently in experimental mode so have fun but expect issues and API changes going forward.

MDQView Class: A View that computes various endpoint data quality metrics

MDQView

MDQView Class: A View that computes various endpoint data quality metrics

Common Usage 
# Grab a FeatureSet and an Endpoint
fs = FeatureSet("abalone_features")
endpoint = Endpoint("abalone-regression-end")

# Create a ModelDataQuality View
mdq_view = MDQView.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")
Source code in src/sageworks/core/views/mdq_view.py 
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
class MDQView:
    """MDQView Class: A View that computes various endpoint data 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 = MDQView.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

create(fs, endpoint, id_column, use_reference_model=False) classmethod

Create a Model Data Quality View with metrics

Parameters:

Name Type Description Default
fs FeatureSet

The FeatureSet object

 required
endpoint Endpoint

The Endpoint object to use for the target and features

 required
id_column str

The name of the id column (must be defined for join logic)

 required
use_reference_model bool

Use the reference model for inference (default: False)

 False

Returns:

Type Description
Union[View, None]

Union[View, None]: The created View object (or None if failed)
Source code in src/sageworks/core/views/mdq_view.py 
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
@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)

Questions?

The SuperCowPowers team is happy to answer any questions you may have about AWS and SageWorks. Please contact us at sageworks@supercowpowers.com or on chat us up on Discord