M/PhѩdZddlmZddlmZddlmZddlZddl m Z ddl m Z m Z ddZdZGddZ d dZ d!dZ d dZ d dZ d dZ d dZ d dZ d dZ d dZdS)"z Functions that are general enough to use for any model fitting. The idea is to untie these from LikelihoodModel so that they may be re-used generally. ) annotations)Any)SequenceN)optimize)SP_LT_15SP_LT_17kwargsdict[str, Any]allowed Sequence[str]methodstrc Htt|t|}|rQddl}|d|dd|dd|dtdSdS)NrzzKeyword arguments have been passed to the optimizer that have no effect. The list of allowed keyword arguments for method z is: z, z<. The list of unsupported keyword arguments passed include: z&. After release 0.14, this will raise.)setlistkeys differencewarningswarnjoin FutureWarning)r r r extrars Z/var/www/html/test/jupyter/venv/lib/python3.11/site-packages/statsmodels/base/optimizer.py check_kwargsrs V[[]]## $ $ / /W > >E    - - - IIg.. - -2651A1A - - -          c6||vrd|z}t|dS)NzUnknown fit method %s) ValueError)r methodsmessages r _check_methodr s- W)F2!!!rc&eZdZ d dZdZdZdS) OptimizerNnewtondTFc |dt} gd}|| z }|}t ||t t tttttttd }| r|| ||}||||||| || | | | \}}|||| | || | | d }|||||fS)aN" Fit function for any model with an objective function. Parameters ---------- objective : function Objective function to be minimized. gradient : function The gradient of the objective function. start_params : array_like, optional Initial guess of the solution for the loglikelihood maximization. The default is an array of zeros. fargs : tuple Extra arguments passed to the objective function, i.e. objective(x,*args) kwargs : dict[str, Any] Extra keyword arguments passed to the objective function, i.e. objective(x,**kwargs) hessian : str, optional Method for computing the Hessian matrix, if applicable. method : str {'newton','nm','bfgs','powell','cg','ncg','basinhopping', 'minimize'} Method can be 'newton' for Newton-Raphson, 'nm' for Nelder-Mead, 'bfgs' for Broyden-Fletcher-Goldfarb-Shanno, 'powell' for modified Powell's method, 'cg' for conjugate gradient, 'ncg' for Newton- conjugate gradient, 'basinhopping' for global basin-hopping solver, if available or a generic 'minimize' which is a wrapper for scipy.optimize.minimize. `method` determines which solver from scipy.optimize is used. The explicit arguments in `fit` are passed to the solver, with the exception of the basin-hopping solver. Each solver has several optional arguments that are not the same across solvers. See the notes section below (or scipy.optimize) for the available arguments and for the list of explicit arguments that the basin-hopping solver supports.. maxiter : int The maximum number of iterations to perform. full_output : bool Set to True to have all available output in the Results object's mle_retvals attribute. The output is dependent on the solver. See LikelihoodModelResults notes section for more information. disp : bool Set to True to print convergence messages. callback : callable callback(xk) Called after each iteration, as callback(xk), where xk is the current parameter vector. retall : bool Set to True to return list of solutions at each iteration. Available in Results object's mle_retvals attribute. Returns ------- xopt : ndarray The solution to the objective function retvals : dict, None If `full_output` is True then this is a dictionary which holds information returned from the solver used. If it is False, this is None. optim_settings : dict A dictionary that contains the parameters passed to the solver. Notes ----- The 'basinhopping' solver ignores `maxiter`, `retall`, `full_output` explicit arguments. Optional arguments for the solvers (available in Results.mle_settings):: 'newton' tol : float Relative error in params acceptable for convergence. 'nm' -- Nelder Mead xtol : float Relative error in params acceptable for convergence ftol : float Relative error in loglike(params) acceptable for convergence maxfun : int Maximum number of function evaluations to make. 'bfgs' gtol : float Stop when norm of gradient is less than gtol. norm : float Order of norm (np.inf is max, -np.inf is min) epsilon If fprime is approximated, use this value for the step size. Only relevant if LikelihoodModel.score is None. 'lbfgs' m : int The maximum number of variable metric corrections used to define the limited memory matrix. (The limited memory BFGS method does not store the full hessian but uses this many terms in an approximation to it.) pgtol : float The iteration will stop when ``max{|proj g_i | i = 1, ..., n} <= pgtol`` where pg_i is the i-th component of the projected gradient. factr : float The iteration stops when ``(f^k - f^{k+1})/max{|f^k|,|f^{k+1}|,1} <= factr * eps``, where eps is the machine precision, which is automatically generated by the code. Typical values for factr are: 1e12 for low accuracy; 1e7 for moderate accuracy; 10.0 for extremely high accuracy. See Notes for relationship to ftol, which is exposed (instead of factr) by the scipy.optimize.minimize interface to L-BFGS-B. maxfun : int Maximum number of iterations. epsilon : float Step size used when approx_grad is True, for numerically calculating the gradient approx_grad : bool Whether to approximate the gradient numerically (in which case func returns only the function value). 'cg' gtol : float Stop when norm of gradient is less than gtol. norm : float Order of norm (np.inf is max, -np.inf is min) epsilon : float If fprime is approximated, use this value for the step size. Can be scalar or vector. Only relevant if Likelihoodmodel.score is None. 'ncg' fhess_p : callable f'(x,*args) Function which computes the Hessian of f times an arbitrary vector, p. Should only be supplied if LikelihoodModel.hessian is None. avextol : float Stop when the average relative error in the minimizer falls below this amount. epsilon : float or ndarray If fhess is approximated, use this value for the step size. Only relevant if Likelihoodmodel.hessian is None. 'powell' xtol : float Line-search error tolerance ftol : float Relative error in loglike(params) for acceptable for convergence. maxfun : int Maximum number of function evaluations to make. start_direc : ndarray Initial direction set. 'basinhopping' niter : int The number of basin hopping iterations. niter_success : int Stop the run if the global minimum candidate remains the same for this number of iterations. T : float The "temperature" parameter for the accept or reject criterion. Higher "temperatures" mean that larger jumps in function value will be accepted. For best results `T` should be comparable to the separation (in function value) between local minima. stepsize : float Initial step size for use in the random displacement. interval : int The interval for how often to update the `stepsize`. minimizer : dict Extra keyword arguments to be passed to the minimizer `scipy.optimize.minimize()`, for example 'method' - the minimization method (e.g. 'L-BFGS-B'), or 'tol' - the tolerance for termination. Other arguments are mapped from explicit argument of `fit`: - `args` <- `fargs` - `jac` <- `score` - `hess` <- `hess` 'minimize' min_method : str, optional Name of minimization method to use. Any method specific arguments can be passed directly. For a list of methods and their arguments, see documentation of `scipy.optimize.minimize`. If no method is specified, then BFGS is used. extra_fit_funcs) r#nmbfgslbfgspowellcgncg basinhoppingminimize) r#r'r(r)r+r,r*r-r.)dispmaxitercallbackretall full_outputhess) optimizer start_paramsr0r3r/fargsr1r2r&)getdictrlowerr _fit_newton_fit_nm _fit_bfgs _fit_lbfgs_fit_cg_fit_ncg _fit_powell_fit_basinhopping _fit_minimizeupdate)self objectivegradientr6r7r hessianr r0r3r/r1r2r&r fit_funcsfuncxoptretvalsoptim_settingss r_fitzOptimizer._fit$s.j!**%6??///?'')))fg&&&"!-%     .   _ - - - Y,v"&($* ")+++ g (.|%,["&H$*PP f%%%Wn,,rct)a TODO: how to add constraints? Something like sm.add_constraint(Model, func) or model_instance.add_constraint(func) model_instance.add_constraint("x1 + x2 = 2") result = model_instance.fit() NotImplementedErrorrEparamss r_fit_constrainedzOptimizer._fit_constraineds "!rctNrPrRs r_fit_regularizedzOptimizer._fit_regularizeds "!r)Nr#r$TTNF)__name__ __module__ __qualname__rNrTrWrrr"r"#sQEI.3Z-Z-Z-Z-x " " """"""rr"Tr$Fc |ddgdfd|D} || d<|| d<gd} gd} |d| vrd } |d| vrd }gd }ts|d gz }ts|d gz }gd }d|vr|d|vr |d}nd }d|vr|d|vr |d}nd}t j||||d|| ||||  }|j}d }| rbt|dtj }|j ||j |j |jd}|r)|d|i||fS)a Fit using scipy minimize, where kwarg `min_method` defines the algorithm. Parameters ---------- f : function Returns negative log likelihood given parameters. score : function Returns gradient of negative log likelihood with respect to params. start_params : array_like, optional Initial guess of the solution for the loglikelihood maximization. The default is an array of zeros. fargs : tuple Extra arguments passed to the objective function, i.e. objective(x,*args) kwargs : dict[str, Any] Extra keyword arguments passed to the objective function, i.e. objective(x,**kwargs) disp : bool Set to True to print convergence messages. maxiter : int The maximum number of iterations to perform. callback : callable callback(xk) Called after each iteration, as callback(xk), where xk is the current parameter vector. retall : bool Set to True to return list of solutions at each iteration. Available in Results object's mle_retvals attribute. full_output : bool Set to True to have all available output in the Results object's mle_retvals attribute. The output is dependent on the solver. See LikelihoodModelResults notes section for more information. hess : str, optional Method for computing the Hessian matrix, if applicable. Returns ------- xopt : ndarray The solution to the objective function retvals : dict, None If `full_output` is True then this is a dictionary which holds information returned from the solver used. If it is False, this is None. min_methodBFGS)r&niterr]tolbounds constraintsc$i|] \}}|v || Sr[r[).0kv filter_optss r z!_fit_minimize..Ns)GGG1!;2F2Fq!2F2F2Frr/r0) Nelder-MeadPowellCGr^COBYLASLSQP)rirjrlN)L-BFGS-BTNCrm trust-constrrjri)rlrmrprarbr[)argsr jacr4rarbr1optionsnitfopt iterationsfcallswarnflag convergedallvecs) setdefaultitemsrrrrr.xgetattrnpnanfunnfevstatussuccessrDvalues)fscorer6r7r r/r0r1r2r3r4rsno_hessno_jac has_boundshas_constraintsrarbresrKrLrtrgs @rrCrCs^ lF+++]\\KGGGG GGGGGFO GIIHHG 0 0 0F lw&& lv%%>==J !xj &}o% 999O6;;==  VL%9Z%G%G! %%&*>/*Q*Q]+   A|%|@T %D[%-w @ @ @C 5DG6c5"&))7# X3: # --  6 NNIszz||4 5 5 5 =r绽|=c t|dd|dd} |dd} d} tj}tj|}|r||g}| |krtjtj||z | krtj| |}tj| dks-|tj|j dxx| z cc<|}|tj |||z }|r| || ||| d z } | |kr-tjtj||z | k||g|R}| |kr8d }|r3td td |ztd | zn7d}|r3td td |ztd| z| rL|||g|R| ||| |f\}}}}}| }||||||d}|r|d|in|}d}||fS)a Fit using Newton-Raphson algorithm. Parameters ---------- f : function Returns negative log likelihood given parameters. score : function Returns gradient of negative log likelihood with respect to params. start_params : array_like, optional Initial guess of the solution for the loglikelihood maximization. The default is an array of zeros. fargs : tuple Extra arguments passed to the objective function, i.e. objective(x,*args) kwargs : dict[str, Any] Extra keyword arguments passed to the objective function, i.e. objective(x,**kwargs) disp : bool Set to True to print convergence messages. maxiter : int The maximum number of iterations to perform. callback : callable callback(xk) Called after each iteration, as callback(xk), where xk is the current parameter vector. retall : bool Set to True to return list of solutions at each iteration. Available in Results object's mle_retvals attribute. full_output : bool Set to True to have all available output in the Results object's mle_retvals attribute. The output is dependent on the solver. See LikelihoodModelResults notes section for more information. hess : str, optional Method for computing the Hessian matrix, if applicable. ridge_factor : float Regularization factor for Hessian matrix. Returns ------- xopt : ndarray The solution to the objective function retvals : dict, None If `full_output` is True then this is a dictionary which holds information returned from the solver used. If it is False, this is None. )r` ridge_factorr#r`g:0yE>rrrNz8Warning: Maximum number of iterations has been exceeded.z# Current function value: %fz Iterations: %dz%Optimization terminated successfully.z Iterations %d)rvrwrHessianryrzr{)rr|rinfasarrayanyabsall diag_indicesshapelinalgsolveappendprintrD)rrr6r7r r/r0r1r2r3r4rr`rw oldparams newparamshistoryHfvalryrKrvr_gopthoptrzrLs rr;r;s b0(;;;   E4 ( (C$$^U;;LJI <((I )i(   BF26)2;3<,=,=?B,C%D%D  JttI ' 'vla'(( ; boagaj)) * * *l : * * *  553C3C D DD  & NN9 % % %   HY   a    BF26)2;3<,=,=?B,C%D%D  1Y    DW  :     7$> ? ? ? +j8 9 9 9  9 9 : : : 7$> ? ? ? *Z7 8 8 8!11Y#7#7#7#7"EE)$4$4Y) tU t!L ut" )++  1 NNIw/ 0 0 0 =rc t|dd|dd} |dtj} |dd} t j||||| | | || ||| }| r?|s |\}}}}}}}n |\}}}}}}}}| }|||||||d }|r|d |in|}d }||fS) a Fit using Broyden-Fletcher-Goldfarb-Shannon algorithm. Parameters ---------- f : function Returns negative log likelihood given parameters. score : function Returns gradient of negative log likelihood with respect to params. start_params : array_like, optional Initial guess of the solution for the loglikelihood maximization. The default is an array of zeros. fargs : tuple Extra arguments passed to the objective function, i.e. objective(x,*args) kwargs : dict[str, Any] Extra keyword arguments passed to the objective function, i.e. objective(x,**kwargs) disp : bool Set to True to print convergence messages. maxiter : int The maximum number of iterations to perform. callback : callable callback(xk) Called after each iteration, as callback(xk), where xk is the current parameter vector. retall : bool Set to True to return list of solutions at each iteration. Available in Results object's mle_retvals attribute. full_output : bool Set to True to have all available output in the Results object's mle_retvals attribute. The output is dependent on the solver. See LikelihoodModelResults notes section for more information. hess : str, optional Method for computing the Hessian matrix, if applicable. Returns ------- xopt : ndarray The solution to the objective function retvals : dict, None If `full_output` is True then this is a dictionary which holds information returned from the solver used. If it is False, this is None. gtolnormepsilonr(rh㈵>rrP>) rqrrrr0r3r/r2r1)rvrHinvrxgcallsryrzr{N)rr|rrr fmin_bfgsrD)rrr6r7r r/r0r1r2r3r4rrrrLrKrvrrrxrryr{rzs rr=r=s-^4f===   V%; < .rs$???Q1;;Avay;;;rrFrNrzRa finite-differences epsilon was provided even though we are not using approx_gradzagradient approximation was requested even though an analytic loglike_and_score function was givencDtd|g|RDS)Nc3K|]}| VdSrVr[)rdr~s r z/_fit_lbfgs....s$"H"H!A2"H"H"H"H"H"Hr)tuple)pars rz_fit_lbfgs..s2U"H"H/@/@/GQ/G/G/G"H"H"HHHrfprime)r0r1rqrar/rygradfuncallsrt)rvrrxryrzrw)rr|lenr8rr fmin_l_bfgs_b)rrr6r7r r/r0r1r2r3r4ranames extra_kwargsrrrJrLrKrvdryrzrrxrwrs ` @rr>r>1shl   x,#l:K:K)K L LF h""" HE????%???L**]E22K #6==jjD))GE{EDEE E&(&%&& &HHHH !& X $T<5.6U,255(455G  dA Z=] y:uX 'i!+--qz =rc lt|dd|dd} |dd} |dd} tj|||| | || | ||| }| r9|s |\}}}}}n |\}}}}}}| }|||||d }|r|d |in|}d}||fS) a Fit using Nelder-Mead algorithm. Parameters ---------- f : function Returns negative log likelihood given parameters. score : function Returns gradient of negative log likelihood with respect to params. start_params : array_like, optional Initial guess of the solution for the loglikelihood maximization. The default is an array of zeros. fargs : tuple Extra arguments passed to the objective function, i.e. objective(x,*args) kwargs : dict[str, Any] Extra keyword arguments passed to the objective function, i.e. objective(x,**kwargs) disp : bool Set to True to print convergence messages. maxiter : int The maximum number of iterations to perform. callback : callable callback(xk) Called after each iteration, as callback(xk), where xk is the current parameter vector. retall : bool Set to True to return list of solutions at each iteration. Available in Results object's mle_retvals attribute. full_output : bool Set to True to have all available output in the Results object's mle_retvals attribute. The output is dependent on the solver. See LikelihoodModelResults notes section for more information. hess : str, optional Method for computing the Hessian matrix, if applicable. Returns ------- xopt : ndarray The solution to the objective function retvals : dict, None If `full_output` is True then this is a dictionary which holds information returned from the solver used. If it is False, this is None. )xtolftolrr'r-C6?rrN) rqrrr0rr3r/r2r1rur{)rr|rfminrD)rrr6r7r r/r0r1r2r3r4rrrrLrKrvr_rxryr{rzs rr<r<s^3T:::   VV , ,D   VV , ,D   x . .FmA|%d!%wv(3$v%-///G  C29 /D$vxx;B 8D$vx L u# )++  1 NNIw/ 0 0 0 =rc t|dd|dd} |dtj} |dd} t j|||| | | || ||| }| r9|s |\}}}}}n |\}}}}}}| }|||||d }|r|d |in|}d }||fS) a Fit using Conjugate Gradient algorithm. Parameters ---------- f : function Returns negative log likelihood given parameters. score : function Returns gradient of negative log likelihood with respect to params. start_params : array_like, optional Initial guess of the solution for the loglikelihood maximization. The default is an array of zeros. fargs : tuple Extra arguments passed to the objective function, i.e. objective(x,*args) kwargs : dict[str, Any] Extra keyword arguments passed to the objective function, i.e. objective(x,**kwargs) disp : bool Set to True to print convergence messages. maxiter : int The maximum number of iterations to perform. callback : callable callback(xk) Called after each iteration, as callback(xk), where xk is the current parameter vector. retall : bool Set to True to return list of solutions at each iteration. Available in Results object's mle_retvals attribute. full_output : bool Set to True to have all available output in the Results object's mle_retvals attribute. The output is dependent on the solver. See LikelihoodModelResults notes section for more information. hess : str, optional Method for computing the Hessian matrix, if applicable. Returns ------- xopt : ndarray The solution to the objective function retvals : dict, None If `full_output` is True then this is a dictionary which holds information returned from the solver used. If it is False, this is None. rr+rrrrr)rrrr0r3r/r2r1)rvrxrryrzr{N)rr|rrrfmin_cgrD)rrr6r7r r/r0r1r2r3r4rrrrLrKrvrxrryr{rzs rr?r?s^4d;;;   V%; < . s . . .tq!a . . .rr_r$rNrg?rg?r2rrrqrrr rnr4) minimizer_kwargsr_rrrr/r1rrzcompleted successfullyr)rvrwrxrz) rr}r|r8rr-r~rrtrr)rrr6r7r r/r0r1r2r3r4r_rrrrrrr rLrKs rrBrBs^T / .v||~~ . . .F   gs + +E%%ot<r<r?r@rArBr[rrrs$#"""""$$$$$$77777777     """ q"q"q"q"q"q"q"q"p?C5:)-aaaaH=A38:?eeeeP;?16%)GGGGTJMCGzzzzz9=/4#'FFFFR9=/4#'FFFFR:>05$(HHHHV=A38'+IIIIXCG9>-1SSSSSSr