o }oi @sUdZddlmZddlZddlmZddlmZddlZddlmZddl Z ddl Z ddl Z ddl Z ddl Z ddlmZddlZddlZddlZddlmZdd lmZdd lmZdd lmZdd lmZdd lmZddlmZddlmZddlm Z ddl!m"Z"ddl!m#Z#ddl$m%Z%edZ&dZ'dtddZ(duddZ)dvd"d#Z*dwd+d,Z+Gd-d.d.eZ,Gd/d0d0Z-dxd4d5Z.dxd6d7Z/dyd:d;Z0Gdd?d?e1Z2Gd@dAdAe1Z3GdBdCdCe1Z4GdDdEdEe1Z5GdFdGdGe1Z6GdHdIdIe1Z7GdJdKdKe1Z8GdLdMdMe1Z9GdNdOdOe1Z:GdPdQdQe1Z;GdRdSdSe1ZdV<dzdWdXZ?d{d[d\Z@d|d`daZAd}d~dedfZBddhdiZCddmdnZDddodpZEddrdsZFdS)zfOptuna CLI module. If you want to add a new command, you also need to update the constant `_COMMANDS` ) annotationsN)ArgumentParser) Namespace)Enum)Any) _LazyImport) optuna_warn) CLIUsageError)ExperimentalWarning) BaseStorage)JournalFileStorage)JournalRedisStorage)JournalStorage) RDBStorage)JournalFileBackend)JournalRedisBackend) TrialStatezoptuna.study._dataframez%Y-%m-%d %H:%M:%S storage_url str | NonereturnstrcCs6|dur|Stjd}|durtdt|Std)NOPTUNA_STORAGEzSpecifying the storage url via 'OPTUNA_STORAGE' environment variable is an experimental feature. The interface can change in the future.zStorage URL is not specified.)osenvirongetrr r )r env_storager>/home/ubuntu/.local/lib/python3.10/site-packages/optuna/cli.py_check_storage_url*s r storage_classr cCst|}|r?|tjkrtt|S|tjkrtt|S|tjkr'tt|S|tjkr2tt|S|tjkr;t|Std| drJtt|St j |rVtt|Szt|WSt jjyhtdw)NzUnsupported storage classredisz.Failed to guess storage class from storage_url)rr__name__rr rr rr startswithrpathisfile sqlalchemyexc ArgumentError)rrrrr _get_storage9s,              r(valuercCs|dus t|ttfr |St|tjr|tSt|tr&tdd|DSt|tr4tdd|DSt|trBdd| DSt |S)Ncs|]}t|VqdSN _format_value.0vrrr Yz _format_value..csr*r+r,r.rrrr1[r2cSsi|] \}}t|t|qSrr,)r/kr0rrr ]sz!_format_value..) isinstanceintfloatdatetimestrftime_DATETIME_FORMATlisttupledictitemsr)r)rrrr-Rs     r-records list[dict[tuple[str, str], Any]]columnslist[tuple[str, str]]flattenbool&tuple[list[dict[str, Any]], list[str]]c sg}g}|r|D]Qddkr|dddqtfdd|DrRd}|D]}|vr=t|t|}q.t|D]}|dd|qBq|dq|D]T}i}|D]H|vriqbt|} ddkr| |ddd<qbtfdd|Drt| D]\}} | |dd|<qqb| |d<qb||q\||fS|D]d|vr|dq|D]s}dd |D} |D]b|vrqt|} tdtr| dikrg| d<| ddgtddt| dd7<| | dd<qԈddkr0| | dd<q| | d<q|| q||fS) Nr_c3$|] }t|ttfVqdSr+r5rr;r<r/recordcolumnrrr1k"z#_convert_to_dict..c3rIr+rJrKrMrrr1|rOcSsi|]}|iqSrr)r/ column_namerrrr4z$_convert_to_dict..) appendanymaxlenranger- enumerater5r6) r?rArCheaderret max_lengthrLirowr)r0attrsrrMr_convert_to_dictbsf        8 r^c@seZdZdZdZdZdS) ValueTyperrFN)r! __module__ __qualname__NONENUMERICSTRINGrrrrr_sr_c@s4eZdZdddZddd Zdd d ZdddZdS) CellValuer)rrNonecCs@||_|dur tj|_dSt|ttfrtj|_dStj|_dSr+) r)r_rc value_typer5r6r7rdre)selfr)rrr__init__s    zCellValue.__init__rcCs$t|jtjr |jtSt|jSr+)r5r)r8r9r:rrirrr__str__s  zCellValue.__str__r6cCstt|jSr+)rUrr)rkrrrwidthszCellValue.widthrhr_rmcCsBt|j}|jdurd|S|tjkr|d|S|d|S)N ><)rr)r_rd)rirhrmr)rrr get_strings   zCellValue.get_stringN)r)rrrg)rrrr6)rhr_rmr6rr)r!rarbrjrlrmrqrrrrrfs   rflist[dict[str, Any]]rX list[str]cCsZg}|D]#}g}|D]}|||durt||ndq |d|qd|S)NrGrn )rRrrjoin)r?rXvaluesrLr\rPrrr _dump_values& rxc sg}|D]}g}|D] }|t||q ||qd}d}dd|D}tt|D]fdd|D} tj} | D] } | tjkrHtj} q>t|dkrVt|} ntt|tfdd|D} |d | d d7}| tjkr|d |d | d 7}n|d |d| d 7}t |D]\} }|| d | | | d 7<qq.d}||d7}||d7}||d7}|D]}||d7}q||d7}|S)N+|cSsg|]}dqS)rzr)r/rHrrr sz_dump_table..csg|]}|jqSr)rhr/r\rMrrr{src3s|] }|VqdSr+)rmr|rMrrr1z_dump_table..-r`rnroz |rprGru) rRrfrrVrUr_rdrerTrWrq)r?rXrowsrLr\rP separator header_string rows_string value_typesrht max_widthr[rY row_stringrrMr _dump_tablesD   $ &    r=list[dict[tuple[str, str], Any]] | dict[tuple[str, str], Any] output_formatcCst|trt|||\}}n t|g||\}}|dkr"t||S|dkr-t||S|dkrFt|tr=t|St|dS|dkr_t|trVt |St |dSt d|d)Nr)tablejsonryamlz"Optuna CLI does not supported the z format.) r5r;r^rxstriprrdumpsr safe_dumpr )r?rArrCrwrXrrr_format_outputs   rc@s.eZdZdZdddZddd Zdd dZdS) _BaseCommandzBase class for commands. Note that command classes are not intended to be called by library users. They are exclusively used within this file to manage Optuna CLI commands. rrgcCstjt|_dSr+)optunalogging get_loggerr!loggerrkrrrrjsz_BaseCommand.__init__parserrcCsdS)zAdd arguments required for each command. Args: parser: `ArgumentParser` object to add arguments Nrrirrrr add_argumentssz_BaseCommand.add_arguments parsed_argsrr6cCst)aDefine action if the command is called. Args: parsed_args: `Namespace` object including arguments specified by user. Returns: Running status of the action. 0 if this method finishes normally, otherwise 1. )NotImplementedError)rirrrr take_action$s z_BaseCommand.take_actionN)rrgrrrrgrrrr6)r!rarb__doc__rjrrrrrrrs    rc@$eZdZdZdddZdd d Zd S) _CreateStudyzCreate a new study.rrrrgcCsP|jdddd|jddtddd|jdd d d d |jd tddddddS)N --study-namez?A human-readable name of a study to distinguish it from others.defaulthelpz --direction)minimizemaximizeznSet direction of optimization to a new study. Set 'minimize' for minimization and 'maximize' for maximization.)rtypechoicesrz--skip-if-existsF store_truezgIf specified, the creation of the study is skipped without any error when the study name is duplicated.ractionrz --directionszSet directions of optimization to a new study. Put whitespace between directions. Each direction should be either "minimize" or "maximize".ry)rrrrnargs add_argumentrrrrrr6s4 z_CreateStudy.add_argumentsrrr6cCs8t|j|j}tj||j|j|j|jdj}t |dS)N)storage study_name direction directionsload_if_existsr) r(rrr create_studyrrrskip_if_existsprint)rirrrrrrrVsz_CreateStudy.take_actionNrrr!rarbrrrrrrrr3s  rc@r) _DeleteStudyzDelete a specified study.rrrrgcCs|jdddddS)Nrz The name of the study to delete.rrrrrrrfsz_DeleteStudy.add_argumentsrrr6cCs(t|j|j}||j}||dS)Nr)r(rrget_study_id_from_namer delete_study)rirrstudy_idrrrris  z_DeleteStudy.take_actionNrrrrrrrrcs rc@r)_StudySetUserAttributez Set a user attribute to a study.rrrrgcCs6|jdddd|jddddd|jddd ddS) NrTz3The name of the study to set the user attribute to.)requiredrz--keyz-kzKey of the user attribute.z--valuezValue to be set.rrrrrrssz$_StudySetUserAttribute.add_argumentsrrr6cCs>t|j|j}tj||jd}||j|j|j ddS)NrrzAttribute successfully written.r) r(rrr load_studyr set_user_attrkeyr)rinfo)rirrstudyrrrr|s  z"_StudySetUserAttribute.take_actionNrrrrrrrrps  rc@r) _StudyNamesz1Get all study names stored in a specified storagerrrrgcCs|jddtdddddS)N-f--formatr)rrrr)Output format.rrrrrrrrrrs z_StudyNames.add_argumentsrrr6cCsTt|j|j}t|}g}d}|D] }|||iqtt||g|jdddS)NnamerGF)rCr) r(rrrget_all_study_namesrRrrformat)rirrall_study_namesr? record_keyrrrrrs z_StudyNames.take_actionNrrrrrrrrs  rc@s,eZdZdZgdZdddZdd d ZdS)_StudieszShow a list of studies.)rrrGn_trialsrGdatetime_startrGrrrrgcCs,|jddtdddd|jddd d d dS) Nrrrrrr --flattenFrz*Flatten nested columns such as directions.rrrrrrrs z_Studies.add_argumentsrrr6cCst|j|j}tj|dd}g}|D]5}|jdur|jtnd}i}|j|d<t dd|j D|d<|j |d<||d<|j |d <| |qtd d|DrW|j d tt||j|j|jd S) NF)include_best_trialrcss|]}|jVqdSr+)r)r/drrrr1sz'_Studies.take_action..rrr user_attrsrGcss|] }|dikVqdS)rNr)r/rrrrr1r}r)r(rrrget_all_study_summariesrr9r:rr<rrrrRrS_study_list_headerrrrrC)rirr summariesr?sstartrLrrrrs.       z_Studies.take_actionNrr)r!rarbrrrrrrrrrs  rc@r)_TrialszShow a list of trials.rrrrgcC>|jdtddd|jddtddd d |jd d d dddS)NrTz,The name of the study which includes trials.rrrrrrrrrrFr5Flatten nested columns such as params and user_attrs.rrrrrrr( z_Trials.add_argumentsrrr6cCsrtdtt|j|j}tj||jd}d|sdnddddd d d f}t ||\}}t t |||j |jd S) NzP'trials' is an experimental CLI command. The interface can change in the future.rnumberr)rwrdatetime_completedurationparamsrstater)rr r(rrrrr_is_multi_objective _dataframe$_create_records_and_aggregate_columnrrrrCrirrrr]r?rArrrrs$ z_Trials.take_actionNrrrrrrrr rc@r) _BestTrialzShow the best trial.rrrrgcCr)NrTz,The name of the study to get the best trial.rrrrrrrrFrrrrrrrrr rz_BestTrial.add_argumentsrrr6cCsztdtt|j|j}tj||jd}d|sdnddddd d d f}t ||\}}t t ||j j||j|jd S) NzT'best-trial' is an experimental CLI command. The interface can change in the future.rrr)rwrrrrrrr)rr r(rrrrrrrrrr best_trialrrrCrrrrr!s, z_BestTrial.take_actionNrrrrrrrrrrc@r) _BestTrialsz2Show a list of trials located at the Pareto front.rrrrgcCr)NrTzJThe name of the study to get the best trials (trials at the Pareto front).rrrrrrrrFrrrrrrrrr@rz_BestTrials.add_argumentsrrr6cstdtt|j|j}tj||jd}dd|jDd| s#dnddd d d d d f}t ||\}}t t fdd|}tt|||j|jdS)NzU'best-trials' is an experimental CLI command. The interface can change in the future.rcSsg|]}|jqSr)r)r/trialrrrr{_rQz+_BestTrials.take_action..rr)rwrrrrrrcs |dvS)NrrGr)rL best_trialsrrls z)_BestTrials.take_action..r)rr r(rrrrrrrrrr;filterrrrrC)rirrrr]r?rA best_recordsrrrrVs( z_BestTrials.take_actionNrrrrrrrr=rrc@seZdZdZd ddZdS) _StorageUpgradez%Upgrade the schema of an RDB storage.rrrr6cCst|j}z t|ddd}Wntjjy |jdYdSw|}| }| }||kr9|j dd S||vrO|j d| |j dd St dd S) NT)skip_compatibility_checkskip_table_creationzInvalid RDBStorage URL.rFzThis storage is up-to-date.z3Upgrading the storage schema to the latest version.z!Completed to upgrade the storage.zYour optuna version seems outdated against the storage version. Please try updating optuna to the latest version by `$ pip install -U optuna`.r)rrrr%r&r'rerrorget_current_versionget_head_versionget_all_versionsrupgrader)rirrrcurrent_version head_versionknown_versionsrrrrts0       z_StorageUpgrade.take_actionNr)r!rarbrrrrrrrqsrc@r)_Askz*Create a new trial and suggest parameters.rrrrgcCsl|jdtdd|jdtdd|jdtdd|jdtd d|jd d td d dd|jddddddS)NrName of study.rrz --samplerz'Class name of sampler object to create.z--sampler-kwargsz8Sampler object initialization keyword arguments as JSON.z--search-spaceztSearch space as JSON. Keys are names and values are outputs from :func:`~optuna.distributions.distribution_to_json`.rrrrrrrFrz&Flatten nested columns such as params.rrrrrrrs4 z_Ask.add_argumentsrrr6cCstdtt|j|j}||jdd}|jdur9|jdur$t |j}ni}t t j |j}|di|}||d<n |jdurBt d|jdurUddt |jD}ni}zt j|d|d |dd }Wn tystd w|j|d } |jd | jd| jdd| ji} dg} t| jdkr|jsi| d<| dn| jD]\} } | | d| f<| d| fqtt| | |j|jdS)NzM'ask' is an experimental CLI command. The interface can change in the future.T)rrrsamplerzm`--sampler_kwargs` is set without `--sampler`. Please specify `--sampler` as well or omit `--sampler-kwargs`.cSs$i|]\}}|tjt|qSr)r distributionsjson_to_distributionrr)r/rdistrrrr4sz$_Ask.take_action..rr)rrr zImplicit study creation within the 'ask' command was dropped in Optuna v4.0.0. Please use the 'create-study' command beforehand.)fixed_distributionsz Asked trial z with parameters .rr)rrGrr)rr r(rrrr sampler_kwargsrloadsgetattrrsamplers ValueError search_spacer>rrKeyErroraskrrrrrUrCrRrrr)rirrcreate_study_kwargsr sampler_clsr rrrrLrA param_name param_valuerrrrs`          z_Ask.take_actionNrrrrrrrrs rc@r)_Tellz5Finish a trial, which was created by the ask command.rrrrgcCsZ|jdtdd|jdtdd|jdtddd |jd td d d |jddddddS)Nrrrz--trial-numberz Trial number.z--valuesryzObjective values.)rrrz--statez Trial state.)completeprunedfail)rrrz--skip-if-finishedFrzSIf specified, tell is skipped without any error when the trial is already finished.r)rrr6r7rrrrrs z_Tell.add_argumentsrrr6c Cstdtt|j|j}tj||jd}|jdur!t |j }nd}|j }|j }|j ||||jd|jd|d|d|ddS) NzN'tell' is an experimental CLI command. The interface can change in the future.r)rrwrskip_if_finishedz Told trial z with values z and state rr)rr r(rrrrrrrupper trial_numberrwtellrrr)rirrrrr!rwrrrr s,  z_Tell.take_actionNrrrrrrrrs r) z create-studyz delete-studyzstudy set-user-attrz study-namesstudiestrialsz best-trialz best-trialszstorage upgraderr"zdict[str, type[_BaseCommand]] _COMMANDScCsPtjtjtjg}tjtjg}|||vr|Std|dt|ddd)NzInvalid choice: z (choose from rF)) rr!rrr r argparseArgumentTypeErrorr)r)rdeprecated_choicesrrr:_parse_storage_class_without_suggesting_deprecated_choices=s r+rrcCs~|jdddd|jdddtd|}|jddd d d d d |jdddd ddd|jddddd|jddddd|S)Nz --storagezbDB URL. (e.g. sqlite:///example.db) Also can be specified via OPTUNA_STORAGE environment variable.rz--storage-classz,Storage class hint (e.g. JournalFileBackend))rrrz-vz --verbosecount verbose_levelrFz.Increase verbosity of output. Can be repeated.)rdestrrz-qz--quiet store_constrz+Suppress output except warnings and errors.)rr.constrz --log-filestorez2Specify a file to log output. Disabled by default.)rrrz--debugFrzShow tracebacks on errors.r)rr+add_mutually_exclusive_group)r verbose_grouprrr_add_common_argumentsNsRr4 main_parser parent_parserdict[str, ArgumentParser]c s}i}tD]#\}}|}|j||gt|d}|||j|jd|||<q d fdd }|jd d d j|d|S) N)parentsr)handlerargsrrrgcs dSr+) print_help)r:r5rr _print_helps z"_add_commands.._print_helprzShow help message and exit.)rr:rrrg) add_subparsersr%r> add_parserinspectgetdocr set_defaultsr) r5r6 subparserscommand_name_to_subparser command_name command_typecommand subparserr=rr<r _add_commands}s  rJrG description0tuple[ArgumentParser, dict[str, ArgumentParser]]cCsLtdd}t|}t||gd}|jddddtjdt||}||fS) NF)add_help)rKr8z --versionversionz{0} {1}r)rrN)rr4rrr __version__rJ)rKr6r5rErrr _get_parsers  rPargvcCst|dkr |ddndg}tt|D]2}t||dD](}d|||d}|tvrF|d|||dd}|g|Sqq|S)NrFrr`rn)rUrVrvr%)rQr[jcommand_candidateoptionsrrr_preprocess_argvsrUr:rrgcCsrt}|tjttj}tjtjtjd |j tj}||| t j ||t j|dS)N)rrFr`)r getLoggersetLevelDEBUG StreamHandlersysstderrWARNINGINFOrr- setFormatterrcreate_default_formatter addHandler set_verbosity)r: root_loggerstream_handler logging_levelrrr_set_verbositys     recCsN|jdurdSt}|tjtj|jd}|tj| |dS)N)filename) log_filerrVrWrX FileHandlerr^rr_r`)r:rb file_handlerrrr _set_log_files  rjr6c Cst\}}tj}t|}||}t|t|td}z| |WSt yM}z|j r5| |n | |||dWYd}~dSd}~wtyld|dd}| d|d|YdSw)NrrrFrn'z/' is not an optuna command. see 'optuna --help')rPrZrQrU parse_argsrerjrrVr9r debug exceptionrr;AttributeErrorrv)r5rErQpreprocessed_argvr:reargv_strrrrmains,       rs)rrrr)rrrrrr )r)rrr)r?r@rArBrCrDrrE)r?rsrXrtrr) r?rrArBrrrCrDrr)r)rrr)rrrr)r5rr6rrr7)rG)rKrrrL)rQrtrrtr>rr)Gr __future__rr(rrr8enumrrArrrrZtypingrsqlalchemy.excr%rroptuna._importsroptuna._warningsroptuna.exceptionsr r optuna.storagesr r r rroptuna.storages.journalrr optuna.trialrrr:rr(r-r^r_rfrxrrrrrrrrrrrrrrr%__annotations__r+r4rJrPrUrerjrsrrrrs                     :  ("0 7254i7   /