o }oi@s^ddlmZddlmZddlZddlmZddlmZddlm Z edGdd d Z dS) ) annotations)AnyN)experimental_class)experimental_func) FrozenTrial2.8.0c@sTeZdZdZ ddd d ZdddZeeddddZeeddddZ dS)RetryFailedTrialCallbacka:Retry a failed trial up to a maximum number of times. When a trial fails, this callback can be used with a class in :mod:`optuna.storages` to recreate the trial in ``TrialState.WAITING`` to queue up the trial to be run again. The failed trial can be identified by the :func:`~optuna.storages.RetryFailedTrialCallback.retried_trial_number` function. Even if repetitive failure occurs (a retried trial fails again), this method returns the number of the original trial. To get a full list including the numbers of the retried trials as well as their original trial, call the :func:`~optuna.storages.RetryFailedTrialCallback.retry_history` function. This callback is helpful in environments where trials may fail due to external conditions, such as being preempted by other processes. Usage: .. testcode:: import optuna from optuna.storages import RetryFailedTrialCallback storage = optuna.storages.RDBStorage( url="sqlite:///:memory:", heartbeat_interval=60, grace_period=120, failed_trial_callback=RetryFailedTrialCallback(max_retry=3), ) study = optuna.create_study( storage=storage, ) .. seealso:: See :class:`~optuna.storages.RDBStorage`. Args: max_retry: The max number of times a trial can be retried. Must be set to :obj:`None` or an integer. If set to the default value of :obj:`None` will retry indefinitely. If set to an integer, will only retry that many times. inherit_intermediate_values: Option to inherit `trial.intermediate_values` reported by :func:`optuna.trial.Trial.report` from the failed trial. Default is :obj:`False`. NF max_retry int | Noneinherit_intermediate_valuesboolreturnNonecCs||_||_dS)N) _max_retry_inherit_intermediate_values)selfr r rN/home/ubuntu/.local/lib/python3.10/site-packages/optuna/storages/_callbacks.py__init__;s z!RetryFailedTrialCallback.__init__study'optuna.study.Study'trialrc Csz|jgd|j}|d|j|jdur!|jt|dkr!dS|tjtjj j |j |j |j ||jr6|jndddS)N) failed_trial retry_historyr)stateparams distributions user_attrs system_attrsintermediate_values)numberrappendrlen add_trialoptuna create_trialr TrialStateWAITINGrrrrr)rrrrrrr__call__As& z!RetryFailedTrialCallback.__call__rcCs|jddS)a Return the number of the original trial being retried. Args: trial: The trial object. Returns: The number of the first failed trial. If not retry of a previous trial, returns :obj:`None`. rNrgetrrrrretried_trial_numberYsz-RetryFailedTrialCallback.retried_trial_numberz3.0.0 list[int]cCs|jdgS)alReturn the list of retried trial numbers with respect to the specified trial. Args: trial: The trial object. Returns: A list of trial numbers in ascending order of the series of retried trials. The first item of the list indicates the original trial which is identical to the :func:`~optuna.storages.RetryFailedTrialCallback.retried_trial_number`, and the last item is the one right before the specified trial in the retry series. If the specified trial is not a retry of any trial, returns an empty list. rr)r+rrrrisz&RetryFailedTrialCallback.retry_history)NF)r r r r r r)rrrrr r)rrr r )rrr r-) __name__ __module__ __qualname____doc__rr( staticmethodrr,rrrrrr s/ r) __future__rtypingrr$optuna._experimentalrr optuna.trialrrrrrrs