0PhVo,ddlZddlZddlZddlZddlmZmZddlmZddl m Z ddl m Z m Z ddlZddlmZmZddlmZmZd d lmZGd d eeZd ZdZdZGdde Zee dZ!GddeZ"Gdde"Z#Gdde"Z$Gdde"Z%Gdde"Z&Gdde"Z'Gdd e'Z(Gd!d"e"Z)Gd#d$e"Z*Gd%d&e"Z+Gd'd(e"Z,Gd)d*e"Z-Gd+d,e"Z.Gd-d.e"Z/Gd/d0e"Z0Gd1d2e"Z1Gd3d4e"Z2Gd5d6e"Z3Gd7d8Z4d9Z5d:Z6dS);N)ABCabstractmethod)Iterable) signature)IntegralReal) csr_matrixissparse)config_context get_config_is_arraylike_not_scalarceZdZdZdS)InvalidParameterErrorzyCustom exception to be raised when the parameter of a class/method/function does not have a valid type or value. N__name__ __module__ __qualname____doc___/var/www/html/test/jupyter/venv/lib/python3.11/site-packages/sklearn/utils/_param_validation.pyrrsrrc |D]\}}||vr ||}|dkrd|D}|D]}||rnxd|D}t|dkr |d}n2dd|dd Dd |d }t d |d |d |d|d dS)aValidate types and values of given parameters. Parameters ---------- parameter_constraints : dict or {"no_validation"} If "no_validation", validation is skipped for this parameter. If a dict, it must be a dictionary `param_name: list of constraints`. A parameter is valid if it satisfies one of the constraints from the list. Constraints can be: - an Interval object, representing a continuous or discrete range of numbers - the string "array-like" - the string "sparse matrix" - the string "random_state" - callable - None, meaning that None is a valid value for the parameter - any type, meaning that any instance of this type is valid - an Options object, representing a set of elements of a given type - a StrOptions object, representing a set of strings - the string "boolean" - the string "verbose" - the string "cv_object" - the string "nan" - a MissingValues object representing markers for missing values - a HasMethods object, representing method(s) an object must have - a Hidden object, representing a constraint not meant to be exposed to the user params : dict A dictionary `param_name: param_value`. The parameters to validate against the constraints. caller_name : str The name of the estimator or function or method that called this function. no_validationc,g|]}t|Sr)make_constraint.0 constraints r z2validate_parameter_constraints..Ks QQQzz22QQQrc g|] }|j | Srhiddenrs rr"z2validate_parameter_constraints..Vs0) @Qrrr, c,g|]}t|Srstrr cs rr"z2validate_parameter_constraints..^s!C!C!CQ#a&&!C!C!CrN or zThe z parameter of z must be z. Got instead.)itemsis_satisfied_bylenjoinr)parameter_constraintsparams caller_name param_name param_val constraintsr!constraints_strs rvalidate_parameter_constraintsr:sF"(&& I 2 2 2 +J7 / ) ) QQ[QQQ %  J)))44  -8K;1$$%0^"5yy!C!C+crc2B!C!C!CDD**#B** (BzBB;BB#BB+4BBB %#&&rct|tr|dkrtSt|tr|dkrtSt|tr|dkrt S|t urt S|tSt|trt|St|tttttfr|St|tr|dkrtSt|tr|dkrt!St|tr|dkrt#St|t$rt'|j}d|_|St|tr|d krt-St/d |) aConvert the constraint into the appropriate Constraint object. Parameters ---------- constraint : object The constraint to convert. Returns ------- constraint : instance of _Constraint The converted constraint. z array-likez sparse matrix random_stateNbooleanverbose cv_objectTnanUnknown constraint type: ) isinstancer) _ArrayLikes_SparseMatrices _RandomStatescallable _Callables_NoneConstrainttype _InstancesOfInterval StrOptionsOptions HasMethods MissingValues _Booleans_VerboseHelper _CVObjectsHiddenrr!r%_NanConstraint ValueErrorr!s rrrhs*c""z\'A'A}}*c""!z_'D'D   *c""z^'C'CX||   *d##(J'''Xz7J N*c""zY'>'>{{*c"" zY'>'>*c""z['@'@||*f%%$Z%:;;  *c"" zU':': === > >>rcfd}|S)aDecorator to validate types and values of functions and methods. Parameters ---------- parameter_constraints : dict A dictionary `param_name: list of constraints`. See the docstring of `validate_parameter_constraints` for a description of the accepted constraints. Note that the *args and **kwargs parameters are not validated and must not be present in the parameter_constraints dictionary. prefer_skip_nested_validation : bool If True, the validation of parameters of inner estimators or functions called by the decorated function will be skipped. This is useful to avoid validating many times the parameters passed by the user from the public facing API. It's also useful to avoid validating parameters that we pass internally to inner functions that are guaranteed to be valid by the test suite. It should be set to True for most functions, except for those that receive non-validated objects as parameters or that are just wrappers around classes because they only perform a partial validation. Returns ------- decorated_function : function or method The decorated function. cntdtjfd}|S)N_skl_parameter_constraintscttd}|r|i|St}|j|i|}|d|jDddgz fd|jD}t |j  t p|5|i|cdddS#1swxYwYdS#t$rA}tj dd j d t|}t||d}~wwxYw) Nskip_parameter_validationcFg|]}|j|j|jfv|jSr)kindVAR_POSITIONAL VAR_KEYWORDname)r ps rr"zGvalidate_params..decorator..wrapper..s;6a. >>>>>>rselfclsc$i|] \}}|v || Srr)r kv to_ignores r zGvalidate_params..decorator..wrapper..s)VVVtq!1ICUCUaCUCUCUr)r5)r[zparameter of \w+ must bez parameter of z must be)r rbindapply_defaults parametersvalues argumentsr/r:rr rresubr)) argskwargsglobal_skip_validationfunc_sigr4emsgrgfuncr3prefer_skip_nested_validations @rwrapperz3validate_params..decorator..wrappers%/\\2M%N "% -tT,V,,, H#X]D3F33F  ! ! # # #!,3355I &% (IVVVVv'7'='='?'?VVVF *%v4;L     8#5O9O11  4000 111111111111111111 ) 8 8 8 f/?D$5???FF ,C00a7 8s<8C, C C,C##C,&C#'C,, D76.decoratorsZ 24IJJJ   ) 8) 8) 8) 8) 8) 8  ) 8Vrr)r3rwr|s`` rvalidate_paramsr}s+>222222h rceZdZdZdS) RealNotIntzA type that represents reals that are not instances of int. Behaves like float, but also works with values extracted from numpy arrays. isintance(1, RealNotInt) -> False isinstance(1.0, RealNotInt) -> True Nrrrrrrsrrcp|j}|j}|dkr|S|tkrdS|tkrdS|d|S)z(Convert type into human readable string.builtinsfloatint.)rrrr)tmodulequalnames r _type_namersP \F~H  dw hu ! !x ! !!rcDeZdZdZdZedZedZdS) _Constraintz&Base class for the constraint objects.cd|_dSNFr$rbs r__init__z_Constraint.__init__s  rcdS)aWhether or not a value satisfies the constraint. Parameters ---------- val : object The value to check. Returns ------- is_satisfied : bool Whether or not the constraint is satisfied by this value. Nrrbvals rr0z_Constraint.is_satisfied_by rcdS)z;A human readable representational string of the constraint.Nrrs r__str__z_Constraint.__str__rrN)rrrrrrr0rrrrrrsd00   ^  JJ^JJJrrc.eZdZdZfdZdZdZxZS)rJz~Constraint representing instances of a given type. Parameters ---------- type : type The valid type. cVt||_dSN)superrrI)rbrI __class__s rrz_InstancesOf.__init__&s$  rc,t||jSrrBrIrs rr0z_InstancesOf.is_satisfied_by*s#ty)))rc0dt|jS)Nzan instance of )rrIrs rrz_InstancesOf.__str__-s:DI!6!6:::rrrrrrr0r __classcell__rs@rrJrJs`***;;;;;;;rrJceZdZdZdZdZdS)rHz+Constraint representing the None singleton.c |duSrrrs rr0z_NoneConstraint.is_satisfied_by4s d{rcdS)NNonerrs rrz_NoneConstraint.__str__7svrNrrrrr0rrrrrHrH1s855rrHceZdZdZdZdZdS)rTz/Constraint representing the indicator `np.nan`.ct|t o(t|totj|Sr)rBrrmathisnanrs rr0z_NanConstraint.is_satisfied_by>s43)) ) Wjd.C.C W SV rcdS)Nz numpy.nanrrs rrz_NanConstraint.__str__C{rNrrrrrTrT;s899   rrTceZdZdZdZdZdS)_PandasNAConstraintz.Constraint representing the indicator `pd.NA`.c ddl}t|t|jo||S#t $rYdSwxYw)NrF)pandasrBrINAisna ImportError)rbrpds rr0z#_PandasNAConstraint.is_satisfied_byJs\     c4;;//@BGGCLL @   55 s:= A  A cdS)Nz pandas.NArrs rrz_PandasNAConstraint.__str__RrrNrrrrrrGs888rrc:eZdZdZddfd ZdZdZdZxZS)rMaGConstraint representing a finite set of instances of a given type. Parameters ---------- type : type options : set The set of valid scalars. deprecated : set or None, default=None A subset of the `options` to mark as deprecated in the string representation of the constraint. N deprecatedct||_||_|p t |_|j|jz rt ddS)Nz7The deprecated options must be a subset of the options.)rrrIoptionssetrrU)rbrIrrrs rrzOptions.__init__esd   $- ?T\ ) XVWW W X Xrc>t||jo||jvSr)rBrIrrs rr0zOptions.is_satisfied_byns #ty))AcT\.AArc(|}||jvr|d}|S)z-Add a deprecated mark to an option if needed.z (deprecated)r)rboption option_strs r_mark_if_deprecatedzOptions._mark_if_deprecatedqs*] T_ $ $&555JrcdfdjD}dtjd|dS)Nr&c:g|]}|Sr)r)r orbs rr"z#Options.__str__..zs'LLL!$22155LLLrza z among {})r2rrrI)rb options_strs` rrzOptions.__str__xsWyyLLLLt|LLLMM O DJty))CCKCCCCr) rrrrrr0rrrrs@rrMrMVs  59XXXXXXXBBBDDDDDDDrrMc(eZdZdZddfd ZxZS)rLa2Constraint representing a finite set of strings. Parameters ---------- options : set of str The set of valid strings. deprecated : set of str or None, default=None A subset of the `options` to mark as deprecated in the string representation of the constraint. NrcZtt||dS)N)rIrr)rrr))rbrrrs rrzStrOptions.__init__s( c7zJJJJJr)rrrrrrrs@rrLrLs\  /3KKKKKKKKKKKrrLc:eZdZdZfdZdZdZdZdZxZ S)rKuMConstraint representing a typed interval. Parameters ---------- type : {numbers.Integral, numbers.Real, RealNotInt} The set of numbers in which to set the interval. If RealNotInt, only reals that don't have the integer type are allowed. For example 1.0 is allowed but 1 is not. left : float or int or None The left bound of the interval. None means left bound is -∞. right : float, int or None The right bound of the interval. None means right bound is +∞. closed : {"left", "right", "both", "neither"} Whether the interval is open or closed. Possible choices are: - `"left"`: the interval is closed on the left and open on the right. It is equivalent to the interval `[ left, right )`. - `"right"`: the interval is closed on the right and open on the left. It is equivalent to the interval `( left, right ]`. - `"both"`: the interval is closed. It is equivalent to the interval `[ left, right ]`. - `"neither"`: the interval is open. It is equivalent to the interval `( left, right )`. Notes ----- Setting a bound to `None` and setting the interval closed is valid. For instance, strictly speaking, `Interval(Real, 0, None, closed="both")` corresponds to `[0, +∞) U {+∞}`. ct||_||_||_||_|dSr)rrrIleftrightclosed _check_params)rbrIrrrrs rrzInterval.__init__sM      rc|jtttfvrt d|jd|jdvrt d|jd|jturd}|j,t|jtstd||j ,t|j tstd||j#|jdvrt d |jd ||j #|jd vrt d |jd |n`|j)t|jtstd |j )t|j tstd|j 6|j1|j |jkr#t d|jd|j dSdSdS)NzFtype must be either numbers.Integral, numbers.Real or RealNotInt. Got r.)rrbothneitherz@closed must be either 'left', 'right', 'both' or 'neither'. Got z"for an interval over the integers.zExpecting left to be an int zExpecting right to be an int rrz"left can't be None when closed ==  rrz#right can't be None when closed == z#Expecting left to be a real number.z$Expecting right to be a real number.z(right can't be less than left. Got left=z and right=) rIrrrrUrrrB TypeErrorr)rbsuffixs rrzInterval._check_paramss" 9XtZ8 8 8- ---  ;B B B.{...  9 9Fy$Z 8-L-L$ Gv G GHHHz%jX.N.N% H H HIIIy T[4D%D%D OOOvOOz!dk5F&F&F P$+PPPPy$Z 4-H-H$ EFFFz%jT.J.J% FGGG : !di&; di@W@W&49&&&&  " !&;&;@W@Wrct|tstj|rdS|jdvr t jn t j}|jdvr t jn t j }|j tj n|j }|j tj n|j }|||rdS|||rdSdS)NFrrT) rBrnprroperatorltlegtgerinfr)rbrleft_cmp right_cmprrs r __contains__zInterval.__contains__s#x(( RXc]] 5"&+1A"A"A8;;x{#';2C#C#CHKK )+ww*,$* 8C   5 9S%  5trc8t||jsdS||vSrrrs rr0zInterval.is_satisfied_bys%#ty)) 5d{rc|jturdnd}|jdvrdnd}|jdn|j}|jdn|j}|jdvrd nd }|jtks)t |jt rt|}|jtks)t |jt rt|}|d ||d ||S) Nzan intza floatr[(z-infrr])z in the range r&)rIrrrrrBrr)rbtype_str left_bracket left_bound right_bound right_brackets rrzInterval.__str__s#yH4488)"k-===ss3 #y0VVdi #z1eetz #{.???S yH$$DIt)D)D$z**JyH$$DJ)E)E$ ,,K H H H' H H+6 H8E H H r) rrrrrrrr0rrrs@rrKrKs!!F%%%N         rrKceZdZdZdZdZdS)rCz#Constraint representing array-likesc t|Srrrs rr0z_ArrayLikes.is_satisfied_bys',,,rcdS)Nz an array-likerrs rrz_ArrayLikes.__str__srNrrrrrCrC s8-----rrCceZdZdZdZdZdS)rDz(Constraint representing sparse matrices.c t|Sr)r rs rr0z_SparseMatrices.is_satisfied_by}}rcdS)Nza sparse matrixrrs rrz_SparseMatrices.__str__s  rNrrrrrDrDs822!!!!!rrDceZdZdZdZdZdS)rGz"Constraint representing callables.c t|Sr)rFrs rr0z_Callables.is_satisfied_by$rrcdS)Nz a callablerrs rrz_Callables.__str__'s|rNrrrrrGrG!s8,,rrGc.eZdZdZfdZdZdZxZS)rEzConstraint representing random states. Convenience class for [Interval(Integral, 0, 2**32 - 1, closed="both"), np.random.RandomState, None] ctttdddt t jjtg|_ dS)Nrlrr) rrrKrrJrrandom RandomStaterH _constraintsrbrs rrz_RandomStates.__init__2sV  Xq)F ; ; ; . / /    rcDtfd|jDS)Nc3BK|]}|VdSrr0r r+rs r z0_RandomStates.is_satisfied_by..;1EEa1$$S))EEEEEEranyrrs `rr0z_RandomStates.is_satisfied_by:)EEEE43DEEEEEErczdd|jddDd|jdS)Nr&c,g|]}t|Srr(r*s rr"z)_RandomStates.__str__..?AAAQ#a&&AAArr,r-r2rrs rrz_RandomStates.__str__=PyyAA$*;CRC*@AAABB ( (!"% ( ( rrrs@rrErE+c      FFF       rrEc.eZdZdZfdZdZdZxZS)rPz[Constraint representing boolean likes. Convenience class for [bool, np.bool_] ctttttjg|_dSr)rrrJboolrbool_rrs rrz_Booleans.__init__KsA      " " rcDtfd|jDS)Nc3BK|]}|VdSrrrs rrz,_Booleans.is_satisfied_by..Srrrrs `rr0z_Booleans.is_satisfied_byRrrczdd|jddDd|jdS)Nr&c,g|]}t|Srr(r*s rr"z%_Booleans.__str__..Wrrr,r-rrs rrz_Booleans.__str__Urrrrs@rrPrPDsc      FFF       rrPc.eZdZdZfdZdZdZxZS)rQzHelper constraint for the verbose parameter. Convenience class for [Interval(Integral, 0, None, closed="left"), bool, numpy.bool_] ctttdddt t t t jg|_dS)Nrrr) rrrKrrJr rr rrs rrz_VerboseHelper.__init__csU  Xq$v 6 6 6     " " rcDtfd|jDS)Nc3BK|]}|VdSrrrs rrz1_VerboseHelper.is_satisfied_by..lrrrrs `rr0z_VerboseHelper.is_satisfied_bykrrczdd|jddDd|jdS)Nr&c,g|]}t|Srr(r*s rr"z*_VerboseHelper.__str__..prrr,r-rrs rrz_VerboseHelper.__str__nrrrrs@rrQrQ\r rrQc0eZdZdZdfd ZdZdZxZS)rOaHelper constraint for the `missing_values` parameters. Convenience for [ Integral, Interval(Real, None, None, closed="both"), str, # when numeric_only is False None, # when numeric_only is False _NanConstraint(), _PandasNAConstraint(), ] Parameters ---------- numeric_only : bool, default=False Whether to consider only numeric missing value markers. Fcrt||_ttt t dddttg|_ |js<|j tttgdSdS)Nrr) rr numeric_onlyrJrrKrrTrrextendr)rH)rbrrs rrzMissingValues.__init__s (  " " T4f 5 5 5     ! !    M   $ $l3&7&79J9J%K L L L L L M MrcDtfd|jDS)Nc3BK|]}|VdSrrrs rrz0MissingValues.is_satisfied_by..rrrrs `rr0zMissingValues.is_satisfied_byrrczdd|jddDd|jdS)Nr&c,g|]}t|Srr(r*s rr"z)MissingValues.__str__..rrr,r-rrs rrzMissingValues.__str__rr)Frrs@rrOrOusn& M M M M M MFFF       rrOc\eZdZdZedeegidfdZdZdZ xZ S)rNaIConstraint representing objects that expose specific methods. It is useful for parameters following a protocol and where we don't want to impose an affiliation to a specific module or class. Parameters ---------- methods : str or list of str The method(s) that the object is expected to expose. methodsT)rwctt|tr|g}||_dSr)rrrBr)r!)rbr!rs rrzHasMethods.__init__s?  gs # # iG rcDtfd|jDS)Nc3TK|]"}tt|dV#dSr)rFgetattr)r methodrs rrz-HasMethods.is_satisfied_by..s7SSF8GC6677SSSSSSr)allr!rs `rr0zHasMethods.is_satisfied_bys(SSSSdlSSSSSSrct|jdkr|jd}n.sAAA!d1ggAAArr,z and zan object implementing )r1r!r2)rbr!s rrzHasMethods.__str__s t|   ! !a,GG99AAt|CRC/@AAABB))L$)) 3222r) rrrrr}r)listrr0rrrs@rrNrNs  _ S$K &*  TTT3333333rrNceZdZdZdZdZdS)_IterablesNotStringz7Constraint representing iterables that are not strings.cXt|tot|t Sr)rBrr)rs rr0z#_IterablesNotString.is_satisfied_bys$#x((EC1E1E-EErcdS)Nz an iterablerrs rrz_IterablesNotString.__str__s}rNrrrrr/r/s;AAFFFrr/c.eZdZdZfdZdZdZxZS)rRzConstraint representing cv objects. Convenient class for [ Interval(Integral, 2, None, closed="left"), HasMethods(["split", "get_n_splits"]), _IterablesNotString(), None, ] ctttdddt ddgt t g|_dS)Nr rrsplit get_n_splits)rrrKrrNr/rHrrs rrz_CVObjects.__init__s_  Xq$v 6 6 6 0 1 1  ! !     rcDtfd|jDS)Nc3BK|]}|VdSrrrs rrz-_CVObjects.is_satisfied_by..rrrrs `rr0z_CVObjects.is_satisfied_byrrczdd|jddDd|jdS)Nr&c,g|]}t|Srr(r*s rr"z&_CVObjects.__str__..rrr,r-rrs rrz_CVObjects.__str__rrrrs@rrRrRsc       FFF       rrRceZdZdZdZdS)rSzClass encapsulating a constraint not meant to be exposed to the user. Parameters ---------- constraint : str or _Constraint instance The constraint to be used internally. c||_dSrrV)rbr!s rrzHidden.__init__s $rN)rrrrrrrrrSrSs-%%%%%rrScNt|trdd|jSt|trt jgdSt|trdSt|trtddiSt|trdSt|trdSt|tr7|j tur)|j |jd z S|j |jd zSt t|trn|j t"t$fvrY|j |jd z S|j |jd zS|jd vr t j S|jd vr t jSt jSt )aReturn a value that does not satisfy the constraint. Raises a NotImplementedError if there exists no invalid value for this constraint. This is only useful for testing purpose. Parameters ---------- constraint : _Constraint instance The constraint to generate a value for. Returns ------- val : object A value that does not satisfy the constraint. znot r-rr r, HasNotMethodsrza stringznot a cv objectNrgư>)rr)rr)rBrLr2rrOrarrayrQrNrIr/rRrKrrrNotImplementedErrorrrrrr@rVs rgenerate_invalid_param_valrBs"*j))87fkk*"455777*m,,#x """*n--r*j))/,tOR,,...*122z*j))!  *h''"JOx,G,G ? &?Q& &   '#a' '"!*h'' JOj?Q,Q,Q ? &?T) )   '#d* *   4 4 4F7N   3 3 36Mv rcTt|trtjgdSt|trt ddgddggSt|t rtjdSt|trdSt|trdSt|trT|j tj urtjgdS|j ttfvrdS| St|t rdSt|t"rdSt|t$r|jr tjSt|t$r |jsdSt|t*r(td d d |jDSt|t.rgdSt|t0rd St|t2r |jD]}|cSt|t6r^|}|j |jdS|j |jdz S|j |jdzS|j tur|j|jzd z S|jdzSt=d|)a1Return a value that does satisfy a constraint. This is only useful for testing purpose. Parameters ---------- constraint : Constraint instance The constraint to generate a value for. Returns ------- val : object A value that does satisfy the constraint. r=rr*c|Srr)xs rz&generate_valid_param..SsrNTmissingValidHasMethodsrci|]}|dS)cdSrrrs rrGz1generate_valid_param...qsDrrr+s rrhz(generate_valid_param..qs#U#U#UQA'8'8#U#U#Urr rA)rBrCrr@rDr rErrrGrHrJrIndarrayrrrPrQrOrr@rNr!r/rRrMrrKrrrU)r!rintervals rgenerate_valid_paramrO:s*k**#x """*o..,Aq6Aq6*+++*m,,)y$$R(((*j)){*o..t*l++ ! ?bj ( (8III&& & ?x. . .1   *i((t*n--q*m,,1Hv *m,,Z5Ly*j))  t r#U#U*BT#U#U#U     *122yy*j))q*g&& (  FMMM*h'' ) = X^%;1 ] ">A% % ^ #=1$ $}$$ 6!;;}q(( === > >>r)7rzrrrnabcrrcollections.abcrinspectrnumbersrrnumpyr scipy.sparser r _configr r validationrrUrrr:rr}rregisterrrrrJrHrTrrMrLrKrCrDrGrErPrQrOrNr/rRrSrBrOrrrrYs  ########$$$$$$""""""""--------00000000000000J IIIX)?)?)?XSSSl E " " "JJJJJ#JJJ4;;;;;;;;;(k     [        +   &D&D&D&D&Dk&D&D&DRKKKKKKKK"z z z z z {z z z z+!!!!!k!!!     K   2        0     [   2* * * * * K* * * Z!3!3!3!3!3!3!3!3H+        > % % % % % % % %;;;|R?R?R?R?R?r