-ji? S SK Jr S SKJr S SKJr S SKJr S SKJr S SKrS SKJ r S SK
J r S S K J
r
S S
KJr S S KJr S S KJr S S
KJr S SKJr S SKJr \R2 " 5 ( a S SKJr \R6 R9 \ 5 r " S S\5 r SSSSSS. S S jjr S S jr! S S S jjr"S S jr# S!S jr$ S" S#S jjr% S" S$S jjr&g)% ) annotations)Callable)Sequence)Any)
NamedTupleN) _deprecated) optuna_warn)_CONSTRAINTS_KEY)Study)"_get_pareto_front_trials_by_trials) FrozenTrial)
TrialState)_imports)_make_hovertext)goc f \ rS rSr% S\S' S\S' S\S' S\S' S\S ' S
\S ' S \S
' S \S' Srg)_ParetoFrontInfo int 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_constraints N)__name__
__module__ __qualname____firstlineno____annotations____static_attributes__r \/home/james-whalen/.local/lib/python3.13/site-packages/optuna/visualization/_pareto_front.pyr r s1 N BB!FF#HH ""r' r T)r r r constraints_functargetsc \ [ R " 5 [ XX#XE5 n[ U5 $ )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)studyr r r r) r* infos r( plot_pareto_frontr1 % s/ @
NN !
5CS D "$ ''r' c U R nU R nU( dY [ U R U R UU R
SSS9[ U R U R UU R SSS9/nO[ U R U R UU R SSS9[ U R U R UU R
SSS9[ U R U R UU R SSS9/nU R S :X aK [ R " S
U R U R S U R U R S S
9nOg[ R " S
U R U R S U R U R S U R U R S S.S9n[ R " X4S9$ )Nz%{text}TrialT)
hovertemplatedominated_trialsz %{text}Best TrialFz&%{text}Infeasible Trial)r3
infeasiblez$%{text}Feasible Trial zPareto-front Plotr )title xaxis_title yaxis_title)r9 r: zaxis_title)r8 scene)datalayout) r r _make_scatter_objectr r r r r r Layoutr Figure)r0 r r r= r> s r( r. r. m s # < < **O (00 ;!%
!(,, @!&
(
!(22 F
!(00 D!%
!(,, @!&
#
6 ~~% ))$//!*<= ))$//!*<=
% # 0 0 1C D # 0 0 1C D # 0 0 1C D
99$ ..r' c 6 Ub/ [ R R SSSS9n[ U[ 5 Ub/ [ R R SSSS9n[ U[ 5 Ub Ub [ S5 e/ n/ nS n U R
S [ R 4S
9 H n
UbH S n [ [ S U" U
5 5 5 ( a UR U
5 OUR U
5 MN U
R R [ 5 n XS L- n U b [ S
U 5 5 ( a UR U
5 M UR U
5 M [ XpR 5 n U( a [# X|5 n
O/ n
[% U 5 S:X a$ U ( a SOSn[& R) SU S35 UnUc+ [% U R 5 S; a [* nO [ S5 e S(S jnU" X5 nU" X5 nU" X5 n S)S jnU" U5 =( d U" U5 nUc3 Ub [% U5 nO$Uc [% U R 5 nO [ S5 eUS; a [ SU S35 eUc1 U R, nUc [/ U5 Vs/ s H nSU 3PM
nnO!UnO [% U5 U:w a [ SU S 35 eUc [1 [/ U5 5 nO[% U5 U:w a [ S U S U S [% U5 S 35 e[% [3 U5 5 U:w a [ S U S!35 e[5 U5 US"-
: a! [ S#U S$[5 U5 S%US"-
S 35 e[7 U5 S: a [ S#U S$[7 U5 S&35 e[9 UUUUUUUU S'9$ s snf )*Nz `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 U S:* $ )N r )xs r( (_get_pareto_front_info.. s cr' c 3 * # U H oS :* v M g7f)rI Nr ).0rJ s r( )_get_pareto_front_info.. s %D 13h s r completedzcompleted and feasiblez Your study does not have any z trials. )r6 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.c U Vs/ s H
o!" U5 PM nnU H/ n[ U[ 5 ( a M [ S[ U5 35 e [ X5 VVs/ s H u p$U[ U5 4PM snn$ s snf s snnf )NzL`targets` should return a sequence of target values. your `targets` returns )
isinstancer
ValueErrortypeziplist)trialsr* trial
target_valuesvs r( _make_trials_with_values8_get_pareto_front_info.._make_trials_with_values s 6<._infer_n_targets s+ ! "Q &)!,Q/0 0r' zNIf `targets` is specified for empty studies, `target_names` must be specified.zD`plot_pareto_front` function only supports 2 or 3 targets. you used z
targets now.z
Objective 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!.r7 zGiven `axis_order` z contains invalid index z
higher than z lower than 0.)r r r r r r r r )rY list[FrozenTrial]r* z(Callable[[FrozenTrial], Sequence[float]]returnr )ra -Sequence[tuple[FrozenTrial, Sequence[float]]]rf z
int | None) r _DEPRECATION_WARNING_TEMPLATEformatr
FutureWarningrU
get_trialsr COMPLETEallmapappend system_attrsgetr
r
directions _get_non_pareto_front_trialsr` _loggerwarning_targets_default metric_namesrangerX setmaxminr )r/ r r r r) r* msgfeasible_trialsinfeasible_trialsr rZ constraints best_trialsnon_best_trials
what_trial_targetsr] r r r rb r rw is r( r- r- sI 77>> wg ?
C '#77>>%WG ?
C 'z 5
4
OO!!5*:M:M9O!P ' "O3)+;E+BCDD &&u-!((/ ((,,-=> d22 #%D %D"D"D " "5 ) $ $U + Q" 5_FVFVWK 6T
;1 $3[9Q
7
|9MNH u F *'H J
M! M9 M
/ M 7{ M":?"U $<=N$Y! I !!89 =M%>I #L)I
_E , ,-I `
" =
2
)) 6;I6FG6Fj ,6FLGL'L \ i 'J9+UVWXX% *+
z?i ' '
|:i[ I z?+1.
s: 9 , >zlJ[ \] ] z?Y] * %j\1I#j/IZ [ (1}oQ0
z?Q %j\1I#j/IZ [
! 7$?&C !9' 7 Hs
Nc U R $ N)values)rZ s r( rv rv K s <<r' c L / nU H nX1; d M
UR U5 M U$ r )ro )rY
pareto_trialsnon_pareto_trialsrZ s r( rs rs O s0 % $ $U + r' c U=( d / n[ U VVs/ s H u pxUPM snnUUUS9n U S:X al [ R " U VV
s/ s H u pXS PM sn
nU VV
s/ s H u pXS PM sn
nU VVs/ s H u px[ U5 PM snnSUU SS9$ U S:X a [ R " U VV
s/ s H u pXS PM sn
nU VV
s/ s H u pXS PM sn
nU VV
s/ s H u pXS PM sn
nU VVs/ s H u px[ U5 PM snnSUU SS 9$ S
5 es snnf s sn
nf s sn
nf s snnf s sn
nf s sn
nf s sn
nf s snnf ) N)r4 r5 r6 r r7 markersF)rJ ytextmoder3 marker
showlegendrR )rJ r zr r r3 r r zMust not reach here) _make_markerr Scatterr Scatter3d) r r r ra r3 r5 r4 rZ _r r s r( r? r? Y sx ,1r
12 185 12 ) F A~zz6HI6Hvm$6HI6HI6Hvm$6HI9KL9KXU/%(9KL'
a ||6HI6Hvm$6HI6HI6Hvm$6HI6HI6Hvm$6HI9KL9KXU/%(9KL'
,++u7 3 JIL JIILs/ D3
D9
#D? >E:E
E 0E E c & U( a U( d [ U 5 S:X d eU( a SS0$ U( a& SSS.U Vs/ s H oDR PM snSSS 0S
.$ SSS.U Vs/ s H oDR PM snS S U( a S
OSSS.S
.$ s snf s snf )Nr colorz#ccccccg ?Grey)widthr Bluesr8 Trial)liner
colorscalecolorbarRedsz
Best Trialg?r7 ( )r8 rJ xpad)r` number)rY r r4 r5 ts r( r r s 86{a Y
!F3(./1hh/!
"F3(./1hh/ % 4S!
0 0s B B)r/ r r list[str] | Noner r r list[int] | Noner) /Callable[[FrozenTrial], Sequence[float]] | Noner* r rf 'go.Figure')r0 r rf r )NTNNN)r/ r r r r r r r r) r r* r rf r )rZ r
rf zSequence[float])rY re r re rf re )FF)r r r z
Sequence[int]r r ra rg r3 strr5 r r4 r rf z 'go.Scatter' | 'go.Scatter3d')
rY zSequence[FrozenTrial]r r r4 r r5 r rf zdict[str, Any])'
__future__r collections.abcr r typingr r optunar optuna._warningsr optuna.samplers._baser
optuna.studyr optuna.study._multi_objectiver optuna.trialr
r $optuna.visualization._plotly_importsr optuna.visualization._utilsr
is_successfulr logging
get_loggerr! rt r r1 r. r- rv rs r? r r r' r( r s " $ $
( 2 L $ # 9 7 7
..
#
#H
-z &*%)#'HL?CE( E( #E( # E(
! E( F
E( =E( E(PA/L &*%)#'HL?C
W W"W #W ! W
F W =
W Wt .? "',', ', #', F ',
',
', ', #',Z #
!
"
r'