From bdc4eaa26e5f63f9947f02970e95b4a36b00abdb Mon Sep 17 00:00:00 2001 From: Duc Trung Le Date: Fri, 20 Oct 2023 11:27:52 +0200 Subject: [PATCH] documentation: switch to pydata theme --- branding/icon/sagemaker-icon.png | Bin 0 -> 8537 bytes doc/conf.py | 33 +++++++++++------- .../deploying_tensorflow_serving.rst | 2 +- doc/requirements.txt | 4 +-- doc/v2.rst | 2 +- .../feature_processor/feature_processor.py | 8 ++--- src/sagemaker/jumpstart/estimator.py | 4 +-- 7 files changed, 30 insertions(+), 23 deletions(-) create mode 100644 branding/icon/sagemaker-icon.png diff --git a/branding/icon/sagemaker-icon.png b/branding/icon/sagemaker-icon.png new file mode 100644 index 0000000000000000000000000000000000000000..85b84cb5977c89e7e4bb42e49625b4cc4971ab97 GIT binary patch literal 8537 zcmb7IRZ|=ctYvX1?(Po7b%8}boW)&=yD#qUE`{PwX>oUVcXuf6S{!cg{RcNQCwWM6 z9+F9Bk|sC zg4N3q-uI4P)1%h_^;QWM9IET<1kYKtO$;ybucWRU&Nhst z=Ij$({x_z(EAl*`g~8(S)?+7Y&h?3m_t!qj zoFTZzrP@V~j0fpzQ9O_A{jtJR6611ZZ$GL&tNi_Ul|g6jA9*4m=9#;Uj%mFVru*f! z#@g$y0O|c|Ss%y4!GrqiM9!7##E{ziA@&fIr-;U&XgGWn<2{F)W9RCcys`50+{Tb* z-0CoE`tuBnI$`_8Y|d@LW+G6f+a5{L5fEs8yc(x!nOkttBuyY#^P_J4&#BOTbkd*K zA?{Q0SM<*_-_k?-fk787R?V}O`XP6tP92ym27%=*%ipa7zCkbT0o67VWAzoDJ50;I ztQU93eH1qr6Qg9|7s96%pi5%j`DC?jP2cX$yaO+N)U&6Hao{NINQX~cNySM@s-DpX zfls9Q!B%ok!>tf~-LXc(bn}L{9AT{1w?7R={mrXmZh}{h?GITUlX`!u?j~$6mKvxW zFFO}D<+%uq>Uwla?W2>3oC)aI7_6J-H~Iavnm|kWqD!}#v*;lR+StNHj)J6%)|T!n zYd=5FhH{0vYjK0Lbvj!K@fjLPUZY*Akq`FAm#Q!LO|=mr0({)W2Tc2h+ z*W|JynuwVPOQjpwFZ7oS&up9g#n+mfiCIYh>O39*T5HyITV@gQ)R;%7E5j?jghkPs zYZ}M6tW#K(ee8Qmn-ofPs6#s745=LR`}Ie09b!1KQl(C2B`<~MPvhS)T8{Z=mD)DTl! zO8c|bETGG6bv32sqqyc0knl5*{sFEG?@n)T6wHF%jgL|0a~Ol!I{tEURJ9B5n5DtL zsd6zHl3`UTO^3ehW*QQ2Q#@WR1(x~UV@${ocRPZ4nmXmA45w`8lL~pvbfEwmLmmE_ zdQws9Himk4rb^ben69oq(Olc0+W7_c^+T3%0kh8X&e8`T>`QV%Py>|)xo8|I$ z@}m&#iuMc~A*e2<5#Lgod1vZzdJ*eJ7~$8T0Ng$f?)9 z1jnjnct^ZwIr5%l7K_xJ#(HJq8umC1i>Gbbq3^2DuDuwd`bGJx8sA;IcGg5LslA!= z6kLnS$_37sfyW>T@sfkfqWJiAAVp(L%|JQr_9!0H$kihW%<3YSf!8zAZUsE`L@gRz zRR}_Or7HXe9aIQyfw^W++5Kx~%e{;I<5{k9p5ri(1iK_{#xXAym596(#=%LTw1Rt0Z$1g|Td@I9q+t}iP#Q;~6y-`4Hae87I?D}bQ=*?YV`M2(Ohi- zBt2zc#GC=#Lt=FcPUkZ4Ao3X);TG`^J5wRQ&;^X2wl@~+%e=R%BrXAd`dW* z5^uw@mJA%u%OrrSPUPZ*0gdx1$M#Doi9>Jx9p(|b)!vozTe`fn zs%21hnX#;@i>Bfcew|ru@AL|x?@-@r(c1)!*;KYVqt$Ol(sLc?k*Dp&NChFXKoN8# zMmvGjx>~Oblm~@|zL~%^wo*{` z_%I1$7b^uhOA6=5xJ=QKr*qoXKyn+JOwjqfl%n&X89s#>){y70AvnVg4a|%7VR_F`)bTyW~p*vT% z)J4+JG+b0ply8nh)R(7;I3Iv6Rg}6$r$gJQ z*V`-Z6q=xsq`%MXdRX~C79McyFT+l1bXww&{T@PRc#B!CTKxU))wTtq`m{FOQ??Z1 zecHqt)KdtapBW)17`f7#LQe?_s6@;4Bt_w}Ap>6c7NRfIlyL%mA8Q@77bW#^-f&svdi0 zUv?Td225PQF5lYq{Aipj%W8)k%5WI@=Bh9i&Ic)=?`=&-LNMI!CvdFAnymG)lszF7 z)<FDQ(meAFBf7t%z~aQE5Os20WL{q zT7#9TaZOU*c@y+oEHmC{cqgQ&<&3mi=cKC}#W0Ge7hk{#mkR8V_&R--{X|j~ z7=f`6hgr%y^XE1?Mr!RRzFF9RF*-aciCh`K0 zB}I$Dp;CdjyVjgH5%YSN{yU1+r>q#to;3>3;&b-EOpcZs&?UTsl9sg-7A)x0!Vr>(EXtezOa$)GY@sPyjn+Z#$<#=(SEXmXB}hMN%TyaPF&r@faO0MezR zL?|+bO%0P>W1dw7pJ%g^;`Vdb@M!-)V9(qcNV%$;_LTG$FzBj9vl$>g2=#->1hP?e zGV_*UiJ2W)IyY0B$OglQX_Agwl`6;2egw_mjaS9r26~%eLbLE5DggG$SFOtB)Zbbte$EP!kY zPb&bt6wQcP*fk&ymWt1nRwUNLEO@j8Dgh_Z{rdp{GmFnQvTN}eB6N@FZ8D_$<{ z8mHUmIze5ui0&I4W`!|5L`Cg8U=cR1%8;N8KZC6sY~-S~?KaZeJ>#@=9)vacAI`zz zerg;)VSSu(f_jv+4fjE5s))3ir+?ubReVxyA%GxLG7=qklGjCS`0b82hjj-OTl%21 zI@)8Ve9xCs6$Lb~>kdSS3bB)JhhXsAR>@Pay{-?8LZkEfI+znp>=n;N6l^DKdIwhO z8adU#bp#2bM9OKQo@lnA>Et&G3%ha{As3Ko=#1IWKY<{bQ zDesm!WZT7fG{ux&bC4=sm9e+-z$McNpod{DQ1cBHk*|f@!Je}<#X&ytJ*HjLk1o$BIq+i^J+?Bew$G!ulXyJm69UII zTqOZJduGQC5b!Eng+yy;0Kyaj(kK+Rrt>E27%ku|5nP@jn*fVXB8o@B*H8^Q^v0Ap z+~1=lmw>H-6Y+9Nr{a8xiaBv7uA|seg{=j5B!{s>b7N7Nd)zO+rD~Afk{*4)ITBd{ zdz?bC*}ZwM?GxVjs`xY&tslZ6Y)UI+2VH|F5n%$=XDbnK+a^)pMq& z%`|VUBThY&4Lotd7LDHytY?Tv3H&L^M2)rg4=XVL3^W`U*Q$ZigAMMmwhmRVIbmra zy3%rmz&}i)MjKm{O?EnJIF&*MAd^8Gv-942$!r`cZcb8%Q!q@@AhD8=EeJSMAWrNs zD}eeIS9+i6v2U4XiPSubXLLwtiA^--GK$+mmJ#!*2uzF zyXl*w7`x4%K${AZXoM1(E<>~|9FCETb7RorBCbK$Vr!Zq>=;VUed?$5PBlV^FkfVf zQK06y2HUfa>14ycG}mi#LU>PwP~@XjzR2kk7)JVfv$E3UMUq5O6${HuQNpqbQ^GYx ziM0%^y3&D&ccVv5ZkwYQ-Kg@I4N&k`_A_{Y>wDGoV2$7SmK1p)@|es9fiMP%0PEIgrRmLP1dS2}kMJFSTUeesVqF4c`LS`Lie2Eh1^*nGV@ zCI1`SnXno?T(N*sFz549Y=6)pFM!R9|N3A!|4nA0XLSv)ZkSKxWuH4J4+^Ov5RP;i z=_`Ec`S0%g3F@nYZf9h@0pE5XV8A^j~HboBC+b3vObu z9I$b{8*QpJLCVZI)UV|WBl-es3L!IU>EDe&nIrP-Fdy(b`Roc2$78bW47?QPg!Mf_ zlYdvzh;d;Q7Vt@vg-X_O(+NkKqG5D2kH#@wy~@bxB|zCyq40fNm_stn#g08~v-NKQ9Oy^L5aST|N{JL-ujSUH<9wCa@)XJw zsm$Nero@Uwk4v>J`=k|lp?)}|j-ih~gsA^WM&|!VY7lU(#q#+|e!J!MvCQ%Q(0!Tk ziSXNLWU;<1{u}^zNr%xZYP4iXBiIl4>=t6@bl=tYZXjLxf_+9(kIwSE)!zPUs0&T% z8l|Pv`|qIz>mn|zj`&Y}5zQi@pwOgbCB)P{voCTCt@M^jhr8=c-9G*cp^cs-3Ugmm z-@vPI^TaqR8Km{9Eja60S6lDVJ~4_-YMu)&D5;5H|67NJ_lxUqjh8F)imCnY(c>D_ zI|i(?LxmmM`*7phk)huBbX7f{rxOaDrPfD}s;SN+gGXNq^dz$!<`bWQBM<+h$JZQK zqK-S~_aq5Y7o;5ls8ZwS!dg9qt#W#Hj}x0cJSZBdot&%1J7M7`>8s&h6$Vpmr~EQS(!cl|Hpc0Y)Zx1af@j%&gFQwC|=FRFL=AhqjZL z*ErR~aV8 zGPrB8B=B9{)$&TC!%*=1&sr(xk0E3e-7hiPQ6aWV0!|f?yAF5?HQy-PQs6f)^TivF9XR!qCVVx z!! z>()Ur_1ysub&^8{y`+(-{{|~yda45^JZ{x1WCY7W5Zy3CM$zxwsr+`<%T?0Y%1c6iA?wspC7^0c0A%Rg!8=d)QH& zu+EE_qb?_%>BbW(=e<;%Fz zOm_>mKpr)kr@%Zt95WiZD|Uk#EdzaK2yO(r&EoYCu!Vd}`$8M?L^0v3oU#|$_#e?B z>4qF6$z9J}{_tPPwzEXv13z;|0S}}n`B8EFVLR3`o9gW-Pkj`cHF!xsz28N$3*~i7CDh14qdBR}zU|g7HN^tb;&ZO3yR?`=?)B9{6>22->)$gJNH!`-=f|-Y$tWCoh@_!+E0dOx$?XLvy=yMC5?Qk2Lb3UlLgGpn` zSg~52Coj;~qgR4g#NXxb9q%~;1e0HJjozEN;g1}Wql%i*J)e+v&X-T*`Ha2LE>m!S zYnY%TJ2X+ne^I@-rdQq+OQ~84@{i_{0t80oL@iPqiv-Y$?9fd(yFxCZ*mZ$f8nl<&2}_O>|$Ww&xEjhx3}j@})|kgG=g9p(>H&vFz;Zc;$hD zy=%y!uZEP1w896X3`=&dz8HUx3j1<733>*MQ3&f^cL?8;ip1Q9yk zdsc(PgMhaS^p4sw4oB-vIkURyaatw@v_2Xi`(uUf%N)EKt(zuJMGoNCELS6;2-j}$ zC8`mxm-^uL0~>`eR*u^1V=vH^b-)Ymn5sZ}B-1_Rll~Jtkr74jBOW^zzO2?3j^v_) z`v|T5#V6)F?yV8i$>Fh2)#@$$8&Z`$BdYX6NvqvEP4&LbYzyaC+_A!2EF?Ywt8Vd| z_(p$Q*H}oz1fq6n@3K_ z+zOtHW6{9rRIlfVF-27deG6TL`Fk?|7e@u(;rADCOo&g#>L%y)>~!$zDCz(u?%hwV z)XwAXTF!ulX@bd{J6?^sTlG0yg(lDaT-H_ZDtiprCS6RVHa*(M4-ymnx|Rj-;Q{O7 z80`mX%4m5Gb+g`Kw>%lP++JBcAX zXaAro)a|bx10>!);+CP~R7jw2rB&gbH<&+UlG_X2_^Fcbue{Z+%PiAe<<$JcRe8rG z{o?g=?~!Qrw4*V%bjF1VxYlv+sOs<79XkX?=h%n&> zu%942_0W)qxnS=D^N{6&yNO_@qjD6t>GaSxTXZ%*$S+SBJJB8Ae=W4R%i9gqb~!B^?KJp-(YUox#WqHB=H3*sYB7fonHGJ`=w(q9 zd*9JWvkFt=YIp^k8GQqifmg5!`vZ^x#rsdwY! zS*sZPLb8sAEA4Vcmy|dmSyIf&&@!BX1Rk^pVj@Mjx}<8-1N{&jwmC9V%8D|-xviZY zS|w71n($PLMoc0Qu$#w!RVY40(7OP;4lW3 z(swL*2-N8f3}KEYU)x`yU{+VO%$4Z>c05kTqcY1_W#Lr5WtL(2KoDCFkWET<8XvZi z`O*jNXUOptWBH-3XlePVJFyK8(z25$TOfr4lo%q#h;hqhJwwvon#eiPrAn$>R?PIO zBzVFEj*j+GtePZvjQ<}9L%Ay$hSDaV|6K@r1RI9YdjGTDr$`gMy6EF7?q^675BhDH zEpDEXrN(e3lINEC|OBGi7IiU;Qs-URB}N8 literal 0 HcmV?d00001 diff --git a/doc/conf.py b/doc/conf.py index d1ce73cb90..09a2f4eeb2 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -52,20 +52,32 @@ # for source files. exclude_trees = ["_build"] -pygments_style = "default" +highlight_language = "python3" +pygments_style = "sphinx" autoclass_content = "both" autodoc_default_flags = ["show-inheritance", "members", "undoc-members"] autodoc_member_order = "bysource" -html_theme = "sphinx_rtd_theme" +html_theme = "pydata_sphinx_theme" + +html_logo = "../branding/icon/sagemaker-icon.png" +html_favicon = "../branding/icon/sagemaker-icon.png" html_theme_options = { "collapse_navigation": True, - "sticky_navigation": True, "navigation_depth": 6, - "includehidden": True, - "titles_only": False, + "icon_links": [ + { + "name": "GitHub", + "url": "https://github.com/aws/sagemaker-python-sdk", + "icon": "fa-brands fa-square-github", + "type": "fontawesome", + } + ], + "logo": { + "text": "Amazon Sagemaker SDK", + }, } @@ -83,16 +95,11 @@ html_css_files = [ "https://cdn.datatables.net/1.10.23/css/jquery.dataTables.min.css", + "_static/theme_overrides.css", + "_static/pagination.css", + "_static/search_accessories.css", ] -html_context = { - "css_files": [ - "_static/theme_overrides.css", - "_static/pagination.css", - "_static/search_accessories.css", - ] -} - # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = {"http://docs.python.org/": None} diff --git a/doc/frameworks/tensorflow/deploying_tensorflow_serving.rst b/doc/frameworks/tensorflow/deploying_tensorflow_serving.rst index 1d7344fbbb..82d2bb7f64 100644 --- a/doc/frameworks/tensorflow/deploying_tensorflow_serving.rst +++ b/doc/frameworks/tensorflow/deploying_tensorflow_serving.rst @@ -515,7 +515,7 @@ either, so you can simplify the layout at the same time: You should now have a directory structure like this: -:: +.. code-block:: text └── multi ├── model1 diff --git a/doc/requirements.txt b/doc/requirements.txt index 365a7c1272..4e48d25034 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,5 +1,5 @@ -sphinx==3.1.2 -sphinx-rtd-theme==0.5.0 +sphinx==5.1.1 +pydata-sphinx-theme==0.14.1 docutils==0.15.2 packaging==20.9 jinja2<3.1 diff --git a/doc/v2.rst b/doc/v2.rst index 0677594b31..6c93169015 100644 --- a/doc/v2.rst +++ b/doc/v2.rst @@ -414,7 +414,7 @@ Usage Currently, the tool supports only converting one file at a time: -.. code:: +.. code:: bash $ sagemaker-upgrade-v2 --in-file input.py --out-file output.py $ sagemaker-upgrade-v2 --in-file input.ipynb --out-file output.ipynb diff --git a/src/sagemaker/feature_store/feature_processor/feature_processor.py b/src/sagemaker/feature_store/feature_processor/feature_processor.py index e957dbd0ea..912c041199 100644 --- a/src/sagemaker/feature_store/feature_processor/feature_processor.py +++ b/src/sagemaker/feature_store/feature_processor/feature_processor.py @@ -11,7 +11,7 @@ # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. """Feature Processor decorator for feature transformation functions.""" -from __future__ import absolute_import +from __future__ import absolute_import, annotations from typing import Any, Callable, Dict, List, Optional, Sequence, Union @@ -33,7 +33,7 @@ def feature_processor( inputs: Sequence[ - Union[FeatureGroupDataSource, CSVDataSource, ParquetDataSource, BaseDataSource] + FeatureGroupDataSource | CSVDataSource | ParquetDataSource | BaseDataSource ], output: str, target_stores: Optional[List[str]] = None, @@ -79,8 +79,8 @@ def transform(input_feature_group, input_csv): return ... Args: - inputs (Sequence[Union[FeatureGroupDataSource, CSVDataSource, ParquetDataSource, - BaseDataSource]]): A list of data sources. + inputs (Sequence[FeatureGroupDataSource | CSVDataSource | ParquetDataSource + | BaseDataSource]): A list of data sources. output (str): A Feature Group ARN to write results of this function to. target_stores (Optional[list[str]], optional): A list containing at least one of 'OnlineStore' or 'OfflineStore'. If unspecified, data will be ingested to the enabled diff --git a/src/sagemaker/jumpstart/estimator.py b/src/sagemaker/jumpstart/estimator.py index 36a188ed55..f595610e7e 100644 --- a/src/sagemaker/jumpstart/estimator.py +++ b/src/sagemaker/jumpstart/estimator.py @@ -251,8 +251,8 @@ def __init__( (Default: None). model_channel_name (Optional[Union[str, PipelineVariable]]): Name of the channel where 'model_uri' will be downloaded. (Default: None). - metric_definitions (Optional[Union[list[dict[str, str], list[dict[str, - PipelineVariable]]]]): A list of dictionaries that defines the metric(s) + metric_definitions (Optional[Union[list[dict[str, str], list[dict[str,PipelineVariable]]]]): + A list of dictionaries that defines the metric(s) used to evaluate the training jobs. Each dictionary contains two keys: 'Name' for the name of the metric, and 'Regex' for the regular expression used to extract the metric from the logs. This should be defined only for jobs that