a jy:@sddlZddlZddlmZmZmZmZddlm Z ddl m Z ddl m Z ddlmZmZmZddlmZmZmZmZdd lmZdd lmZdd lmZd gZGd d d eeZdS)N) BaseEstimatorRegressorMixin _fit_contextclone)NotFittedError)LinearRegression)FunctionTransformer)Bunch_safe_indexing check_array)MetadataRouter MethodMapping_routing_enabledprocess_routing) HasMethods)get_tags)check_is_fittedTransformedTargetRegressorcseZdZUdZeddgdgeddgedgedgdgdZeed<ddddd d d d Z d dZ e ddddZ ddZ fddZeddZddZdddZZS)ra Meta-estimator to regress on a transformed target. Useful for applying a non-linear transformation to the target `y` in regression problems. This transformation can be given as a Transformer such as the :class:`~sklearn.preprocessing.QuantileTransformer` or as a function and its inverse such as `np.log` and `np.exp`. The computation during :meth:`fit` is:: regressor.fit(X, func(y)) or:: regressor.fit(X, transformer.transform(y)) The computation during :meth:`predict` is:: inverse_func(regressor.predict(X)) or:: transformer.inverse_transform(regressor.predict(X)) Read more in the :ref:`User Guide `. .. versionadded:: 0.20 Parameters ---------- regressor : object, default=None Regressor object such as derived from :class:`~sklearn.base.RegressorMixin`. This regressor will automatically be cloned each time prior to fitting. If `regressor is None`, :class:`~sklearn.linear_model.LinearRegression` is created and used. transformer : object, default=None Estimator object such as derived from :class:`~sklearn.base.TransformerMixin`. Cannot be set at the same time as `func` and `inverse_func`. If `transformer is None` as well as `func` and `inverse_func`, the transformer will be an identity transformer. Note that the transformer will be cloned during fitting. Also, the transformer is restricting `y` to be a numpy array. func : function, default=None Function to apply to `y` before passing to :meth:`fit`. Cannot be set at the same time as `transformer`. If `func is None`, the function used will be the identity function. If `func` is set, `inverse_func` also needs to be provided. The function needs to return a 2-dimensional array. inverse_func : function, default=None Function to apply to the prediction of the regressor. Cannot be set at the same time as `transformer`. The inverse function is used to return predictions to the same space of the original training labels. If `inverse_func` is set, `func` also needs to be provided. The inverse function needs to return a 2-dimensional array. check_inverse : bool, default=True Whether to check that `transform` followed by `inverse_transform` or `func` followed by `inverse_func` leads to the original targets. Attributes ---------- regressor_ : object Fitted regressor. transformer_ : object Transformer used in :meth:`fit` and :meth:`predict`. n_features_in_ : int Number of features seen during :term:`fit`. Only defined if the underlying regressor exposes such an attribute when fit. .. versionadded:: 0.24 feature_names_in_ : ndarray of shape (`n_features_in_`,) Names of features seen during :term:`fit`. Defined only when `X` has feature names that are all strings. .. versionadded:: 1.0 See Also -------- sklearn.preprocessing.FunctionTransformer : Construct a transformer from an arbitrary callable. Notes ----- Internally, the target `y` is always converted into a 2-dimensional array to be used by scikit-learn transformers. At the time of prediction, the output will be reshaped to a have the same number of dimensions as `y`. Examples -------- >>> import numpy as np >>> from sklearn.linear_model import LinearRegression >>> from sklearn.compose import TransformedTargetRegressor >>> tt = TransformedTargetRegressor(regressor=LinearRegression(), ... func=np.log, inverse_func=np.exp) >>> X = np.arange(4).reshape(-1, 1) >>> y = np.exp(2 * X).ravel() >>> tt.fit(X, y) TransformedTargetRegressor(...) >>> tt.score(X, y) 1.0 >>> tt.regressor_.coef_ array([2.]) For a more detailed example use case refer to :ref:`sphx_glr_auto_examples_compose_plot_transformed_target.py`. fitpredictN transformboolean regressor transformerfunc inverse_func check_inverse_parameter_constraintsT)rrrrcCs"||_||_||_||_||_dSNr)selfrrrrrr"=E:\soccer\ml_env\Lib\site-packages\sklearn/compose/_target.py__init__s z#TransformedTargetRegressor.__init__cCs,|jdur(|jdus|jdur(tdn|jdur@t|j|_n|jdurT|jdush|jdur|jdur|jdurvdnd\}}td|d|d|dt|j|jd |jd |_|jjd d |j ||jr(t ddt d |j dd}t ||}|j|}t||j|s(tdtdS)zCheck transformer and fit transformer. Create the default transformer, fit it and make additional inverse check on a subset (optional). NzE'transformer' and functions 'func'/'inverse_func' cannot both be set.)rr)rrzWhen 'z' is provided, 'z' must also be provided. If zU is supposed to be the default, you need to explicitly pass it the identity function.T)rrvalidaterdefault)rr zThe provided functions or transformer are not strictly inverse of each other. If you are sure you want to proceed regardless, set 'check_inverse=False')rrr ValueErrorr transformer_r rZ set_outputrslicemaxshaper rnpZallcloseinverse_transformwarningswarn UserWarning)r!yZ lacking_paramZexisting_paramZ idx_selectedZy_selZy_sel_tr"r"r#_fit_transformersR      z+TransformedTargetRegressor._fit_transformerF)Zprefer_skip_nested_validationc Ks|durtd|jjdt|ddddddd}|j|_|jd krR|d d }n|}|||j |}|jd kr|j d d kr|j d d }|j dd |_ trt|dfi|}ntt|dd}|j j||fi|jjt|j dr|j j|_|S)aFit the model according to the given training data. Parameters ---------- X : {array-like, sparse matrix} of shape (n_samples, n_features) Training vector, where `n_samples` is the number of samples and `n_features` is the number of features. y : array-like of shape (n_samples,) Target values. **fit_params : dict - If `enable_metadata_routing=False` (default): Parameters directly passed to the `fit` method of the underlying regressor. - If `enable_metadata_routing=True`: Parameters safely routed to the `fit` method of the underlying regressor. .. versionchanged:: 1.6 See :ref:`Metadata Routing User Guide ` for more details. Returns ------- self : object Fitted estimator. NzThis z= estimator requires y to be passed, but the target y is None.r3FTnumeric)Z input_nameZ accept_sparseZensure_all_finiteZ ensure_2dZdtypeZallow_ndr'rZaxis) get_cloner)rrfeature_names_in_)r) __class____name__r ndim _training_dimreshaper4r*rr-squeeze_get_regressor regressor_rrr rrhasattrr:)r!Xr3Z fit_paramsZy_2dZy_trans routed_paramsr"r"r#rs:        zTransformedTargetRegressor.fitcKst|tr"t|dfi|}ntt|dd}|jj|fi|jj}|jdkrj|j | dd}n |j |}|j dkr|jdkr|j ddkr|j dd}|S)aPredict using the base regressor, applying inverse. The regressor is used to predict and the `inverse_func` or `inverse_transform` is applied before returning the prediction. Parameters ---------- X : {array-like, sparse matrix} of shape (n_samples, n_features) Samples. **predict_params : dict of str -> object - If `enable_metadata_routing=False` (default): Parameters directly passed to the `predict` method of the underlying regressor. - If `enable_metadata_routing=True`: Parameters safely routed to the `predict` method of the underlying regressor. .. versionchanged:: 1.6 See :ref:`Metadata Routing User Guide ` for more details. Returns ------- y_hat : ndarray of shape (n_samples,) Predicted values. r)rr9r'r6rr7)rrrr rBrrr=r*r/r?r>r-r@)r!rDZpredict_paramsrEpredZ pred_transr"r"r#r,s     z"TransformedTargetRegressor.predictcs>|}t}d|j_t|jj|j_t|jj |j_ |S)NT) rAsuper__sklearn_tags__Zregressor_tagsZ poor_scorerZ input_tagssparseZ target_tagsZ multi_output)r!rtagsr;r"r#rH[s  z+TransformedTargetRegressor.__sklearn_tags__c CsNz t|Wn8tyD}z td|jj|WYd}~n d}~00|jjS)z+Number of features seen during :term:`fit`.z*{} object has no n_features_in_ attribute.N)rrAttributeErrorformatr;r<rBn_features_in_)r!Znfer"r"r#rNcs z)TransformedTargetRegressor.n_features_in_cCs6t|jjdj|tjdddjdddd}|S)ajGet metadata routing of this object. Please check :ref:`User Guide ` on how the routing mechanism works. .. versionadded:: 1.6 Returns ------- routing : MetadataRouter A :class:`~sklearn.utils.metadata_routing.MetadataRouter` encapsulating routing information. )ownerr)ZcallerZcalleer)rZmethod_mapping)r r;r<addrAr)r!Zrouterr"r"r#get_metadata_routingssz/TransformedTargetRegressor.get_metadata_routingcCs$|jdurtS|rt|jS|jSr )rrr)r!r8r"r"r#rAs z)TransformedTargetRegressor._get_regressor)N)F)r< __module__ __qualname____doc__rcallablerdict__annotations__r$r4rrrrHpropertyrNrQrA __classcell__r"r"rKr#rs2 p   ; L/  )r0numpyr.baserrrr exceptionsrZ linear_modelrZ preprocessingr utilsr r r Zutils._metadata_requestsr rrrZutils._param_validationrZ utils._tagsrZutils.validationr__all__rr"r"r"r#s