,YHhxnddlmZddlZddlmZddlZddlZddlZddlm Z ddl m Z ddl m Z ddl m Z ddlZddlZddlmZe deeeefZd Zd ZGd d ej4ZGd deZeddeGddeZeddeGddeZeddeGddeZGddeZ eddeGdde Z!eddeGdde Z" d)dZ#Gdd eZ$e e"e!eeeee$fZ%d*d!Z&d+d"Z' d,d#Z(d-d$Z)d.d%Z*d/d&Z+ d0 d1d'Z,d2d(Z-y)3) annotationsN)Sequence)Real)Any)cast)Union)deprecated_classz=Use :class:`~optuna.distributions.FloatDistribution` instead.z;Use :class:`~optuna.distributions.IntDistribution` instead.ceZdZdZd dZej d dZej d dZej ddZ ddZ ddZ ddZ dd Z y )BaseDistributionzBase class for distributions. Note that distribution classes are not supposed to be called by library users. They are used by :class:`~optuna.trial.Trial` and :class:`~optuna.samplers` internally. c|S)a0Convert internal representation of a parameter value into external representation. Args: param_value_in_internal_repr: Optuna's internal representation of a parameter value. Returns: Optuna's external representation of a parameter value. selfparam_value_in_internal_reprs M/var/www/html/planif/env/lib/python3.12/site-packages/optuna/distributions.pyto_external_reprz!BaseDistribution.to_external_repr#s ,+ct)a0Convert external representation of a parameter value into internal representation. Args: param_value_in_external_repr: Optuna's external representation of a parameter value. Returns: Optuna's internal representation of a parameter value. NotImplementedError)rparam_value_in_external_reprs rto_internal_reprz!BaseDistribution.to_internal_repr0s "!rct)zTest whether the range of this distribution contains just a single value. Returns: :obj:`True` if the range of this distribution contains just a single value, otherwise :obj:`False`. rrs rsinglezBaseDistribution.single>s "!rct)agTest if a parameter value is contained in the range of this distribution. Args: param_value_in_internal_repr: Optuna's internal representation of a parameter value. Returns: :obj:`True` if the parameter value is contained in the range of this distribution, otherwise :obj:`False`. rrs r _containszBaseDistribution._containsIs "!rc|jSN)__dict__rs r_asdictzBaseDistribution._asdictXs }}rct|tstSt|t|ury|j|jk(SNF) isinstancer NotImplementedtyper )rothers r__eq__zBaseDistribution.__eq__[s9%!12! ! :T%[ (}}..rc t|jftt|jj zSr)hash __class__tuplesortedr itemsrs r__hash__zBaseDistribution.__hash__bs0T^^%fT]]5H5H5J.K(LLMMrcdjdt|jjD}dj |j j |S)Nz, c3FK|]\}}dj||yw)z{}={}N)format).0kvs r z,BaseDistribution.__repr__..fs[DAq7>>!Q/[s!z{}({}))joinr-r!r.r2r+__name__)rkwargss r__repr__zBaseDistribution.__repr__esE[F4<<>CWCWCYr<dictr'rr<r>)r<int)r<str)r8 __module__ __qualname____doc__rabcabstractmethodrrrr!r(r/r:r rrr r sp ,  " " ""  " "/N@rr cFeZdZdZ d ddZd dZd dZd dZy) FloatDistributionaaA distribution on floats. This object is instantiated by :func:`~optuna.trial.Trial.suggest_float`, and passed to :mod:`~optuna.samplers` in general. .. note:: When ``step`` is not :obj:`None`, if the range :math:`[\mathsf{low}, \mathsf{high}]` is not divisible by :math:`\mathsf{step}`, :math:`\mathsf{high}` will be replaced with the maximum of :math:`k \times \mathsf{step} + \mathsf{low} < \mathsf{high}`, where :math:`k` is an integer. Attributes: low: Lower endpoint of the range of the distribution. ``low`` is included in the range. ``low`` must be less than or equal to ``high``. If ``log`` is :obj:`True`, ``low`` must be larger than 0. high: Upper endpoint of the range of the distribution. ``high`` is included in the range. ``high`` must be greater than or equal to ``low``. log: If ``log`` is :obj:`True`, this distribution is in log-scaled domain. In this case, all parameters enqueued to the distribution must be positive values. This parameter must be :obj:`False` when the parameter ``step`` is not :obj:`None`. step: A discretization step. ``step`` must be larger than 0. This parameter must be :obj:`None` when the parameter ``log`` is :obj:`True`. Nc|r | td||kDrtdj|||r |dkrtdj||||dkrtdj|d|_|t|||}t ||_t ||_t ||_||_y)Nz9The parameter `step` is not supported when `log` is true.TThe `low` value must be smaller than or equal to the `high` value (low={}, high={}).zOThe `low` value must be larger than 0 for a log distribution (low={}, high={}).r>The `step` value must be non-zero positive value, but step={}.) ValueErrorr2step_adjust_discrete_uniform_highr;lowhighlogrrSrTrUrQs r__init__zFloatDistribution.__init__s 4#XY Y :%%+VC%6  3#:%%+VC%6    SZZ[_`   0dDADd DI:$K rc|j|j|jk(S|j|jk(rytjt |j}tjt |j}tjt |j}||z |kSNT)rQrSrTdecimalDecimalrD)rrTrSrQs rrzFloatDistribution.singles 99 88tyy( (xx499$??3tyy>2D//#dhh-0C??3tyy>2D3J$& &rc|}|j$|j|cxkxr|jkScS||jz |jz }|j|cxkxr|jkncxrt|t |z dkS)Ng:0yE>)rQrSrTabsround)rrvaluer4s rrzFloatDistribution._containssu, 99 88u1 1 11 1!TYY.A88u1 1Pc!eAh,6G&6P Prc t|}tj|rtd|d|j r|dkrtd|d|S#ttf$r}td|d|d}~wwxYwN'z8' is not a valid type. float-castable value is expected.`z` is invalid value.rNz)` is invalid value for the case log=True.r;rP TypeErrornpisnanrUrr internal_repres rrz"FloatDistribution.to_internal_repr !">?M 88M "q!= >>QRS S 88 ,011Z[ I& 01244   AA7"A22A7)FN) rSr;rTr;rUr>rQz None | floatr<Noner=r?)rr;r<r;)r8rErFrGrWrrrr rrrKrKjsL<PT %,0@L @ 'QrrKz3.0.0z6.0.0)textc,eZdZdZdfd ZddZxZS)UniformDistributionaA uniform distribution in the linear domain. This object is instantiated by :func:`~optuna.trial.Trial.suggest_float`, and passed to :mod:`~optuna.samplers` in general. Attributes: low: Lower endpoint of the range of the distribution. ``low`` is included in the range. ``low`` must be less than or equal to ``high``. high: Upper endpoint of the range of the distribution. ``high`` is included in the range. ``high`` must be greater than or equal to ``low``. c,t|||ddyNFrSrTrUrQsuperrWrrSrTr+s rrWzUniformDistribution.__init__ StTBrctj|j}|jd|jd|SNrUrQcopydeepcopyr poprds rr!zUniformDistribution._asdict/ MM$-- ( e  f rrSr;rTr;r<rmr@r8rErFrGrWr! __classcell__r+s@rrprps Crrpc,eZdZdZdfd ZddZxZS)LogUniformDistributionaKA uniform distribution in the log domain. This object is instantiated by :func:`~optuna.trial.Trial.suggest_float` with ``log=True``, and passed to :mod:`~optuna.samplers` in general. Attributes: low: Lower endpoint of the range of the distribution. ``low`` is included in the range. ``low`` must be larger than 0. ``low`` must be less than or equal to ``high``. high: Upper endpoint of the range of the distribution. ``high`` is included in the range. ``high`` must be greater than or equal to ``low``. c,t|||ddyNTrsrtrvs rrWzLogUniformDistribution.__init__ StDArctj|j}|jd|jd|Sryrzr~s rr!zLogUniformDistribution._asdictrrrr@rrs@rrrs BrrcdeZdZdZdfd ZddZeddZejd dZxZ S) DiscreteUniformDistributionaoA discretized uniform distribution in the linear domain. This object is instantiated by :func:`~optuna.trial.Trial.suggest_float` with ``step`` argument, and passed to :mod:`~optuna.samplers` in general. .. note:: If the range :math:`[\mathsf{low}, \mathsf{high}]` is not divisible by :math:`q`, :math:`\mathsf{high}` will be replaced with the maximum of :math:`k q + \mathsf{low} < \mathsf{high}`, where :math:`k` is an integer. Args: low: Lower endpoint of the range of the distribution. ``low`` is included in the range. ``low`` must be less than or equal to ``high``. high: Upper endpoint of the range of the distribution. ``high`` is included in the range. ``high`` must be greater than or equal to ``low``. q: A discretization step. ``q`` must be larger than 0. Attributes: low: Lower endpoint of the range of the distribution. ``low`` is included in the range. high: Upper endpoint of the range of the distribution. ``high`` is included in the range. c*t||||y)NrSrTrQrt)rrSrTqr+s rrWz$DiscreteUniformDistribution.__init__!s St!4rctj|j}|jd|jd}||d<|S)NrUrQrrz)rrrQs rr!z#DiscreteUniformDistribution._asdict$s: MM$-- ( e uuV}#rc6tt|jS)zDiscretization step. :class:`~optuna.distributions.DiscreteUniformDistribution` is a subtype of :class:`~optuna.distributions.FloatDistribution`. This property is a proxy for its ``step`` attribute. )rr;rQrs rrzDiscreteUniformDistribution.q,sE499%%rc||_yr)rQ)rr5s rrzDiscreteUniformDistribution.q6s  r)rSr;rTr;rr;r<rmr@)r<r;)r5r;r<rm) r8rErFrGrWr!propertyrsetterrrs@rrrs>85&&XXrrc:eZdZdZdd dZd dZd dZd dZd dZy)IntDistributiona^A distribution on integers. This object is instantiated by :func:`~optuna.trial.Trial.suggest_int`, and passed to :mod:`~optuna.samplers` in general. .. note:: When ``step`` is not :obj:`None`, if the range :math:`[\mathsf{low}, \mathsf{high}]` is not divisible by :math:`\mathsf{step}`, :math:`\mathsf{high}` will be replaced with the maximum of :math:`k \times \mathsf{step} + \mathsf{low} < \mathsf{high}`, where :math:`k` is an integer. Attributes: low: Lower endpoint of the range of the distribution. ``low`` is included in the range. ``low`` must be less than or equal to ``high``. If ``log`` is :obj:`True`, ``low`` must be larger than or equal to 1. high: Upper endpoint of the range of the distribution. ``high`` is included in the range. ``high`` must be greater than or equal to ``low``. log: If ``log`` is :obj:`True`, this distribution is in log-scaled domain. In this case, all parameters enqueued to the distribution must be positive values. This parameter must be :obj:`False` when the parameter ``step`` is not 1. step: A discretization step. ``step`` must be a positive integer. This parameter must be 1 when the parameter ``log`` is :obj:`True`. c|r|dk7r td||kDrtdj|||r |dkrtdj|||dkrtdj|||_t||_t||_t|}t |j ||j|_y)NzZSamplers and other components in Optuna only accept step is 1 when `log` argument is True.rMz\The `low` value must be equal to or greater than 1 for a log distribution (low={}, high={}).rrO)rPr2rUrCrQrS_adjust_int_uniform_highrTrVs rrWzIntDistribution.__init__Ys 419/  :%%+VC%6  37%%+VC%6  19PWWX\] I s84y,TXXtTYYG rct|Sr)rCrs rrz IntDistribution.to_external_reprws/00rc t|}tj|rtd|d|j r|dkrtd|d|S#ttf$r}td|d|d}~wwxYwrardrhs rrz IntDistribution.to_internal_reprzrkrlc|jr|j|jk(S|j|jk(ry|j|jz |jkSrY)rUrSrTrQrs rrzIntDistribution.singlesK 8888tyy( ( 88tyy  DHH$ 11rc|}|j|cxkxr|jkncxr||jz |jzdk(SNrr)rrr_s rrzIntDistribution._containss<,xx5-DII-U54883Ctyy2PTU2UUrN)Fr) rSrCrTrCrUr>rQrCr<rm)rr;r<rC)rrCr<r;r=r?) r8rErFrGrWrrrrr rrrr;s":H<1"2Vrrc.eZdZdZddfd ZddZxZS)IntUniformDistributionaA uniform distribution on integers. This object is instantiated by :func:`~optuna.trial.Trial.suggest_int`, and passed to :mod:`~optuna.samplers` in general. .. note:: If the range :math:`[\mathsf{low}, \mathsf{high}]` is not divisible by :math:`\mathsf{step}`, :math:`\mathsf{high}` will be replaced with the maximum of :math:`k \times \mathsf{step} + \mathsf{low} < \mathsf{high}`, where :math:`k` is an integer. Attributes: low: Lower endpoint of the range of the distribution. ``low`` is included in the range. ``low`` must be less than or equal to ``high``. high: Upper endpoint of the range of the distribution. ``high`` is included in the range. ``high`` must be greater than or equal to ``low``. step: A discretization step. ``step`` must be a positive integer. c,t|||d|yrrrtrrSrTrQr+s rrWzIntUniformDistribution.__init__rwrcftj|j}|jd|SNrUrzr~s rr!zIntUniformDistribution._asdict$ MM$-- ( e rrrSrCrTrCrQrCr<rmr@rrs@rrrs.Crrc.eZdZdZddfd ZddZxZS)IntLogUniformDistributionaA uniform distribution on integers in the log domain. This object is instantiated by :func:`~optuna.trial.Trial.suggest_int`, and passed to :mod:`~optuna.samplers` in general. Attributes: low: Lower endpoint of the range of the distribution. ``low`` is included in the range and must be larger than or equal to 1. ``low`` must be less than or equal to ``high``. high: Upper endpoint of the range of the distribution. ``high`` is included in the range. ``high`` must be greater than or equal to ``low``. step: A discretization step. ``step`` must be a positive integer. c,t|||d|yrrtrs rrWz"IntLogUniformDistribution.__init__rrcftj|j}|jd|Srrzr~s rr!z!IntLogUniformDistribution._asdictrrrrr@rrs@rrrs"Brrct|txrtjt |}t|txrtjt |}||k(xs|xr|S)zA function to check two choices equal considering NaN. This function can handle NaNs like np.float32("nan") other than float. )r$rrfrgr;)value1value2 value1_is_nan value2_is_nans r_categorical_choice_equalrsUvt,H%-1HMvt,H%-1HM f  B-"AMBrcXeZdZdZd dZd dZd dZd dZd dZddZ e jZ y)CategoricalDistributionaTA categorical distribution. This object is instantiated by :func:`~optuna.trial.Trial.suggest_categorical`, and passed to :mod:`~optuna.samplers` in general. Args: choices: Parameter value candidates. ``choices`` must have one element at least. .. note:: Not all types are guaranteed to be compatible with all storages. It is recommended to restrict the types of the choices to :obj:`None`, :class:`bool`, :class:`int`, :class:`float` and :class:`str`. Attributes: choices: Parameter value candidates. c t|dk(r td|D]`}|t|ttt t fr'dj|t|j}tj|bt||_ y)Nrz0The `choices` must contain one or more elements.zChoices for a categorical distribution should be a tuple of None, bool, int, float and str for persistent storage but contains {} which is of type {}.)lenrPr$r>rCr;rDr2r&r8warningswarnr,choices)rrchoicemessages rrWz CategoricalDistribution.__init__s} w<1 OP P 'F!*VdCPS=T*U &f)>)>?  g& 'W~ rc2|jt|Sr)rrCrs rrz(CategoricalDistribution.to_external_reprs||C <=>>rc |jj|S#t$r2t|jD]\}}t ||s|ccYSYnwxYwtd|d|jd)Nrbz ' not in .)rindexrP enumerater)rrrrs rrz(CategoricalDistribution.to_internal_repr s} ! <<%%&BC C !!*4<QRSTTs0AAAAc2t|jdk(S)Nr)rrrs rrzCategoricalDistribution.singles4<< A%%rc^t|}d|cxkxrt|jkScSr)rCrr)rrrs rrz!CategoricalDistribution._containss,01E-C -----rct|tstSt||jsy|jj |jj k7ry|jj D]l\}}|dk(rQt|tt||k7ryt|t||D]\}}t||ry\|t||k7slyy)NFrT) r$r r%r+r keysr.rgetattrzipr)rr'keyr_r other_choices rr(zCategoricalDistribution.__eq__ s%!12! !%0 ==   5>>#6#6#8 8----/ !JCiu:WUC%8!99 ,/wuc7J,K%(FL4V\J$%GE3//  !rN)rzSequence[CategoricalChoiceType]r<rm)rr;r<CategoricalChoiceType)rrr<r;r=r?rB) r8rErFrGrWrrrrr(r r/r rrrrs3* &? U&.& ((Hrrc>tj|}d|vrt|dtjk(rt |dd|dd<t D]!}|d|jk(s|di|dcSt dj|d|ddk(rt|dS|ddvrW|d}|d }|jd }|jd d }|dd k(rt||||S|d}t||||St dj|d)zDeserialize a distribution in JSON format. Args: json_str: A JSON-serialized distribution. Returns: A deserialized distribution. name attributesrzUnknown distribution class: {}r& categorical)r;rCrSrTrQrUFr;)rUrQrrszUnknown distribution type: {}r ) jsonloadsrr8r,DISTRIBUTION_CLASSESrPr2getrKr)json_str json_dictclsrSrTrQrUs rjson_to_distributionrBsS 8$I  V  7 @ @ @16y7Ny7Y1ZIl #I .' 6C CLL05Y|455 69@@6ARSTT V  -*9Y+?@ @ v "2 2E"CV$D==(D--u-C G+(d$GG<D&3TsNN8?? &@QRSSrcvtj|jj|j dS)zSerialize a distribution to JSON format. Args: dist: A distribution to be serialized. Returns: A JSON string of a given distribution. )rr)rdumpsr+r8r!)dists rdistribution_to_jsonrns( ::t~~66dllnU VVrcv|j|jk7r tdt|ttfr|}t||z|z|z}t j dj |||||S)N0The distribution is specified by [{low}, {old_high}] and step={step}, but the range is not divisible by `step`. It will be replaced by [{low}, {high}].rSold_highrTrQ)rZr[rDr;rrr2)rSrTrQd_highd_lowd_stepd_rrs rrRrRs __SY 'F OOCH %E __SY 'F 5.C V|ws++cVmv-56  RRXRX(DSYS  Krc||z }||zdk7r5|}||z|z|z}tjdj|||||S)Nrrr)rrr2)rSrTrQrrs rrrsc s A4x1}Dy4#%  RRXRX(DSYS Krc|jsJt|ttfr |jSt|t r|j dSJr)rr$rKrrSrr distributions r_get_single_valuersY         L"9 :##A&&5rct|tr$t|j|jdd}nt|t r$t|j|jdd}nt|t r.t|j|jd|j}n~t|tr.t|j|jd|j}n@t|tr.t|j|jd|j}n|}||k7r$|s"|d|d}tj|t|S)NFrsTz+ is deprecated and internally converted to z3. See https://github.com/optuna/optuna/issues/2941.)r$rprKrSrTrrrrrrQrrr FutureWarning)rsuppress_warningnew_distributionrs r-_convert_old_distribution_to_new_distributionrsI, 34,  ""   L"8 9,  ""   L"= >,  ""   L"8 9*  """"   L"; <*  """"  (<'0@n !!T V   g}- rcHt|ttfr |jSyr#)r$rKrrUrs r_is_distribution_logrs!,!2O DE r)rrrrr<r>)rrDr<r )rr r<rD)rr rr r<rm)rSr;rTr;rQr;r<r;)rSrCrTrCrQrCr<rC)rr r<z#int | float | CategoricalChoiceType)F)rr rr>r<r )rr r<r>). __future__rrHcollections.abcrr{rZrnumbersrtypingrrrrnumpyrfoptuna._deprecatedr r>rCr;rDr"_float_distribution_deprecated_msg _int_distribution_deprecated_msgABCr rKrprrrrrrrrrrrrRrrrrr rrrs " $  /dD#uc9:D#$a K@swwK@\`(`F'7)KL+M4'7)KL.M4'7)KL4"34M4nZV&ZVz'7)IJ_KB'7)IJK6 C ! C+@ C  CP).P)h )TX W# # *:#  # L(  (#8"888vr