Source code for foreshadow.intents.categorical

"""Categorical intent."""

from foreshadow.metrics import (
    MetricWrapper,
    is_numeric,
    num_valid,
    unique_heur,
)
from foreshadow.utils import standard_col_summary

from .base import BaseIntent


# Due to pickling issue in Parallel process, the lambda x: 1 needs to be
# rewritten as a public method.
def return_one(X):  # noqa: D401
    """Method that always return 1.

    Args:
        X: input data frame

    Returns:
        the value 1

    """
    return 1


class Categoric(BaseIntent):
    """Defines a categoric column type."""

    confidence_computation = {
        MetricWrapper(num_valid): 0.25,
        MetricWrapper(unique_heur): 0.65,
        MetricWrapper(is_numeric, invert=True): 0.1,
        # MetricWrapper(return_one): (1 / 4),
    }

    def fit(self, X, y=None, **fit_params):
        """Empty fit.

        Args:
            X: The input data
            y: The response variable
            **fit_params: Additional parameters for the fit

        Returns:
            self

        """
        return self

    def transform(self, X, y=None):
        """Pass-through transform.

        Args:
            X: The input data
            y: The response variable

        Returns:
            The input column

        """
        return X

    @classmethod
    def column_summary(cls, df):  # noqa
        return standard_col_summary(df)