-jiKSSKJr SSKrSSKJr SSKJr SSKJr SSKJr SSK J r SSK J r SS K Jr SS KJr SS KJr SS KJr SS KJr Sr"SS\R.5rg)) annotationsN) Container)Sequence)Any)cast)JSONSerializable)BaseDistribution)UpdateFinishedTrialError) FrozenStudy)StudyDirection) FrozenTrial) TrialStatezno-name-c\rSrSrSr\R S!S"Sjj5r\R S#Sj5r\R S$Sj5r \R S%Sj5r \R S&Sj5r \R S'S j5r \R S(S j5r \R S)S j5r\R S)S j5r\R S*S j5r\R S!S+Sjj5r\R S,Sj5rS-SjrS.SjrS/Sjr\R S!S0Sjj5r\R S1Sj5r\R S2Sj5r\R S3Sj5r\R S4Sj5r\R S5S6Sjj5rS!S7SjjrS8SjrS9SjrS9SjrS9Sjr S:Sjr!S;Sjr"S r#g)< BaseStoragearBase class for storages. This class is not supposed to be directly accessed by library users. This class abstracts a backend database and provides internal interfaces to read/write histories of studies and trials. A storage class implementing this class must meet the following requirements. **Thread safety** A storage class instance can be shared among multiple threads, and must therefore be thread-safe. It must guarantee that a data instance read from the storage must not be modified by subsequent writes. For example, `FrozenTrial` instance returned by `get_trial` should not be updated by the subsequent `set_trial_xxx`. This is usually achieved by replacing the old data with a copy on `set_trial_xxx`. A storage class can also assume that a data instance returned are never modified by its user. When a user modifies a return value from a storage class, the internal state of the storage may become inconsistent. Consequences are undefined. **Ownership of RUNNING trials** Trials in finished states are not allowed to be modified. Trials in the WAITING state are not allowed to be modified except for the `state` field. Nc[e)aACreate a new study from a name. If no name is specified, the storage class generates a name. The returned study ID is unique among all current and deleted studies. Args: directions: A sequence of direction whose element is either :obj:`~optuna.study.StudyDirection.MAXIMIZE` or :obj:`~optuna.study.StudyDirection.MINIMIZE`. study_name: Name of the new study to create. Returns: ID of the created study. Raises: :exc:`optuna.exceptions.DuplicatedStudyError`: If a study with the same ``study_name`` already exists. NotImplementedError)self directions study_names O/home/james-whalen/.local/lib/python3.13/site-packages/optuna/storages/_base.pycreate_new_studyBaseStorage.create_new_study3s 0"!c[e)zDelete a study. Args: study_id: ID of the study. Raises: :exc:`KeyError`: If no study with the matching ``study_id`` exists. rrstudy_ids r delete_studyBaseStorage.delete_studyMs "!rc[e)aIRegister a user-defined attribute to a study. This method overwrites any existing attribute. Args: study_id: ID of the study. key: Attribute key. value: Attribute value. It should be JSON serializable. Raises: :exc:`KeyError`: If no study with the matching ``study_id`` exists. rrrkeyvalues rset_study_user_attrBaseStorage.set_study_user_attr[ $"!rc[e)aMRegister an optuna-internal attribute to a study. This method overwrites any existing attribute. Args: study_id: ID of the study. key: Attribute key. value: Attribute value. It should be JSON serializable. Raises: :exc:`KeyError`: If no study with the matching ``study_id`` exists. rr"s rset_study_system_attr!BaseStorage.set_study_system_attror'rc[e)zRead the ID of a study. Args: study_name: Name of the study. Returns: ID of the study. Raises: :exc:`KeyError`: If no study with the matching ``study_name`` exists. r)rrs rget_study_id_from_name"BaseStorage.get_study_id_from_name "!rc[e)zRead the study name of a study. Args: study_id: ID of the study. Returns: Name of the study. Raises: :exc:`KeyError`: If no study with the matching ``study_id`` exists. rrs rget_study_name_from_id"BaseStorage.get_study_name_from_idr.rc[e)zRead whether a study maximizes or minimizes an objective. Args: study_id: ID of a study. Returns: Optimization directions list of the study. Raises: :exc:`KeyError`: If no study with the matching ``study_id`` exists. rrs rget_study_directions BaseStorage.get_study_directionsr.rc[e)zRead the user-defined attributes of a study. Args: study_id: ID of the study. Returns: Dictionary with the user attributes of the study. Raises: :exc:`KeyError`: If no study with the matching ``study_id`` exists. rrs rget_study_user_attrs BaseStorage.get_study_user_attrsr.rc[e)aRead the optuna-internal attributes of a study. Args: study_id: ID of the study. Returns: Dictionary with the optuna-internal attributes of the study. Raises: :exc:`KeyError`: If no study with the matching ``study_id`` exists. rrs rget_study_system_attrs"BaseStorage.get_study_system_attrsr.rc[e)zRead a list of :class:`~optuna.study.FrozenStudy` objects. Returns: A list of :class:`~optuna.study.FrozenStudy` objects, sorted by ``study_id``. rrs rget_all_studiesBaseStorage.get_all_studiess "!rc[e)aCreate and add a new trial to a study. The returned trial ID is unique among all current and deleted trials. Args: study_id: ID of the study. template_trial: Template :class:`~optuna.trial.FrozenTrial` with default user-attributes, system-attributes, intermediate-values, and a state. Returns: ID of the created trial. Raises: :exc:`KeyError`: If no study with the matching ``study_id`` exists. r)rrtemplate_trials rcreate_new_trialBaseStorage.create_new_trial ("!rc[e)aSet a parameter to a trial. Args: trial_id: ID of the trial. param_name: Name of the parameter. param_value_internal: Internal representation of the parameter value. distribution: Sampled distribution of the parameter. Raises: :exc:`KeyError`: If no trial with the matching ``trial_id`` exists. :exc:`~optuna.exceptions.UpdateFinishedTrialError`: If the trial is already finished. r)rtrial_id param_nameparam_value_internal distributions rset_trial_paramBaseStorage.set_trial_params 4"!rcURUSS9n[U5U::a[SRX!55eX2R$)aRead the trial ID of a trial. Args: study_id: ID of the study. trial_number: Number of the trial. Returns: ID of the trial. Raises: :exc:`KeyError`: If no trial with the matching ``study_id`` and ``trial_number`` exists. F)deepcopyz?No trial with trial number {} exists in study with study_id {}.)get_all_trialslenKeyErrorformat _trial_id)rr trial_numbertrialss r'get_trial_id_from_study_id_trial_number3BaseStorage.get_trial_id_from_study_id_trial_numbersT $$X$> v;, &QXX   #---rc8URU5R$)aRead the trial number of a trial. .. note:: The trial number is only unique within a study, and is sequential. Args: trial_id: ID of the trial. Returns: Number of the trial. Raises: :exc:`KeyError`: If no trial with the matching ``trial_id`` exists. ) get_trialnumberrrEs rget_trial_number_from_id$BaseStorage.get_trial_number_from_id1s$~~h'...rczURU5nURURURU5$)a2Read the parameter of a trial. Args: trial_id: ID of the trial. param_name: Name of the parameter. Returns: Internal representation of the parameter. Raises: :exc:`KeyError`: If no trial with the matching ``trial_id`` exists. If no such parameter exists. )rW distributionsto_internal_reprparams)rrErFtrials rget_trial_paramBaseStorage.get_trial_paramEs7"x("":.?? Z@XYYrc[e)a"Update the state and values of a trial. Set return values of an objective function to values argument. If values argument is not :obj:`None`, this method overwrites any existing trial values. Args: trial_id: ID of the trial. state: New state of the trial. values: Values of the objective function. Returns: :obj:`True` if the state is successfully updated. :obj:`False` if the state is kept the same. The latter happens when this method tries to update the state of :obj:`~optuna.trial.TrialState.RUNNING` trial to :obj:`~optuna.trial.TrialState.RUNNING`. Raises: :exc:`KeyError`: If no trial with the matching ``trial_id`` exists. :exc:`~optuna.exceptions.UpdateFinishedTrialError`: If the trial is already finished. r)rrEstatevaluess rset_trial_state_values"BaseStorage.set_trial_state_valuesYs <"!rc[e)aReport an intermediate value of an objective function. This method overwrites any existing intermediate value associated with the given step. Args: trial_id: ID of the trial. step: Step of the trial (e.g., the epoch when training a neural network). intermediate_value: Intermediate value corresponding to the step. Raises: :exc:`KeyError`: If no trial with the matching ``trial_id`` exists. :exc:`~optuna.exceptions.UpdateFinishedTrialError`: If the trial is already finished. r)rrEstepintermediate_values rset_trial_intermediate_value(BaseStorage.set_trial_intermediate_valueys ,"!rc[e)aSet a user-defined attribute to a trial. This method overwrites any existing attribute. Args: trial_id: ID of the trial. key: Attribute key. value: Attribute value. It should be JSON serializable. Raises: :exc:`KeyError`: If no trial with the matching ``trial_id`` exists. :exc:`~optuna.exceptions.UpdateFinishedTrialError`: If the trial is already finished. rrrEr#r$s rset_trial_user_attrBaseStorage.set_trial_user_attrrCrc[e)aSet an optuna-internal attribute to a trial. This method overwrites any existing attribute. Args: trial_id: ID of the trial. key: Attribute key. value: Attribute value. It should be JSON serializable. Raises: :exc:`KeyError`: If no trial with the matching ``trial_id`` exists. :exc:`~optuna.exceptions.UpdateFinishedTrialError`: If the trial is already finished. rrns rset_trial_system_attr!BaseStorage.set_trial_system_attrrCrc[e)zRead a trial. Args: trial_id: ID of the trial. Returns: Trial with a matching trial ID. Raises: :exc:`KeyError`: If no trial with the matching ``trial_id`` exists. rrYs rrWBaseStorage.get_trialr.rc[e)aRead all trials in a study. Args: study_id: ID of the study. deepcopy: Whether to copy the list of trials before returning. Set to :obj:`True` if you intend to update the list or elements of the list. states: Trial states to filter on. If :obj:`None`, include all states. Returns: List of trials in the study, sorted by ``trial_id``. Raises: :exc:`KeyError`: If no study with the matching ``study_id`` exists. r)rrrLstatess rrMBaseStorage.get_all_trialss 2"!rcf[U[5(aU4n[URUSUS95$)a-Count the number of trials in a study. Args: study_id: ID of the study. state: Trial states to filter on. If :obj:`None`, include all states. Returns: Number of trials in the study. Raises: :exc:`KeyError`: If no study with the matching ``study_id`` exists. FrLrw) isinstancerrNrM)rrrds r get_n_trialsBaseStorage.get_n_trialss5( eZ ( (HE4&&x%&NOOrc2URUS[R/S9n[U5S:Xa [ S5eUR U5n[U5S:a [ S5eUSnU[R:Xa [USS9nU$[US S9nU$) aReturn the trial with the best value in a study. This method is valid only during single-objective optimization. Args: study_id: ID of the study. Returns: The trial with the best objective value among all finished trials in the study. Raises: :exc:`KeyError`: If no study with the matching ``study_id`` exists. :exc:`RuntimeError`: If the study has more than one direction. :exc:`ValueError`: If no trials have been completed. FrzrzNo trials are completed yet.zBBest trial can be obtained only for single-objective optimization.c6[[UR5$Nrfloatr$ts r,BaseStorage.get_best_trial..$tE1777Kr)r#c6[[UR5$rrrs rrr&rr) rMrCOMPLETErN ValueErrorr3 RuntimeErrorr MAXIMIZEmaxmin)rr all_trialsr direction best_trials rget_best_trialBaseStorage.get_best_trials(((E:K^K^J_(` z?a ;< <..x8 z?Q T qM // /Z-KLJZ-KLJrc8URU5R$)a9Read the parameter dictionary of a trial. Args: trial_id: ID of the trial. Returns: Dictionary of a parameters. Keys are parameter names and values are external representations of the parameter values. Raises: :exc:`KeyError`: If no trial with the matching ``trial_id`` exists. )rWr_rYs rget_trial_paramsBaseStorage.get_trial_params*s~~h'...rc8URU5R$)zRead the user-defined attributes of a trial. Args: trial_id: ID of the trial. Returns: Dictionary with the user-defined attributes of the trial. Raises: :exc:`KeyError`: If no trial with the matching ``trial_id`` exists. )rW user_attrsrYs rget_trial_user_attrs BaseStorage.get_trial_user_attrs;s~~h'222rc8URU5R$)aRead the optuna-internal attributes of a trial. Args: trial_id: ID of the trial. Returns: Dictionary with the optuna-internal attributes of the trial. Raises: :exc:`KeyError`: If no trial with the matching ``trial_id`` exists. )rW system_attrsrYs rget_trial_system_attrs"BaseStorage.get_trial_system_attrsKs~~h'444rcg)z'Clean up all connections to a database.Nr<s rremove_sessionBaseStorage.remove_session[s rcUR5(a5URU5n[SRUR55eg)aCheck whether a trial state is updatable. Args: trial_id: ID of the trial. Only used for an error message. trial_state: Trial state to check. Raises: :exc:`~optuna.exceptions.UpdateFinishedTrialError`: If the trial is already finished. z5Trial#{} has already finished and can not be updated.N) is_finishedrWr rPrX)rrE trial_stater`s rcheck_trial_is_updatable$BaseStorage.check_trial_is_updatable_sE  " " $ $NN8,E*GNNu||\  %rrr)rzSequence[StudyDirection]rz str | Nonereturnint)rrrNone)rrr#strr$rrr)rrr#rr$rrr)rrrr)rrrr)rrrzlist[StudyDirection])rrrdict[str, Any])rzlist[FrozenStudy])rrr@zFrozenTrial | Nonerr) rErrFrrGrrHr rr)rrrRrrr)rErrr)rErrFrrr)rErrdrrezSequence[float] | Nonerbool)rErrirrjrrr)rErr#rr$rrr)rErr#rr$rrr)rErrr )TN)rrrLrrwzContainer[TrialState] | Nonerzlist[FrozenTrial])rrrdz*tuple[TrialState, ...] | TrialState | Nonerr)rrrr )rErrr)rr)rErrrrr)$__name__ __module__ __qualname____firstlineno____doc__abcabstractmethodrrr%r)r,r0r3r6r9r=rArIrTrZrarfrkrorrrWrMr|rrrrrr__static_attributes__rrrrrs: MQ"2"@J" ""2  " " ""& ""* ""  ""  ""  ""  ""  "" ""* """$ " ' "  ""6.2/(Z( QU""$."8N" ""> ""#&"rsF" %$+16,8$#'\ #''\ r