o
/wi> @ sL d dl mZ d dlmZ d dlmZ d dlmZ d dlmZ d dlZd dl Z d dl m
Z
d dl m Z d d l
mZ d d
lmZ d d lmZ d d lmZ d d
lmZ d dlmZ e r`d dlmZ e je Z G dd deZ dddddddCd!d"Z dDd$d%Z dEdFd&d'Z!dGd+d,Z"dHd0d1Z# 2 2dIdJd=d>Z$ 2 2dIdKdAdBZ%dS )L ) annotations)Callable)Sequence)Any)
NamedTupleN) _deprecated)_CONSTRAINTS_KEY)Study)"_get_pareto_front_trials_by_trials) FrozenTrial)
TrialState)_imports_make_hovertext)goc @ sN e Zd ZU ded< ded< ded< ded< ded< d ed
< d ed < d ed
< dS )_ParetoFrontInfoint n_targetsz list[str] target_names%list[tuple[FrozenTrial, list[float]]]best_trials_with_valuesnon_best_trials_with_values infeasible_trials_with_valuesz list[int]
axis_orderboolinclude_dominated_trialshas_constraintsN)__name__
__module__ __qualname____annotations__ r! r! _/home/ubuntu/sommelier/.venv/lib/python3.10/site-packages/optuna/visualization/_pareto_front.pyr s
r T)r r r constraints_functargetsstudyr r list[str] | Noner r r list[int] | Noner# /Callable[[FrozenTrial], Sequence[float]] | Noner$ return 'go.Figure'c C s" t t| |||||}t|S )a Plot the Pareto front of a study.
.. seealso::
Please refer to :ref:`multi_objective` for the tutorial of the Pareto front visualization.
Args:
study:
A :class:`~optuna.study.Study` object whose trials are plotted for their objective
values. The number of objectives must be either 2 or 3 when ``targets`` is :obj:`None`.
target_names:
Objective name list used as the axis titles. If :obj:`None` is specified,
"Objective {objective_index}" is used instead. If ``targets`` is specified
for a study that does not contain any completed trial,
``target_name`` must be specified.
include_dominated_trials:
A flag to include all dominated trial's objective values.
axis_order:
A list of indices indicating the axis order. If :obj:`None` is specified,
default order is used. ``axis_order`` and ``targets`` cannot be used at the same time.
.. warning::
Deprecated in v3.0.0. This feature will be removed in the future. The removal of
this feature is currently scheduled for v5.0.0, but this schedule is subject to
change. See https://github.com/optuna/optuna/releases/tag/v3.0.0.
constraints_func:
An optional function that computes the objective constraints. It must take a
:class:`~optuna.trial.FrozenTrial` and return the constraints. The return value must
be a sequence of :obj:`float` s. A value strictly larger than 0 means that a
constraint is violated. A value equal to or smaller than 0 is considered feasible.
This specification is the same as in, for example,
:class:`~optuna.samplers.NSGAIISampler`.
If given, trials are classified into three categories: feasible and best, feasible but
non-best, and infeasible. Categories are shown in different colors. Here, whether a
trial is best (on Pareto front) or not is determined ignoring all infeasible trials.
.. warning::
Deprecated in v4.0.0. This feature will be removed in the future. The removal of
this feature is currently scheduled for v6.0.0, but this schedule is subject to
change. See https://github.com/optuna/optuna/releases/tag/v4.0.0.
targets:
A function that returns targets values to display.
The argument to this function is :class:`~optuna.trial.FrozenTrial`.
``axis_order`` and ``targets`` cannot be used at the same time.
If ``study.n_objectives`` is neither 2 nor 3, ``targets`` must be specified.
.. note::
Added in v3.0.0 as an experimental feature. The interface may change in newer
versions without prior notice.
See https://github.com/optuna/optuna/releases/tag/v3.0.0.
Returns:
A :class:`plotly.graph_objects.Figure` object.
)r
check_get_pareto_front_info_get_pareto_front_plot)r% r r r r# r$ infor! r! r" plot_pareto_front% s
@ r/ r. c
C s | j }| j}|s#t| j| j|| jdddt| j| j|| jdddg}n&t| j| j|| jdddt| j| j|| jdddt| j| j|| jdddg}| jd krctj d
| j
| jd | j
| jd d
}n tj d
| j
| jd | j
| jd | j
| jd dd}tj ||dS )Nz%{text}TrialT)
hovertemplatedominated_trialsz %{text}Best TrialFz&%{text}Infeasible Trial)r0
infeasiblez$%{text}Feasible Trial zPareto-front Plotr )title xaxis_title yaxis_title)r6 r7 zaxis_title)r5 scene)datalayout) r r _make_scatter_objectr r r r r r Layoutr Figure)r. r r r: r; r! r! r" r- m sv
r- c
C s< |d urt jjdddd}t|t |d ur&t jjdddd}t|t |d ur2|d ur2tdg }g }d } | jd tj fd
D ]C}
|d ur`d } t
t d d
||
rZ| |
n| |
qA|
j
t} | | d uO } | d u syt
dd | D r| |
qA| |
qAt|| j} |rt|| }
ng }
t| dkr| rdnd}td| d |}|d u rt| jdv rt}ntdd5d d }|| |}||
|}|||}d6d"d#}||p||}|d u r|d urt|}n|d u rt| j}ntd$|dvrtd%||d u r | j}|d u r d&d' t|D }n|}nt||kr/td(| d)|d u r;tt|}nWt||krRtd*| d+| d,t| d)tt||krctd-| d.t||d/ kr~td0| d1t| d2|d/ d)t |dk rtd0| d1t | d3t |||||||| d4S )7Nz `axis_order`z3.0.0z5.0.0)named_verr_verz`constraints_func`z4.0.0z6.0.0z]Using both `targets` and `axis_order` is not supported. Use either `targets` or `axis_order`.F)deepcopystatesTc S s | dkS )N r! )xr! r! r" s z(_get_pareto_front_info..c s s | ]}|d kV qdS )rD Nr! ).0rE r! r! r" s z)_get_pareto_front_info..r completedzcompleted and feasiblez Your study does not have any z trials. )r3 z`plot_pareto_front` function only supports 2 or 3 objective studies when using `targets` is `None`. Please use `targets` if your objective studies have more than 3 objectives.trialslist[FrozenTrial]r$ (Callable[[FrozenTrial], Sequence[float]]r) r c sL fdd| D }|D ]}t |tstdt|q dd t| |D S )Nc s g | ]} |qS r! r! )rG trialr$ r! r"
zL_get_pareto_front_info.._make_trials_with_values..zN`targets` should return a sequence of target values. your `targets` returns {}c S s g | ]
\}}|t |fqS r! )list)rG rN vr! r! r" rP )
isinstancer
ValueErrorformattypezip)rK r$
target_valuesrS r! rO r" _make_trials_with_values s
z8_get_pareto_front_info.._make_trials_with_valuestrials_with_values-Sequence[tuple[FrozenTrial, Sequence[float]]]
int | Nonec S s t | dkrt | d d S d S )Nr r4 len)r\ r! r! r" _infer_n_targets s z0_get_pareto_front_info.._infer_n_targetszNIf `targets` is specified for empty studies, `target_names` must be specified.zS`plot_pareto_front` function only supports 2 or 3 targets. you used {} targets now.c S s g | ]}d | qS )z
Objective r! )rG ir! r! r" rP $ s z*_get_pareto_front_info..z/The length of `target_names` is supposed to be .zSize of `axis_order` z
. Expect: z
, Actual: z Elements of given `axis_order` z are not unique!.r4 zGiven `axis_order` z contains invalid index z
higher than z lower than 0.)r r r r r r r r )rK rL r$ rM r) r )r\ r] r) r^ ) r _DEPRECATION_WARNING_TEMPLATErW warningswarn
FutureWarningrV
get_trialsr COMPLETEallmapappend system_attrsgetr r
directions _get_non_pareto_front_trialsr` _loggerwarning_targets_default metric_namesrangerR setmaxminr )r% r r r r# r$ msgfeasible_trialsinfeasible_trialsr rN constraints best_trialsnon_best_trials
what_trial_targetsr[ r r r ra r rt r! r! r" r, s
r, rN r Sequence[float]c C s | j S N)values)rN r! r! r" rs K s rs rK rL
pareto_trialsc C s$ g }| D ] }||vr| | q|S r )rl )rK r non_pareto_trialsrN r! r! r" rp O s
rp Fr r
Sequence[int]r\ r] r0 strr2 r1 'go.Scatter' | 'go.Scatter3d'c
s |pg }t dd |D |||d}| dkr4tj fdd|D fdd|D dd |D d||d d
S | d kr_tj fd d|D fd
d|D fdd|D dd |D d||d dS J d)Nc S s g | ]\}}|qS r! r! rG rN _r! r! r" rP e rQ z(_make_scatter_object..)r1 r2 r3 c g | ]
\}}| d qS r r! rG r r r r! r" rP l rT c r r4 r! r r r! r" rP m rT c S g | ]\}}t |qS r! r r r! r! r" rP n markersF)rE ytextmoder0 marker
showlegendrJ c r r r! r r r! r" rP v rT c r r r! r r r! r" rP w rT c r )r3 r! r r r! r" rP x rT c S r r! r r r! r! r" rP y r )rE r zr r r0 r r zMust not reach here) _make_markerr Scatter Scatter3d)r r r r\ r0 r2 r1 r r! r r" r< Y s: r< Sequence[FrozenTrial]dict[str, Any]c C sx |r |s t | dks J |rddiS |r%ddddd | D d d
d id S dddd
d | D dd|r5dndddd S )Nr colorz#ccccccg ?Grey)widthr c S g | ]}|j qS r! numberrG tr! r! r" rP z _make_marker..Bluesr5 Trial)liner
colorscalecolorbarc S r r! r r r! r! r" rP r Redsz
Best Trialg?r4 ( )r5 rE xpadr_ )rK r r1 r2 r! r! r" r s(
r )r% r r r& r r r r' r# r( r$ r( r) r* )r. r r) r* )NTNNN)r% r r r& r r r r' r# r( r$ r( r) r )rN r r) r )rK rL r rL r) rL )FF)r r r r r r r\ r] r0 r r2 r r1 r r) r )
rK r r r r1 r r2 r r) r )&
__future__r collections.abcr r typingr r re optunar optuna.samplers._baser optuna.studyr optuna.study._multi_objectiver
optuna.trialr r $optuna.visualization._plotly_importsr
optuna.visualization._utilsr
is_successfulr logging
get_loggerr rq r r/ r- r, rs rp r< r r! r! r! r" sR
HF
-