o /win@sddlmZddlZddlZddlZddlZddlZddlmZddl m Z ddl m Z ddl m Z ddl m Z ddlZddlmZe rJdd lmZe deeeefZd Zd ZGd d d ejZGdddeZeddedGdddeZeddedGdddeZeddedGdddeZGdddeZ eddedGddde Z!eddedGddde Z"dGd$d%Z#Gd&d'd'eZ$e e"e!eeeee$fZ%dHd*d+Z&dId-d.Z'dJd2d3Z(dKd8d9Z)dLd;d<Z*dMd?d@Z+ AdNdOdCdDZ,dPdEdFZ-dS)Q) annotationsN)Real)Any)cast) TYPE_CHECKING)Union)deprecated_class)Sequencez=Use :class:`~optuna.distributions.FloatDistribution` instead.z;Use :class:`~optuna.distributions.IntDistribution` instead.c@sreZdZdZdddZejdd d Zejdd d Zejd ddZ d!ddZ d"ddZ d#ddZ d$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_reprfloatreturnrcCs|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. selfr rrQ/home/ubuntu/sommelier/.venv/lib/python3.10/site-packages/optuna/distributions.pyto_external_repr&s z!BaseDistribution.to_external_reprparam_value_in_external_reprcCt)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)rrrrrto_internal_repr3s z!BaseDistribution.to_internal_reprboolcCr)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`. rrrrrsingleAs zBaseDistribution.singlecCr)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`. rrrrr _containsLs zBaseDistribution._containsdictcCs|jSN)__dict__rrrr_asdict[szBaseDistribution._asdictothercCs.t|tstSt|t|urdS|j|jkSNF) isinstancer NotImplementedtyper)rr rrr__eq__^s  zBaseDistribution.__eq__intcCst|jftt|jSr)hash __class__tuplesortedritemsrrrr__hash__eszBaseDistribution.__hash__strcCs0dddt|D}d|jj|S)Nz, css |] \}}d||VqdS)z{}={}N)format).0kvrrr isz,BaseDistribution.__repr__..z{}({}))joinr*rr+r.r(__name__)rkwargsrrr__repr__hs zBaseDistribution.__repr__N)r r r r)rrr r r rr r r rr rr rr r)r r&)r r-)r4 __module__ __qualname____doc__rabcabstractmethodrrrrr%r,r6rrrrr s       r c@s<eZdZdZ ddd dZdddZdddZdddZdS)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`. FNlowr highlogrstep None | floatr NonecCs|r |dur td||krtd|||r$|dkr$td|||dur3|dkr3td|d|_|durEt|||}t||_t||_t||_||_dS)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={}.) ValueErrorr.rD_adjust_discrete_uniform_highr rArBrCrrArBrCrDrrr__init__s.       zFloatDistribution.__init__cCsb|jdur |j|jkS|j|jkrdStt|j}tt|j}tt|j}|||kSNT)rDrArBdecimalDecimalr-)rrBrArDrrrrs    zFloatDistribution.singler cCsj|}|jdur|j|ko|jkSS||j|j}|j|ko(|jkno4t|t|dkS)Ng:0yE>)rDrArBabsround)rr valuer0rrrrs  0zFloatDistribution._containsrc Cxzt|}Wnttfy}z td|d|d}~wwt|r+td|d|jr:|dkr:td|d|SN'z8' is not a valid type. float-castable value is expected.`z` is invalid value.rHz)` is invalid value for the case log=True.r rJ TypeErrormathisnanrCrr internal_reprerrrr"    z"FloatDistribution.to_internal_repr)FN) rAr rBr rCrrDrEr rFr7r8)rr r r )r4r;r<r=rMrrrrrrrr@ms r@z3.0.0z6.0.0)textc,eZdZdZd fdd Zd d d ZZS)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``. rAr rBr rFctj||ddddSNFrArBrCrDsuperrMrrArBr(rrrMzUniformDistribution.__init__rcC$t|j}|d|d|SNrCrDcopydeepcopyrpoprdrrrr   zUniformDistribution._asdictrAr rBr r rFr9r4r;r<r=rMr __classcell__rrrirrbrbcra)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``. rAr rBr rFcrcNTrerfrhrirrrMrjzLogUniformDistribution.__init__rcCrkrlrmrqrrrrrszLogUniformDistribution._asdictrtr9rurrrirrxrwrxcsJeZdZdZdfdd Zdd d Zedd dZejdddZZ 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. rAr rBqr rFcstj|||ddS)NrArBrDrf)rrArBr{rirrrM$sz$DiscreteUniformDistribution.__init__rcCs,t|j}|d|d}||d<|S)NrCrDr{rm)rrrrDrrrr's   z#DiscreteUniformDistribution._asdictcCs 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 )rrDrrrrr{/s zDiscreteUniformDistribution.qr1cCs ||_dSr)rD)rr1rrrr{9s )rAr rBr r{r r rFr9)r r )r1r r rF) r4r;r<r=rMrpropertyr{setterrvrrrirrzs   rzc@sDeZdZdZddd d ZdddZdddZdddZdddZdS) 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`. FrAr&rBrCrrDr rFcCs|r |dkr td||krtd|||r$|dkr$td|||dkr/td|||_t||_t||_t|}t|j||j|_dS)NrzZSamplers and other components in Optuna only accept step is 1 when `log` argument is True.rGz\The `low` value must be equal to or greater than 1 for a log distribution (low={}, high={}).rrI)rJr.rCr&rDrA_adjust_int_uniform_highrBrLrrrrM\s.    zIntDistribution.__init__r r cCst|Sr)r&rrrrrzsz IntDistribution.to_external_reprrc CrTrUrXr\rrrr}r_z IntDistribution.to_internal_reprcCs4|jr |j|jkS|j|jkrdS|j|j|jkSrN)rCrArBrDrrrrrs   zIntDistribution.singlecCs4|}|j|ko |jkno||j|jdkSNrr|)rr rSrrrrs0zIntDistribution._containsN)Fr) rAr&rBr&rCrrDr&r rF)r r r r&)rr&r r r7r8) r4r;r<r=rMrrrrrrrrr>s    rc.eZdZdZddfd d Zdd d ZZS)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. rrAr&rBrDr rFctj||d|ddSrdrfrrArBrDrirrrMrjzIntUniformDistribution.__init__rcCt|j}|d|SNrCrmrqrrrr  zIntUniformDistribution._asdictrrAr&rBr&rDr&r rFr9rurrrirrsrcr)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. rrAr&rBrDr rFcrryrfrrirrrMrjz"IntLogUniformDistribution.__init__rcCrrrmrqrrrrrz!IntLogUniformDistribution._asdictrrr9rurrrirrsrvalue1CategoricalChoiceTypevalue2r rcCs@t|to tt|}t|tott|}||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"rrZr[r )rr value1_is_nan value2_is_nanrrr_categorical_choice_equalsrc@sReZdZdZdddZdd d ZdddZdddZdddZdddZ 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]r rFcCsbt|dkr td|D]}|dur)t|ttttfs)d|t|j }t |q t ||_ 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 {} which is of type {}.)lenrJr"rr&r r-r.r$r4warningswarnr)r)rrchoicemessagerrrrMs  z CategoricalDistribution.__init__r r rcCs|jt|Sr)rr&rrrrr z(CategoricalDistribution.to_external_reprrcCsdz|j|WSty%t|jD]\}}t||r"|YSqYnwtd|d|jd)NrVz ' not in .)rindexrJ enumerater)rrrrrrrr s   z(CategoricalDistribution.to_internal_reprrcCst|jdkS)Nr)rrrrrrrrzCategoricalDistribution.singlecCs&t|}d|kot|jkSSr)r&rr)rr rrrrrsz!CategoricalDistribution._containsr rcCst|tstSt||jsdS|j|jkrdS|jD]7\}}|dkrMt|tt||kr6dSt |t||D] \}}t ||sKdSq>q |t||krWdSq dS)NFrT) r"r r#r(rkeysr+rgetattrzipr)rr keyrSr other_choicerrrr%#s&   zCategoricalDistribution.__eq__N)rrr rF)r r r r)rrr r r7r8r:) r4r;r<r=rMrrrrr%r r,rrrrrs       rjson_strr-cCs t|}d|vr<|dtjkrt|dd|dd<tD]}|d|jkr2|di|dSqtd|d|ddkrHt|dS|ddvr}|d}|d }|d }|d d }|dd krot ||||dS|durud}t ||||dStd|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 r&rArBrDrCFr )rCrDNrrezUnknown distribution type: {}r) jsonloadsrr4r)DISTRIBUTION_CLASSESrJr.getr@r)r json_dictclsrArBrDrCrrrjson_to_distributionEs,       rdistcCst|jj|dS)zSerialize a distribution to JSON format. Args: dist: A distribution to be serialized. Returns: A JSON string of a given distribution. )rr)rdumpsr(r4r)rrrrdistribution_to_jsonqs rdist_olddist_newrFcCs~|j|jkr tdt|ttfr$t|ttfsJ|j|jkr$tdt|ts+dSt|ts2dS||kr=ttjddS)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.)r(rJr"r@rrCrr4)rrrrr check_distribution_compatibilitys    rrAr rBrDcCsxtt|}tt|}tt|}||}||tdkr:|}t||||}tdj||||d|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}].rAold_highrBrD)rOrPr-r rrr.)rArBrDd_highd_lowd_stepd_rrrrrrKsrKr&cCsD||}||dkr |}||||}tdj||||d|S)Nrrr)rrr.)rArBrDrrrrrrs r distribution#int | float | CategoricalChoiceTypecCs8|sJt|ttfr|jSt|tr|jdSJr)rr"r@rrArrrrrr_get_single_values   rFsuppress_warningcCst|trt|j|jddd}nEt|tr t|j|jddd}n5t|tr1t|j|jd|jd}n$t|trBt |j|jd|j d}nt|t rSt |j|jd|j d}n|}||kri|si|d|d}t |t|S)NFreTz+ is deprecated and internally converted to z3. See https://github.com/optuna/optuna/issues/2941.)r"rbr@rArBrxrzr{rrrDrrr FutureWarning)rrnew_distributionrrrr-_convert_old_distribution_to_new_distributionsV       rcCst|ttfr |jSdSr!)r"r@rrCrrrr_is_distribution_logsr)rrrrr r)rr-r r )rr r r-)rr rr r rF)rAr rBr rDr r r )rAr&rBr&rDr&r r&)rr r r)F)rr rrr r )rr r r). __future__rr>rnrOrrZnumbersrtypingrrrrroptuna._deprecatedrcollections.abcr rr&r r-r"_float_distribution_deprecated_msg _int_distribution_deprecated_msgABCr r@rbrxrzrrrrrrrrrrKrrrrrrrrsh        N c  7 ] !  T ,  &   ;