o }oik@sddlmZddlZddlZddlZddlZddlZddlmZddl m Z ddl m Z ddl m Z ddl m Z ddlmZdd lmZe rLdd lmZe deeeefZd Zd ZGd ddejZGdddeZeddedGdddeZeddedGdddeZeddedGdddeZ GdddeZ!eddedGddde!Z"eddedGddde!Z#dHd%d&Z$Gd'd(d(eZ%e!e#e"eeee e%fZ&dId+d,Z'dJd.d/Z(dKd3d4Z)dLd9d:Z*dMdis z,BaseDistribution.__repr__..())joinr,r!r-r*__name__)rkwargsrrr__repr__hs zBaseDistribution.__repr__N)r rrr)rrrrrrr rrrrrr"rrr)rr()rr/)r9 __module__ __qualname____doc__rabcabstractmethodrrrr!r'r.r;rrrrr 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`. FNlowrhighlogrstep None | floatrNonecCs|r |dur td||krtd|d|d|r*|dkr*td|d|d|dur:|dkr:td|d d|_|durLt|||}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=.) ValueErrorrI_adjust_discrete_uniform_highrrFrGrHrrFrGrHrIrrr__init__s       zFloatDistribution.__init__cCsb|jdur |j|jkS|j|jkrdStt|j}tt|j}tt|j}|||kSNT)rIrFrGdecimalDecimalr/)rrGrFrIrrrrs    zFloatDistribution.singler cCsj|}|jdur|j|ko|jkSS||j|j}|j|ko(|jkno4t|t|dkS)Ng:0yE>)rIrFrGabsround)rr valuer3rrrrs  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.rOz)` is invalid value for the case log=True.rrR TypeErrormathisnanrHrr internal_reprerrrr"    z"FloatDistribution.to_internal_repr)FN) rFrrGrrHrrIrJrrKr<r=)rrrr)r9r@rArBrUrrrrrrrrEms  rEz3.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``. rFrrGrrKctj||ddddSNFrFrGrHrIsuperrUrrFrGr*rrrUzUniformDistribution.__init__rcC$t|j}|d|d|SNrHrIcopydeepcopyr poprdrrrr!   zUniformDistribution._asdictrFrrGrrrKr>r9r@rArBrUr! __classcell__rrrqrrjrjcri)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``. rFrrGrrKcrkNTrmrnrprqrrrUrrzLogUniformDistribution.__init__rcCrsrtruryrrrr!r{zLogUniformDistribution._asdictr|r>r}rrrqrrrrcsJeZdZdZdfdd 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. rFrrGqrrKcstj|||ddS)NrFrGrIrn)rrFrGrrqrrrUsz$DiscreteUniformDistribution.__init__rcCs,t|j}|d|d}||d<|S)NrHrIrru)rrzrIrrrr!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)rrIrrrrr's zDiscreteUniformDistribution.qr4cCs ||_dSr)rI)rr4rrrr1s )rFrrGrrrrrKr>)rr)r4rrrK) r9r@rArBrUr!propertyrsetterr~rrrqrrs   rc@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`. FrFr(rGrHrrIrrKcCs|r |dkr td||krtd|d|d|r*|dkr*td|d|d|dkr6td|d ||_t||_t||_t|}t|j||j|_dS) NrzZSamplers and other components in Optuna only accept step is 1 when `log` argument is True.rLrMrNz2`low >= 1` must hold for `log=True`, but got (low=rrPrQ)rRrHr(rIrF_adjust_int_uniform_highrGrTrrrrUTs    zIntDistribution.__init__r rcCst|Sr)r(rrrrrjsz IntDistribution.to_external_reprrc Cr\r]r`rdrrrrmrgz IntDistribution.to_internal_reprcCs4|jr |j|jkS|j|jkrdS|j|j|jkSrV)rHrFrGrIrrrrr~s   zIntDistribution.singlecCs4|}|j|ko |jkno||j|jdkSNrr)rr r[rrrrs0zIntDistribution._containsN)Fr) rFr(rGr(rHrrIr(rrK)r rrr()rr(rrr<r=) r9r@rArBrUrrrrrrrrr6s    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. rrFr(rGrIrrKctj||d|ddSrlrnrrFrGrIrqrrrUrrzIntUniformDistribution.__init__rcCt|j}|d|SNrHruryrrrr!  zIntUniformDistribution._asdictrrFr(rGr(rIr(rrKr>r}rrrqrrsrcr)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. rrFr(rGrIrrKcrrrnrrqrrrUrrz"IntLogUniformDistribution.__init__rcCrrruryrrrr!rz!IntLogUniformDistribution._asdictrrr>r}rrrqrrsrvalue1CategoricalChoiceTypevalue2rrcCs@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$rrbrcr)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]rrKcCsft|dkr td|D]}|dur+t|ttttfs+d|dt|jd}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 z which is of type rQ) lenrRr$rr(rr/r&r9r r+r)rrchoicemessagerrrrUs z CategoricalDistribution.__init__r rrcCs|jt|Sr)rr(rrrrrz(CategoricalDistribution.to_external_reprrcCsdz|j|WSty%t|jD]\}}t||r"|YSqYnwtd|d|jd)Nr^z ' not in rQ)rindexrR enumerater)rrrrrrrrs   z(CategoricalDistribution.to_internal_reprrcCst|jdkS)Nr)rrrrrrr rzCategoricalDistribution.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*r keysr-rgetattrzipr)rr"keyr[r other_choicerrrr's&   zCategoricalDistribution.__eq__N)rrrrK)r rrr)rrrrr<r=r?) r9r@rArBrUrrrrr'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)rr(rFrGrIrHFr)rHrINrrmzUnknown distribution type: r) jsonloadsrr9r+DISTRIBUTION_CLASSESrRgetrEr)r json_dictclsrFrGrIrHrrrjson_to_distribution5s,       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*r9r!)rrrrdistribution_to_jsonas rdist_olddist_newrKcCs~|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*rRr$rErrHrr9)rrrrr check_distribution_compatibilityos    rrFrrGrIc Cstt|}tt|}tt|}||}||tdkrB|}t||||}td|d|d|d|d|d |S)N0"The distribution is specified by [r0 ] and step=F, but the range is not divisible by `step`. It will be replaced with [].)rWrXr/rr )rFrGrId_highd_lowd_stepd_rold_highrrrrSsrSr(c CsT||}||dkr(|}||||}td|d|d|d|d|d |S)Nrrr0rrrr )rFrGrIrrrrrrs r distribution#int | float | CategoricalChoiceTypecCs8|sJt|ttfr|jSt|tr|jdSJr)rr$rErrFrrrrrr_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|}||krh|sh|d|d}t |t |S)NFrmTz+ is deprecated and internally converted to z3. See https://github.com/optuna/optuna/issues/2941.)r$rjrErFrGrrrrrrIrr FutureWarning)rrnew_distributionrrrr-_convert_old_distribution_to_new_distributionsV       rcCst|ttfr |jSdSr#)r$rErrHrrrr_is_distribution_logsr)rrrrrr)rr/rr )rr rr/)rr rr rrK)rFrrGrrIrrr)rFr(rGr(rIr(rr()rr rr)F)rr rrrr )rr rr)/ __future__rrCrvrWrrbnumbersrtypingrrrroptuna._deprecatedroptuna._warningsr collections.abcr rr(rr/r"_float_distribution_deprecated_msg _int_distribution_deprecated_msgABCr rErjrrrrrrrrrrrrSrrrrrrrrsh         N [  7 U !  T ,  &   ;