j,kddlmZddlZddlZddlZddlZddlZddlmZddl m Z ddl m Z ddl m Z ddl m Z ddlmZdd lmZe rdd lmZe deeeefZd Zd ZGd dejZGddeZeddeGddeZeddeGddeZeddeGddeZ GddeZ!eddeGdde!Z"eddeGdde!Z#d>d%Z$Gd&d'eZ%e!e#e"eeee e%fZ&d?d*Z'd@d,Z(dAd0Z)dBd5Z*dCd7Z+dDd:Z, dEdFd=Z-dS)G) annotationsN)Real)Any)cast) TYPE_CHECKING)Union)deprecated_class optuna_warn)Sequencez=Use :class:`~optuna.distributions.FloatDistribution` instead.z;Use :class:`~optuna.distributions.IntDistribution` instead.ceZdZdZddZejddZejdd Zejdd Z dd Z ddZ ddZ ddZ dS)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. param_value_in_internal_reprfloatreturnrc|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. selfrs w/home/lighthouse/badge-speaker-benchmark/.benchmark-venv-community/lib/python3.11/site-packages/optuna/distributions.pyto_external_reprz!BaseDistribution.to_external_repr&s ,+param_value_in_external_reprct)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)rrs rto_internal_reprz!BaseDistribution.to_internal_repr3s "!rboolct)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.singleAs "!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._containsLs "!rdictc|jSN)__dict__r s r_asdictzBaseDistribution._asdict[s }rotherct|tstSt|t|urdS|j|jkS)NF) isinstancerNotImplementedtyper')rr)s r__eq__zBaseDistribution.__eq__^sF%!122 "! ! ::T%[[ ( (5}..rintc t|jftt|jzSr&)hash __class__tuplesortedr'itemsr s r__hash__zBaseDistribution.__hash__es8T^%fT]5H5H5J5J.K.K(L(LLMMMrstrcddt|D}|jjd|dS)N, c3*K|]\}}|d|VdS)=Nr).0kvs r z,BaseDistribution.__repr__..is0QQ$!Qa::!::QQQQQQr())joinr4r(r5r2__name__)rkwargss r__repr__zBaseDistribution.__repr__hsZQQ&9M9M9O9O2P2PQQQQQ.)55F5555rN)rrrr)rrrrrrrrrrrr$r)rrr)rr/)rr7)rC __module__ __qualname____doc__rabcabstractmethodrr!r#r(r.r6rErrrrrs , , , ,  " " " " """"  " " " "////NNNN666666rrc6eZdZdZ ddd ZddZddZddZdS)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`. FNlowrhighlogrstep None | floatrNonec|r|td||krtd|d|d|r|dkrtd|d|d||dkrtd|d d|_|%t|||}t||_t||_t||_||_dS) Nz9The parameter `step` is not supported when `log` is true.&`low <= high` must hold, but got (low=, high=).z1`low > 0` must hold for `log=True`, but got (low=r#`step > 0` must hold, but got step=.) ValueErrorrT_adjust_discrete_uniform_highrrQrRrSrrQrRrSrTs r__init__zFloatDistribution.__init__s  Z4#XYY Y ::S#SS$SSSTT T  `3#::^S^^UY^^^__ _   FdFFFGG G  0dDAADd DI::$KK rcJ|j|j|jkS|j|jkrdStjt |j}tjt |j}tjt |j}||z |kSNT)rTrQrRdecimalDecimalr7)rrRrQrTs rr!zFloatDistribution.singles 9 8ty( (x49$$t?3ty>>22D/#dh--00C?3ty>>22D3J$& &rrc|}|j|j|cxko |jkncS||jz |jz }|j|cxko |jknco"t|t |z dkS)Ng:0yE>)rTrQrRabsround)rrvaluer=s rr#zFloatDistribution._containss, 9 8u1111 1111 1!TY.A8u1111 1111Pc!eAhh,6G6G&6P Prrc t|}n-#ttf$r}td|d|d}~wwxYwtj|rtd|d|jr|dkrtd|d|SN'z8' is not a valid type. float-castable value is expected.`z` is invalid value.r[z)` is invalid value for the case log=True.rr^ TypeErrormathisnanrSrr internal_repres rrz"FloatDistribution.to_internal_repr !">??MMI&   40444   :m $ $ TR!=RRRSS S 8  ,,[0[[[ <7<)FN) rQrrRrrSrrTrUrrVrFrG)rrrr)rCrJrKrLrar!r#rrrrrPrPms~<PT0 ' ' ' 'QQQQrrPz3.0.0z6.0.0)textc,eZdZdZd fd Zd d ZxZS) 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``. rQrrRrrVcRt||dddSNFrQrRrSrTsuperrarrQrRr2s rrazUniformDistribution.__init__* StTBBBBBrr$ctj|j}|d|d|SNrSrTcopydeepcopyr'poprds rr(zUniformDistribution._asdict6 M$- ( ( e  f rrQrrRrrrVrHrCrJrKrLrar( __classcell__r2s@rryrysa  CCCCCCrryc,eZdZdZd fd Zd d ZxZS) 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``. rQrrRrrVcRt||dddSNTr|r}rs rrazLogUniformDistribution.__init__* StDAAAAArr$ctj|j}|d|d|Srrrs rr(zLogUniformDistribution._asdictrrrrHrrs@rrrsa  BBBBBBrrcfeZdZdZdfd Zdd Zedd Zejdd ZxZ 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. rQrrRqrrVcPt|||dS)NrQrRrTr})rrQrRrr2s rraz$DiscreteUniformDistribution.__init__s( St!44444rr$ctj|j}|d|d}||d<|S)NrSrTrr)rrrTs rr(z#DiscreteUniformDistribution._asdicts? M$- ( ( e uuV}}#rc,td|jS)zDiscretization step. :class:`~optuna.distributions.DiscreteUniformDistribution` is a subtype of :class:`~optuna.distributions.FloatDistribution`. This property is a proxy for its ``step`` attribute. r)rrTr s rrzDiscreteUniformDistribution.q'sGTY'''rr>c||_dSr&)rT)rr>s rrzDiscreteUniformDistribution.q1s  r)rQrrRrrrrrVrH)rr)r>rrrV) rCrJrKrLrar(propertyrsetterrrs@rrrs8555555(((X(XXrrc<eZdZdZddd ZddZddZddZddZdS)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`. FrQr/rRrSrrTrrVc|r|dkrtd||krtd|d|d|r|dkrtd|d|d|dkrtd|d ||_t||_t||_t|}t |j||j|_dS) NrzZSamplers and other components in Optuna only accept step is 1 when `log` argument is True.rXrYrZz2`low >= 1` must hold for `log=True`, but got (low=rr\r])r^rSr/rTrQ_adjust_int_uniform_highrRr`s rrazIntDistribution.__init__Ts  4199/  ::S#SS$SSSTT T  a377_c__VZ___`` ` 199FdFFFGG GII s884yy,TXtTYGG rrrc t|Sr&)r/rs rrz IntDistribution.to_external_reprjs/000rrc t|}n-#ttf$r}td|d|d}~wwxYwtj|rtd|d|jr|dkrtd|d|Srkrnrrs rrz IntDistribution.to_internal_reprmrurvc|jr|j|jkS|j|jkrdS|j|jz |jkSrc)rSrQrRrTr s rr!zIntDistribution.single~sE 8 )8ty( ( 8ty 4 DH$ 11rcf|}|j|cxko |jknco||jz |jzdkSNrr)rrris rr#zIntDistribution._containssF,x5----DI----U5483Cty2PTU2UUrN)Fr) rQr/rRr/rSrrTr/rrV)rrrr/)rr/rrrFrG) rCrJrKrLrarrr!r#rrrrr6s:HHHHH,1111"2222VVVVVVrrc.eZdZdZd d fd Zdd ZxZS)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. rrQr/rRrTrrVcRt||d|dSr{r}rrQrRrTr2s rrazIntUniformDistribution.__init__rrr$cbtj|j}|d|SNrSrrs rr(zIntUniformDistribution._asdict' M$- ( ( e rrrQr/rRr/rTr/rrVrHrrs@rrrsg.CCCCCCCrrc.eZdZdZd d fd Zdd ZxZS)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. rrQr/rRrTrrVcRt||d|dSrr}rs rraz"IntLogUniformDistribution.__init__rrr$cbtj|j}|d|Srrrs rr(z!IntLogUniformDistribution._asdictrrrrrHrrs@rrrsg"BBBBBBBrrvalue1CategoricalChoiceTypevalue2rrct|to tjt |}t|to tjt |}||kp|o|S)zA function to check two choices equal considering NaN. This function can handle NaNs like np.float32("nan") other than float. )r+rrprqr)rr value1_is_nan value2_is_nans r_categorical_choice_equalrsavt,,JE&MM1J1JMvt,,JE&MM1J1JM f  B-"AMBrcPeZdZdZddZdd Zdd ZddZddZddZ e j Z dS)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. choicesSequence[CategoricalChoiceType]rrVc$t|dkrtd|D]V}|Rt|ttt t fs*d|dt|jd}t|Wt||_ dS)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 z which is of type r]) lenr^r+rr/rr7r-rCr r3r)rrchoicemessages rraz CategoricalDistribution.__init__s w<<1  OPP P % %F!*VdCPS=T*U*U!JJJ15f1FJJJ G$$$W~~ rrrrc6|jt|Sr&)rr/rs rrz(CategoricalDistribution.to_external_reprs|C <==>>rrc |j|S#t$r3t|jD]\}}t ||r|ccYSYnwxYwtd|d|jd)Nrlz ' not in r])rindexr^ enumerater)rrrrs rrz(CategoricalDistribution.to_internal_reprs ! <%%&BCC C ! ! !!*4#6#6#8#8 8 85---// ! !JCiu::WUC%8%8!9!999 55,/wuc7J7J,K,K%%(FL4V\JJ%$uuu%%GE3//// 550trN)rrrrV)rrrr)rrrrrFrGrI) rCrJrKrLrarrr!r#r.rr6rrrrrs* & & & &???? U U U U&&&&....& (HHHrrjson_strr7ctj|}d|vr}|dtjkr$t |dd|dd<t D]#}|d|jkr|di|dcS$t d|d|ddkrt|dS|ddvrq|d}|d }|d }|d d }|dd krt||||S|d}t||||St d|d)zDeserialize a distribution in JSON format. Args: json_str: A JSON-serialized distribution. Returns: A deserialized distribution. name attributesrzUnknown distribution class: r- categorical)rr/rQrRrTrSFr)rSrTNrr|zUnknown distribution type: r) jsonloadsrrCr3DISTRIBUTION_CLASSESr^getrPr)r json_dictclsrQrRrTrSs rjson_to_distributionr5s 8$$I  V  7 @ @ @16y7Ny7Y1Z1ZIl #I .' 6 6C CL00s55Y|4555551K &8IKKLLL V  - -*9Y+?@@ @ v "2 2 2E"CV$D==((D--u--C G++(d$GGGG<D&3TsNNNNJy7HJJKKKrdistchtj|jj|dS)zSerialize a distribution to JSON format. Args: dist: A distribution to be serialized. Returns: A JSON string of a given distribution. )rr)rdumpsr2rCr()rs rdistribution_to_jsonras) :t~6dllnnUU V VVrdist_olddist_newrVc|j|jkrtdt|ttfr=t|ttfsJ|j|jkrtdt|t sdSt|t sdS||krtt jdzdS)a!A function to check compatibility of two distributions. It checks whether ``dist_old`` and ``dist_new`` are the same kind of distributions. If ``dist_old`` is :class:`~optuna.distributions.CategoricalDistribution`, it further checks ``choices`` are the same between ``dist_old`` and ``dist_new``. Note that this method is not supposed to be called by library users. Args: dist_old: A distribution previously recorded in storage. dist_new: A distribution newly added to storage. zBCannot set different distribution kind to the same parameter name.zBCannot set different log configuration to the same parameter name.Nz& does not support dynamic value space.)r2r^r+rPrrSrrC)rrs r check_distribution_compatibilityros$X///]^^^(.@AAc(%6$HIIIII <8< ' 'abb b h 7 8 8 h 7 8 88 # ,/W W   rrQrrRrTc ~tjt|}tjt|}tjt|}||z }||ztjdkr9|}t||z|z|z}t d|d|d|d|d|d |S)N0"The distribution is specified by [r9 ] and step=F, but the range is not divisible by `step`. It will be replaced with [].)rdrer7rr )rQrRrTd_highd_lowd_stepd_rold_highs rr_r_s _SYY ' 'F OCHH % %E _SYY ' 'F 5.C V|ws++++cVmv-566 R R R R R R RBE R RIM R R R   Krr/c z||z }||zdkr,|}||z|z|z}td|d|d|d|d|d |S)Nrrr9rrrr )rQrRrTrrs rrrs s A4x1}}Dy4#% R R R R R R RBE R RIM R R R    Kr distribution#int | float | CategoricalChoiceTypec|sJt|ttfr|jSt|t r |jdSJr)r!r+rPrrQrr)rs r_get_single_valuersk           ' L"9 : :'#A&&LrFsuppress_warningcpt|trt|j|jdd}nt|t rt|j|jdd}nt|t r#t|j|jd|j}nrt|tr#t|j|jd|j }n:t|tr#t|j|jd|j }n|}||kr|s|d|d}t|t|S)NFr|Tz+ is deprecated and internally converted to z3. See https://github.com/optuna/optuna/issues/2941.)r+ryrPrQrRrrrrrrTrr FutureWarning)rrnew_distributionrs r-_convert_old_distribution_to_new_distributionrs, 344((, "     L"8 9 9!(, "     L"= > >(, "     L"8 9 9(* ""     L"; < < (* ""    (<''0@' V V  V V V  G]+++ r)rrrrrr)rr7rr)rrrr7)rrrrrrV)rQrrRrrTrrr)rQr/rRr/rTr/rr/)rrrr)F)rrrrrr). __future__rrMrrdrrpnumbersrtypingrrrroptuna._deprecatedr optuna._warningsr collections.abcr rr/rr7r"_float_distribution_deprecated_msg _int_distribution_deprecated_msgABCrrPryrrrrrrrrrrrr_rrrrrrrsC""""""   //////(((((()((((((dD#uc9:D#$a K6K6K6K6K6swK6K6K6\XXXXX(XXXv'7)KLLL+ML4'7)KLLL.ML4'7)KLLL44444"344ML4nRVRVRVRVRV&RVRVRVj'7)IJJJ_KJB'7)IJJJKJ6 C C C CP)P)P)P)P).P)P)P)h )L)L)L)LX W W W W# # # # L$        (#8888888r