:j,kddlmZddlZddlZddlZddlZddlZddlmZddl m Z ddl m Z ddl m Z ddl m Z ddlmZdd lmZe rdd lmZe deeeefZd Zd ZGd dej6ZGddeZeddeGddeZeddeGddeZeddeGddeZ GddeZ!eddeGdde!Z"eddeGdde!Z# d*d Z$Gd!d"eZ%e!e#e"eeee e%fZ&d+d#Z'd,d$Z( d-d%Z)d.d&Z*d/d'Z+d0d(Z, d1 d2d)Z-y)3) 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.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 i/home/mcse/projects/srt_converter/srt-converter-venv/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_repr3s "!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.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 "!rc|jSN)__dict__rs r_asdictzBaseDistribution._asdict[s }}rct|tstSt|t|ury|j|jk(S)NF) isinstancerNotImplementedtyper#)rothers r__eq__zBaseDistribution.__eq__^s9%!12! ! :T%[ (}}..rc t|jftt|jj zSr")hash __class__tuplesortedr#itemsrs r__hash__zBaseDistribution.__hash__es0T^^%fT]]5H5H5J.K(LLMMrcdjdt|jjD}|jj d|dS)N, c30K|]\}}|d|yw)=Nr).0kvs r z,BaseDistribution.__repr__..isQ$!QaS!:Qs())joinr/r$r0r-__name__)rkwargss r__repr__zBaseDistribution.__repr__hsHQ&9M9M9O2PQQ..))*!F8155rN)rfloatreturnr)rrrAr@rAboolrr@rArCrAdictr)rrArC)rAint)rAstr)r= __module__ __qualname____doc__rabcabstractmethodrrr r$r*r1r?rrrrrso ,  " " ""  " "/N6rrcFeZdZdZ 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`. NcH|r | td||kDrtd|d|d|r|dkrtd|d|d||dkrtd|d d|_|t|||}t||_t||_t||_||_y) 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=.) ValueErrorstep_adjust_discrete_uniform_highr@lowhighlogrr[r\r]rYs r__init__zFloatDistribution.__init__s 4#XY Y :F#x$PRST T 3#:QSFRZUYT[[]^_ _   CdWAFG G  0dDADd DI:$K rc|j|j|jk(S|j|jk(rytjt |j}tjt |j}tjt |j}||z |kSNT)rYr[r\decimalDecimalrI)rr\r[rYs 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>)rYr[r\absround)rrvaluer7s rr zFloatDistribution._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.rUz)` is invalid value for the case log=True.r@rX TypeErrormathisnanr]rr internal_repres rrz"FloatDistribution.to_internal_repr !">?M ::m $q!= >>QRS S 88 ,011Z[ I& 01244   AA7"A22A7)FN) r[r@r\r@r]rCrYz None | floatrANonerBrD)rr@rAr@)r=rJrKrLr_rr rrrrrPrPmsK<PT %,0@L 0 'QrrPz3.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|||ddyNFr[r\r]rYsuperr_rr[r\r-s rr_zUniformDistribution.__init__ StTBrctj|j}|jd|jd|SNr]rYcopydeepcopyr#poprds rr$zUniformDistribution._asdict/ MM$-- ( e  f rr[r@r\r@rArurEr=rJrKrLr_r$ __classcell__r-s@rrxrxs Crrxc,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|||ddyNTr{r|r~s rr_zLogUniformDistribution.__init__ StDArctj|j}|jd|jd|Srrrs rr$zLogUniformDistribution._asdictrrrrErrs@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)Nr[r\rYr|)rr[r\qr-s rr_z$DiscreteUniformDistribution.__init__s St!4rctj|j}|jd|jd}||d<|S)Nr]rYrr)rrrYs rr$z#DiscreteUniformDistribution._asdicts: MM$-- ( 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@)rrYrs rrzDiscreteUniformDistribution.q'sGTYY''rc||_yr")rY)rr8s rrzDiscreteUniformDistribution.q1s  r)r[r@r\r@rr@rArurE)rAr@)r8r@rAru) r=rJrKrLr_r$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||kDrtd|d|d|r|dkrtd|d|d|dkrtd|d ||_t||_t||_t|}t |j||j|_y) NzZSamplers and other components in Optuna only accept step is 1 when `log` argument is True.rRrSrTz2`low >= 1` must hold for `log=True`, but got (low=rrVrW)rXr]rHrYr[_adjust_int_uniform_highr\r^s rr_zIntDistribution.__init__Ts 419/  :F#x$PRST T 37RcVS[VZU\\^_` ` 19CdWAFG GI s84y,TXXtTYYG rct|Sr")rHrs rrz IntDistribution.to_external_reprjs/00rc t|}tj|rtd|d|j r|dkrtd|d|S#ttf$r}td|d|d}~wwxYwrirlrps rrz IntDistribution.to_internal_reprmrsrtc|jr|j|jk(S|j|jk(ry|j|jz |jkSra)r]r[r\rYrs rrzIntDistribution.single~sK 8888tyy( ( 88tyy  DHH$ 11rc|}|j|cxkxr|jkncxr||jz |jzdk(SNrr)rrrgs rr zIntDistribution._containss<,xx5-DII-U54883Ctyy2PTU2UUrN)Fr) r[rHr\rHr]rCrYrHrAru)rr@rArH)rrHrAr@rBrD) r=rJrKrLr_rrrr rrrrr6s":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|yrzr|rr[r\rYr-s rr_zIntUniformDistribution.__init__rrcftj|j}|jd|SNr]rrs rr$zIntUniformDistribution._asdict$ MM$-- ( e rrr[rHr\rHrYrHrArurErrs@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|yrr|rs rr_z"IntLogUniformDistribution.__init__rrcftj|j}|jd|Srrrs rr$z!IntLogUniformDistribution._asdictrrrrrErrs@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&rrnror@)value1value2 value1_is_nan value2_is_nans r_categorical_choice_equalrsUvt,JE&M1JMvt,JE&M1JM 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. ct|dk(r td|D]M}|t|ttt t fr'd|dt|jd}t|Ot||_ 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 z which is of type rW) lenrXr&rCrHr@rIr(r=r r.choices)rrchoicemessages rr_z CategoricalDistribution.__init__s w<1 OP P %F!*VdCPS=T*UIh0f1F1F0GqJ G$ %W~ rc2|jt|Sr")rrHrs rrz(CategoricalDistribution.to_external_reprs||C <=>>rc |jj|S#t$r2t|jD]\}}t ||s|ccYSYnwxYwtd|d|jd)Nrjz ' not in rW)rindexrX enumerater)rrrrs rrz(CategoricalDistribution.to_internal_reprs} ! <<%%&BC C !!*4<QRSTTs0AAAAc2t|jdk(S)Nr)rrrs rrzCategoricalDistribution.single s4<< A%%rc^t|}d|cxkxrt|jkScSr)rHrr)rrrs rr z!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&rr'r-r#keysr0rgetattrzipr)rr)keyrgr 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]rAru)rr@rACategoricalChoiceType)rrrAr@rBrDrG) r=rJrKrLr_rrrr r*rr1rrrrrs3* &? U&.& ((Hrrctj|}d|vrh|dtjk(rt |dd|dd<t D]!}|d|jk(s|di|dcSt d|d|ddk(rt|dS|ddvrW|d}|d }|jd }|jd d }|dd k(rt||||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)r@rHr[r\rYr]Fr@)r]rYrr{zUnknown distribution type: r) jsonloadsrr=r.DISTRIBUTION_CLASSESrXgetrPr)json_str json_dictclsr[r\rYr]s rjson_to_distributionr5sM 8$I  V  7 @ @ @16y7Ny7Y1ZIl #I .' 6C CLL05Y|455 67 &8I7JKLL V  -*9Y+?@ @ v "2 2E"CV$D==(D--u-C G+(d$GG<D&3TsNN6y7H6IJKKrcvtj|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-r=r$)dists rdistribution_to_jsonras( ::t~~66dllnU VVrcv|j|jk7r tdt|ttfr,  ""   L"8 9*  """"   L"; <*  """"  (<'0@n !!T V  G]+ r)rrrrrArC)rrIrAr)rrrArI)rrrrrAru)r[r@r\r@rYr@rAr@)r[rHr\rHrYrHrArH)rrrAz#int | float | CategoricalChoiceType)F)rrrrCrAr). __future__rrMrrbrrnnumbersrtypingrrrroptuna._deprecatedr optuna._warningsr collections.abcr rCrHr@rIr"_float_distribution_deprecated_msg _int_distribution_deprecated_msgABCrrPrxrrrrrrrrrrrrZrrrrrrrs "   /((dD#uc9:D#$a K6swwK6\X(Xv'7)KL+M4'7)KL.M4'7)KL4"34M4nRV&RVj'7)IJ_KB'7)IJK6 C ! C+@ C  CP).P)h )LX W# # *:#  # L$  (#8"888r