Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dataframe compatibility for transformers #34

Merged
merged 6 commits into from
Jun 7, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 2 additions & 15 deletions src/sknnr/_base.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
import warnings
from contextlib import contextmanager
from typing import Literal

import numpy as np
from sklearn.base import BaseEstimator
from sklearn.neighbors import KNeighborsRegressor
from sklearn.utils.validation import _get_feature_names, check_is_fitted

from .transformers._base import set_temp_output


class IDNeighborsRegressor(KNeighborsRegressor):
"""
Expand Down Expand Up @@ -80,15 +79,3 @@ def kneighbors(self, X=None, n_neighbors=None, return_distance=True):
return super().kneighbors(
X=X_transformed, n_neighbors=n_neighbors, return_distance=return_distance
)


@contextmanager
def set_temp_output(estimator: BaseEstimator, temp_mode: Literal["default", "pandas"]):
"""Temporarily set the output mode of an estimator."""
previous_config = getattr(estimator, "_sklearn_output_config", {}).copy()

estimator.set_output(transform=temp_mode)
try:
yield
finally:
estimator._sklearn_output_config = previous_config
18 changes: 18 additions & 0 deletions src/sknnr/transformers/_base.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
from contextlib import contextmanager
from typing import Literal

import numpy as np
from sklearn.base import TransformerMixin
from sklearn.preprocessing import StandardScaler


Expand All @@ -11,3 +15,17 @@ def fit(self, X, y=None, sample_weight=None):
scaler = super().fit(X, y, sample_weight)
scaler.scale_ = np.std(np.asarray(X), axis=0, ddof=self.ddof)
return scaler


@contextmanager
def set_temp_output(
transformer: TransformerMixin, temp_mode: Literal["default", "pandas"]
):
"""Temporarily set the output mode of an transformer."""
aazuspan marked this conversation as resolved.
Show resolved Hide resolved
previous_config = getattr(transformer, "_sklearn_output_config", {}).copy()

transformer.set_output(transform=temp_mode)
try:
yield
finally:
transformer._sklearn_output_config = previous_config
2 changes: 2 additions & 0 deletions src/sknnr/transformers/_ccora_transformer.py
aazuspan marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import numpy as np
from sklearn.base import BaseEstimator, TransformerMixin
from sklearn.utils.validation import check_is_fitted

from . import StandardScalerWithDOF
from ._ccora import CCorA
Expand All @@ -24,6 +25,7 @@ def fit(self, X, y):
return self

def transform(self, X, y=None):
check_is_fitted(self)
return self.scaler_.transform(X) @ self.ccora_.projector

def fit_transform(self, X, y):
Expand Down
2 changes: 2 additions & 0 deletions src/sknnr/transformers/_mahalanobis_transformer.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import numpy as np
from sklearn.base import BaseEstimator, OneToOneFeatureMixin, TransformerMixin
from sklearn.utils.validation import check_is_fitted

from . import StandardScalerWithDOF

Expand All @@ -14,6 +15,7 @@ def fit(self, X, y=None):
return self

def transform(self, X, y=None):
check_is_fitted(self)
return self.scaler_.transform(X) @ self.transform_

def fit_transform(self, X, y=None):
Expand Down
2 changes: 1 addition & 1 deletion tests/test_transformers.py
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ def test_set_temp_output(moscow_euclidean, config_type):
transformer.set_output(transform="pandas")

# Temp output mode should override previously set config
with set_temp_output(estimator=transformer, temp_mode="default"):
with set_temp_output(transformer=transformer, temp_mode="default"):
assert isinstance(transformer.transform(moscow_euclidean.X), np.ndarray)

# Previous config should be restored
Expand Down