Source code for simpleml.transformers.base_transformer

[docs]__author__ = "Elisha Yadgaran"


from typing import Any, Dict, List, Optional

from sklearn.base import TransformerMixin as SklearnTransformerMixin


[docs]class TransformerMixin(SklearnTransformerMixin):
    """
    Base Transformer class that implements all the necessary methods

    Default behavior is to do nothing - overwrite later
    """

[docs]    object_type: str = "TRANSFORMER"

[docs]    def reset(self) -> None:
        """
        Flag to reset state to initialized values. Expects subclasses to implement
        """
        raise NotImplementedError

[docs]    def fit(self, X: Any, y: Optional[Any] = None, **kwargs):
        return self

[docs]    def partial_fit(self, X: Any, y: Optional[Any] = None, **kwargs):
        raise NotImplementedError

[docs]    def transform(self, X: Any, y: Optional[Any] = None, **kwargs) -> Any:
        return X

[docs]    def get_params(self, **kwargs) -> Dict[str, Any]:
        """
        Should only return seeding parameters, not fit ones
        (ie params of unfit object should be identical to fit object)
        """
        return {}

[docs]    def set_params(self, **kwargs) -> None:
        pass

[docs]    def get_feature_names(self, input_feature_names: List[str]) -> List[str]:
        return input_feature_names


[docs]class Transformer(TransformerMixin):
    """
    Base Transformer class with param management - Can interfere with mro
    if used as a mixin - Use `TransformerMixin` in that case
    """

    def __init__(self, **kwargs):
        """
        Assumes only seeding kwargs passed - will affect hash otherwise
        if random unused parameters are passed
        """
        self.params: Dict[str, Any] = kwargs

[docs]    def get(self, param: str) -> Any:
        return self.params.get(param)

[docs]    def get_params(self, **kwargs) -> Dict[str, Any]:
        """
        Should only return seeding parameters, not fit ones
        (ie params of unfit object should be identical to fit object)
        """
        return self.params

[docs]    def set_params(self, **kwargs) -> None:
        self.params.update(kwargs)