o /wi @sUdZddlmZddlZddlmZddlmZddlZddlmZddl Z ddl Z ddl Z ddl Z ddl Z ddlmZddlZddlZddlZddlZddlmZdd lmZdd lmZdd lmZdd lmZdd lmZddlmZddlmZddl m!Z!ddl m"Z"ddl#m$Z$edZ%dZ&dsddZ'dtddZ(dud!d"Z)dvd*d+Z*Gd,d-d-eZ+Gd.d/d/Z,dwd3d4Z-dwd5d6Z.dxd9d:Z/Gd;d<d<Z0Gd=d>d>e0Z1Gd?d@d@e0Z2GdAdBdBe0Z3GdCdDdDe0Z4GdEdFdFe0Z5GdGdHdHe0Z6GdIdJdJe0Z7GdKdLdLe0Z8GdMdNdNe0Z9GdOdPdPe0Z:GdQdRdRe0Z;e1e2e3e4e5e6e7e8e9e:e;dS ZdzdZd[Z?d{d_d`Z@d|d}dddeZAd~dgdhZBddldmZCddndoZDddqdrZEdS)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) CLIUsageError)ExperimentalWarning) BaseStorage)JournalFileStorage)JournalRedisStorage)JournalStorage) RDBStorage)JournalFileBackend)JournalRedisBackend) TrialStatezoptuna.study._dataframez%Y-%m-%d %H:%M:%S storage_url str | NonereturnstrcCs8|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.)osenvirongetwarningswarnr r)r env_storagerG/home/ubuntu/sommelier/.venv/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__r r rr rr startswithrpathisfile sqlalchemyexc ArgumentError)rr rrr _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/rrrr2[r3cSsi|] \}}t|t|qSrr-)r0kr1rrr ]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,r6rr<r=r0recordcolumnrrr2k"z#_convert_to_dict..c3rJr,rKrLrNrrr2|rPcSsi|]}|iqSrr)r0 column_namerrrr5z$_convert_to_dict..) appendanymaxlenranger. enumerater6r7) r@rBrDheaderret max_lengthrMirowr*r1attrsrrNr_convert_to_dictbsf        8 r_c@seZdZdZdZdZdS) ValueTyperrGN)r" __module__ __qualname__NONENUMERICSTRINGrrrrr`sr`c@s4eZdZdddZddd Zdd d ZdddZdS) CellValuer*rrNonecCs@||_|dur tj|_dSt|ttfrtj|_dStj|_dSr,) r*r`rd value_typer6r7r8rerf)selfr*rrr__init__s    zCellValue.__init__rcCs$t|jtjr |jtSt|jSr,)r6r*r9r:r;rrjrrr__str__s  zCellValue.__str__r7cCstt|jSr,)rVrr*rlrrrwidthszCellValue.widthrir`rncCsBt|j}|jdurd|S|tjkr|d|S|d|S)N ><)rr*r`re)rjrirnr*rrr get_strings   zCellValue.get_stringN)r*rrrh)rrrr7)rir`rnr7rr)r"rbrcrkrmrnrrrrrrrgs   rglist[dict[str, Any]]rY list[str]cCsZg}|D]#}g}|D]}|||durt||ndq |d|qd|S)NrHro )rSrrjoin)r@rYvaluesrMr]rQrrr _dump_values& ryc 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)r{r)r0rIrrr sz_dump_table..csg|]}|jqSr)rir0r]rNrrr|src3s|] }|VqdSr,)rnr}rNrrr2z_dump_table..-rarorpz |rqrHrv) rSrgrrWrVr`rerfrUrXrr)r@rYrowsrMr]rQ separator header_string rows_string value_typesrit max_widthr\rZ row_stringrrNr _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.) r6r<r_rystriprrdumpsr safe_dumpr)r@rBrrDrxrYrrr_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. rrhcCstjt|_dSr,)optunalogging get_loggerr"loggerrlrrrrksz_BaseCommand.__init__parserrcCsdS)zAdd arguments required for each command. Args: parser: `ArgumentParser` object to add arguments Nrrjrrrr add_argumentssz_BaseCommand.add_arguments parsed_argsrr7cCst)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)rjrrrr take_action$s z_BaseCommand.take_actionN)rrhrrrrhrrrr7)r"rbrc__doc__rkrrrrrrrs    rc@$eZdZdZdddZdd d Zd S) _CreateStudyzCreate a new study.rrrrhcCsP|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".rz)rrrrnargs add_argumentrrrrrr6s4 z_CreateStudy.add_argumentsrrr7cCs8t|j|j}tj||j|j|j|jdj}t |dS)N)storage study_name direction directionsload_if_existsr) r)rr r create_studyrrrskip_if_existsprint)rjrrrrrrrVsz_CreateStudy.take_actionNrrr"rbrcrrrrrrrr3s  rc@r) _DeleteStudyzDelete a specified study.rrrrhcCs|jdddddS)Nrz The name of the study to delete.rrrrrrrfsz_DeleteStudy.add_argumentsrrr7cCs(t|j|j}||j}||dS)Nr)r)rr get_study_id_from_namer delete_study)rjrrstudy_idrrrris  z_DeleteStudy.take_actionNrrrrrrrrcs rc@r)_StudySetUserAttributez Set a user attribute to a study.rrrrhcCs6|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_argumentsrrr7cCs>t|j|j}tj||jd}||j|j|j ddS)NrrzAttribute successfully written.r) r)rr r load_studyr set_user_attrkeyr*rinfo)rjrrstudyrrrr|s  z"_StudySetUserAttribute.take_actionNrrrrrrrrps  rc@r) _StudyNamesz1Get all study names stored in a specified storagerrrrhcCs|jddtdddddS)N-f--formatr*rrrr*Output format.rrrrrrrrrrs z_StudyNames.add_argumentsrrr7cCsTt|j|j}t|}g}d}|D] }|||iqtt||g|jdddS)NnamerHF)rDr) r)rr rget_all_study_namesrSrrformat)rjrrall_study_namesr@ record_keyrrrrrs z_StudyNames.take_actionNrrrrrrrrs  rc@s,eZdZdZgdZdddZdd d ZdS)_StudieszShow a list of studies.)rrrHn_trialsrHdatetime_startrHrrrrhcCs,|jddtdddd|jddd d d dS) Nrrrrrr --flattenFrz*Flatten nested columns such as directions.rrrrrrrs z_Studies.add_argumentsrrr7cCst|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)r0drrrr2sz'_Studies.take_action..rrr user_attrsrHcss|] }|dikVqdS)rNr)r0rrrrr2r~r)r)rr rget_all_study_summariesrr:r;rr=rrrrSrT_study_list_headerrrrrD)rjrr summariesr@sstartrMrrrrs.       z_Studies.take_actionNrr)r"rbrcrrrrrrrrrs  rc@r)_TrialszShow a list of trials.rrrrhcC>|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_argumentsrrr7cCsttdtt|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*rxrdatetime_completedurationparamsrstater)rrr r)rr rrr_is_multi_objective _dataframe$_create_records_and_aggregate_columnrrrrDrjrrrr^r@rBrrrrs$ z_Trials.take_actionNrrrrrrrr rc@r) _BestTrialzShow the best trial.rrrrhcCr)NrTz,The name of the study to get the best trial.rrrrrrrrFrrrrrrrrr rz_BestTrial.add_argumentsrrr7cCs|tdtt|j|j}tj||jd}d| sdnddddd d d f}t ||\}}t t ||jj||j|jd S) NzT'best-trial' is an experimental CLI command. The interface can change in the future.rrr*rxrrrrrrr)rrr r)rr rrrrrrrr best_trialrrrDrrrrr!s, z_BestTrial.take_actionNrrrrrrrrrrc@r) _BestTrialsz2Show a list of trials located at the Pareto front.rrrrhcCr)NrTzJThe name of the study to get the best trials (trials at the Pareto front).rrrrrrrrFrrrrrrrrr@rz_BestTrials.add_argumentsrrr7cstdtt|j|j}tj||jd}dd|j Dd| s$dnddd d d d d f}t ||\}}t tfdd|}tt|||j|jdS)NzU'best-trials' is an experimental CLI command. The interface can change in the future.rcSsg|]}|jqSr)r)r0trialrrrr|_rRz+_BestTrials.take_action..rr*rxrrrrrrcs |dvS)NrrHr)rM best_trialsrrls z)_BestTrials.take_action..r)rrr r)rr rrrrrrrr<filterrrrrD)rjrrrr^r@rB best_recordsrrrrVs( z_BestTrials.take_actionNrrrrrrrr=rrc@seZdZdZd ddZdS) _StorageUpgradez%Upgrade the schema of an RDB storage.rrrr7cCst|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.rGzThis 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_versionsrupgraderr)rjrrrcurrent_version head_versionknown_versionsrrrrts0       z_StorageUpgrade.take_actionNr)r"rbrcrrrrrrrqsrc@r)_Askz*Create a new trial and suggest parameters.rrrrhcCsl|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_argumentsrrr7cCstdtt|j|j}||jdd}|jdur:|jdur%t |j}ni}t t j |j}|di|}||d<n |jdurCtd|jdurVddt |jD}ni}zt j|d|d |dd }Wn tyttd 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)r0rdistrrrr5sz$_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)rrHrr)rrr r)rr rr sampler_kwargsrloadsgetattrrsamplers ValueError search_spacer?rrKeyErroraskrrrrrVrDrSrrr)rjrrcreate_study_kwargsr sampler_clsr rrrrMrB param_name param_valuerrrrs`          z_Ask.take_actionNrrrrrrrrs rc@r)_Tellz5Finish a trial, which was created by the ask command.rrrrhcCsZ|jdtdd|jdtdd|jdtddd |jd td d d |jddddddS)Nrrr z--trial-numberz Trial number.z--valuesrzzObjective values.)rrrz--statez Trial state.)completeprunedfail)rrrz--skip-if-finishedFrzSIf specified, tell is skipped without any error when the trial is already finished.r)rrr7r8rrrrrs z_Tell.add_argumentsrrr7c Cstdtt|j|j}tj||jd}|j dur"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)rrxrskip_if_finishedz Told trial z with values z and state rr)rrr r)rr rrrrrupper trial_numberrxtellr rr)rjrrrrr"rxrrrr 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 rG)) 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_levelrGz.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_argumentsNsRr5 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)handlerargsrrrhcs dSr,) print_help)r;r6rr _print_helps z"_add_commands.._print_helprzShow help message and exit.)rr;rrrh) add_subparsersr&r? add_parserinspectgetdocr set_defaultsr) r6r7 subparserscommand_name_to_subparser command_name command_typecommand subparserr>rr=r _add_commands}s  rKrH description0tuple[ArgumentParser, dict[str, ArgumentParser]]cCsLtdd}t|}t||gd}|jddddtjdt||}||fS) NF)add_help)rLr9z --versionversionz{0} {1}r)rrO)rr5rrr __version__rK)rLr7r6rFrrr _get_parsers  rQargvcCst|dkr |ddndg}tt|D]2}t||dD](}d|||d}|tvrF|d|||dd}|g|Sqq|S)NrGrraro)rVrWrwr&)rRr\jcommand_candidateoptionsrrr_preprocess_argvsrVr;rrhcCsrt}|tjttj}tjtjtjd |j tj}||| t j ||t j|dS)N)rrGra)r getLoggersetLevelDEBUG StreamHandlersysstderrWARNINGINFOrr. setFormatterrcreate_default_formatter addHandler set_verbosity)r; root_loggerstream_handler logging_levelrrr_set_verbositys     rfcCsN|jdurdSt}|tjtj|jd}|tj| |dS)N)filename) log_filerrWrXrY FileHandlerr_rr`ra)r;rc file_handlerrrr _set_log_files  rkr7c Cst\}}tj}t|}||}t|t|td}z| |WSt yM}z|j r5| |n | |||dWYd}~dSd}~wtyld|dd}| d|d|YdSw)NrrrGro'z/' is not an optuna command. see 'optuna --help')rQr[rRrV parse_argsrfrkrrWr:rdebug exceptionrr<AttributeErrorrw)r6rFrRpreprocessed_argvr;reargv_strrrrmains,       rt)rrrr)rrr rrr )r*rrr)r@rArBrCrDrErrF)r@rtrYrurr) r@rrBrCrrrDrErr)r*rrr)rrrr)r6rr7rrr8)rH)rLrrrM)rRrurrur?rs)Fr __future__rr)rrr9enumrrBrrrr[typingrrsqlalchemy.excr&rroptuna._importsroptuna.exceptionsrr optuna.storagesr r r r roptuna.storages.journalrr optuna.trialrrr;rr)r.r_r`rgryrrrrrrrrrrrrrrr&__annotations__r,r5rKrQrVrfrkrtrrrrs                    :  ("0 7254i7   /