,ʞj,kSSKJr SSKrSSKrSSKrSSKrSSKrSSKJr SSK J r SSK J r SSK J r SSK J r SSKJr SS KJr \ (aSS KJr \ S\\\\4rS rS r"S S\R65r"SS\5r\"SS\S9"SS\55r\"SS\S9"SS\55r\"SS\S9"SS\55r "SS\5r!\"SS\S9"SS\!55r"\"SS\S9"SS\!55r#S*S jr$"S!S"\5r%\!\#\"\\\\ \%4r&S+S#jr'S,S$jr(S-S%jr)S.S&jr*S/S'jr+S0S(jr,S1S2S)jjr-g)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.c\rSrSrSrS Sjr\RSSj5r\RSSj5r \RSSj5r SSjr SSjr SS jr SS jrS rg )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. cU$)aConvert 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 ڢC:\Users\johnn\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.13_qbz5n2kfra8p0\LocalCache\local-packages\Python313\site-packages\optuna/distributions.pyto_external_repr!BaseDistribution.to_external_repr&s ,+c[e)aConvert 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_repr!BaseDistribution.to_internal_repr3s "!rc[e)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 rsingleBaseDistribution.singleAs "!rc[e)a/Test 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 _containsBaseDistribution._containsLs "!rcUR$N)__dict__r s r_asdictBaseDistribution._asdict[s }}rc[U[5(d[$[U5[U5LagURUR:H$)NF) isinstancerNotImplementedtyper()rothers r__eq__BaseDistribution.__eq__^s<%!122! ! :T%[ (}}..rc [UR4[[URR 555-5$r')hash __class__tuplesortedr(itemsr s r__hash__BaseDistribution.__hash__es0T^^%fT]]5H5H5J.K(LLMMrcSRS[UR5R5555nURR SUS3$)N, c34# UHupUSU3v M g7f)=Nr).0kvs r ,BaseDistribution.__repr__..isQ2P$!aS!:2Ps())joinr6r)r7r4__name__)rkwargss r__repr__BaseDistribution.__repr__hsHQ&9M9M9O2PQQ..))*!F8155rrN)rfloatreturnr)rrrKrJrKboolrrJrKrMrKdictr/rrKrM)rKint)rKstr)rF __module__ __qualname____firstlineno____doc__rabcabstractmethodrr!r$r)r0r8rH__static_attributes__rrrrrso ,  " " ""  " "/N6rrcX\rSrSrSrS S SjjrS SjrS SjrS SjrSr g)FloatDistributionmaA 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`. NclU(aUb [S5eX:a[SU<SU<S35eU(aUS::a[SU<SU<S35eUbUS::a[SU<S 35eSUlUb[XU5n[U5Ul[U5Ul[U5UlX0lg) 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_highrJlowhighlogrrhrirjrfs r__init__FloatDistribution.__init__s 4#XY Y :F#x$PRST T 3#:QSFRZUYT[[]^_ _   CdWAFG G  0DADd DI:$K rcURcURUR:H$URUR:Xag[R"[ UR55n[R"[ UR55n[R"[ UR55nX- U:$NT)rfrhridecimalDecimalrS)rrirhrfs rr!FloatDistribution.singles 99 88tyy( (xx499$??3tyy>2D//#dhh-0C??3tyy>2DJ$& &rc<UnURc)URUs=:*=(a UR:*$s $X R- UR- nURUs=:*=(a UR:*Os =(a [U[ U5- 5S:$)Ng:0yE>)rfrhriabsround)rrvaluer?s rr$FloatDistribution._containssy, 99 88u11 1 11 1!TYY.A88u11 1Pc!eAh,6G&6P Prc[U5n[R"U5(a[SUS35eUR (aUS::a[SUS35eU$![[4an[SUS35UeSnAff=fN'z8' is not a valid type. float-castable value is expected.`z` is invalid value.rbz)` is invalid value for the case log=True.rJre TypeErrormathisnanrjrr internal_repres rr"FloatDistribution.to_internal_repr !">?M ::m $ $q!= >>QRS S 88 ,011Z[ I& 01244   AB/A??Brirjrhrf)FN) rhrJrirJrjrMrfz None | floatrKNonerLrN)rrJrKrJ) rFrTrUrVrWrlr!r$rrZrrrr\r\msK<PT %,0@L 0 'Qrr\z3.0.0z6.0.0)textc:^\rSrSrSrSU4SjjrSSjrSrU=r$)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$>[TU]XSSS9 gNFrhrirjrfsuperrlrrhrir4s rrlUniformDistribution.__init__ STBrc[R"UR5nURS5 URS5 U$Nrjrfcopydeepcopyr(poprds rr)UniformDistribution._asdict/ MM$-- ( e  f rrrhrJrirJrKrrO rFrTrUrVrWrlr)rZ __classcell__r4s@rrrs Crrc:^\rSrSrSrSU4SjjrSSjrSrU=r$)LogUniformDistributiona#A 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$>[TU]XSSS9 gNTrrrs rrlLogUniformDistribution.__init__ SDArc[R"UR5nURS5 URS5 U$rrrs rr)LogUniformDistribution._asdictrrrrrOrrs@rrrs Brrcv^\rSrSrSrSU4SjjrS Sjr\S Sj5r\RS Sj5rSr U=r $) DiscreteUniformDistributionaA 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">[TU]XUS9 g)Nrhrirfr)rrhriqr4s rrl$DiscreteUniformDistribution.__init__s S!4rc[R"UR5nURS5 URS5nX!S'U$)Nrjrfrr)rrrfs rr)#DiscreteUniformDistribution._asdicts8 MM$-- ( e uuV}#rc.[SUR5$)zDiscretization step. :class:`~optuna.distributions.DiscreteUniformDistribution` is a subtype of :class:`~optuna.distributions.FloatDistribution`. This property is a proxy for its ``step`` attribute. rJ)rrfr s rrDiscreteUniformDistribution.q'sGTYY''rcXlgr'rf)rr@s rrr1s rr)rhrJrirJrrJrKrrO)rKrJ)r@rJrKr) rFrTrUrVrWrlr)propertyrsetterrZrrs@rrrs>85((XXrrcN\rSrSrSrS S SjjrS SjrS SjrSSjrSSjr Sr g )IntDistributioni6aA 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`. cU(aUS:wa [S5eX:a[SU<SU<S35eU(aUS:a[SU<SU<S35eUS::a[SU<S 35eX0l[U5Ul[U5Ul[U5n[ URX R5Ulg) NzZSamplers and other components in Optuna only accept step is 1 when `log` argument is True.r_r`raz2`low >= 1` must hold for `log=True`, but got (low=rrcrd)rerjrRrfrh_adjust_int_uniform_highrirks rrlIntDistribution.__init__Ts 419/  :F#x$PRST T 37RcVS[VZU\\^_` ` 19CdWAFG GI s84y,TXXtYYG rc[U5$r')rRrs rr IntDistribution.to_external_reprjs/00rc[U5n[R"U5(a[SUS35eUR (aUS::a[SUS35eU$![[4an[SUS35UeSnAff=fryr|rs rr IntDistribution.to_internal_reprmrrcUR(aURUR:H$URUR:XagURUR- UR:$ro)rjrhrirfr s rr!IntDistribution.single~sK 8888tyy( ( 88tyy  DHH$ 11rcUnURUs=:*=(a UR:*Os =(a X R- UR-S:H$Nrr)rrrvs rr$IntDistribution._containss=,xx5--DII-U5883Ctyy2PTU2UUrrN)Fr) rhrRrirRrjrMrfrRrKr)rrJrKrR)rrRrKrJrLrN) rFrTrUrVrWrlrrr!r$rZrrrrr6s":H,1"2Vrrc>^\rSrSrSrSSU4SjjjrSSjrSrU=r$) IntUniformDistributioniaJA 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$>[TU]XSUS9 grrrrhrirfr4s rrlIntUniformDistribution.__init__rrch[R"UR5nURS5 U$Nrjrrs rr)IntUniformDistribution._asdict$ MM$-- ( e rrrrhrRrirRrfrRrKrrOrrs@rrrs.CCrrc>^\rSrSrSrSSU4SjjjrSSjrSrU=r$) IntLogUniformDistributioniapA 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$>[TU]XSUS9 grrrs rrl"IntLogUniformDistribution.__init__rrch[R"UR5nURS5 U$rrrs rr)!IntLogUniformDistribution._asdictrrrrrrOrrs@rrrs"BBrrc[U[5=(a [R"[ U55n[U[5=(a [R"[ U55nX:H=(d U=(a U$)zA function to check two choices equal considering NaN. This function can handle NaNs like np.float32("nan") other than float. )r,rr~rrJ)value1value2 value1_is_nan value2_is_nans r_categorical_choice_equalrsSvt,JE&M1JMvt,JE&M1JM   B-"AMBrcl\rSrSrSrS SjrS SjrS SjrSSjrSSjr SSjr \ Rr S r g )CategoricalDistributionia A 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[U5S:Xa [S5eUHVnUcM[U[[[ [ 45(aM/SUS[U5RS3n[U5 MX [U5Ul g)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 rd) lenrer,rMrRrJrSr.rFr r5choices)rrchoicemessages rrl CategoricalDistribution.__init__s w<1 OP PF!*VdCPS=T*U*UIh0f1F1F0GqJ G$W~ rc2UR[U5$r')rrRrs rr(CategoricalDistribution.to_external_reprs||C <=>>rcURRU5$![a7 [UR5Hup#[ X5(dMUs s$ Of=f[SUSURS35e)Nrzz ' not in rd)rindexre enumerater)rrrrs rr(CategoricalDistribution.to_internal_reprsw ! <<%%&BC C !!*4<QRSTTs2AAAAc2[UR5S:H$)Nr)rrr s rr!CategoricalDistribution.single s4<< A%%rch[U5nSUs=:*=(a [UR5:$s $r)rRrr)rrrs rr$!CategoricalDistribution._containss/01E--C -----rc[U[5(d[$[XR5(dgURR 5URR 5:wagURR 5Hrup#US:XaV[U5[[X55:wa g[U[X55HupE[XE5(aM g MaU[X5:wdMr g g)NFrT) r,rr-r4r(keysr7rgetattrzipr)rr/keyrvr other_choices rr0CategoricalDistribution.__eq__s%!122! !%00 ==   5>>#6#6#8 8----/JCiu:WU%8!99 ,/wu7J,K(F4VJJ$-LGE// 0r)rN)rzSequence[CategoricalChoiceType]rKr)rrJrKCategoricalChoiceType)rrrKrJrLrNrQ)rFrTrUrVrWrlrrr!r$r0rr8rZrrrrrs3* &? U&.& ((Hrrc[R"U5nSU;alUS[R:Xa[ USS5USS'[ H#nUSUR:XdMU"S0USD6s $ [ SUS35eUSS:Xa[US5$USS;aOUSnUS nURS 5nURS S 5nUSS :Xa [X4XeS9$UcSn[X4XeS9$[ SUS35e)zDeserialize a distribution in JSON format. Args: json_str: A JSON-serialized distribution. Returns: A deserialized distribution. name attributesrzUnknown distribution class: r. categorical)rJrRrhrirfrjFrJ)rjrfrrzUnknown distribution type: r) jsonloadsrrFr5DISTRIBUTION_CLASSESregetr\r)json_str json_dictclsrhrirfrjs rjson_to_distributionr5s@ 8$I  V  7 @ @ @16y7Ny7Y1ZIl #I .'C CLL05Y|455(7 &8I7JKLL V  -*9Y+?@ @ v "2 2E"CV$D==(D--u-C G+(GG<D&3sNN6y7H6IJKKrcx[R"URRUR 5S.5$)zSerialize a distribution to JSON format. Args: dist: A distribution to be serialized. Returns: A JSON string of a given distribution. )rr)rdumpsr4rFr))dists rdistribution_to_jsonr as( ::t~~66dllnU VVrcURUR:wa [S5e[U[[45(aB[U[[45(deUR UR :wa [S5e[U[ 5(dg[U[ 5(dgX:wa[[ RS-5eg)aA 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.)r4rer,r\rrjrrF)dist_olddist_news r check_distribution_compatibilityr os$X///]^^(.@AA(%6$HIIII <<8<< 'ab b h 7 8 8 h 7 8 8 # , ,/W W  rc b[R"[U55n[R"[U55n[R"[U55nX4- nXe-[R"S5:wa1Un[Xe-U-U-5n[ SUSUSU<SUSUS3 5 U$)N0"The distribution is specified by [r; ] and step=F, but the range is not divisible by `step`. It will be replaced with [].)rprqrSrJr )rhrirfd_highd_lowd_stepd_rold_highs rrgrgs __SY 'F OOCH %E __SY 'F .C |ws++cmv-560RzwOBBEbb R Krc nX- nX2-S:wa(UnX2-U-U-n[SUSUSU<SUSUS3 5 U$)Nrrr;rrrr )rhrirfrrs rrrsd Ax1}y4#%0RzwOBBEbb R  KrcUR5(de[U[[45(a UR$[U[ 5(aUR S$er)r!r,r\rrhrr) distributions r_get_single_valuersd         L"9 : :##A&&5rc[U[5(a![URURSSS9nO[U[ 5(a![URURSSS9nO[U[ 5(a+[URURSURS9nO[U[5(a+[URURSURS9nOB[U[5(a+[URURSURS9nOUnX :waU(dUSUS3n[U[5 U$)NFrTz+ is deprecated and internally converted to z3. See https://github.com/optuna/optuna/issues/2941.)r,rr\rhrirrrrrrfrr FutureWarning)rsuppress_warningnew_distributionrs r-_convert_old_distribution_to_new_distributionr"sR, 344,  ""   L"8 9 9,  ""   L"= > >,  ""   L"8 9 9*  """"   L"; < <*  """"  ('0@n !!T V  G]+ r)rrrrrKrM)rrSrKr)rrrKrS)r rr rrKr)rhrJrirJrfrJrKrJ)rhrRrirRrfrRrKrR)rrrKz#int | float | CategoricalChoiceType)F)rrr rMrKr). __future__rrXrrprr~numbersrtypingrrrroptuna._deprecatedr optuna._warningsr collections.abcr rMrRrJrSr"_float_distribution_deprecated_msg _int_distribution_deprecated_msgABCrr\rrrrrrrrrrr r rgrrr"rrrr,s "   /((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