From 1605ff8ba1a68f46d7b0a3e86940bd9535d4783e Mon Sep 17 00:00:00 2001 From: Soledad Galli Date: Thu, 18 Aug 2022 17:45:46 +0200 Subject: [PATCH 1/2] refactor docstrings --- feature_engine/_docstrings/class_inputs.py | 15 ------------ .../init_parameters.py} | 23 +++++++++++++++---- feature_engine/_docstrings/methods.py | 5 ++++ .../combine_with_reference_feature.py | 8 +++---- feature_engine/creation/cyclical.py | 8 +++---- feature_engine/creation/cyclical_features.py | 8 +++---- feature_engine/creation/math_features.py | 8 +++---- .../creation/mathematical_combination.py | 8 +++---- feature_engine/creation/relative_features.py | 10 ++++---- .../discretisation/decision_tree.py | 2 +- .../discretisation/equal_frequency.py | 2 +- feature_engine/discretisation/equal_width.py | 2 +- feature_engine/encoding/base_encoder.py | 10 ++++---- feature_engine/encoding/count_frequency.py | 10 ++++---- feature_engine/encoding/decision_tree.py | 6 ++--- feature_engine/encoding/mean_encoding.py | 10 ++++---- feature_engine/encoding/one_hot.py | 8 +++---- feature_engine/encoding/ordinal.py | 10 ++++---- feature_engine/encoding/probability_ratio.py | 10 ++++---- feature_engine/encoding/rare_label.py | 8 +++---- feature_engine/encoding/woe.py | 10 ++++---- feature_engine/outliers/artbitrary.py | 12 +++++----- feature_engine/outliers/trimmer.py | 8 +++---- feature_engine/outliers/winsorizer.py | 8 +++---- .../preprocessing/match_categories.py | 12 +++++----- .../forecasting/base_forecast_transformers.py | 8 +++---- .../forecasting/expanding_window_features.py | 11 +++++---- .../timeseries/forecasting/lag_features.py | 10 ++++---- .../timeseries/forecasting/window_features.py | 10 ++++---- feature_engine/transformation/arcsin.py | 2 +- feature_engine/transformation/boxcox.py | 2 +- feature_engine/transformation/log.py | 12 +++++----- feature_engine/transformation/power.py | 13 ++++++----- feature_engine/transformation/reciprocal.py | 12 +++++----- feature_engine/transformation/yeojohnson.py | 2 +- 35 files changed, 154 insertions(+), 149 deletions(-) delete mode 100644 feature_engine/_docstrings/class_inputs.py rename feature_engine/{encoding/_docstrings.py => _docstrings/init_parameters.py} (56%) diff --git a/feature_engine/_docstrings/class_inputs.py b/feature_engine/_docstrings/class_inputs.py deleted file mode 100644 index ad7678b4d..000000000 --- a/feature_engine/_docstrings/class_inputs.py +++ /dev/null @@ -1,15 +0,0 @@ -_variables_numerical_docstring = """variables: list, default=None - The list of numerical variables to transform. If None, the transformer will - automatically find and select all numerical variables. - """.rstrip() - -_drop_original_docstring = """drop_original: bool, default=False - If True, the original variables to transform will be dropped from the dataframe. - """.rstrip() - -_missing_values_docstring = """missing_values: string, default='raise' - Indicates if missing values should be ignored or raised. If 'raise' the - transformer will return an error if the the datasets to `fit` or `transform` - contain missing values. If 'ignore', missing data will be ignored when learning - parameters or performing the transformation. - """.rstrip() diff --git a/feature_engine/encoding/_docstrings.py b/feature_engine/_docstrings/init_parameters.py similarity index 56% rename from feature_engine/encoding/_docstrings.py rename to feature_engine/_docstrings/init_parameters.py index 654ac01d2..f166f8b85 100644 --- a/feature_engine/encoding/_docstrings.py +++ b/feature_engine/_docstrings/init_parameters.py @@ -1,4 +1,21 @@ -_variables_docstring = """variables: list, default=None +_variables_numerical_docstring = """variables: list, default=None + The list of numerical variables to transform. If None, the transformer will + automatically find and select all numerical variables. + """.rstrip() + +_drop_original_docstring = """drop_original: bool, default=False + If True, the original variables to transform will be dropped from the dataframe. + """.rstrip() + +_missing_values_docstring = """missing_values: string, default='raise' + Indicates if missing values should be ignored or raised. If 'raise' the + transformer will return an error if the the datasets to `fit` or `transform` + contain missing values. If 'ignore', missing data will be ignored when learning + parameters or performing the transformation. + """.rstrip() + +# used in categorical encoders +_variables_categorical_docstring = """variables: list, default=None The list of categorical variables that will be encoded. If None, the encoder will find and transform all variables of type object or categorical by default. You can also make the transformer accept numerical variables, see the @@ -19,7 +36,3 @@ error. If 'ignore', then unseen categories will be set as NaN and a warning will be raised instead. """.rstrip() - -_transform_docstring = """transform: - Encode the categories to numbers. - """.rstrip() diff --git a/feature_engine/_docstrings/methods.py b/feature_engine/_docstrings/methods.py index bdfb1af81..97c99e409 100644 --- a/feature_engine/_docstrings/methods.py +++ b/feature_engine/_docstrings/methods.py @@ -36,3 +36,8 @@ _inverse_transform_docstring = """inverse_transform: Convert the data back to the original representation. """.rstrip() + +# used in categorical encoders +_transform_encoders_docstring = """transform: + Encode the categories to numbers. + """.rstrip() diff --git a/feature_engine/creation/combine_with_reference_feature.py b/feature_engine/creation/combine_with_reference_feature.py index cfe6b5ad9..8b1355153 100644 --- a/feature_engine/creation/combine_with_reference_feature.py +++ b/feature_engine/creation/combine_with_reference_feature.py @@ -5,10 +5,6 @@ from sklearn.utils import deprecated from sklearn.utils.validation import check_is_fitted -from feature_engine._docstrings.class_inputs import ( - _drop_original_docstring, - _missing_values_docstring, -) from feature_engine._docstrings.fit_attributes import ( _feature_names_in_docstring, _n_features_in_docstring, @@ -17,6 +13,10 @@ _fit_not_learn_docstring, _fit_transform_docstring, ) +from feature_engine._docstrings.init_parameters import ( + _drop_original_docstring, + _missing_values_docstring, +) from feature_engine._docstrings.substitute import Substitution from feature_engine._variable_handling.variable_type_selection import ( _find_or_check_numerical_variables, diff --git a/feature_engine/creation/cyclical.py b/feature_engine/creation/cyclical.py index 92b5ebd4b..6cc26d2ec 100644 --- a/feature_engine/creation/cyclical.py +++ b/feature_engine/creation/cyclical.py @@ -4,16 +4,16 @@ import pandas as pd from sklearn.utils import deprecated -from feature_engine._docstrings.class_inputs import ( - _drop_original_docstring, - _variables_numerical_docstring, -) from feature_engine._docstrings.fit_attributes import ( _feature_names_in_docstring, _n_features_in_docstring, _variables_attribute_docstring, ) from feature_engine._docstrings.methods import _fit_transform_docstring +from feature_engine._docstrings.init_parameters import ( + _variables_numerical_docstring, + _drop_original_docstring, +) from feature_engine._docstrings.substitute import Substitution from feature_engine._variable_handling.init_parameter_checks import ( _check_init_parameter_variables, diff --git a/feature_engine/creation/cyclical_features.py b/feature_engine/creation/cyclical_features.py index 5eab67239..644031125 100644 --- a/feature_engine/creation/cyclical_features.py +++ b/feature_engine/creation/cyclical_features.py @@ -4,16 +4,16 @@ import pandas as pd from sklearn.utils.validation import check_is_fitted -from feature_engine._docstrings.class_inputs import ( - _drop_original_docstring, - _variables_numerical_docstring, -) from feature_engine._docstrings.fit_attributes import ( _feature_names_in_docstring, _n_features_in_docstring, _variables_attribute_docstring, ) from feature_engine._docstrings.methods import _fit_transform_docstring +from feature_engine._docstrings.init_parameters import ( + _variables_numerical_docstring, + _drop_original_docstring, +) from feature_engine._docstrings.substitute import Substitution from feature_engine._variable_handling.init_parameter_checks import ( _check_init_parameter_variables, diff --git a/feature_engine/creation/math_features.py b/feature_engine/creation/math_features.py index 150e28fab..61eea543c 100644 --- a/feature_engine/creation/math_features.py +++ b/feature_engine/creation/math_features.py @@ -3,10 +3,6 @@ import pandas as pd from sklearn.utils.validation import check_is_fitted -from feature_engine._docstrings.class_inputs import ( - _drop_original_docstring, - _missing_values_docstring, -) from feature_engine._docstrings.fit_attributes import ( _feature_names_in_docstring, _n_features_in_docstring, @@ -15,6 +11,10 @@ _fit_not_learn_docstring, _fit_transform_docstring, ) +from feature_engine._docstrings.init_parameters import ( + _drop_original_docstring, + _missing_values_docstring, +) from feature_engine._docstrings.substitute import Substitution from feature_engine.creation.base_creation import BaseCreation diff --git a/feature_engine/creation/mathematical_combination.py b/feature_engine/creation/mathematical_combination.py index 3086e0b8a..c3a1b7d23 100644 --- a/feature_engine/creation/mathematical_combination.py +++ b/feature_engine/creation/mathematical_combination.py @@ -5,10 +5,6 @@ from sklearn.utils import deprecated from sklearn.utils.validation import check_is_fitted -from feature_engine._docstrings.class_inputs import ( - _drop_original_docstring, - _missing_values_docstring, -) from feature_engine._docstrings.fit_attributes import ( _feature_names_in_docstring, _n_features_in_docstring, @@ -17,6 +13,10 @@ _fit_not_learn_docstring, _fit_transform_docstring, ) +from feature_engine._docstrings.init_parameters import ( + _drop_original_docstring, + _missing_values_docstring, +) from feature_engine._docstrings.substitute import Substitution from feature_engine._variable_handling.variable_type_selection import ( _find_or_check_numerical_variables, diff --git a/feature_engine/creation/relative_features.py b/feature_engine/creation/relative_features.py index 8a82dc267..5314df170 100644 --- a/feature_engine/creation/relative_features.py +++ b/feature_engine/creation/relative_features.py @@ -3,11 +3,6 @@ import pandas as pd from sklearn.utils.validation import check_is_fitted -from feature_engine._docstrings.class_inputs import ( - _drop_original_docstring, - _missing_values_docstring, - _variables_numerical_docstring, -) from feature_engine._docstrings.fit_attributes import ( _feature_names_in_docstring, _n_features_in_docstring, @@ -16,6 +11,11 @@ _fit_not_learn_docstring, _fit_transform_docstring, ) +from feature_engine._docstrings.init_parameters import ( + _variables_numerical_docstring, + _drop_original_docstring, + _missing_values_docstring, +) from feature_engine._docstrings.substitute import Substitution from feature_engine._variable_handling.variable_type_selection import ( _find_or_check_numerical_variables, diff --git a/feature_engine/discretisation/decision_tree.py b/feature_engine/discretisation/decision_tree.py index 13050f1a6..bde8a3778 100644 --- a/feature_engine/discretisation/decision_tree.py +++ b/feature_engine/discretisation/decision_tree.py @@ -8,13 +8,13 @@ from sklearn.tree import DecisionTreeClassifier, DecisionTreeRegressor from sklearn.utils.multiclass import check_classification_targets, type_of_target -from feature_engine._docstrings.class_inputs import _variables_numerical_docstring from feature_engine._docstrings.fit_attributes import ( _feature_names_in_docstring, _n_features_in_docstring, _variables_attribute_docstring, ) from feature_engine._docstrings.methods import _fit_transform_docstring +from feature_engine._docstrings.init_parameters import _variables_numerical_docstring from feature_engine._docstrings.substitute import Substitution from feature_engine._variable_handling.init_parameter_checks import ( _check_init_parameter_variables, diff --git a/feature_engine/discretisation/equal_frequency.py b/feature_engine/discretisation/equal_frequency.py index 0c49be74f..f636a7833 100644 --- a/feature_engine/discretisation/equal_frequency.py +++ b/feature_engine/discretisation/equal_frequency.py @@ -5,13 +5,13 @@ import pandas as pd -from feature_engine._docstrings.class_inputs import _variables_numerical_docstring from feature_engine._docstrings.fit_attributes import ( _feature_names_in_docstring, _n_features_in_docstring, _variables_attribute_docstring, ) from feature_engine._docstrings.methods import _fit_transform_docstring +from feature_engine._docstrings.init_parameters import _variables_numerical_docstring from feature_engine._docstrings.substitute import Substitution from feature_engine._variable_handling.init_parameter_checks import ( _check_init_parameter_variables, diff --git a/feature_engine/discretisation/equal_width.py b/feature_engine/discretisation/equal_width.py index cbd2c9848..a96565641 100644 --- a/feature_engine/discretisation/equal_width.py +++ b/feature_engine/discretisation/equal_width.py @@ -5,13 +5,13 @@ import pandas as pd -from feature_engine._docstrings.class_inputs import _variables_numerical_docstring from feature_engine._docstrings.fit_attributes import ( _feature_names_in_docstring, _n_features_in_docstring, _variables_attribute_docstring, ) from feature_engine._docstrings.methods import _fit_transform_docstring +from feature_engine._docstrings.init_parameters import _variables_numerical_docstring from feature_engine._docstrings.substitute import Substitution from feature_engine._variable_handling.init_parameter_checks import ( _check_init_parameter_variables, diff --git a/feature_engine/encoding/base_encoder.py b/feature_engine/encoding/base_encoder.py index 95c4876ba..38c9b850a 100644 --- a/feature_engine/encoding/base_encoder.py +++ b/feature_engine/encoding/base_encoder.py @@ -19,10 +19,10 @@ _check_X_matches_training_df, check_X, ) -from feature_engine.encoding._docstrings import ( +from feature_engine._docstrings.init_parameters import ( + _variables_categorical_docstring, _ignore_format_docstring, _unseen_docstring, - _variables_docstring, ) from feature_engine.encoding._helper_functions import check_parameter_unseen from feature_engine.get_feature_names_out import _get_feature_names_out @@ -31,7 +31,7 @@ @Substitution( ignore_format=_ignore_format_docstring, - variables=_variables_docstring, + variables=_variables_categorical_docstring, ) class CategoricalInitMixin: """Shared initialization parameters across transformers. @@ -61,7 +61,7 @@ def __init__( @Substitution( ignore_format=_ignore_format_docstring, - variables=_variables_docstring, + variables=_variables_categorical_docstring, unseen=_unseen_docstring, ) class CategoricalInitExpandedMixin(CategoricalInitMixin): @@ -90,7 +90,7 @@ def __init__( @Substitution( ignore_format=_ignore_format_docstring, - variables=_variables_docstring, + variables=_variables_categorical_docstring, ) class CategoricalMethodsMixin(BaseEstimator, TransformerMixin): """Shared methods across categorical transformers. diff --git a/feature_engine/encoding/count_frequency.py b/feature_engine/encoding/count_frequency.py index 00b01f1c5..efc023654 100644 --- a/feature_engine/encoding/count_frequency.py +++ b/feature_engine/encoding/count_frequency.py @@ -14,14 +14,14 @@ from feature_engine._docstrings.methods import ( _fit_transform_docstring, _inverse_transform_docstring, + _transform_encoders_docstring, ) from feature_engine._docstrings.substitute import Substitution from feature_engine.dataframe_checks import check_X -from feature_engine.encoding._docstrings import ( +from feature_engine._docstrings.init_parameters import ( + _variables_categorical_docstring, _ignore_format_docstring, - _transform_docstring, _unseen_docstring, - _variables_docstring, ) from feature_engine.encoding._helper_functions import check_parameter_unseen from feature_engine.encoding.base_encoder import ( @@ -37,13 +37,13 @@ @Substitution( ignore_format=_ignore_format_docstring, - variables=_variables_docstring, + variables=_variables_categorical_docstring, unseen=_unseen_docstring, variables_=_variables_attribute_docstring, feature_names_in_=_feature_names_in_docstring, n_features_in_=_n_features_in_docstring, fit_transform=_fit_transform_docstring, - transform=_transform_docstring, + transform=_transform_encoders_docstring, inverse_transform=_inverse_transform_docstring, ) class CountFrequencyEncoder(CategoricalInitMixin, CategoricalMethodsMixin): diff --git a/feature_engine/encoding/decision_tree.py b/feature_engine/encoding/decision_tree.py index eef4ac530..aac1254c2 100644 --- a/feature_engine/encoding/decision_tree.py +++ b/feature_engine/encoding/decision_tree.py @@ -16,9 +16,9 @@ from feature_engine._docstrings.substitute import Substitution from feature_engine.dataframe_checks import check_X_y from feature_engine.discretisation import DecisionTreeDiscretiser -from feature_engine.encoding._docstrings import ( +from feature_engine._docstrings.init_parameters import ( + _variables_categorical_docstring, _ignore_format_docstring, - _variables_docstring, ) from feature_engine.encoding.base_encoder import ( CategoricalInitMixin, @@ -30,7 +30,7 @@ @Substitution( ignore_format=_ignore_format_docstring, - variables=_variables_docstring, + variables=_variables_categorical_docstring, variables_=_variables_attribute_docstring, feature_names_in_=_feature_names_in_docstring, n_features_in_=_n_features_in_docstring, diff --git a/feature_engine/encoding/mean_encoding.py b/feature_engine/encoding/mean_encoding.py index 32d3fc6b9..95987b797 100644 --- a/feature_engine/encoding/mean_encoding.py +++ b/feature_engine/encoding/mean_encoding.py @@ -13,14 +13,14 @@ from feature_engine._docstrings.methods import ( _fit_transform_docstring, _inverse_transform_docstring, + _transform_encoders_docstring, ) from feature_engine._docstrings.substitute import Substitution from feature_engine.dataframe_checks import check_X_y -from feature_engine.encoding._docstrings import ( +from feature_engine._docstrings.init_parameters import ( + _variables_categorical_docstring, _ignore_format_docstring, - _transform_docstring, _unseen_docstring, - _variables_docstring, ) from feature_engine.encoding.base_encoder import ( CategoricalInitExpandedMixin, @@ -30,13 +30,13 @@ @Substitution( ignore_format=_ignore_format_docstring, - variables=_variables_docstring, + variables=_variables_categorical_docstring, unseen=_unseen_docstring, variables_=_variables_attribute_docstring, feature_names_in_=_feature_names_in_docstring, n_features_in_=_n_features_in_docstring, fit_transform=_fit_transform_docstring, - transform=_transform_docstring, + transform=_transform_encoders_docstring, inverse_transform=_inverse_transform_docstring, ) class MeanEncoder(CategoricalInitExpandedMixin, CategoricalMethodsMixin): diff --git a/feature_engine/encoding/one_hot.py b/feature_engine/encoding/one_hot.py index 3faaa8c90..7f6c3e84f 100644 --- a/feature_engine/encoding/one_hot.py +++ b/feature_engine/encoding/one_hot.py @@ -14,10 +14,10 @@ ) from feature_engine._docstrings.methods import _fit_transform_docstring from feature_engine._docstrings.substitute import Substitution -from feature_engine.dataframe_checks import _check_contains_na, check_X -from feature_engine.encoding._docstrings import ( +from feature_engine.dataframe_checks import check_X, _check_contains_na +from feature_engine._docstrings.init_parameters import ( + _variables_categorical_docstring, _ignore_format_docstring, - _variables_docstring, ) from feature_engine.encoding.base_encoder import ( CategoricalInitMixin, @@ -27,7 +27,7 @@ @Substitution( ignore_format=_ignore_format_docstring, - variables=_variables_docstring, + variables=_variables_categorical_docstring, variables_=_variables_attribute_docstring, feature_names_in_=_feature_names_in_docstring, n_features_in_=_n_features_in_docstring, diff --git a/feature_engine/encoding/ordinal.py b/feature_engine/encoding/ordinal.py index e7c986f13..217cfe145 100644 --- a/feature_engine/encoding/ordinal.py +++ b/feature_engine/encoding/ordinal.py @@ -13,14 +13,14 @@ from feature_engine._docstrings.methods import ( _fit_transform_docstring, _inverse_transform_docstring, + _transform_encoders_docstring, ) from feature_engine._docstrings.substitute import Substitution from feature_engine.dataframe_checks import check_X, check_X_y -from feature_engine.encoding._docstrings import ( +from feature_engine._docstrings.init_parameters import ( + _variables_categorical_docstring, _ignore_format_docstring, - _transform_docstring, _unseen_docstring, - _variables_docstring, ) from feature_engine.encoding.base_encoder import ( CategoricalInitExpandedMixin, @@ -30,13 +30,13 @@ @Substitution( ignore_format=_ignore_format_docstring, - variables=_variables_docstring, + variables=_variables_categorical_docstring, unseen=_unseen_docstring, variables_=_variables_attribute_docstring, feature_names_in_=_feature_names_in_docstring, n_features_in_=_n_features_in_docstring, fit_transform=_fit_transform_docstring, - transform=_transform_docstring, + transform=_transform_encoders_docstring, inverse_transform=_inverse_transform_docstring, ) class OrdinalEncoder(CategoricalInitExpandedMixin, CategoricalMethodsMixin): diff --git a/feature_engine/encoding/probability_ratio.py b/feature_engine/encoding/probability_ratio.py index 121ba4174..283d12a23 100644 --- a/feature_engine/encoding/probability_ratio.py +++ b/feature_engine/encoding/probability_ratio.py @@ -14,14 +14,14 @@ from feature_engine._docstrings.methods import ( _fit_transform_docstring, _inverse_transform_docstring, + _transform_encoders_docstring, ) from feature_engine._docstrings.substitute import Substitution from feature_engine.dataframe_checks import check_X_y -from feature_engine.encoding._docstrings import ( +from feature_engine._docstrings.init_parameters import ( + _variables_categorical_docstring, _ignore_format_docstring, - _transform_docstring, _unseen_docstring, - _variables_docstring, ) from feature_engine.encoding.base_encoder import ( CategoricalInitExpandedMixin, @@ -32,13 +32,13 @@ @Substitution( ignore_format=_ignore_format_docstring, - variables=_variables_docstring, + variables=_variables_categorical_docstring, unseen=_unseen_docstring, variables_=_variables_attribute_docstring, feature_names_in_=_feature_names_in_docstring, n_features_in_=_n_features_in_docstring, fit_transform=_fit_transform_docstring, - transform=_transform_docstring, + transform=_transform_encoders_docstring, inverse_transform=_inverse_transform_docstring, ) class PRatioEncoder(CategoricalInitExpandedMixin, CategoricalMethodsMixin): diff --git a/feature_engine/encoding/rare_label.py b/feature_engine/encoding/rare_label.py index fc1b80cfd..fc2c4bf5f 100644 --- a/feature_engine/encoding/rare_label.py +++ b/feature_engine/encoding/rare_label.py @@ -14,10 +14,10 @@ ) from feature_engine._docstrings.methods import _fit_transform_docstring from feature_engine._docstrings.substitute import Substitution -from feature_engine.dataframe_checks import _check_contains_na, check_X -from feature_engine.encoding._docstrings import ( +from feature_engine.dataframe_checks import check_X +from feature_engine._docstrings.init_parameters import ( + _variables_categorical_docstring, _ignore_format_docstring, - _variables_docstring, ) from feature_engine.encoding.base_encoder import ( CategoricalInitMixin, @@ -27,7 +27,7 @@ @Substitution( ignore_format=_ignore_format_docstring, - variables=_variables_docstring, + variables=_variables_categorical_docstring, variables_=_variables_attribute_docstring, feature_names_in_=_feature_names_in_docstring, n_features_in_=_n_features_in_docstring, diff --git a/feature_engine/encoding/woe.py b/feature_engine/encoding/woe.py index 314a556f8..0f165680a 100644 --- a/feature_engine/encoding/woe.py +++ b/feature_engine/encoding/woe.py @@ -14,14 +14,14 @@ from feature_engine._docstrings.methods import ( _fit_transform_docstring, _inverse_transform_docstring, + _transform_encoders_docstring, ) from feature_engine._docstrings.substitute import Substitution from feature_engine.dataframe_checks import check_X_y -from feature_engine.encoding._docstrings import ( +from feature_engine._docstrings.init_parameters import ( + _variables_categorical_docstring, _ignore_format_docstring, - _transform_docstring, _unseen_docstring, - _variables_docstring, ) from feature_engine.encoding.base_encoder import ( CategoricalInitExpandedMixin, @@ -32,13 +32,13 @@ @Substitution( ignore_format=_ignore_format_docstring, - variables=_variables_docstring, + variables=_variables_categorical_docstring, unseen=_unseen_docstring, variables_=_variables_attribute_docstring, feature_names_in_=_feature_names_in_docstring, n_features_in_=_n_features_in_docstring, fit_transform=_fit_transform_docstring, - transform=_transform_docstring, + transform=_transform_encoders_docstring, inverse_transform=_inverse_transform_docstring, ) class WoEEncoder(CategoricalInitExpandedMixin, CategoricalMethodsMixin): diff --git a/feature_engine/outliers/artbitrary.py b/feature_engine/outliers/artbitrary.py index 24c51086e..ff81ef32c 100644 --- a/feature_engine/outliers/artbitrary.py +++ b/feature_engine/outliers/artbitrary.py @@ -6,16 +6,16 @@ import pandas as pd -from feature_engine._docstrings.class_inputs import _missing_values_docstring -from feature_engine._docstrings.fit_attributes import ( - _feature_names_in_docstring, - _n_features_in_docstring, - _variables_attribute_docstring, -) from feature_engine._docstrings.methods import ( _fit_not_learn_docstring, _fit_transform_docstring, ) +from feature_engine._docstrings.fit_attributes import ( + _variables_attribute_docstring, + _feature_names_in_docstring, + _n_features_in_docstring, +) +from feature_engine._docstrings.init_parameters import _missing_values_docstring from feature_engine._docstrings.substitute import Substitution from feature_engine._variable_handling.variable_type_selection import ( _find_or_check_numerical_variables, diff --git a/feature_engine/outliers/trimmer.py b/feature_engine/outliers/trimmer.py index 06b74ac9d..4f6524e88 100644 --- a/feature_engine/outliers/trimmer.py +++ b/feature_engine/outliers/trimmer.py @@ -4,16 +4,16 @@ import numpy as np import pandas as pd -from feature_engine._docstrings.class_inputs import ( - _missing_values_docstring, - _variables_numerical_docstring, -) from feature_engine._docstrings.fit_attributes import ( _feature_names_in_docstring, _n_features_in_docstring, _variables_attribute_docstring, ) from feature_engine._docstrings.methods import _fit_transform_docstring +from feature_engine._docstrings.init_parameters import ( + _variables_numerical_docstring, + _missing_values_docstring, +) from feature_engine._docstrings.substitute import Substitution from feature_engine.outliers.base_outlier import WinsorizerBase diff --git a/feature_engine/outliers/winsorizer.py b/feature_engine/outliers/winsorizer.py index 365a5c98a..57d95d8b4 100644 --- a/feature_engine/outliers/winsorizer.py +++ b/feature_engine/outliers/winsorizer.py @@ -6,16 +6,16 @@ import numpy as np import pandas as pd -from feature_engine._docstrings.class_inputs import ( - _missing_values_docstring, - _variables_numerical_docstring, -) from feature_engine._docstrings.fit_attributes import ( _feature_names_in_docstring, _n_features_in_docstring, _variables_attribute_docstring, ) from feature_engine._docstrings.methods import _fit_transform_docstring +from feature_engine._docstrings.init_parameters import ( + _variables_numerical_docstring, + _missing_values_docstring, +) from feature_engine._docstrings.substitute import Substitution from feature_engine.dataframe_checks import check_X from feature_engine.outliers.base_outlier import WinsorizerBase diff --git a/feature_engine/preprocessing/match_categories.py b/feature_engine/preprocessing/match_categories.py index 49181e914..f9b119737 100644 --- a/feature_engine/preprocessing/match_categories.py +++ b/feature_engine/preprocessing/match_categories.py @@ -3,7 +3,11 @@ import pandas as pd -from feature_engine._docstrings.class_inputs import _missing_values_docstring +from feature_engine._docstrings.init_parameters import ( + _missing_values_docstring, + _variables_categorical_docstring, + _ignore_format_docstring, +) from feature_engine._docstrings.fit_attributes import ( _feature_names_in_docstring, _n_features_in_docstring, @@ -11,10 +15,6 @@ ) from feature_engine._docstrings.substitute import Substitution from feature_engine.dataframe_checks import _check_contains_na, check_X -from feature_engine.encoding._docstrings import ( - _ignore_format_docstring, - _variables_docstring, -) from feature_engine.encoding.base_encoder import ( CategoricalInitMixin, CategoricalMethodsMixin, @@ -24,7 +24,7 @@ @Substitution( ignore_format=_ignore_format_docstring, missing_values=_missing_values_docstring, - variables=_variables_docstring, + variables=_variables_categorical_docstring, variables_=_variables_attribute_docstring, feature_names_in_=_feature_names_in_docstring, n_features_in_=_n_features_in_docstring, diff --git a/feature_engine/timeseries/forecasting/base_forecast_transformers.py b/feature_engine/timeseries/forecasting/base_forecast_transformers.py index 947bc04b6..579995c9e 100644 --- a/feature_engine/timeseries/forecasting/base_forecast_transformers.py +++ b/feature_engine/timeseries/forecasting/base_forecast_transformers.py @@ -4,15 +4,15 @@ from sklearn.base import BaseEstimator, TransformerMixin from sklearn.utils.validation import check_is_fitted -from feature_engine._docstrings.class_inputs import ( - _drop_original_docstring, - _missing_values_docstring, -) from feature_engine._docstrings.fit_attributes import ( _feature_names_in_docstring, _n_features_in_docstring, ) from feature_engine._docstrings.methods import _fit_not_learn_docstring +from feature_engine._docstrings.init_parameters import ( + _drop_original_docstring, + _missing_values_docstring, +) from feature_engine._docstrings.substitute import Substitution from feature_engine._variable_handling.init_parameter_checks import ( _check_init_parameter_variables, diff --git a/feature_engine/timeseries/forecasting/expanding_window_features.py b/feature_engine/timeseries/forecasting/expanding_window_features.py index 804276a50..637dd69f0 100644 --- a/feature_engine/timeseries/forecasting/expanding_window_features.py +++ b/feature_engine/timeseries/forecasting/expanding_window_features.py @@ -6,11 +6,7 @@ import pandas as pd from sklearn.utils.validation import check_is_fitted -from feature_engine._docstrings.class_inputs import ( - _drop_original_docstring, - _missing_values_docstring, - _variables_numerical_docstring, -) + from feature_engine._docstrings.fit_attributes import ( _feature_names_in_docstring, _n_features_in_docstring, @@ -19,6 +15,11 @@ _fit_not_learn_docstring, _fit_transform_docstring, ) +from feature_engine._docstrings.init_parameters import ( + _variables_numerical_docstring, + _drop_original_docstring, + _missing_values_docstring, +) from feature_engine._docstrings.substitute import Substitution from feature_engine.timeseries.forecasting.base_forecast_transformers import ( BaseForecastTransformer, diff --git a/feature_engine/timeseries/forecasting/lag_features.py b/feature_engine/timeseries/forecasting/lag_features.py index 40cf411f7..227948cb7 100644 --- a/feature_engine/timeseries/forecasting/lag_features.py +++ b/feature_engine/timeseries/forecasting/lag_features.py @@ -6,11 +6,6 @@ import pandas as pd from sklearn.utils.validation import check_is_fitted -from feature_engine._docstrings.class_inputs import ( - _drop_original_docstring, - _missing_values_docstring, - _variables_numerical_docstring, -) from feature_engine._docstrings.fit_attributes import ( _feature_names_in_docstring, _n_features_in_docstring, @@ -19,6 +14,11 @@ _fit_not_learn_docstring, _fit_transform_docstring, ) +from feature_engine._docstrings.init_parameters import ( + _variables_numerical_docstring, + _drop_original_docstring, + _missing_values_docstring, +) from feature_engine._docstrings.substitute import Substitution from feature_engine.timeseries.forecasting.base_forecast_transformers import ( BaseForecastTransformer, diff --git a/feature_engine/timeseries/forecasting/window_features.py b/feature_engine/timeseries/forecasting/window_features.py index 6fbafab4c..f49c0a2d9 100644 --- a/feature_engine/timeseries/forecasting/window_features.py +++ b/feature_engine/timeseries/forecasting/window_features.py @@ -3,11 +3,6 @@ import pandas as pd from sklearn.utils.validation import check_is_fitted -from feature_engine._docstrings.class_inputs import ( - _drop_original_docstring, - _missing_values_docstring, - _variables_numerical_docstring, -) from feature_engine._docstrings.fit_attributes import ( _feature_names_in_docstring, _n_features_in_docstring, @@ -16,6 +11,11 @@ _fit_not_learn_docstring, _fit_transform_docstring, ) +from feature_engine._docstrings.init_parameters import ( + _variables_numerical_docstring, + _drop_original_docstring, + _missing_values_docstring, +) from feature_engine._docstrings.substitute import Substitution from feature_engine.timeseries.forecasting.base_forecast_transformers import ( BaseForecastTransformer, diff --git a/feature_engine/transformation/arcsin.py b/feature_engine/transformation/arcsin.py index 8040d748b..e2d6aa427 100644 --- a/feature_engine/transformation/arcsin.py +++ b/feature_engine/transformation/arcsin.py @@ -6,7 +6,7 @@ import numpy as np import pandas as pd -from feature_engine._docstrings.class_inputs import _variables_numerical_docstring +from feature_engine._docstrings.init_parameters import _variables_numerical_docstring from feature_engine._docstrings.fit_attributes import ( _feature_names_in_docstring, _n_features_in_docstring, diff --git a/feature_engine/transformation/boxcox.py b/feature_engine/transformation/boxcox.py index cee47c15a..33e18a08e 100644 --- a/feature_engine/transformation/boxcox.py +++ b/feature_engine/transformation/boxcox.py @@ -7,7 +7,7 @@ import scipy.stats as stats from scipy.special import inv_boxcox -from feature_engine._docstrings.class_inputs import _variables_numerical_docstring +from feature_engine._docstrings.init_parameters import _variables_numerical_docstring from feature_engine._docstrings.fit_attributes import ( _feature_names_in_docstring, _n_features_in_docstring, diff --git a/feature_engine/transformation/log.py b/feature_engine/transformation/log.py index 71bc302b1..cf3e2c34a 100644 --- a/feature_engine/transformation/log.py +++ b/feature_engine/transformation/log.py @@ -6,17 +6,17 @@ import numpy as np import pandas as pd -from feature_engine._docstrings.class_inputs import _variables_numerical_docstring -from feature_engine._docstrings.fit_attributes import ( - _feature_names_in_docstring, - _n_features_in_docstring, - _variables_attribute_docstring, -) from feature_engine._docstrings.methods import ( _fit_not_learn_docstring, _fit_transform_docstring, _inverse_transform_docstring, ) +from feature_engine._docstrings.fit_attributes import ( + _variables_attribute_docstring, + _feature_names_in_docstring, + _n_features_in_docstring, +) +from feature_engine._docstrings.init_parameters import _variables_numerical_docstring from feature_engine._docstrings.substitute import Substitution from feature_engine._variable_handling.init_parameter_checks import ( _check_init_parameter_variables, diff --git a/feature_engine/transformation/power.py b/feature_engine/transformation/power.py index 171104765..dae4c6a46 100644 --- a/feature_engine/transformation/power.py +++ b/feature_engine/transformation/power.py @@ -6,17 +6,18 @@ import numpy as np import pandas as pd -from feature_engine._docstrings.class_inputs import _variables_numerical_docstring -from feature_engine._docstrings.fit_attributes import ( - _feature_names_in_docstring, - _n_features_in_docstring, - _variables_attribute_docstring, -) from feature_engine._docstrings.methods import ( _fit_not_learn_docstring, _fit_transform_docstring, _inverse_transform_docstring, ) + +from feature_engine._docstrings.fit_attributes import ( + _variables_attribute_docstring, + _feature_names_in_docstring, + _n_features_in_docstring, +) +from feature_engine._docstrings.init_parameters import _variables_numerical_docstring from feature_engine._docstrings.substitute import Substitution from feature_engine._variable_handling.init_parameter_checks import ( _check_init_parameter_variables, diff --git a/feature_engine/transformation/reciprocal.py b/feature_engine/transformation/reciprocal.py index ae4ed2983..4a91b2320 100644 --- a/feature_engine/transformation/reciprocal.py +++ b/feature_engine/transformation/reciprocal.py @@ -6,17 +6,17 @@ import numpy as np import pandas as pd -from feature_engine._docstrings.class_inputs import _variables_numerical_docstring -from feature_engine._docstrings.fit_attributes import ( - _feature_names_in_docstring, - _n_features_in_docstring, - _variables_attribute_docstring, -) from feature_engine._docstrings.methods import ( _fit_not_learn_docstring, _fit_transform_docstring, _inverse_transform_docstring, ) +from feature_engine._docstrings.fit_attributes import ( + _variables_attribute_docstring, + _feature_names_in_docstring, + _n_features_in_docstring, +) +from feature_engine._docstrings.init_parameters import _variables_numerical_docstring from feature_engine._docstrings.substitute import Substitution from feature_engine._variable_handling.init_parameter_checks import ( _check_init_parameter_variables, diff --git a/feature_engine/transformation/yeojohnson.py b/feature_engine/transformation/yeojohnson.py index 8c09e6441..c3227db43 100644 --- a/feature_engine/transformation/yeojohnson.py +++ b/feature_engine/transformation/yeojohnson.py @@ -6,13 +6,13 @@ import pandas as pd import scipy.stats as stats -from feature_engine._docstrings.class_inputs import _variables_numerical_docstring from feature_engine._docstrings.fit_attributes import ( _feature_names_in_docstring, _n_features_in_docstring, _variables_attribute_docstring, ) from feature_engine._docstrings.methods import _fit_transform_docstring +from feature_engine._docstrings.init_parameters import _variables_numerical_docstring from feature_engine._docstrings.substitute import Substitution from feature_engine._variable_handling.init_parameter_checks import ( _check_init_parameter_variables, From b745a80f149198cd0be3c4a5df394f5649551855 Mon Sep 17 00:00:00 2001 From: Soledad Galli Date: Fri, 19 Aug 2022 08:13:09 +0200 Subject: [PATCH 2/2] fix merge conflict --- .../creation/combine_with_reference_feature.py | 8 ++++---- feature_engine/creation/cyclical.py | 4 ++-- feature_engine/creation/cyclical_features.py | 4 ++-- feature_engine/creation/math_features.py | 8 ++++---- feature_engine/creation/mathematical_combination.py | 8 ++++---- feature_engine/creation/relative_features.py | 10 +++++----- feature_engine/discretisation/decision_tree.py | 2 +- feature_engine/discretisation/equal_frequency.py | 2 +- feature_engine/discretisation/equal_width.py | 2 +- feature_engine/encoding/base_encoder.py | 10 +++++----- feature_engine/encoding/count_frequency.py | 10 +++++----- feature_engine/encoding/decision_tree.py | 8 ++++---- feature_engine/encoding/mean_encoding.py | 10 +++++----- feature_engine/encoding/one_hot.py | 8 ++++---- feature_engine/encoding/ordinal.py | 10 +++++----- feature_engine/encoding/probability_ratio.py | 10 +++++----- feature_engine/encoding/rare_label.py | 8 ++++---- feature_engine/encoding/woe.py | 10 +++++----- feature_engine/imputation/arbitrary_number.py | 1 - feature_engine/outliers/artbitrary.py | 10 +++++----- feature_engine/outliers/trimmer.py | 4 ++-- feature_engine/outliers/winsorizer.py | 4 ++-- feature_engine/preprocessing/match_categories.py | 10 +++++----- .../forecasting/base_forecast_transformers.py | 2 +- .../forecasting/expanding_window_features.py | 11 +++++------ .../timeseries/forecasting/lag_features.py | 10 +++++----- .../timeseries/forecasting/window_features.py | 10 +++++----- feature_engine/transformation/arcsin.py | 2 +- feature_engine/transformation/boxcox.py | 2 +- feature_engine/transformation/log.py | 12 ++++++------ feature_engine/transformation/power.py | 13 ++++++------- feature_engine/transformation/reciprocal.py | 12 ++++++------ feature_engine/transformation/yeojohnson.py | 2 +- .../test_creation/test_check_estimator_creation.py | 9 ++++----- tests/test_creation/test_math_features.py | 1 - tests/test_creation/test_relative_features.py | 1 - tests/test_datetime/test_datetime_features.py | 1 - .../test_encoding/test_check_estimator_encoders.py | 2 +- tests/test_encoding/test_count_frequency_encoder.py | 2 +- tests/test_encoding/test_onehot_encoder.py | 1 - .../test_check_estimator_imputers.py | 2 +- tests/test_imputation/test_missing_indicator.py | 1 - .../test_outliers/test_check_estimator_outliers.py | 2 +- .../test_check_estimator_preprocessing.py | 2 +- .../test_check_estimator_selectors.py | 12 +++++------- .../test_check_estimator_forecasting.py | 2 +- .../test_check_estimator_transformers.py | 4 ++-- .../test_wrappers/test_check_estimator_wrappers.py | 8 +++----- tests/test_wrappers/test_sklearn_wrapper.py | 2 +- 49 files changed, 138 insertions(+), 151 deletions(-) diff --git a/feature_engine/creation/combine_with_reference_feature.py b/feature_engine/creation/combine_with_reference_feature.py index 8b1355153..74bbae24f 100644 --- a/feature_engine/creation/combine_with_reference_feature.py +++ b/feature_engine/creation/combine_with_reference_feature.py @@ -9,14 +9,14 @@ _feature_names_in_docstring, _n_features_in_docstring, ) -from feature_engine._docstrings.methods import ( - _fit_not_learn_docstring, - _fit_transform_docstring, -) from feature_engine._docstrings.init_parameters import ( _drop_original_docstring, _missing_values_docstring, ) +from feature_engine._docstrings.methods import ( + _fit_not_learn_docstring, + _fit_transform_docstring, +) from feature_engine._docstrings.substitute import Substitution from feature_engine._variable_handling.variable_type_selection import ( _find_or_check_numerical_variables, diff --git a/feature_engine/creation/cyclical.py b/feature_engine/creation/cyclical.py index 6cc26d2ec..7465bdf47 100644 --- a/feature_engine/creation/cyclical.py +++ b/feature_engine/creation/cyclical.py @@ -9,11 +9,11 @@ _n_features_in_docstring, _variables_attribute_docstring, ) -from feature_engine._docstrings.methods import _fit_transform_docstring from feature_engine._docstrings.init_parameters import ( - _variables_numerical_docstring, _drop_original_docstring, + _variables_numerical_docstring, ) +from feature_engine._docstrings.methods import _fit_transform_docstring from feature_engine._docstrings.substitute import Substitution from feature_engine._variable_handling.init_parameter_checks import ( _check_init_parameter_variables, diff --git a/feature_engine/creation/cyclical_features.py b/feature_engine/creation/cyclical_features.py index 644031125..8ff8f04df 100644 --- a/feature_engine/creation/cyclical_features.py +++ b/feature_engine/creation/cyclical_features.py @@ -9,11 +9,11 @@ _n_features_in_docstring, _variables_attribute_docstring, ) -from feature_engine._docstrings.methods import _fit_transform_docstring from feature_engine._docstrings.init_parameters import ( - _variables_numerical_docstring, _drop_original_docstring, + _variables_numerical_docstring, ) +from feature_engine._docstrings.methods import _fit_transform_docstring from feature_engine._docstrings.substitute import Substitution from feature_engine._variable_handling.init_parameter_checks import ( _check_init_parameter_variables, diff --git a/feature_engine/creation/math_features.py b/feature_engine/creation/math_features.py index 61eea543c..ce0b750a1 100644 --- a/feature_engine/creation/math_features.py +++ b/feature_engine/creation/math_features.py @@ -7,14 +7,14 @@ _feature_names_in_docstring, _n_features_in_docstring, ) -from feature_engine._docstrings.methods import ( - _fit_not_learn_docstring, - _fit_transform_docstring, -) from feature_engine._docstrings.init_parameters import ( _drop_original_docstring, _missing_values_docstring, ) +from feature_engine._docstrings.methods import ( + _fit_not_learn_docstring, + _fit_transform_docstring, +) from feature_engine._docstrings.substitute import Substitution from feature_engine.creation.base_creation import BaseCreation diff --git a/feature_engine/creation/mathematical_combination.py b/feature_engine/creation/mathematical_combination.py index c3a1b7d23..34baee840 100644 --- a/feature_engine/creation/mathematical_combination.py +++ b/feature_engine/creation/mathematical_combination.py @@ -9,14 +9,14 @@ _feature_names_in_docstring, _n_features_in_docstring, ) -from feature_engine._docstrings.methods import ( - _fit_not_learn_docstring, - _fit_transform_docstring, -) from feature_engine._docstrings.init_parameters import ( _drop_original_docstring, _missing_values_docstring, ) +from feature_engine._docstrings.methods import ( + _fit_not_learn_docstring, + _fit_transform_docstring, +) from feature_engine._docstrings.substitute import Substitution from feature_engine._variable_handling.variable_type_selection import ( _find_or_check_numerical_variables, diff --git a/feature_engine/creation/relative_features.py b/feature_engine/creation/relative_features.py index 5314df170..6cd602db9 100644 --- a/feature_engine/creation/relative_features.py +++ b/feature_engine/creation/relative_features.py @@ -7,14 +7,14 @@ _feature_names_in_docstring, _n_features_in_docstring, ) -from feature_engine._docstrings.methods import ( - _fit_not_learn_docstring, - _fit_transform_docstring, -) from feature_engine._docstrings.init_parameters import ( - _variables_numerical_docstring, _drop_original_docstring, _missing_values_docstring, + _variables_numerical_docstring, +) +from feature_engine._docstrings.methods import ( + _fit_not_learn_docstring, + _fit_transform_docstring, ) from feature_engine._docstrings.substitute import Substitution from feature_engine._variable_handling.variable_type_selection import ( diff --git a/feature_engine/discretisation/decision_tree.py b/feature_engine/discretisation/decision_tree.py index bde8a3778..0040dadf7 100644 --- a/feature_engine/discretisation/decision_tree.py +++ b/feature_engine/discretisation/decision_tree.py @@ -13,8 +13,8 @@ _n_features_in_docstring, _variables_attribute_docstring, ) -from feature_engine._docstrings.methods import _fit_transform_docstring from feature_engine._docstrings.init_parameters import _variables_numerical_docstring +from feature_engine._docstrings.methods import _fit_transform_docstring from feature_engine._docstrings.substitute import Substitution from feature_engine._variable_handling.init_parameter_checks import ( _check_init_parameter_variables, diff --git a/feature_engine/discretisation/equal_frequency.py b/feature_engine/discretisation/equal_frequency.py index f636a7833..a75d29356 100644 --- a/feature_engine/discretisation/equal_frequency.py +++ b/feature_engine/discretisation/equal_frequency.py @@ -10,8 +10,8 @@ _n_features_in_docstring, _variables_attribute_docstring, ) -from feature_engine._docstrings.methods import _fit_transform_docstring from feature_engine._docstrings.init_parameters import _variables_numerical_docstring +from feature_engine._docstrings.methods import _fit_transform_docstring from feature_engine._docstrings.substitute import Substitution from feature_engine._variable_handling.init_parameter_checks import ( _check_init_parameter_variables, diff --git a/feature_engine/discretisation/equal_width.py b/feature_engine/discretisation/equal_width.py index a96565641..741603c5e 100644 --- a/feature_engine/discretisation/equal_width.py +++ b/feature_engine/discretisation/equal_width.py @@ -10,8 +10,8 @@ _n_features_in_docstring, _variables_attribute_docstring, ) -from feature_engine._docstrings.methods import _fit_transform_docstring from feature_engine._docstrings.init_parameters import _variables_numerical_docstring +from feature_engine._docstrings.methods import _fit_transform_docstring from feature_engine._docstrings.substitute import Substitution from feature_engine._variable_handling.init_parameter_checks import ( _check_init_parameter_variables, diff --git a/feature_engine/encoding/base_encoder.py b/feature_engine/encoding/base_encoder.py index 38c9b850a..9d20c7531 100644 --- a/feature_engine/encoding/base_encoder.py +++ b/feature_engine/encoding/base_encoder.py @@ -5,6 +5,11 @@ from sklearn.base import BaseEstimator, TransformerMixin from sklearn.utils.validation import check_is_fitted +from feature_engine._docstrings.init_parameters import ( + _ignore_format_docstring, + _unseen_docstring, + _variables_categorical_docstring, +) from feature_engine._docstrings.methods import _get_feature_names_out_docstring from feature_engine._docstrings.substitute import Substitution from feature_engine._variable_handling.init_parameter_checks import ( @@ -19,11 +24,6 @@ _check_X_matches_training_df, check_X, ) -from feature_engine._docstrings.init_parameters import ( - _variables_categorical_docstring, - _ignore_format_docstring, - _unseen_docstring, -) from feature_engine.encoding._helper_functions import check_parameter_unseen from feature_engine.get_feature_names_out import _get_feature_names_out from feature_engine.tags import _return_tags diff --git a/feature_engine/encoding/count_frequency.py b/feature_engine/encoding/count_frequency.py index efc023654..66fee6145 100644 --- a/feature_engine/encoding/count_frequency.py +++ b/feature_engine/encoding/count_frequency.py @@ -11,6 +11,11 @@ _n_features_in_docstring, _variables_attribute_docstring, ) +from feature_engine._docstrings.init_parameters import ( + _ignore_format_docstring, + _unseen_docstring, + _variables_categorical_docstring, +) from feature_engine._docstrings.methods import ( _fit_transform_docstring, _inverse_transform_docstring, @@ -18,11 +23,6 @@ ) from feature_engine._docstrings.substitute import Substitution from feature_engine.dataframe_checks import check_X -from feature_engine._docstrings.init_parameters import ( - _variables_categorical_docstring, - _ignore_format_docstring, - _unseen_docstring, -) from feature_engine.encoding._helper_functions import check_parameter_unseen from feature_engine.encoding.base_encoder import ( CategoricalInitMixin, diff --git a/feature_engine/encoding/decision_tree.py b/feature_engine/encoding/decision_tree.py index aac1254c2..03a45bf9e 100644 --- a/feature_engine/encoding/decision_tree.py +++ b/feature_engine/encoding/decision_tree.py @@ -12,14 +12,14 @@ _n_features_in_docstring, _variables_attribute_docstring, ) +from feature_engine._docstrings.init_parameters import ( + _ignore_format_docstring, + _variables_categorical_docstring, +) from feature_engine._docstrings.methods import _fit_transform_docstring from feature_engine._docstrings.substitute import Substitution from feature_engine.dataframe_checks import check_X_y from feature_engine.discretisation import DecisionTreeDiscretiser -from feature_engine._docstrings.init_parameters import ( - _variables_categorical_docstring, - _ignore_format_docstring, -) from feature_engine.encoding.base_encoder import ( CategoricalInitMixin, CategoricalMethodsMixin, diff --git a/feature_engine/encoding/mean_encoding.py b/feature_engine/encoding/mean_encoding.py index 95987b797..9cec04145 100644 --- a/feature_engine/encoding/mean_encoding.py +++ b/feature_engine/encoding/mean_encoding.py @@ -10,6 +10,11 @@ _n_features_in_docstring, _variables_attribute_docstring, ) +from feature_engine._docstrings.init_parameters import ( + _ignore_format_docstring, + _unseen_docstring, + _variables_categorical_docstring, +) from feature_engine._docstrings.methods import ( _fit_transform_docstring, _inverse_transform_docstring, @@ -17,11 +22,6 @@ ) from feature_engine._docstrings.substitute import Substitution from feature_engine.dataframe_checks import check_X_y -from feature_engine._docstrings.init_parameters import ( - _variables_categorical_docstring, - _ignore_format_docstring, - _unseen_docstring, -) from feature_engine.encoding.base_encoder import ( CategoricalInitExpandedMixin, CategoricalMethodsMixin, diff --git a/feature_engine/encoding/one_hot.py b/feature_engine/encoding/one_hot.py index 7f6c3e84f..fd209ca2d 100644 --- a/feature_engine/encoding/one_hot.py +++ b/feature_engine/encoding/one_hot.py @@ -12,13 +12,13 @@ _n_features_in_docstring, _variables_attribute_docstring, ) -from feature_engine._docstrings.methods import _fit_transform_docstring -from feature_engine._docstrings.substitute import Substitution -from feature_engine.dataframe_checks import check_X, _check_contains_na from feature_engine._docstrings.init_parameters import ( - _variables_categorical_docstring, _ignore_format_docstring, + _variables_categorical_docstring, ) +from feature_engine._docstrings.methods import _fit_transform_docstring +from feature_engine._docstrings.substitute import Substitution +from feature_engine.dataframe_checks import _check_contains_na, check_X from feature_engine.encoding.base_encoder import ( CategoricalInitMixin, CategoricalMethodsMixin, diff --git a/feature_engine/encoding/ordinal.py b/feature_engine/encoding/ordinal.py index 217cfe145..6f508bf8b 100644 --- a/feature_engine/encoding/ordinal.py +++ b/feature_engine/encoding/ordinal.py @@ -10,6 +10,11 @@ _n_features_in_docstring, _variables_attribute_docstring, ) +from feature_engine._docstrings.init_parameters import ( + _ignore_format_docstring, + _unseen_docstring, + _variables_categorical_docstring, +) from feature_engine._docstrings.methods import ( _fit_transform_docstring, _inverse_transform_docstring, @@ -17,11 +22,6 @@ ) from feature_engine._docstrings.substitute import Substitution from feature_engine.dataframe_checks import check_X, check_X_y -from feature_engine._docstrings.init_parameters import ( - _variables_categorical_docstring, - _ignore_format_docstring, - _unseen_docstring, -) from feature_engine.encoding.base_encoder import ( CategoricalInitExpandedMixin, CategoricalMethodsMixin, diff --git a/feature_engine/encoding/probability_ratio.py b/feature_engine/encoding/probability_ratio.py index 283d12a23..79c61d012 100644 --- a/feature_engine/encoding/probability_ratio.py +++ b/feature_engine/encoding/probability_ratio.py @@ -11,6 +11,11 @@ _n_features_in_docstring, _variables_attribute_docstring, ) +from feature_engine._docstrings.init_parameters import ( + _ignore_format_docstring, + _unseen_docstring, + _variables_categorical_docstring, +) from feature_engine._docstrings.methods import ( _fit_transform_docstring, _inverse_transform_docstring, @@ -18,11 +23,6 @@ ) from feature_engine._docstrings.substitute import Substitution from feature_engine.dataframe_checks import check_X_y -from feature_engine._docstrings.init_parameters import ( - _variables_categorical_docstring, - _ignore_format_docstring, - _unseen_docstring, -) from feature_engine.encoding.base_encoder import ( CategoricalInitExpandedMixin, CategoricalMethodsMixin, diff --git a/feature_engine/encoding/rare_label.py b/feature_engine/encoding/rare_label.py index fc2c4bf5f..afc040b17 100644 --- a/feature_engine/encoding/rare_label.py +++ b/feature_engine/encoding/rare_label.py @@ -12,13 +12,13 @@ _n_features_in_docstring, _variables_attribute_docstring, ) -from feature_engine._docstrings.methods import _fit_transform_docstring -from feature_engine._docstrings.substitute import Substitution -from feature_engine.dataframe_checks import check_X from feature_engine._docstrings.init_parameters import ( - _variables_categorical_docstring, _ignore_format_docstring, + _variables_categorical_docstring, ) +from feature_engine._docstrings.methods import _fit_transform_docstring +from feature_engine._docstrings.substitute import Substitution +from feature_engine.dataframe_checks import _check_contains_na, check_X from feature_engine.encoding.base_encoder import ( CategoricalInitMixin, CategoricalMethodsMixin, diff --git a/feature_engine/encoding/woe.py b/feature_engine/encoding/woe.py index 0f165680a..5204c077a 100644 --- a/feature_engine/encoding/woe.py +++ b/feature_engine/encoding/woe.py @@ -11,6 +11,11 @@ _n_features_in_docstring, _variables_attribute_docstring, ) +from feature_engine._docstrings.init_parameters import ( + _ignore_format_docstring, + _unseen_docstring, + _variables_categorical_docstring, +) from feature_engine._docstrings.methods import ( _fit_transform_docstring, _inverse_transform_docstring, @@ -18,11 +23,6 @@ ) from feature_engine._docstrings.substitute import Substitution from feature_engine.dataframe_checks import check_X_y -from feature_engine._docstrings.init_parameters import ( - _variables_categorical_docstring, - _ignore_format_docstring, - _unseen_docstring, -) from feature_engine.encoding.base_encoder import ( CategoricalInitExpandedMixin, CategoricalMethodsMixin, diff --git a/feature_engine/imputation/arbitrary_number.py b/feature_engine/imputation/arbitrary_number.py index 04939f585..0107a4414 100644 --- a/feature_engine/imputation/arbitrary_number.py +++ b/feature_engine/imputation/arbitrary_number.py @@ -15,7 +15,6 @@ _fit_transform_docstring, ) from feature_engine._docstrings.substitute import Substitution - from feature_engine._variable_handling.init_parameter_checks import ( _check_init_parameter_variables, ) diff --git a/feature_engine/outliers/artbitrary.py b/feature_engine/outliers/artbitrary.py index ff81ef32c..96b0e303c 100644 --- a/feature_engine/outliers/artbitrary.py +++ b/feature_engine/outliers/artbitrary.py @@ -6,16 +6,16 @@ import pandas as pd -from feature_engine._docstrings.methods import ( - _fit_not_learn_docstring, - _fit_transform_docstring, -) from feature_engine._docstrings.fit_attributes import ( - _variables_attribute_docstring, _feature_names_in_docstring, _n_features_in_docstring, + _variables_attribute_docstring, ) from feature_engine._docstrings.init_parameters import _missing_values_docstring +from feature_engine._docstrings.methods import ( + _fit_not_learn_docstring, + _fit_transform_docstring, +) from feature_engine._docstrings.substitute import Substitution from feature_engine._variable_handling.variable_type_selection import ( _find_or_check_numerical_variables, diff --git a/feature_engine/outliers/trimmer.py b/feature_engine/outliers/trimmer.py index 4f6524e88..a84ad507a 100644 --- a/feature_engine/outliers/trimmer.py +++ b/feature_engine/outliers/trimmer.py @@ -9,11 +9,11 @@ _n_features_in_docstring, _variables_attribute_docstring, ) -from feature_engine._docstrings.methods import _fit_transform_docstring from feature_engine._docstrings.init_parameters import ( - _variables_numerical_docstring, _missing_values_docstring, + _variables_numerical_docstring, ) +from feature_engine._docstrings.methods import _fit_transform_docstring from feature_engine._docstrings.substitute import Substitution from feature_engine.outliers.base_outlier import WinsorizerBase diff --git a/feature_engine/outliers/winsorizer.py b/feature_engine/outliers/winsorizer.py index 57d95d8b4..b6593843c 100644 --- a/feature_engine/outliers/winsorizer.py +++ b/feature_engine/outliers/winsorizer.py @@ -11,11 +11,11 @@ _n_features_in_docstring, _variables_attribute_docstring, ) -from feature_engine._docstrings.methods import _fit_transform_docstring from feature_engine._docstrings.init_parameters import ( - _variables_numerical_docstring, _missing_values_docstring, + _variables_numerical_docstring, ) +from feature_engine._docstrings.methods import _fit_transform_docstring from feature_engine._docstrings.substitute import Substitution from feature_engine.dataframe_checks import check_X from feature_engine.outliers.base_outlier import WinsorizerBase diff --git a/feature_engine/preprocessing/match_categories.py b/feature_engine/preprocessing/match_categories.py index f9b119737..75b48fee1 100644 --- a/feature_engine/preprocessing/match_categories.py +++ b/feature_engine/preprocessing/match_categories.py @@ -3,16 +3,16 @@ import pandas as pd -from feature_engine._docstrings.init_parameters import ( - _missing_values_docstring, - _variables_categorical_docstring, - _ignore_format_docstring, -) from feature_engine._docstrings.fit_attributes import ( _feature_names_in_docstring, _n_features_in_docstring, _variables_attribute_docstring, ) +from feature_engine._docstrings.init_parameters import ( + _ignore_format_docstring, + _missing_values_docstring, + _variables_categorical_docstring, +) from feature_engine._docstrings.substitute import Substitution from feature_engine.dataframe_checks import _check_contains_na, check_X from feature_engine.encoding.base_encoder import ( diff --git a/feature_engine/timeseries/forecasting/base_forecast_transformers.py b/feature_engine/timeseries/forecasting/base_forecast_transformers.py index 579995c9e..6324b1fbd 100644 --- a/feature_engine/timeseries/forecasting/base_forecast_transformers.py +++ b/feature_engine/timeseries/forecasting/base_forecast_transformers.py @@ -8,11 +8,11 @@ _feature_names_in_docstring, _n_features_in_docstring, ) -from feature_engine._docstrings.methods import _fit_not_learn_docstring from feature_engine._docstrings.init_parameters import ( _drop_original_docstring, _missing_values_docstring, ) +from feature_engine._docstrings.methods import _fit_not_learn_docstring from feature_engine._docstrings.substitute import Substitution from feature_engine._variable_handling.init_parameter_checks import ( _check_init_parameter_variables, diff --git a/feature_engine/timeseries/forecasting/expanding_window_features.py b/feature_engine/timeseries/forecasting/expanding_window_features.py index 637dd69f0..4e46962af 100644 --- a/feature_engine/timeseries/forecasting/expanding_window_features.py +++ b/feature_engine/timeseries/forecasting/expanding_window_features.py @@ -6,19 +6,18 @@ import pandas as pd from sklearn.utils.validation import check_is_fitted - from feature_engine._docstrings.fit_attributes import ( _feature_names_in_docstring, _n_features_in_docstring, ) -from feature_engine._docstrings.methods import ( - _fit_not_learn_docstring, - _fit_transform_docstring, -) from feature_engine._docstrings.init_parameters import ( - _variables_numerical_docstring, _drop_original_docstring, _missing_values_docstring, + _variables_numerical_docstring, +) +from feature_engine._docstrings.methods import ( + _fit_not_learn_docstring, + _fit_transform_docstring, ) from feature_engine._docstrings.substitute import Substitution from feature_engine.timeseries.forecasting.base_forecast_transformers import ( diff --git a/feature_engine/timeseries/forecasting/lag_features.py b/feature_engine/timeseries/forecasting/lag_features.py index 227948cb7..39d911dbf 100644 --- a/feature_engine/timeseries/forecasting/lag_features.py +++ b/feature_engine/timeseries/forecasting/lag_features.py @@ -10,14 +10,14 @@ _feature_names_in_docstring, _n_features_in_docstring, ) -from feature_engine._docstrings.methods import ( - _fit_not_learn_docstring, - _fit_transform_docstring, -) from feature_engine._docstrings.init_parameters import ( - _variables_numerical_docstring, _drop_original_docstring, _missing_values_docstring, + _variables_numerical_docstring, +) +from feature_engine._docstrings.methods import ( + _fit_not_learn_docstring, + _fit_transform_docstring, ) from feature_engine._docstrings.substitute import Substitution from feature_engine.timeseries.forecasting.base_forecast_transformers import ( diff --git a/feature_engine/timeseries/forecasting/window_features.py b/feature_engine/timeseries/forecasting/window_features.py index f49c0a2d9..133675db6 100644 --- a/feature_engine/timeseries/forecasting/window_features.py +++ b/feature_engine/timeseries/forecasting/window_features.py @@ -7,14 +7,14 @@ _feature_names_in_docstring, _n_features_in_docstring, ) -from feature_engine._docstrings.methods import ( - _fit_not_learn_docstring, - _fit_transform_docstring, -) from feature_engine._docstrings.init_parameters import ( - _variables_numerical_docstring, _drop_original_docstring, _missing_values_docstring, + _variables_numerical_docstring, +) +from feature_engine._docstrings.methods import ( + _fit_not_learn_docstring, + _fit_transform_docstring, ) from feature_engine._docstrings.substitute import Substitution from feature_engine.timeseries.forecasting.base_forecast_transformers import ( diff --git a/feature_engine/transformation/arcsin.py b/feature_engine/transformation/arcsin.py index e2d6aa427..4f5602b26 100644 --- a/feature_engine/transformation/arcsin.py +++ b/feature_engine/transformation/arcsin.py @@ -6,12 +6,12 @@ import numpy as np import pandas as pd -from feature_engine._docstrings.init_parameters import _variables_numerical_docstring from feature_engine._docstrings.fit_attributes import ( _feature_names_in_docstring, _n_features_in_docstring, _variables_attribute_docstring, ) +from feature_engine._docstrings.init_parameters import _variables_numerical_docstring from feature_engine._docstrings.methods import ( _fit_not_learn_docstring, _fit_transform_docstring, diff --git a/feature_engine/transformation/boxcox.py b/feature_engine/transformation/boxcox.py index 33e18a08e..389a7ba77 100644 --- a/feature_engine/transformation/boxcox.py +++ b/feature_engine/transformation/boxcox.py @@ -7,12 +7,12 @@ import scipy.stats as stats from scipy.special import inv_boxcox -from feature_engine._docstrings.init_parameters import _variables_numerical_docstring from feature_engine._docstrings.fit_attributes import ( _feature_names_in_docstring, _n_features_in_docstring, _variables_attribute_docstring, ) +from feature_engine._docstrings.init_parameters import _variables_numerical_docstring from feature_engine._docstrings.methods import ( _fit_transform_docstring, _inverse_transform_docstring, diff --git a/feature_engine/transformation/log.py b/feature_engine/transformation/log.py index cf3e2c34a..903327bb2 100644 --- a/feature_engine/transformation/log.py +++ b/feature_engine/transformation/log.py @@ -6,17 +6,17 @@ import numpy as np import pandas as pd -from feature_engine._docstrings.methods import ( - _fit_not_learn_docstring, - _fit_transform_docstring, - _inverse_transform_docstring, -) from feature_engine._docstrings.fit_attributes import ( - _variables_attribute_docstring, _feature_names_in_docstring, _n_features_in_docstring, + _variables_attribute_docstring, ) from feature_engine._docstrings.init_parameters import _variables_numerical_docstring +from feature_engine._docstrings.methods import ( + _fit_not_learn_docstring, + _fit_transform_docstring, + _inverse_transform_docstring, +) from feature_engine._docstrings.substitute import Substitution from feature_engine._variable_handling.init_parameter_checks import ( _check_init_parameter_variables, diff --git a/feature_engine/transformation/power.py b/feature_engine/transformation/power.py index dae4c6a46..7816278d2 100644 --- a/feature_engine/transformation/power.py +++ b/feature_engine/transformation/power.py @@ -6,18 +6,17 @@ import numpy as np import pandas as pd -from feature_engine._docstrings.methods import ( - _fit_not_learn_docstring, - _fit_transform_docstring, - _inverse_transform_docstring, -) - from feature_engine._docstrings.fit_attributes import ( - _variables_attribute_docstring, _feature_names_in_docstring, _n_features_in_docstring, + _variables_attribute_docstring, ) from feature_engine._docstrings.init_parameters import _variables_numerical_docstring +from feature_engine._docstrings.methods import ( + _fit_not_learn_docstring, + _fit_transform_docstring, + _inverse_transform_docstring, +) from feature_engine._docstrings.substitute import Substitution from feature_engine._variable_handling.init_parameter_checks import ( _check_init_parameter_variables, diff --git a/feature_engine/transformation/reciprocal.py b/feature_engine/transformation/reciprocal.py index 4a91b2320..255bd380b 100644 --- a/feature_engine/transformation/reciprocal.py +++ b/feature_engine/transformation/reciprocal.py @@ -6,17 +6,17 @@ import numpy as np import pandas as pd -from feature_engine._docstrings.methods import ( - _fit_not_learn_docstring, - _fit_transform_docstring, - _inverse_transform_docstring, -) from feature_engine._docstrings.fit_attributes import ( - _variables_attribute_docstring, _feature_names_in_docstring, _n_features_in_docstring, + _variables_attribute_docstring, ) from feature_engine._docstrings.init_parameters import _variables_numerical_docstring +from feature_engine._docstrings.methods import ( + _fit_not_learn_docstring, + _fit_transform_docstring, + _inverse_transform_docstring, +) from feature_engine._docstrings.substitute import Substitution from feature_engine._variable_handling.init_parameter_checks import ( _check_init_parameter_variables, diff --git a/feature_engine/transformation/yeojohnson.py b/feature_engine/transformation/yeojohnson.py index c3227db43..cd0ddfffc 100644 --- a/feature_engine/transformation/yeojohnson.py +++ b/feature_engine/transformation/yeojohnson.py @@ -11,8 +11,8 @@ _n_features_in_docstring, _variables_attribute_docstring, ) -from feature_engine._docstrings.methods import _fit_transform_docstring from feature_engine._docstrings.init_parameters import _variables_numerical_docstring +from feature_engine._docstrings.methods import _fit_transform_docstring from feature_engine._docstrings.substitute import Substitution from feature_engine._variable_handling.init_parameter_checks import ( _check_init_parameter_variables, diff --git a/tests/test_creation/test_check_estimator_creation.py b/tests/test_creation/test_check_estimator_creation.py index 82618ca97..db7074d7b 100644 --- a/tests/test_creation/test_check_estimator_creation.py +++ b/tests/test_creation/test_check_estimator_creation.py @@ -1,14 +1,13 @@ import pytest from sklearn.utils.estimator_checks import check_estimator -from feature_engine.creation import ( - CyclicalFeatures, - MathFeatures, - RelativeFeatures, - # FIXME: remove in version 1.4 +from feature_engine.creation import ( # FIXME: remove in version 1.4 CombineWithReferenceFeature, + CyclicalFeatures, CyclicalTransformer, MathematicalCombination, + MathFeatures, + RelativeFeatures, ) from tests.estimator_checks.estimator_checks import check_feature_engine_estimator diff --git a/tests/test_creation/test_math_features.py b/tests/test_creation/test_math_features.py index b0ef314b3..34f949018 100644 --- a/tests/test_creation/test_math_features.py +++ b/tests/test_creation/test_math_features.py @@ -1,7 +1,6 @@ import numpy as np import pandas as pd import pytest - from sklearn.pipeline import Pipeline from feature_engine.creation import MathFeatures diff --git a/tests/test_creation/test_relative_features.py b/tests/test_creation/test_relative_features.py index ff4378d83..23f8fcd1c 100644 --- a/tests/test_creation/test_relative_features.py +++ b/tests/test_creation/test_relative_features.py @@ -1,7 +1,6 @@ import numpy as np import pandas as pd import pytest - from sklearn.pipeline import Pipeline from feature_engine.creation import RelativeFeatures diff --git a/tests/test_datetime/test_datetime_features.py b/tests/test_datetime/test_datetime_features.py index 89c5c5fa9..416a32ba7 100644 --- a/tests/test_datetime/test_datetime_features.py +++ b/tests/test_datetime/test_datetime_features.py @@ -1,7 +1,6 @@ import numpy as np import pandas as pd import pytest - from sklearn.exceptions import NotFittedError from sklearn.pipeline import Pipeline diff --git a/tests/test_encoding/test_check_estimator_encoders.py b/tests/test_encoding/test_check_estimator_encoders.py index 6bc09a638..13af9882e 100644 --- a/tests/test_encoding/test_check_estimator_encoders.py +++ b/tests/test_encoding/test_check_estimator_encoders.py @@ -1,5 +1,5 @@ -import pytest import pandas as pd +import pytest from sklearn.utils.estimator_checks import check_estimator from feature_engine.encoding import ( diff --git a/tests/test_encoding/test_count_frequency_encoder.py b/tests/test_encoding/test_count_frequency_encoder.py index d858838ec..62071c0df 100644 --- a/tests/test_encoding/test_count_frequency_encoder.py +++ b/tests/test_encoding/test_count_frequency_encoder.py @@ -1,8 +1,8 @@ import warnings -from numpy import nan import pandas as pd import pytest +from numpy import nan from feature_engine.encoding import CountFrequencyEncoder diff --git a/tests/test_encoding/test_onehot_encoder.py b/tests/test_encoding/test_onehot_encoder.py index fa5429cc8..0b3ce30b8 100644 --- a/tests/test_encoding/test_onehot_encoder.py +++ b/tests/test_encoding/test_onehot_encoder.py @@ -1,6 +1,5 @@ import pandas as pd import pytest - from sklearn.pipeline import Pipeline from feature_engine.encoding import OneHotEncoder diff --git a/tests/test_imputation/test_check_estimator_imputers.py b/tests/test_imputation/test_check_estimator_imputers.py index 7417fd011..1e2bb91c5 100644 --- a/tests/test_imputation/test_check_estimator_imputers.py +++ b/tests/test_imputation/test_check_estimator_imputers.py @@ -1,7 +1,6 @@ import pytest from sklearn.utils.estimator_checks import check_estimator -from tests.estimator_checks.estimator_checks import check_feature_engine_estimator from feature_engine.imputation import ( AddMissingIndicator, ArbitraryNumberImputer, @@ -11,6 +10,7 @@ MeanMedianImputer, RandomSampleImputer, ) +from tests.estimator_checks.estimator_checks import check_feature_engine_estimator _estimators = [ MeanMedianImputer(), diff --git a/tests/test_imputation/test_missing_indicator.py b/tests/test_imputation/test_missing_indicator.py index e29c60168..d4a33ba45 100644 --- a/tests/test_imputation/test_missing_indicator.py +++ b/tests/test_imputation/test_missing_indicator.py @@ -1,5 +1,4 @@ import pytest - from sklearn.pipeline import Pipeline from feature_engine.imputation import AddMissingIndicator diff --git a/tests/test_outliers/test_check_estimator_outliers.py b/tests/test_outliers/test_check_estimator_outliers.py index 2d8bec5c9..c14c6d91e 100644 --- a/tests/test_outliers/test_check_estimator_outliers.py +++ b/tests/test_outliers/test_check_estimator_outliers.py @@ -1,8 +1,8 @@ import pytest from sklearn.utils.estimator_checks import check_estimator -from tests.estimator_checks.estimator_checks import check_feature_engine_estimator from feature_engine.outliers import ArbitraryOutlierCapper, OutlierTrimmer, Winsorizer +from tests.estimator_checks.estimator_checks import check_feature_engine_estimator _estimators = [ ArbitraryOutlierCapper(max_capping_dict={"0": 10}), diff --git a/tests/test_preprocessing/test_check_estimator_preprocessing.py b/tests/test_preprocessing/test_check_estimator_preprocessing.py index 70c6801af..06cfc62ba 100644 --- a/tests/test_preprocessing/test_check_estimator_preprocessing.py +++ b/tests/test_preprocessing/test_check_estimator_preprocessing.py @@ -1,8 +1,8 @@ import pytest from sklearn.utils.estimator_checks import check_estimator -from tests.estimator_checks.estimator_checks import check_feature_engine_estimator from feature_engine.preprocessing import MatchCategories, MatchVariables +from tests.estimator_checks.estimator_checks import check_feature_engine_estimator _estimators = [MatchCategories(ignore_format=True), MatchVariables()] diff --git a/tests/test_selection/test_check_estimator_selectors.py b/tests/test_selection/test_check_estimator_selectors.py index 725ecfd67..ad53cdb3f 100644 --- a/tests/test_selection/test_check_estimator_selectors.py +++ b/tests/test_selection/test_check_estimator_selectors.py @@ -2,13 +2,6 @@ from sklearn.linear_model import LogisticRegression from sklearn.utils.estimator_checks import check_estimator -from tests.estimator_checks.estimator_checks import ( - check_feature_engine_estimator, -) -from tests.estimator_checks.init_params_triggered_functionality_checks import ( - check_confirm_variables, - check_raises_error_if_only_1_variable, -) from feature_engine.selection import ( DropConstantFeatures, DropCorrelatedFeatures, @@ -22,6 +15,11 @@ SelectByTargetMeanPerformance, SmartCorrelatedSelection, ) +from tests.estimator_checks.estimator_checks import check_feature_engine_estimator +from tests.estimator_checks.init_params_triggered_functionality_checks import ( + check_confirm_variables, + check_raises_error_if_only_1_variable, +) _logreg = LogisticRegression(C=0.0001, max_iter=2, random_state=1) diff --git a/tests/test_time_series/test_forecasting/test_check_estimator_forecasting.py b/tests/test_time_series/test_forecasting/test_check_estimator_forecasting.py index bf70522e2..09dba6ba7 100644 --- a/tests/test_time_series/test_forecasting/test_check_estimator_forecasting.py +++ b/tests/test_time_series/test_forecasting/test_check_estimator_forecasting.py @@ -4,12 +4,12 @@ from sklearn.base import clone from sklearn.utils.estimator_checks import check_estimator -from tests.estimator_checks.estimator_checks import check_feature_engine_estimator from feature_engine.timeseries.forecasting import ( ExpandingWindowFeatures, LagFeatures, WindowFeatures, ) +from tests.estimator_checks.estimator_checks import check_feature_engine_estimator _estimators = [ LagFeatures(missing_values="ignore"), diff --git a/tests/test_transformation/test_check_estimator_transformers.py b/tests/test_transformation/test_check_estimator_transformers.py index 5a857a754..bd8bf66be 100644 --- a/tests/test_transformation/test_check_estimator_transformers.py +++ b/tests/test_transformation/test_check_estimator_transformers.py @@ -1,16 +1,16 @@ import pytest from sklearn.utils.estimator_checks import check_estimator -from tests.estimator_checks.estimator_checks import check_feature_engine_estimator from feature_engine.transformation import ( + ArcsinTransformer, BoxCoxTransformer, LogCpTransformer, - ArcsinTransformer, LogTransformer, PowerTransformer, ReciprocalTransformer, YeoJohnsonTransformer, ) +from tests.estimator_checks.estimator_checks import check_feature_engine_estimator _estimators = [ BoxCoxTransformer(), diff --git a/tests/test_wrappers/test_check_estimator_wrappers.py b/tests/test_wrappers/test_check_estimator_wrappers.py index abe8ec350..ba0ef2e24 100644 --- a/tests/test_wrappers/test_check_estimator_wrappers.py +++ b/tests/test_wrappers/test_check_estimator_wrappers.py @@ -3,18 +3,16 @@ from sklearn.preprocessing import OrdinalEncoder, StandardScaler from sklearn.utils.estimator_checks import check_estimator +from feature_engine.wrappers import SklearnTransformerWrapper from tests.estimator_checks.estimator_checks import ( check_raises_error_when_input_not_a_df, ) from tests.estimator_checks.fit_functionality_checks import check_feature_names_in -from tests.estimator_checks.non_fitted_error_checks import ( - check_raises_non_fitted_error, -) +from tests.estimator_checks.non_fitted_error_checks import check_raises_non_fitted_error from tests.estimator_checks.variable_selection_checks import ( - check_numerical_variables_assignment, check_all_types_variables_assignment, + check_numerical_variables_assignment, ) -from feature_engine.wrappers import SklearnTransformerWrapper def test_sklearn_transformer_wrapper(): diff --git a/tests/test_wrappers/test_sklearn_wrapper.py b/tests/test_wrappers/test_sklearn_wrapper.py index b0db6d9a4..7d5535374 100644 --- a/tests/test_wrappers/test_sklearn_wrapper.py +++ b/tests/test_wrappers/test_sklearn_wrapper.py @@ -571,7 +571,7 @@ def test_function_transformer_works_with_numericals(): X_expected = pd.DataFrame({"col1": [2, 3, 4], "col2": ["a", "b", "c"]}) transformer = SklearnTransformerWrapper( - FunctionTransformer(lambda x: x+1), variables=["col1"] + FunctionTransformer(lambda x: x + 1), variables=["col1"] ) X_tf = transformer.fit_transform(X)