From 900dd2a4910a04e4b9d6ebada0a4edaa77b4f1ee Mon Sep 17 00:00:00 2001 From: c-bata Date: Wed, 15 Feb 2023 22:45:15 +0900 Subject: [PATCH] Add API references --- .gitignore | 4 +- README.md | 2 +- docs/_static/css/custom.css | 173 +++++++++++++++++++++++++++++++++++ docs/_static/favicon.ico | Bin 0 -> 17470 bytes docs/_static/optuna-logo.png | Bin 0 -> 16019 bytes docs/api.rst | 40 ++++++++ docs/conf.py | 35 +++++-- docs/index.rst | 16 +++- docs/installation.rst | 17 ++++ requirements.txt | 4 + 10 files changed, 277 insertions(+), 14 deletions(-) create mode 100644 docs/_static/css/custom.css create mode 100644 docs/_static/favicon.ico create mode 100644 docs/_static/optuna-logo.png create mode 100644 docs/api.rst create mode 100644 docs/installation.rst diff --git a/.gitignore b/.gitignore index 7990289f..eaa61537 100644 --- a/.gitignore +++ b/.gitignore @@ -14,5 +14,5 @@ tmp/ *.sqlite3 *.db -_build/ - +docs/_build/ +docs/_generated/ diff --git a/README.md b/README.md index f252e289..60bd5ce8 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ You can install optuna-dashboard via [PyPI](https://pypi.org/project/optuna-dash $ pip install optuna-dashboard ``` -Also you can install following optional dependencies to make optuna-dashboard faster. +Also, you can install following optional dependencies to make optuna-dashboard faster. ```console $ pip install optuna-fast-fanova gunicorn diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css new file mode 100644 index 00000000..42bc2d90 --- /dev/null +++ b/docs/_static/css/custom.css @@ -0,0 +1,173 @@ +/* Parameter names and colons after them in a signature */ +em.sig-param > span:nth-child(1), +em.sig-param > span:nth-child(2) { + color: #555555; +} + +/* Type hints and default values in a signature */ +em.sig-param > span:not(:nth-child(1)):not(:nth-child(2)) { + color: #2980b9; +} + +/* Internal links in a signature */ +.rst-content dl.class > dt a.reference.internal, +.rst-content dl.method > dt a.reference.internal, +.rst-content dl.function > dt a.reference.internal { + color: #2980b9; +} + +/* External links in a signature */ +.rst-content dl.class > dt a.reference.external, +.rst-content dl.method > dt a.reference.external, +.rst-content dl.function > dt a.reference.external { + color: #2980b9; +} + +/* Containers for a signature */ +.rst-content dl.class > dt, +.rst-content dl.function > dt { + background-color: #f0f0f0; +} + +/* Containers for methods, properties, parameters, and returns */ +.rst-content dl:not(.docutils) dl dt { + border-left: solid 3px #6ab0de; +} + +/* Main content */ +.wy-nav-content { + max-width: 1200px; +} + +/* Sidebar header (and topbar for mobile) */ +.wy-side-nav-search, +.wy-nav-top { + background: #f1f3f4; +} +.wy-side-nav-search div.version { + color: #404040; +} + +.wy-nav-top a { + color: #404040; +} + +.wy-nav-top i { + color: #404040; +} + +/* Sidebar */ +.wy-nav-side { + background: #f1f3f4; +} + +/* A tag */ +.wy-menu-vertical a { + color: #707070; +} + +a { + color: #2ba9cd; +} + +.wy-menu-vertical a:active { + background-color: #2ba9cd; + cursor: pointer; + color: #f1f3f4; +} + +.highlight { + background: #f1f3f4; +} + +.navbar { + background: #ffffff; +} + +@media only screen and (max-width: 896px) { + .navbar { + height: 0; + } +} + +.navbar-nav { + background: #ffffff; + list-style: none; + display: flex; + flex-direction: row; + align-items: center; + justify-content: flex-end; + padding: 20px; + max-width: 1200px; + margin-left: 300px; +} + +.ml-auto { + margin-left: auto !important; +} + +.header_link { + margin: 15px 2px; + font-size: 16px; + font-weight: 600; + cursor: pointer; + padding: 0.5rem 0.8rem 0.5rem 0.5rem; + color: #636a73; +} + +.navbar-nav a:focus, +a:hover { + color: #2ba9cd; + text-decoration: none; +} + +.navbar-nav a:visited { + color: #636a73; + text-decoration: none; +} + +.wy-alert.wy-alert-info .wy-alert-title, +.rst-content .note .wy-alert-title, +.rst-content .wy-alert-info.attention .wy-alert-title, +.rst-content .wy-alert-info.caution .wy-alert-title, +.rst-content .wy-alert-info.danger .wy-alert-title, +.rst-content .wy-alert-info.error .wy-alert-title, +.rst-content .wy-alert-info.hint .wy-alert-title, +.rst-content .wy-alert-info.important .wy-alert-title, +.rst-content .wy-alert-info.tip .wy-alert-title, +.rst-content .wy-alert-info.warning .wy-alert-title, +.rst-content .seealso .wy-alert-title, +.rst-content .wy-alert-info.admonition-todo .wy-alert-title, +.rst-content .wy-alert-info.admonition .wy-alert-title, +.wy-alert.wy-alert-info .rst-content .admonition-title, +.rst-content .wy-alert.wy-alert-info .admonition-title, +.rst-content .note .admonition-title, +.rst-content .wy-alert-info.attention .admonition-title, +.rst-content .wy-alert-info.caution .admonition-title, +.rst-content .wy-alert-info.danger .admonition-title, +.rst-content .wy-alert-info.error .admonition-title, +.rst-content .wy-alert-info.hint .admonition-title, +.rst-content .wy-alert-info.important .admonition-title, +.rst-content .wy-alert-info.tip .admonition-title, +.rst-content .wy-alert-info.warning .admonition-title, +.rst-content .seealso .admonition-title, +.rst-content .wy-alert-info.admonition-todo .admonition-title, +.rst-content .wy-alert-info.admonition .admonition-title { + background: #2ba9cd; +} + +.wy-alert, +.rst-content .note, +.rst-content .attention, +.rst-content .caution, +.rst-content .danger, +.rst-content .error, +.rst-content .hint, +.rst-content .important, +.rst-content .tip, +.rst-content .warning, +.rst-content .seealso, +.rst-content .admonition-todo, +.rst-content .admonition { + background: #f1f3f4; +} \ No newline at end of file diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..1e78869f4915ec4e15d03e2d64cf456464a696ff GIT binary patch literal 17470 zcmeHucU)9w+UOBMF`8(MEfy3D*n6*75gQ5u(wp?YhwEc79 zGSksEri74jzozfMvMoIVGp_$d>ma1ZtR*LAy0-Yrg2tj)t6JK{s2bK6u| zQvuc&;t6p`BQ9_&|352)P~%iiPUBTh{~cz4#k4*ve2x6FtA`-MHmf3FXBEeHeRr9s z^^;PsRe#|4togRg-SS(G&xUWxyjK1v$9whTa=(ptDuQ>5g%L-t$`c(=YVxBjehw~e zLzyC;fByVm@td}>F@0)r9a|C{pfB zk+QQCDRqQvq~!EOQN(0IX#ID_$Icmosu- z>O>6}J5hrp?Xdk22gX30RJgxJ%Dh&6FNm~NsZ#xqvh!k%GG^@WfA;;@`E-KobEKDC zlR19d{)^`}oss?0u8+kK&u77pf}l;` zR|Ks4S`f7Ud!FxtpSa%hiO_crk@!v}VsC)ijUw2;#2LnMqV$MMKH#F`}?r&4k zKBIV`VK4sKJb~l0at-B_^upOtj_;<=_yBjQ14RlQsKF9vvp(221HvrveTh`~EhWN` z%}*r}d#Yry2d`CLbM~mCJ#1=IT-IrM>8o4IQkQ8vrBC+R-&3OwX8TuO^NlR? z+R(=ZS}Z(`{5q*0=$zSaq3?Vm2-*BrO|qNkyLEzTY@dHb{cc_Ew7SdyM`_HVh6+C` z1`og!!*KnCvXt*>K}6BVWTFB$a6SUlLOLex}{@Ua--m1$-5^Ap5rpsd&WvH$k$gH}0 z>{3ngaesBD$5GAAz~zs1swppmp(!`|fF$N%v(O*pfIGt%$P)&ng^CcHcUpM#QtUTk zcfDwcU-XQH{rU4plSNS{8!KGQNWm#;xah3;V6l_Q0O~6N@VDZked&XC(Q6}vjtit1 zdyo0qqv6cZ-1I+PebqKk9>29)8fE>pG-45{jDDR|MZZd_qo=?%aio5QsG?^PS>!?@ zjkNww9>483%1Z|d)!9A{IL^-(U6<+WDhS^AG0IAy!6B5l6~G(ZfE~{obEDT|`@a{u0dfiH6(#&*uEP2$s?B#dEB-q zHE-Cbzp2cyV&}lRM{{$ABJrd^60nq%F>=A=M;_E*PkmW;-H3xgqy0U$+h4pNE9(T2 z$LlN3O-9%Uikv17p)MBy%?ZPHJVv>V1C8D94o9~E(n4669Kr1rveQWIxFl#vWxhDE_tzbJ?@ zC;(4YI9|-A?`r7N8SgalXO0D;Ce1&z;`|y$4gnqf$ORjN8?fsS?II(-SXv(2=SBBp zb*LoHF^6~VWs-l2G88#YVPF?|nG$K-v7Y;C?riK&Q`7{kAGh$PSHE%MmNaUmzB0m; z2m@hnVSlS)ClYzA1*uG2_oOCikGMYlSd1pe^<;ao&lW8we7Pp;q(!GNaaBu!*Vcwx zPN(Y9?c%E6*dtM0+592kWVkM23QPurKuq1 z2tRQBw-q1<5C_N$yr8}B{_aiLtJvn3=tg?Prc);QxtF^yA^9iKmYFn4^U_$`o-g0I z$KsxmZ;d%YM-}lqpH@eiGjPM68ERrpi86lq54EYsrOmfIk3H$iewkh8FR8zJteVnX z=wnltek@OQdGlv=iStOMktX_Je7ziL3izU$K63+YZg$M(;)`2^VY|NKft>_=`lA4B zZc&VV75jed{<6>5n#GTnn`+7N+5A;8%K5Vs2ax8`1{H?x{HUiU_jR^C*3~JFNz#aA zL;?H?>*`fRP(a^HNL}hNNqb4i+OchE@Do(@stHX6b`$Z!d-QSfQqj}|0lmmvKvU*F z*If@Ai{~`vcqA}*NH8TRH^ialy}|&L4>O4B%CUwgUFuQ%A`bWg>%Qe84jia{zQ8S6BPmm3UbHsJ;=!?8l2_0sE{vIl#8$ zoF(!+?7jIQ+E{!a3sRfv>x*l^0=OD4i`l5Ej(nL20zhU5QTn=sS4k~>SofYLXP&VY zMIp?1vA>zVpX$tYg6Q?F#U8Frw`>y|bBs9w5hJk4o6KSXW-QQ&fRGhJ7D|eIKZarAW;i2de-t zjQ+#5_HY7my`#2JmpEo~Q@%sCCVTHYw=>rDHD_6q*6Ws}?fL@dYK2;xy@+TstVw;w z+CMg2-&@~S=IzDWb2zV#_A$pA%Ueo%wK8$-$0|lPP8>iSR7ZmSaOIfT*uwZ-_oO`lToxWb*eq$kN$(l*jsk2Fa+5$se z+Twxwv?Y4xN?!u^3kT~`=8=ZFV^2`nK%Z9xY%5szGPtY< z)#=s@PU@0p3^iw%6Qq@Nyop|5LzqC)8uy#Po$lu9&(RuJYBi8n{ zmR;G5@3GV*dwL3dElHt0WvKA9B#KLJ{`g!qCPvqIGi+gr$I35D&cNO~j_*bN!4KT@ z!JD#7MtAC@^n6LghR>uR>x4m*`fxr)!sG1bkQn z9+nQ>&R8)Bv@uXiPa|#F(@De4!@v8mRj>@_<8U^avA%f24fiXx3A15OV9x?g29#(! zCLV0Vc5D$v*tByo&Vn@HzwJKm558l0UmADHo8vN*=VW~`Vw&i*+LK+~YZkD7f+0PE2kHqgNUf^CK&)F2^UN6SyxPB|YXefzUjBT_f z7dMH+*7OR2?uCKodO672%1hh-^Zj-?V*|2s>HT)@Y)$roC)x~<3CXkdux^7oec^Ct z!A8aT zUy8KvK=ldSO^77w@TkmJUa~7xhCod6JoqMoXxqIEGTI>>J44KORKGReI;Lqw*y&lw zzeDwD7NnyPXqx9+0rQW_?jE3B#{N-(ejK?TLygbqF|pLQ>u4KovHhp*d20y34|K3( zxR#zi*am#noM)ej^Mj4R&@qf}QgwCDoodjD!eBFo1|*@2N&R)7W7rOh;?imV3eVRG z@_4DoiqEvAG^R!T{sT z#9H;Xltrw=zD*HJ8T@LC+(NXOi%Ct=1Vde_CBVLLs6BrZ>Exd;!FE^>MxBl}1sOT2 zdzlww{-JDptfD8dy#3)_*|OGB$B$cYEj8jG&C*a$Q=~q1b^kq4%vS6QeifthZ)ZFC zSH;gW(m(*!uL>OpewGc79lo(BZXwri?K2MAMCUAs?1~#qLs7ECv-V}@=An;gz!+n> z&+vem__N)FeGpG*6XX4Tb^6-o z0^9GJuP+51vcymae9)RX4dmfbDZXcM)uo{4f=qs<0AEuWG@%b=wK#I)r}yP~44-0K zQTTop+VUJHh{Xr(&BJHHu!CV-mse5t>CsLS1n;=Zu2qq6h@%KLBOp@@0LO%}L=I zs*mqB4q~b{rP!AA^q5H^Hg(Ctm*oeHGxC1iEK-+#DiGg8VfIs#xu>xy)fD)C2JZbp zdyW-pEjim{Y{KmQsGZTJ4CnQzoJp71jcG4iD@#WuVub}A7CQo|sx z1}a0Rk*X`FFJK!iD%xvznTKU>Ily1)zWf>LeSY|XLY_0kwoaq3^eT}ioM75(`BxT* z!q$E+0h>Y)V2U;-QO1IOmE~~UI2!DwDs5g}%9>|J+JAkpK6QbiGk*hVukc~)CbS9I zc*@(gm%JY;ok&~xq2V^}u|6ID80@`Mf2Yv(k9P#8NNc&Rp|$)l>8U(J?kR!<>>R9& z*YSPB+wwL8{0l(8%mZC8k!Z5^%CH@4!#3r3?vq7Z3}cK5e3O2(1>|x2E7-AgTzWp& zckSnB;}@Mj z?ub49$2*N#dmnf6rgv9HUh5P%kT$N}P#fp);KNE6@}TY#W2dq3-&b8)*?4Q`_YIi~ zVXg)JO{wF+KG^aQbE-H#mUe#3VtJhPHyCFV1e)|KKp#pXH#QsJQq-s5e^mr-eTe&C z;tV!Z>?x0O|Bc1C{}|undMzYXNiK~4diz%Fc46?UpG3e%DEkq9S=4j_YRQHjuPNv7 zk(#7Ar0$Igq&{T<&_B>*?hf*%B=jh@84G_0|5WQ+l9RCiNBi%~?a5tv@I`hUtnbOs zOS+}_{#b9f^EroY zM&M^)xGVFQA&<9}+x6a;pCVm~K%)&&OfmjQw<^lNTXqKVGpOSqB^`X1=Z|z;#@55J z5Esn_$Gci@SR$?UH>N@S_zLw=6HSf6|417@S&^{h1B{&_{HOz@v3uV~eS>3Q;rXpn zl!KqcaWW^oK$|o{=%I_;bJLhOAJ2O!sZBf2?0-G&v{Deb=v#*V15F0O?lsiLPX&MP zNThKjfUhEab8WI!uaW-e8S2w42XzJONjt|m8{1$`oTY(>YTBV&?hJf>*wDeVgZ*{= z=H1royV$YbRD{;PB{@Obc*pbzf2Y9tix2N{M&nHYziD&+(FfWaix~QENEr_}U;X5X z`p>boN7@^cmGR3S8{s$YmjV2esBOO)yZ>B2ODV!%4l*C|)P>TxGv4Lr<{j?~Q|_@}x&Y&!|sX`LrQ<9O(Wzu>Xq<+MCNr zOQGEdEY4Anu`q)Cm;F|ChO`2YcU0IRjNjaq`0(yXyjyhw*n95L;a0BQPY)F*$Q`L4 z<5#nBqj#DLW;W*R{k$p50^pwq{7(^0=3cagM|tF)Dr2TRZq;XKqYDDYGyE@(*x1I- zk2TkCO(m0WcY+-C`OQVLMCZLlE*4D8r@{l|U;HsW|W?8XYH+QPJ0P>5%r(tkUC@Wa69;NcZDI0o>YMyLx?fnf;j0?hE+cRJ#Y_Y zpx_AUmL7-uqevG+ZJ-k$$d8jwk=vi%ZO+_+>s96KVC=hl;&9uB>syFAZ65j;{o0Hv z;0qin#x|_{Zz~R6A&*)1J;sRz0pt3WD6?XAim?q_DuQ>lF@B)aBqEHkE3Cg2y8wOP zqSKgjHYbwk!;D>o?G=efaumUn82d*UWHyAk3Pr5ta7)SgQ611$>g{|R;ubYYAdgZl zhS2Y6xoL$o@WrFMTuU5h#NHpZ1G=l@!#jm;k30Adq)T!dZ~zzZz7BN29kJJg9!=VA z>^Gu28C#&O)J4{jvjTa45at?cNLxtS3SAjlgfTK^o*bW(ikO8=92#sky)xt_@Pllw z;5#hOx>b|7e(T=Bd^N`j^2(uy(vW^Qz8gEyCPKOpgzkYjn$iAHXZW2G1+n(;cmu?I zKn6^JHP{szM>N_dw=;G;KzgiAnFn#4#Y`NdqhJHbGG~zCUofAa$xzQA1%qev#6YUyr?i{|IJ{Nf2qOUQ9BDXWQ zfBd^QOPKgX!AQHhHm(K|mf+CU}%zlni~abH;Rg-&{5R5srgL>|+m ztsu2YXqQ@o-@6Rfw|ua(a1&`SbG-Yct70y@2J{645EEv9zo^y;Y|QBqU+_U~hE+@c zk;8apjGd#3c0W?; zwrIEz;=3izbBQ?q6r-mqG4AWSjNtQf$R$_P9*hjcepOdbzo877LipeVh=NRqfd>q= z2`_=|af0zdZANVGmICLSZP{~34Q-BbJ&*&|V4tlV>@3_ceA@Q@_-_%*cu3m~skd~Q*n@`}rL9OG$|^c6V6@;i(H@Xn1V;;18R zKkB|Td%ie)!A=*6>5_vEpT|IuFb8r$bZ^@G}L>)OlRiyL$H47J=qzi+XjF2zEB8+^?A zv<><@qUasiZ)|*Bo#Dun_X|}JTdnX%Jzx&`7o#q$O*x=t$H$sHe?GY- z-%-YJ-uqJEupa$Z(y5fzbqvQa}#*e{9P_*+rlXQIlpe}jb`F5Ub zXgk;SI>d_FoAUPe>I&C`ep|$h0rsxG0eL=s9qHhPy5d}DTd?w^gP*WbabaU0%6(y= zSufhXvbcR<8yn+4*j{}rVgsBN`3Z9POdOCGu!mVYoBL?Uk6&Htx%zv=4c~JHq< zu^$#fJ~dZfIQTZ|6Ob)>QOE?ufua85Y@)ewj>a~uKa6%hMMNyiUmc?j}Df3_>CuGwfX{)e$I+kj5Qmu! zVg6o~xC~@busgOXu>12FfOc-sSv50d7Y;SzdY~}25yra8eb;=BZ~^?J*u`Q%NxL(=kBwLx70+t| z4fJ9xOyDt@NaIhI;d`4A8CRd>?WKrVLWCd-#Gw-h#i8R3ib%AHR_mMdoNci!(gC}+ zPkK~STZ`QzgFMjdkQ18E zM2rUv@qDdFT~>e{zNbg%NS)z%RTZ@e zZ6d&d`Jg1+Y!J^YC=;#v+DgMl^#*IVVP7!PUv4Y&acI1Cq^u!(=Wo=R>%Uf~uO4d5 zT0t5xUX%$j|MXSE>Wp>YX|i{}*PMHl+g9f3z}nC_2JZO?%`@w4&G$Yik6rQu`g+2k zm-+<0K=r&lPs$$?A7Vv^N6yl=c69({{f+`VmIXOnX zjO|gMu{I3;#)3XL*bB=#%YFB?7CD`1$X@NxT4aBwqtx?&P7wZooO?q3j&QSj9>>rY z1h^{`*7VB(c96%tn3JlGUJh|-uZ#G8EL`FkI}OJ53LH%Pih%YxKAZmQ-bfywg&F%` zVf$65g*$S+tT7j8;JZW4J@SAS<(jdTQC6t4d}3vh)o2YMO!opl%If*pLQ z?k#2Nl9Bd|ea@lhzJxNHefHOCj2q%LwhwvsY?3JJQgOV>lhd*X@YZszfp0Q>nK&S} zXL-IhBj5zb%W4SezQDn}uLNXTx&Mx*>{+s(?>##g@)_O(E+z;gZSUe)Q^<++3m_K` z=k7RcJD?TDhP^9JwNzcPt*?w;L@Htb!9E0;FuoV%qWaPtQk}HxQ+4L4YdT*1YPRn$ ztGqNwR5B!MO(}*BeAJXFsYUCW3Fb^`nN|h(jaejbqQC=>#`yc;`3&fU>T@ zVTwNQ1laZNa1JfmkI_@~2p|97*1_5Y-Kx@gyuh6wV_q0>An~6M{_)8gJQs(3b9NYW z4|sn&+s9Lpu=9hesA&uyfF}%KBlM$etV^6qR2SF&P($x;tIs%|)OhRciI(!PRd0#o zXQ7VxpP#-v4bOPqhdgU*q333G)+vv=WZM$em7O1|;5-eUbwHm6Vw$81a4d;fIarl+ zvH;Ir;oNvmgdTyZg_FEr5O&}P^ydm3%=AF_gFINjFzTcP+hSq!p2lA<{?Fo|Q<$|1 zas^*v%nZ%~^@_YE5K*K}4}1O%dYg<~6z0;Zla7Zd5_UYQjD}bu$V5B`hCYJ~WEIBd zYZ9h|4?TZanXuy9%0#QD)z@}^P@8h%!^(>r9>ZC<&lRyt|D=qWO{!xjFy~yv7{dfQ zS3&Gm61j3fk+56VoEN%Z;vM zZGPk?c0OQ4GraIO>hj8KZs|PV<;+=h*!RKwGp71d;CYVkmaoA6VR(<-Q+AABQqv=F zwU^UY6+ye-7r2ebGyZ+}{el?yK^k*dtI0L`BO~J>J&YF2OQ|zl9Dpuzl!?3A6mjc6 zl15p5BaK|#Ck~xzkc7<{7KhFnmV`|oglE0*?vL`gO^<<>G?kYR(Dj*ahsK`o0=Z*K zkJutONn=jTW^u%RoydC@DT2K&beuGZxvWy~z=f-pJ2($9?nFL|@ZXMTmS-;S8BJ&*;$RaqSXx;~VK8*Cv z@mNm8aSj|dHbTDuf4_GApSK^e8yLCZF(+%*fHV(&durJJC#8mehcCa z`BcBTkUw4dohWQ;H+=9fIf$d*DEC?S1t0K$_BNcmG=94TxG2Z-vuHp0fIjql zg^2tCCw_|v&&NW~^`7yk3O|bvEOX?erPiDod=%9!t-muXK*Ib zv>*1o5B*cjVRBvPfPCNaxirz`;#VW*+7LF@hWmTr{A>LQoTH@2&=`K#DULZ6#|zrs z!-4aLs4MWy4SpvAXR_g&5s($m@Esg{=Z4>}u;0M3HS!Ph%@?#q*;?#04!)-v-;du` zfqY})HWe=8NvW$PoaNj7TS>fA?7f;l=ZG*505tgz;q|`;``Gs*v^Fa1QU8PQv0oH< zW{BJQdOs*L4Od zc3U!3=Dq$gd`ntXndE7UbFgc$fj#(twdd@dFQ_3VWn)T@#FE(e*^k7dtG-538<>@pj8nHqpS23ajxqij{*zbW~NQ;=K)I#2=HYI4CJpRNEuvNE1 zOnQ4o(3%}JDFIvX{86_mhq3KnFfWV`=PHcnS6?{(3;O&^9%1eheGObI>S6k4wDAiU gWy18eu`$K5Q1<@9e*bRvZw&k!1OLXrU&O%w1~mtyr~m)} literal 0 HcmV?d00001 diff --git a/docs/_static/optuna-logo.png b/docs/_static/optuna-logo.png new file mode 100644 index 0000000000000000000000000000000000000000..752d6c8074256118b4459f611fb0acb89318458f GIT binary patch literal 16019 zcmXY22RK~K*Wc(Oh!Ua`5kwFX!RkcsqC~Xl5#27U*XS&w_tkrg=q-sFb@eDq^j&2o zEUWuA|M%Nxp4oHHJ#&6%&dj|tbLUL7j+Qd{UBpLJlWqCmDI5P?-4baihSHv-EYild3t1GLjD*yZ8i2vxS zs*1|W|I%xp%5t1cWo21e*?&?LR+&T=Svbjxsw!$H*kjiM9RH4ST1iRCe@t8s(D@9| zO8l49<8k>vj_zk%e#bcdAFUFL%WRk#5tUdX=OVzHWPnQCf7$?c`Txq|gzfT)-HQLw{{sc+eFm6i{il`? z$5;M`4tSr9?@;isY-J_DBm-cW3b4%i$5)L5=qKX}0zMW{cvn#SRLZ8bJdbI_x66MK z^96T_`$;A>i>30Z z#5v?u{MY+Fl{jsQj zp#Qb6O)kJD4`2@iXe9hoh;ud00IM8;ZQegm{%g26&X8JwT^>L;31FRza|L%;-M_YY zm+{YU_W1zwEL>YK1yuiYyG0gPXdO#X4Sz%fuF3c#8+bp}Gx%3O4X+o9Ze$OtVGF8x z=vO5e)qtxAM{q53U^S(8CC;%lzLhvT0eZ=FepLYbyl3I{v^YXP1y_Z8kP4h10O|=Z zVj6M%2j_WWNV#%myS4nRIWej>nLRFf3k8tDx z@wP`Ani=sLO-Y*}V6U+J6WS z?<9xloQJCmfy}1?{nmlsyNQfD{ee*}01rl;@E|8hiymSpT~c|ixTDiH_kS3|#FonK)gEhlE@heszT zTI*GE9>)LxJ3#fdoWA$sK`ycP1A~iO!C3w1a?;12J}Z%ggcDGQ%04OxXZ1~gq(Vhl z{8Up;HwMO2ZPxcA6k!Iz`V`&?#f#R9JHK-We|Q%!lvd$c)YXp0g`i*f*os*?q+c4>$d4%@K|E z6Hpe3Q{f>9J92~-4k-#0m@kCTgsEXKp{u$ggH2R;6EvcJy} zu=J@nk`#}yxUjt+)W9p#oxNa7`?3Kcy|~6a2zG(%<%+EsGz>^fN<1GcwdQzNcW4IXRd|Unh6Vc7_L$ zI0v&ryustxtNPZAzgiBWS)Qy__S(c%6nLqe+eQY%6)f~;H(T^a7SFEe@0^)_Tq2ws z)3upi!ZnS8GP z5)Wztzn~tcwZ`hws?6-`c8bSc@h!i--M|fEu41Ku0m2c%`^@xAnOV;-8UkaV@AbtR zy){xefja*VBMuqXDj)-oR!rn+vv?sAU3Y=NCsQD9N1fMdi)W)gBwpXc2g`-4x+$^W zI7<|2$O)eEHKBOkg7O0S1hx|=_C$R(s6xWH9ci|kelxabHxzB#W7DDAY(@R-5!gj^)5v_54|?21|F z&TT*FAgGfPUN{$4b{(c)hVbe{rZAJ(RJEhl#MhX84wyOzC3zk{`si^~KO4{ z8yZ9MmqRiCwAo9`^uwFvL--{H-a4K$~(z{)^ zI=zn^(V>?DB7M+cM|`}6;>5hAzwMy)=AHNBEu}vG@6PHkS+h&-++>yt%4}RvUz-tk zE7X1Znb+u(l$|2WqCy<9Z=g@D-Xh%6Rn9Zn>oym)!q6zq85MNC#jO+&?OxW&W^#sv z*=Uyryd<0XUK%D#!Q(-)meYE0K9o}j1!F(eZ^ju*kgk9Ft4&Vrz+KH|BKGuqfVJb2 zW)ApgsX`8}i<U)^zM;xNY*Ht|r7BuJEF%7d!Sj%A6y+Lu)dXS^3i{&3-jEE$g4oJLy_{x1RvRabH1H3mycwXHQ`YG7wy(FI$uy9;DfbMK zPVzY{)J%x1NMhIF6<7XyZa(Z|L{=C|L-c$!skc^qZzj%BV<%IsjK$l<)qKh2r6xeIJSA4S8bzz6_dS8Rh02Mh~?UMMb=W(Ry{e>$l(kZtz7K zcUI{mN_!uR-!GqG?8qfR#vRx2ZqMad-EfI)$9b^)wGg?spIs(pz}6Tqn@q2Z2n*Y} z`W;76bOZxqXA{_RMHa3CnsV*sfyFCw>^(DHB8##v;+g#x}9z^Grq*!uR z7pHpC*z8U*>m}wK zYfFEeDyO+**BXi*mvEXR!1Jj~d^~p^LxX;D>JNAC6ZcwDt4DC--s6c(@xhE9$ySU#W$w2}p8PuY zuL5pwga$Z^PM+sxVIH=6vnQs1gve6Dk3oY>h|_RF!e^56MIiEH$lR}EqKG=6{4#{G zoSv3hgmPx7!6(VzlWcz%fak*mJEQ^HwllJ7i@kH(f2iJ@N|G}{(Q+WQtc-vt0gqO& z*cYs#=AJ7{-%s#EI(6S_r@1TV*fYlbDoUW~$?Z6xJ-)ryd~9|v=*_*E3as?-nVl$n zRKhVEMRHjkD!cN5T?E3$s;(7cds z4P{TXFJYD?x_;`pJbN?!n_`f3CsbhkZ` zwgAU0fK-mCtM9HSf4|&&72hT2nH6Sp?9d?QT817 z>_I3rOBGK~*^ZP2a-lj7O9g`5t;#widkXIDcWsO_FqR%_3%jrMQ=3rFOv$mgFml+f zFJ|`b5VrPQPixEUQ>+WT~m^#FVIx={!lzo3|0FV-XBHW;egzoHA7>O z-te)WV+pmkfm6yX3RcOe+t?eZyM1-g?e|z$9|hn?zd_hxeu>v#o8f54uQo!0FNQN5 zbOlT-So6#N*UXJORnOww^T+zqI3=J|$`@3zH~8P7#)IV+<`ObPW;y2as%1~E>lg1y zq}@xjj>Zz&odC%ilh;Od7yNwa z8q{nfHDOq{T;K(db=W4ro0sqCeBx17>s+A9P|S| zJdn{gZEU|%JGot7BQ=N^o+vk%Pow;O^KSU^!y1aArZ`r=Yrt6xK`y81idr7>zHM?n zG18u3_KT`}H}W${xwQ zV`;+86Hjw@CD(VNEsQKsf!eG0b|Ee_Cep#a5f-Q?loKCHnQv2sMc+?fNIjD|QPNyq z4N|X{>xq$q_-s4w%OuI|KqV;PLD!y8V^#sJfgJf8{;AvgKNdZ<_3GufopVpaR_!UY zhjf!`y@ulFHQMu_Aa6i_7sR{0*R|(+$n?r@d@DqiVdM9-mx5f#rt1Jo(TcjwpR%i_ z%0BX*CelamA}lHz6JYb;O}?Izvdg+!ldxK4q}~$&r@6qa=wv)_V^Ta#&wQuX=GWU` zDK9+n^-FHu49GC>=y%imYstH_LET?Rt$r=nBU)XRL{X76qna0Yc9>RfeLF<4-i_^B zcY%7xH-Pp7n4d4VEx;FHXYP;TKWy^#wODW4AnD5f97XfOJqMI5o%!=kkMj1_-gH?I zEW=u%w&0q4Dk$mCYPVcHO)peeCV+_hw@8t+=NE(B+-z_s^x#jjyHaxP{8a8SqH5;& zRG`QDop@MnSNI8_9RXX_9f!$GEi4`S922N+a;$9S32TS)*vX9bp;DV-O9Sdg1ZY~! zzFh@nxD%Wio26j$%gyF>m5VL1KHOZ6^^afLr)6SQNWp{t*itF~)(Pb_QKYeP6C)n- zG!(s72_(OelJ>vQ9D9Rq-w{ZidqnplOaO?cxhDv>eY$QMJ1&k}j)b1^8h`S#nkU`G zLyc&fyzS^L5e4HL2fU_Uum<2+c)5$d?k&OfAl zAAcE?PJY2-11AHALB)f9=$x8g2$N1U;0B)C1WT>oH@T|sa|@tx!112}*j%Lx{b`qu z{&0DrfF31Z;`6_>KZ_+A+jjZ8S5POzEST!*0YG~V%)W_72JU#~edis6xh3p(oBEO< z7xSx!nAo0f>tB(!3lr(lOM!oWf2W}ZX|*X~T?={kA9{|3DJ!vb;NH!LLET`7FR8~` zYEFF+nd;GSO?u)Vz$xMBVXR4)`FWUmj32A4D8GdPuOK`!?ZQO*u_|_XmCoenMqVFL zZYsQDqx-Fo?;np`kkxpSh4(DHW%WQ=knfsvIjLg0LhpYBp&M}~5EN8f;#^$>1{`fPCpgf}a*PSOJ z314!LPi_$VoFi=D7RZxev@o)Xjh7yNyK6L|=ZF$1C94n<`kCtQ-2>-SAio$<+i}d_ z2`aS}85V!FGxQ$xrrTv0B)mDhBL~s;_2*P%;rdOOebW`LnUKv19%F|;NX~0j$dIuN z3aJUn7xf!EB9_`?1t65*jS*>N$d*e_^2!*&$yeDeJ?Jr7HYDsd@|QcC)9i$aXX5eK$J1 z1JQlm!4`Bt>$w_@g{sbLTpSPFH69w_vPua&`%`q(OL>>iWS?THY?jv%^pP8Bd~yfO zBnO#RJ$#6)>A3Wva+#TzBH&KC&%%K5!LyL#qui?yqbrz5GMSPuHE+L?+P)(069+Bv zZr4d~o{N$MgtQ;VVU8`yH5x9L-I7QvU3<}KixT&!jx5!;X9Nq_pCk3wm z{?7LG`86MNscUo0lsi95*viQ7j$=HNn3|kbCkMFS%Ma#NswWp?hpm%G$$?S;S=Yk} zh7sqJci+NRI;-XK?JVJbU)kE%^Zc?`OdyK!<8;_^a|(@_4qJ~ttz_e6*ffb5en7VW z4ZWb*4^l|{FjBZKyn+w0rxa2uY`Sz* z7cB9Y$E?$^GDEP}OEuA8b88zi)p*wmixZ`M=R~F^r0Il4(@gSAh0(}<>-I_2m9bn4 zCNT#OaYf{G+x~0abnB+FRJrE;3PkUeW4-P0*U9@RD>xzC{gXhi=wCe0G9|0cU-7N0 z2l;^s^}P0~a@Pc!U7X1`otE|eZe1IQ>K}7PBvUlbgou|L3oG@%ytB@8b*CBNt|H<* z<+uD}%&vn6`|4yr^J&0UTb2AQcnBxUkN6v6(9*HxKIo*_j+Q*;uimiPpJj(n(k8wO zTJ!>IcY&&X0hjz6rpJr84|AeEgh@9tbfp`km*KV%McYSU<~wF9`%Ss`i_4aLHV_}T z)3cr|T!1YCAB<0>1Xp>Fa==}WE~=KE)yb1j;c>jCw|mLO zW+;X2?2Og(k=XPZgB8U|X!mi9Cy57rPgu33Zbn66rbm5xtjbHV0*}>AplhX>y^)ma zd=m@Qua@SUGQ_mvp9xs@61^fEx(P$y{fIU#1;|1=OlLXZj^3*vjbx$xd;5&mjuYYJfJ*38Ic61acyeli)$abM~wOn(WO9cKYISGRUQC>oaRR*W%of^aI zec?Pvy1m-TQUNjQmB9NdkD@YGE6TvY=`TcxzOW8_*_H>GrIGs>hk@aelY8)+h_LLn z{?dcz$YOr2U%#Fm)UWXO>bZlsj>S_SV(KPfaT1z+4yXP_w-O~Xk-1o!ug*k@D92fa z0g@7M4kTR?<04OA9q)iG?H1n-4@?J$V|wXUua%>S^_6$&2r;KRKC- zUZOjax-&oYs_6OIeZC-QuWDG6sw0Lw6LuN*zQ9K$a#n7*lw*CTpK}%$tsrk;F04hh zs)!d^J9+6XYRsaOTf>B=3fx32w(Ip9-3>2uIznGrCEswO6MA7x8W+p*bHWNo=qYq% zgM3Fv{7Dm|^sA0pP_g*9DBQK`K%Y+_7(Jj3BEnpBkBOImOv_jOX=ea-kc-`J8{uf* zZd>KHU9W{Rw%fqx+xV&wQmC$U*1+E(#H@j+E>*fgDU8MEgv;+Q{syugWLjRMr(l_I zVo!M45@dDuc=AEd>Ypu(Qy9}K<}RQM41-`F4f=L)!dBOo)^`l;R>=;&P`bkhdGjs< zd0+SZQWiqWj1aMiqqR-){0G!0{GaWHU^R?`n71}`)^js4^r`qyI>@Ik3x2v2V8F!5 z=oa6h-0~K)gq~C>BtNq%t-c*xLiE^l&4UP&MwjaDD$_kK_If@UeKFibvfq|38F-b^ zO>I_L!{1R@ww@t(d)*TBHb)%O)f40dKS|fn>Dg<_SD7EpJbuiAbuD3qk~!rgVHWCi zY?_ZbA5kIyS~epf$y+w%Goc|`Bh=oD?IH^ z$L>q6WH2+u)QPz8{8S%t_=*^lgx!qb3{hSld^!4cMgpvb2<}YOrKH1>plYZrE9xC( z5YTCvUGTR~-Xdqk?iD(VwQwWgLBi&>GJ*ZrgA~xbqobI7i%Os7#r&XQ`;BaQwCe5Y z?M=c3I$hHr@}*vJV&LS3Y6n}rXGdDZnEwH|%4P8LXT8uH6=wj#9G=b8_+@W|0Ne}l z;%5`op`1bHjkSF6F_d|c94hb$`FW??kYrLjakio?P}n(&%tUHnbl{6b|*KFsw}k97Ld+0&$ULx`(Ne6Ps_US`@voJ?!cDFd=0F5i}K38X7a;i zw)XCFc?P&UFAMa_&0ntTm@Hc^3iMuB^iS3$-?DQ6pB8TDGrvH-(GWfey8XqEoX^*F zzIgl@dKpq<`Q{k?Gu$Kbrnq$te<3X1W@8aZ)IRv7mE+*t2+*}2w(@P0sk0(7VSo;P zyY8IdVbEXl>Rs%(hr7h5633tOBuH@Uz489&#%1nDa6!HbvBtQ|xCANW#Ytpp89^N< zN~|-2JfzlXYKHhAZQR6;g01^Wd|9B0MFk`3A(Hj5Z~$ni`QPJ zZoEq3t6dOR>)M~<6_4$2D88gwC*$w&*!q0$qT)@$Wv}?7YjMzOu7F{e+m;qrSWn5P z=Fvn?e!WF0{R}42=BsDG;2V1amZl#~f8Y_c<*>*nwvFEttvsD`e$hu7eciN;QhLCE zQU7W}M431x2}v$_rX93Tjtnx&!S1N6u<#r9!({5522Kgg=j9vSvvxS1)p!#29|GWa z!1l7ri2D(JP6pUXcUUlMDt~Zo9d=h%R%ZBOJ>`Bty=s&TbwQ+bk=`{H_rwpVwCmaU zso$FtG;4KJT!?k9{p^*#>&T?DnA?ZsO=SWPwJ(taU7lO41-5-W1`q}~HP;s_iiT8$ z?=n6ua)iZ#=0s`W3u<8ILhToMXf8rjq&w{`2LCCNl4q5Y?WT_pRc^aY$;BiZBKkcG z++lA8$A&11dT9cXB?P%TRj(A9z}ZA(v~cS$;o^Fdnk+ZP`bx?$SE`*Bgeu5=r)S#$ z<2le@kxV=8b8*YyR{kuY1?0h$rHn)&kk zN=vp&ik5_3dnIhz4qHA4;k?T82d&araY!ewc{;65}Y4@7xgldiqr_5P|$-G$$vO6sAr`+K~qY63E zal8XcSUNQ(iLT-V2pm_y8Iy;HY**B7E!B=FhQ-b{oj(NsEMx+?3%31To^@J&ETS|| zhLT~D8x(4PfMnu9Mt(__=MzTOFlULIRmj<&pPbAI-!UQNLH>P&q?&{EOb<#S1-(fo zSKY9`Ps(PiJ51ohwD5i#(_c?0+5?!ljb!16qFQ2(zwzMeq`uaCiC=E4Jh$)(F^{P* zZyn(~pWcROnL;+S96j6*xKKiEBB$-^^Bu3A)^>c3%Z9b0A0Z1UJ>b)PLP$OhB?d!c zxH=h-ZNT<}()x&j2>}n1MG?OAZV+h_N-orHGdUa1Tg&d_vy1Pte6e@b63lm|z{Sv_ z5$NBH*Z%7{&EHoElj-{J;I6`m`75G--IB6NqxRUbp-@BCRc}ks1(UKy1eY5$#x~d) zL-fr3#NQ6L?`<`O(ZTrWuB{ucN~;|@YMqL1Fvb)>w;3u}fMdzE})&jq1$YKrfkW+HS9wCPDRE$T9|Gop;n^ zKf9EEreeX@_Kq9(G=2*S*Eu|<)6%Ku!Yba+ZRuSz9I$1?*EdgVxTHKC5d%$G#-@AQ z0{?6$n>QP)wMRJSF_Wsm&tDic3D>@EM*7+_Gd=b^b*D7OCdh2pfFd%5W8@%GHx`R{ zBeLmO8_FP~J7&xFLQ2G4WBIJ$e0_RZK@sE+5}{s#yX~eYd9p;g{2$jkQW^XZEm2LC zu$|jh`4(%dF7&|BqRh-zx$Ex$^U&2dK{uZ-M&s{+o68l=OM(6^U&2w%hw1CjhkWNrW!nkW7LaJ!iv5s-YG|KXHuZJ~o zBR-N`Mr1V3kMSVy8HK-LsRDFT_7?NTGPCm6bYA%&k_ynyd0m(K5G-`%@Ie~C(;+yN zRWP(xG``M|SesVO&@=O;H=c9G)w^=#RfK%y2HJP+8KOG;US4Z)+T{Fx+I*1=ui?!L zNW%&8^kn3ULDuzOm!$Ny|J(4Obj0A2SO9tPi6LN5MA|YU;WM?wh8u?&1D7rHiGPbx z4%3c-lZ_wuG^w!BtE$;1d54sp5iULefbspmSb!Ndp}-(F;$|c<#X{T3Vm<)lhg(g` zrVlDHJkcS@e9piFD~pB63^{Lz^}4C>a?EW}Hm5$dDEsIX59(SY+!>gyq0BA0e3oZ- z{lY_F{N&Sf!qeg@K^jGQFu?^L0Fh*uIehPeWhyKJtuUiK4V0D3&*Rq!8CxTh2jR$Gs}_q>*^C5DIMOi#amw#uL>dXWdb19i3s7> zgl43{Gh>V{SK02^V%a+Zs;>~=EOGn$9Ug@z7g^mQ_!V_yDdVG&1Ap1CtAFZ4Hr!Nf z^^1Rk@}w0NFl=w90^0n){pJMYM_PkxFCU7d#$UOq+<~8yq$mTxCbC9q^mWKiF(Tos7QrYT(awTDEE^3=6c@qz`r>L-MCa&XUr4mNM+_h2Z&$l44%pOf|k8 z92L@25llICm3^}zz#}16P4>z!cCG?zZ(@L8@SnF^++w1`a#*bVxm^JTtjj62b$I);C5i$+<5)47&)7a5HVkKCTXnqEj z9IzB-ql^xK9D6}DYTGVvMjszrpaQJm+Q@?!F*~eSw98lL7nQY1&dL3giPl&TIDHBq zvIdVBvn^K}L);z$OJdD~1FN3NrVq$Is-WR{S!+V{1j$Pa&Whh4GeF%S2NRCJ`h5ZK zu2p{yjMzblzUv%OrFbvALC8QviFc$_6Py`y! zdF1<}B}xL4|Jw1_z3rOlSoJ$QyfEi?m85m@{B6dT*IyxKxzn_xu&MB*p6G3}m*&06 zOY~xhta4jxv)2lQpFi!X@o;^Nd%$_{N^wk;e5eaxX!^9Eu7hF2jtx1mI{iGP(6j3s zfmAUkU$KQEY>!V`f;p`nq3$)2I)Omlb%fYU3Eu`BxQHH})G|Y#z{aAExDUKeyy@r9Eu1FWd{LqNR9_ibeG=;y(KfCh

H3e_@`$}DiFUmZh_^?0=0ZC3I6%;LKEeYalEH}d1x$Cg<@=PuP zY@-={2lJpNyYgc1VlD_IE-)x38rtzg)M&MLn=UZag)W4=h8;FI#ox< zy1#ZzJ_V`?T+}}i2okp#WQH&oEfJAho%U6 zI+8S_V~dCQz>T2eAz#vN0*mAMIwo5)8r_2{BtJxY->)`*4~qXBhM^8SWNl8<|Mh{t zOTSp=dX0Cxm5j)&qM!q487A<|EO}`i;!_%==-JETaWO=D zmoQAm)$JSBCKVEF1?tn+YheBT0Gr(X?1e)#45Q~;xJ27#&1_-RoG*KV_Y>@OWjdy z>n6?PZ8~QM*;Yt%P9OJ``BW{rrS*vr+D7a=Z3v+v59W*c(jjdq^c z%UT?6`H{bd_dofC8xTCK`oPQwpt4t2?prAmZtu$%GJqojmuC;N)&|L9$q_VRUyYXHfnlT>d}OynnT z>ZEoKa36RTK}$_%Ic`uB+o+8j|JDjQ?rb5diLS6SV788XeDw#054SaDtNV{uT;6ga zW-y-5TDNgfFS`3;Ug*XoiZ9!}(iN0&VKo zxQM4mB`BudR*kZ$oVBmLtM5*XozOj34#m^gu->z3zW7BdkOf3Jy9k`R6$d9&=Qz+eYHVKU4EMmyID+8 zExqI+81uH=a3uh3Hj|w)8^8rE-r4yNn-(iq6ImPyI<$H-yE0F$L}C>mEWKx<>@;tia?m0OFVlQbm`5CSMzyN>OF8Wk=LQk z#w$=$r@+K~9RQXr@U}}_tGvGLvrmfF<@+sulX75mv2f9N^~GV&?afjo(`x=vYbozx zPoUzG%JjwC=I}@D7ds;{3rAFl~8|I+=4{we=#^pH0dm z&QNio9hpbts{Xk5yInGk&1OCJkb@*q*y@x>-YqWRmvEu5U zN{lr0Vu#6ccXzA^b3QZl48QkF@br6Ng9!_(GHqv0veq(Wy~nyr%b338TIbudXS^rDrSUz<>)6vG*Y59H5=V=?+h1#6 zt=ghmkHeAN*gD$dbB9l$Wqz8&-yc$Mx=k{YaO*4DkNd~O=CcM`FedI>B6j2fM(=_` zL=AGXDEJyR>L7(~Q$!p6IMdrA5o`a!vKLk8XxEu=hm)h9P9j`r)i zI-U`*6O>vb;jQ^ArH?JUn-C!r<>=T4Vq4oJznMpG4f)s-And2Ah*Fu5+cZ3QWSC!0 z?jAXIQ=o8Lj_|)Q& zUC>RTL;3|{*oFW_ntS}ngk_`cX+N=qZ)A(h=7`z+wI_YBxmr9X`q=kXK7t-T){}xq z29|uJr!lx?b9W+ZR1-Kp=rDe%5j!8`$p310D1f{C&79CddpB32^{~jODi}KDcC2a9 z^d=A8nk<05vtF1vw9MSa=klqy#k==ZI>o274S<=l-}FCoao&Hb4cFw>A$W+KTsTsq z5I4``x& z9W)tLvNIF1ZJ#4mIiRbXoO>w>r!Ca~c2w36==a{#dJrPS-aY>#3n__pt}p-5%=4OJ z8aMHA7FLch&V2+v#-{5QYw6ss!AKP{&G+@?-)3r(V`PG0dB!3c|zJfT-_9*#?_W=vd;Brdm3^rpz+icI8E~HnVh@*LExKFy3EC+Mv z=9r=IOxB9E0{C24pd+!CiGv)Z?LrhA?4z!HnsNL9!-U6%srT-#*=40J*-^Ty9miCE zTh3Y;pCA}Uw^)9%@W41n5Zt4be$H|`RO4CIRH@sgn!GFWuBo*L^^$(b zm~gfe6+zeXA>aFiQNg69)jr_CnTr2xloKyoStiERVQ)?7V@BZPy5z|8{TJ@%#EfH6 zr*-3w-`*4iQ4i0%pf_v3b5Lxpd8PYv0MUAcQfJ0`?>LD9NKIegA4--_7DF02q;$&_ z){AhjJIzAb{CN(9Cel zy@$oK@8B7an6JJ-b-(lQ13%lsH9Q=ID$?72+^^KX@44EAmQuSBZZG~FNJu+oLS#IF zEkF;75(f2aEaSEM|BJ&Ldj&k)*iu*&(C>uAV-~!yMV>y7v>SFlFmEO|Ov!Cf?R0)k zqoqivBskJL=%Z%hlG2oZY{k`rDh4T$&9vYm5;Z^B-Upe#JrYlt5b=|i-S!99Znh47 z>&FE#8n(MkIb`HzSM9%jh~eSP#S9gsn65Zo8pfaGB`Z(6JzIrdpQaw&-}wa6dqTks zxj#g#XvcT$o~624Iaj9qW=dBo_sQz9}vYet%e#C9e^vQho%L;2# zxMv_);jtoGP9$ta$I9QY=fNe$o!(LjE+;-QKjGV8&IaWkPaY-x-0|p-yFB%B zTaaa6oiUskEciEXjJ;&IFjWF&*Cy5CHs^yT{2E(U8_zFBmpyb}?)bJ}BPWHP?)2O6 zlX)&*{xHA~@qd8+BqfV={yyGeH{HQVq0Y))0F7^txJb*qc?tgn&AjC6HGR30ah%#f zcbWr4>lovQTN7fqIT+tFC1Cy<(s$9{7TeXdXGS-1Ls^hx zC6IX>x-s~m1@Yib$_NlQ(_SH}eMqvIP#B>??opiOVl{16EB9G<{tB}D&9S;}7>Vc) z_{IwK`TI#U=mF1Q#)gfA=uSfAxLlUq#EFO_;|~6sZ;0#-FJld3Lm%87pxjG}GF<9zkg?Y`K(ULACXCdo-s=ATzvD91_2sGyR(R zUN#`)%1{DPY@H3I@o1aK>R(A}EZ5yB2T`*22L4@7GXU9Z4`uk|mu3nJKN$^J-+}~k z#aR!D3@1&PpAin`v>kNav!F6F829_JsDFPbh(ECxtakBengO?~%}k?v%UlFK0G6<9 zK)(+JO;QcwMp`nFVZ~9AmVh+N$7W|lA;&C>5cp{^Nvl3CGJR$~F;QXVa*lR7%#RXw zBcYU=>4}JLx$pI>VFVg4PKk?AU`zZcrhX)u1WIvZ!|N@Qh3Vnq^HtjIrYA}=*;f2Y z;@Sr;=);*$IbZz2a6k0e{1Wt?=Qhqd@4ckrqF|-eDn)J`4(P!$jYwD3tFBh>&i=o> z!22`0@1XTsmV;kubZNS?A3-(5K?_ortjkR*o6N*WUbj?P*wj-=^XO?+beFe6PCred zFF)7@9b7iZNX$+=+nM%_dIz2L*v*ldh{2jYYETOtkdc zu}&U2=A9z5y9@=SEMC+z4U`FQ|BZB9Yx!1@EDBoj=MACZT^f+^hi3ZV+KkhmfF1V4 zgI6qq#s*FoZSHdu(JWu}>{(2_;v@+3{$BIinu31yY^JdBA>m74GoP8=!a`6RaK|qg zbbm-G9MjkPi0hE0Y%|X@9nC8JVNQ$a(w^2Uq5~>snIjA3ky+swD>N+41Tp53`H1~y zCitTH9o4A_#SX2dm?m9v{dVtSW2y&n_g<@8t#~G}HQ>J-C6=69dU~Y2@_N~;8A^C` zz@B*hE|kXOi{>Eul1N)*Ux2jB&ONQcb7ztFd7#slHEAz@_WDNqjo#yuwNv(SiRN%J z+&Pa*LOs!Elrx}-2l2;}HjgC5IW{I!$sk!O3jVT@<_^8<%aT$bbg0~ye7vFbut5bG z+}V>BrT2#{$$vW zlKL@;O^;rL+Y}d83cK8bCOn8_Cy7>Vt1f1OyHp>`N```T}t)0*RcaWLYmF74q_@TVY1^D@hgvU0p%ZO zL~gsvtGX!s&yYThTdk#O>O$NIH#TSONbyAW#N?O*ReVpO%kdgtyGmznHP#cdL1w>$ zcJastUG~I{-BMhQM0d|0^BH~p@RfztzYjJ`0HVu@-R|V9HpCCfF{5WbHcVNokZHt0U zYAkEz^jj&mBCWTAS?S`^{9JSK&Xh4KS`X(vCk01SXws!bEq>%=9J|Q)ke^zPLNY<@FC-OV4d-qo9}wFSTP)U{ZBnr_3(*@(uc zn_Wkir_e-s{o5X^WSCj8)G9#o#u!TFp(d{O{rd}%`#kSynUl4~+TYKU?nimCKtKm2 zxOb`NumnY1cmf^4T^>bp4QicqkaCo+U!d!A~2PBj>CmLeF<#fw9Wk%_+WC}Ej?+K>xz~ILnXYmMgjNCsMQ^`_. .. toctree:: - :maxdepth: 2 + :maxdepth: 3 :caption: Contents: + installation + api +Links +===== + +* `Github `_ +* `PyPI `_ + Indices and tables ================== diff --git a/docs/installation.rst b/docs/installation.rst new file mode 100644 index 00000000..c8fb2ac1 --- /dev/null +++ b/docs/installation.rst @@ -0,0 +1,17 @@ +Installation +============ + +Optuna Dashboard supports Python 3.7 or newer. + +We recommend to install Optuna via pip: +You can install optuna-dashboard via `PyPI `_ or `Anaconda Cloud `_. + +.. code-block:: console + + $ pip install optuna-dashboard + +Also, you can install following optional dependencies to make optuna-dashboard faster. + +.. code-block:: console + + $ pip install optuna-fast-fanova gunicorn diff --git a/requirements.txt b/requirements.txt index 57ecdd36..25c37877 100644 --- a/requirements.txt +++ b/requirements.txt @@ -17,3 +17,7 @@ moto[s3] # visual regression tests pyppeteer + +# docs +sphinx +sphinx_rtd_theme