From b897bddf38083ae363f5b7e09654a5380939fd10 Mon Sep 17 00:00:00 2001 From: Sam Wu Date: Mon, 24 Apr 2023 11:25:31 -0600 Subject: [PATCH] Linkcheck and prepare alpha (#2078) --- .readthedocs.yaml | 9 ++- docs/.sphinx/_toc.yml.in | 6 -- docs/.sphinx/requirements.txt | 6 +- docs/conf.py | 31 ++++++++ .../framework_compatibility/with_pytorch.png | Bin 0 -> 10724 bytes .../with_tensorflow.png | Bin 0 -> 13757 bytes docs/deploy.md | 2 +- docs/deploy/build_source.md | 1 - docs/deploy/spack.md | 1 - docs/how_to/docker_gpu_isolation.md | 5 -- .../how_to/pytorch_install/pytorch_install.md | 2 +- docs/how_to/system_debugging.md | 67 +++++++++++++++++- docs/reference/all.md | 6 +- .../framework_compatibility.md | 39 ++++++++-- docs/reference/gpu_libraries/fft.md | 9 ++- docs/reference/gpu_libraries/rand.md | 8 +-- .../kernel_userspace_comp.md | 1 - docs/reference/management_tools.md | 6 +- docs/reference/rocmcc/rocmcc.md | 2 +- docs/release.md | 1 - docs/release/compatibility.md | 4 ++ docs/release/docker_support_matrix.md | 32 ++++----- docs/release/licensing.md | 8 +-- docs/under_construction.md | 5 ++ docs/understand/compiler_disambiguation.md | 14 +++- docs/understand/installing_linux.md | 2 - mdlrc-style.rb | 6 +- 27 files changed, 205 insertions(+), 68 deletions(-) create mode 100644 docs/data/framework_compatibility/with_pytorch.png create mode 100644 docs/data/framework_compatibility/with_tensorflow.png delete mode 100644 docs/deploy/build_source.md delete mode 100644 docs/deploy/spack.md delete mode 100644 docs/how_to/docker_gpu_isolation.md delete mode 100644 docs/reference/kernel_userspace_compatibility/kernel_userspace_comp.md delete mode 100644 docs/release.md create mode 100644 docs/under_construction.md diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 43a0890c9..641e7513f 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -9,6 +9,13 @@ sphinx: formats: [htmlzip] python: - version: "3.8" install: - requirements: docs/.sphinx/requirements.txt + +build: + os: "ubuntu-20.04" + tools: + python: "3.8" + jobs: + pre_build: + - python -m sphinx -b linkcheck docs/ _build/linkcheck diff --git a/docs/.sphinx/_toc.yml.in b/docs/.sphinx/_toc.yml.in index 3042a46ec..0a9b7f50e 100644 --- a/docs/.sphinx/_toc.yml.in +++ b/docs/.sphinx/_toc.yml.in @@ -7,7 +7,6 @@ root: index subtrees: - caption: Release Info entries: - - file: release - file: release/gpu_os_support - url: https://github.com/RadeonOpenCompute/ROCm/labels/Verified%20Issue title: Known Issues @@ -16,7 +15,6 @@ subtrees: - entries: - file: release/docker_support_matrix - file: reference/framework_compatibility/framework_compatibility - - file: reference/kernel_userspace_compatibility/kernel_userspace_comp - file: release/licensing - caption: Deploy ROCm @@ -33,9 +31,6 @@ subtrees: - file: how_to/quick_start_windows title: Windows - file: deploy/docker - - file: deploy/spack - - file: deploy/build_source - - caption: APIs and Reference entries: @@ -173,7 +168,6 @@ subtrees: - caption: How to Guides entries: - - file: how_to/docker_gpu_isolation - file: how_to/deep_learning_rocm subtrees: - entries: diff --git a/docs/.sphinx/requirements.txt b/docs/.sphinx/requirements.txt index 343205363..4494dec8e 100644 --- a/docs/.sphinx/requirements.txt +++ b/docs/.sphinx/requirements.txt @@ -1,8 +1,8 @@ # -# This file is autogenerated by pip-compile with Python 3.8 +# This file is autogenerated by pip-compile with Python 3.10 # by the following command: # -# pip-compile requirements.in +# pip-compile .sphinx/requirements.in # accessible-pygments==0.0.3 # via pydata-sphinx-theme @@ -187,7 +187,7 @@ requests==2.28.1 # pygithub # sphinx rocm-docs-core==0.6.0 - # via -r requirements.in + # via -r .sphinx/requirements.in six==1.16.0 # via # asttokens diff --git a/docs/conf.py b/docs/conf.py index 319d4223d..29bcb958b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -9,6 +9,37 @@ shutil.copy2('../CONTRIBUTING.md','./contributing.md') from rocm_docs import ROCmDocs +# working anchors that linkcheck cannot find +linkcheck_anchors_ignore = [ + 'd90e61', + 'd1667e113', + 'd2999e60', + 'building-from-source', + 'use-the-rocm-build-tool-rbuild', + 'use-cmake-to-build-migraphx', + 'example' +] +linkcheck_ignore = [ + # site to be built + "https://rocmdocs.amd.com/projects/ROCmCC/en/latest/", + "https://rocmdocs.amd.com/projects/RVS/en/latest/", + "https://rocmdocs.amd.com/projects/amdsmi/en/latest/", + "https://rocmdocs.amd.com/projects/rdc/en/latest/", + "https://rocmdocs.amd.com/projects/rocmsmi/en/latest/", + "https://rocmdocs.amd.com/projects/roctracer/en/latest/", + "https://rocmdocs.amd.com/projects/MIGraphX/en/latest/", + "https://rocmdocs.amd.com/projects/rocprofiler/en/latest/", + "https://github.com/ROCm-Developer-Tools/HIP-VS/blob/master/README.md", + "https://rocmdocs.amd.com/projects/HIPIFY/en/develop/", + # correct links that linkcheck times out on + r"https://www.amd.com/system/files/.*.pdf", + "https://www.amd.com/en/developer/aocc.html", + "https://www.amd.com/en/support/linux-drivers", + "https://www.amd.com/en/technologies/infinity-hub", + r"https://bitbucket.org/icl/magma/*", + "http://cs231n.stanford.edu/" +] + docs_core = ROCmDocs("ROCm Docs 5.6.0 Alpha") docs_core.setup() docs_core.disable_main_doc_link() diff --git a/docs/data/framework_compatibility/with_pytorch.png b/docs/data/framework_compatibility/with_pytorch.png new file mode 100644 index 0000000000000000000000000000000000000000..dd5595b804f601eec8834e0d6a59fa7856595f0d GIT binary patch literal 10724 zcmeHNd0dm%nvP;+5kbVt(f}$}Tcv^`7}mI;(JD~16|BlqR6q*^Spo?mMV9CVg4A17 zwy3G16^K-kH3=pPB1;VW5|)UBKuE$CA_+<63rO#sCU@q}Oz*Gl%>3amlJ7g`yzhJ7 z=e*DJo?Q9D4YpFtSPKLKtvqzl=p0^dF>Xy)`#H&H{Et!->cUT9VS$7;olQ}8XE&6*x@1so^x)*) z^9@Ep;F{eAvN+9Kb4F=K$3BSsc}LU%Hm)G`<+XlU`}erkm4}ABB`(ipTQ;nSGXmBG z`O+*&D-{1J+o%Cp1OlBLOC-pJ6nV;vZ;HJv*4CeE)Plid9$5m9>i0obC!?2uKwhTQ z46895BF3IaWHOf>iFGys9V8(I(6q>+JV7P_p1hBF@ki^XWb zsQ>I#-0_&QI9bp5;Zv4S?f!FBGcP2>7N40J+W3aJ#%y|hrfjIOy(75f^h!ZU{&^gQ z-_*hCt;b6)O7BX$+huNidCa@$spxM@~+&tSDy-&2CL^3RzE3E*eSfg zLuYEkbOlrIOcM#8#w|;$BV*xDx=LkeV=Te%-HdE>{PgGF>CXqD+I}nqVNQ}tOr)+c=*^i&-CSt@Hu&*77sB!#|Dr`}mD ze^n{(k86w zv$(abN%PyneIzgLZW_#du->7fe)?UB4*I|ufq&_B&z3#@p^ZHhs5RIXy>`@(E!~>DMnUD&f%E;98__8;-x5lDT z+D9C}PKaFe)r^|fMrF`CddjU!G}od`Cyw+Tf;fZIE-*3byy2^P6_pnUaP@!P7kkR? zn>m?8(C!+06*>KEnl&&?GtC_|xvhpk*rHAQi?fTuM23a}gtuGMg%`wK!w9)--AiL&4;f1|&8#=)WlAlh5fb&f|HX@eebYLj{#)g=joiW(J*wS;8 zZm-X{wjlO=(|MyxzeFU`jkO&e2*BM-ppC(Ib`MJNkF&JhVM&B4SucEg+-7#SZNaj6 zbhZ20Uw)3?AbIw@x=++AZv}lz<4?mQ25KueFKwRoe>&3NuXzxbOvuGQsu1)?xgJB5 z9DsI3a=7k}qerNWxO=kIFL}NwP68)CiBKRz*Q!Hb>0a0~kND1Wqm1qkwhM2XM=y0e znjl;N_OdtbL8n(I67~<^b>qW#&%e3q5`5V@wf_#>|Fe_h9M*j8!kKj4W-IvF5Ub1* z*R(P~lpL-LCt@qEBc<4NV9mk*Ti<%E2cu2;NOQsOhGM+tkIA`_PysPYKGt3#yXf+1 zc$w6y>fJ<1zqXlytocItSiD_VPc~g$=F(YzMi)VrH8??&{c}U*NSirs7p0afgx2B3 z&U3R8eQy*cPL3*b`iVMwDo=9E8)KYuDwQI4nlqM6j`7Ano%P3i)4K*S$xv#COh^>u zcQ_VMEaEO`&DDtGy2-%g#a*Hf1+cJr`}w zXd$rz>CSwV^j>;xB5}~JJ;wU=xx7>dA~gD9l5a$7U7X|fp}0Bjb>9s5G`_SFZMO=C zTd}e-A?iW=lTn%b@|vl!5pcWHjAFeK`bf>pcBVDB@U;BCtlY;uSD!k?-RGU3AxU5FJmENVz=pUodg&^P+Z;jb%BrX#?~Qiis@R zY4B~gb{FY=hDYC2D4HPYS}>KJNlTQVRug#Trblv9+mZ*RARpE zFiht)6`;oivaTtnlYNS(23bmDAcdAOuJ-N_V`tqCUK1UIH_SpUeH8)eCK0xarG-Qx zpS7(uS%H_5EfiFd|Pwp1QeQ&%z@ za&9UsGUW8GZFSPWcHpVsvpAhj-D9FL_>-{-c#%}TX9dh)GLRR`=jPEegrqFGzc0rO z*G|M-xo{Ng0IQ_*FAuBQ_v9m->AvHqvOA7A_LXDsBz$R?2ojhEi(U~f9&D2C2`UxU zCK77VUyFPL@Q8>mY(kRu(JJP6Xtl)`cX3U8xvvjLSqeATxob z62sQxcU1&Lihh`}@OLFfRXydloJ}S~j$YS-4c=ljolj+qOu&wQuCb$~B@TTegd^9^yOzTyL zUL}dpme&Sn&bkY_b8qK5gGFK~=7W87{PCXfOC|d3>fJXS%cH#UvC^b+3(;HQ)?yb( z)?C<|v<_J%=Gs2%nX{8bP0mEi`C6WQnov`(dHA8JWGnwfO?lG@N(?=IvP|{^@sO0t zxQe}64lT4r;?)pVZ$R>i$TS**jGxS|7|e8P%F)If7~&2XRPA57H#+@8HR@2gS+w-? zg4MVK2#ri#7@B+-8Y0hE^UsAxjCcBk(RVaOy7h-&VR3#G3#p7FKT~$8AKfBv<4NEV zA&|;lIjHYYPOYR?F7){<&0~%c6HjsH9DNY$%cn8QSz~>0{t~|M3(--cd=;9e_l&b~ zi`fmOp)Qo#^Y9%w$r}z69u*1^fkeprs0SSw4S>u3nZCW;#k%~So1dNM=1f7oe3l}o zpSQCgbOVavND=?8H-^1-J^0EOv(*ufMq&BtWvKFpfV24W{Ti?hUpiZvxF2ASEa7|e zN4-ad0U>(S42>UjkJMh%Lm{GmViv}cOp(-Z7c z*7acocL>WmDITTMgj3iKy3D#y+2f3BG)Ae&Gktx4+w0lMb8|>4!ve?}+-7tBGzejd zh_n=ntxI3-WpU1zk;}96BFH)dZ|7xqvgt5Vx`T48&J@?4&vrP7r80O}){FGY{h`U} z?nnb46?2}TG1xY{@Mcg#M5%X`T>PUb;?89JNc4_3!0w4IdIEV24NsZYgz0m|_1F5^ zlV7Rd8?3wR;8fjPf4cWDN!IXL^JZ|c_tZP1jeJv+dn(4xHt4Z9fhyLnUvkgEm zow*^=Tu<354c5Uw(X=nmK<1Tk%8QF99#i#BnTjOM4yUJbwG@fNboyW8=YM5aEY{+j z`{r!tCg(y(b5^lEQ&|8DjU%7?<}@azxu;vjG32HLbBG7@vX*k1ow*HMkn~ z+oMZMkwC+zX77t4epF5}iy5!raL>Rfh}gagHQST!E9B1{3Juz?d}@st;K)_8vq-*i zqYAJ^Xu)_zdU%_x!zxDV zRE#sBGKN`VJLugg3*{jEKi1~YUuCRK_7|x?9O9%(%G5~|!rRIS=EP4P3)OA_VquaS zW+u8N+J9|NqJy{1=)#Eu#@;1Z^9N0*$$>jA!)qTNSg3861|LO4)S#IOeFm<}_4v_k z_km*!o2M5 z2c7wQ1Sy*mG!RwiTNkP-7D}MZYrY!6ELBC~?OXUXPuh0;bsg11`@pgv%T*b^SO{Oy=Ia~B<}(XL-z^<^ z(m~an@2lZsKDfkT|AgGnOjYbIvf(=&`I zCJM8w(L}3iOWPuRv;g>w>nmMxd6{? zB#EkhH3q+Wu!zksAPQ2Pg%ZR+TUGP$=pyoO!6RyNO?Qg=)DqUGdfr`x<{lO&)xjx{ zPf}mL&ye`}BJdNa3?l^cH4~+)oowa(!{V``o&+2#)3?e+riR*nzoFqjdqKp}Q$6GL zQsP7r}H&-s-uYFI1(JJ(gpyInBmLt zzp^08yK%7{{=_8t%?7YZO_=hgysct!@+?Db<2f%Rblvo}cMTrNgUXxqa+b!pf~oni zR(Yc`A^}>xy*ryVnC^2!<`HN5U-RFn^8*A?nb)pq|ThN}eauKHXxg?=1{3(%Y69V~^5 zkg!ygPJr-V(D7SPQ1cZpMNxmJL87dEUJLp~;r7HgKpg}`4T-(#_=4n7gsw_aOcg5D zF7a=Y0sKdt_E*LBu#Yq{S~STL?!t>Og=XBw@rgqpwo#S6%mL%bBucl|ju?osIvyxG zQhhUt6f@%Q!VS|0N zAl=^=U~9o-Y>pPpr*AAaZKlFNKyiLhv<2d=ph-YapaV=@kpCGeTCi+lvG7770k8aY zKE0Gyc)Nq9m);hoV#5qR#6>w@B~2{}_EF&!pg{FQqU1$)>fleLBC`p?oVkj(l9C9h zy}LIUN~@IvI8Mi29*8amxEs)x@DA7bTVvy&wS695F90?NbURRu>kEGAm;8yQRfWs^ z3*=+Zq)dQv8YDQt{*V;)_hB9B@<*HNoMe$Ze`vp8~0EZsu`y1nN#=Z;$l03K zknhCeJn$jf{|;o4n@j+LKyjALwglm+TuoRlOH}|AWXODd{-4Xo zBgy~%mNJZDNupdE=4eqdHHMj z6JeLRbLh013g(tkzXAp{V`sQNY_px+R8_>7O7*Dpf3E(>TouCukgR5QKTjLxfT{I3 znfS4)C4k!QfC*U53QSPNDChO+|C8QdDav0LS6Y}4IQOF_{>ov~vPu#8T6OMq_ezy%02@wzjG~pR^Z6v~$E-Wvi|UgMvEP-``%#k<93gPB&@}jk zK8s$wzt4)VL<#&3mEHGzFK_?$vj%1_O7}2zKWS02qQl-_kqz+sP+qIIjV|hEehML+ z)O<49S8>6^QR7S5D_;CTO?MuB{Kt(7!^z#=G;I|7C z;x^#IgV)QQa@dzW@S@keUiHhJ{w1zgZwkGFxjN1911;XPTywh0H!sGpIFf!EF_s;u zu6p5%vn)=CbOOKmhcC7M!5cBGz-)OHTH|0S*4_Q5pL7&7{U2lmKt>lXGXH+#f$njz zX$CJjyAHl{;$RxxMEYF8h8M0c|32GJ#X%OSvhu@uy8P$L9|iOH{h*Lh2YZ-ljc!$!s+>HSO(RZ*f*rn+8);Q)kVZ3A}U61JVY(e2V$nH9$>Gho<^br~7?> zOij(gZ~K;w`+_rih>y?)!s63|3&*t41)J^YyGLf}d}6G%6nf-DrPCJb*-iS(4o3;6 z!Cq*`IxMALJk}v>xfrzNa;|IlJ;mKuOiw$G!E{JvL3*1(o;cUS)g!4{3s_PuE_m-! z)oaUj3IwJUE0x9?6Hj#e4?l1#Lugjh)YPtTBF~Kq_(V-@-6iaDE#WLRwZpRoTNknB zs;O1ZuZdfiv0P2s=W}{6HGkt#~mm1#a07#HMLzgxwHPsiJti*+^G>T ziYsERILa)HGSoICkr|C)VD5R!G_g2AUtY)TWXJg)phZWMYeh;Pkxh$ch=qdDy)xOCbF6b^P<|SJ~#;zyp+K_H1(ovrZVIFi0X; zRV=vFKpHzlb|sdKlIj>(sFoL+RLooP$!qm-^R!>rQ7&59zf{)6f%5FAGPE+}FuHsv zbhvo4tbv{7)3`2%4K;kKS;HLl`2Gd)O204*&*%_k1=y@|Ni5;jYqoN{61)lp0S<); z6`3{$mJ#=dR>Rmh@f|!XG)idkphl@c2jY&)1`T-&+}&*421u!dSDb>8_<5ZZTV`cR zHMIySKZ^dkqLd+#p-zWwJ<4x%Nj)I>>WFtozgX;w?#P@Gx+GmfZetU|nmZB5iZf7L zxh2I8rj*w6kOX8}$}OgsB%+2{C3qF%UPo$@aeUJGf+YtL_2Q@9hy2)=qD$_ytQ+6- zW%Q2EmrxFoLq;VlaZxT+hiPtK6!M;%nZeAU=!y%25zkmnO|P+ZZ`KicPlX;uCL@Sb zn6|TIZI8Q-h$MU1ED`QlG1tR2g6P$3PGG}5rkk;cdu0TMgWL^yA#ZyFHb-!r9FlettM`xf%<$$xWl7KO7lDEZWr6{Z%}er`O=MvTUrsw}GLG^k*e(_(a8x(OuA*2&<~Q3({v)}3$U zjz;oQ(#>4l@Y7CYD3!gXZV&xhL(3IwSW%xFQ4!K5qy^D>h#$@jw^^k`MB0XmHLh?Z zBq34ynT{!pFd!+OZ=gSplxOD9hp6VV2APL!6hjCr_om}IVi?RQari`EZ($2Z8)jbKkZZ z#}vz@P`?Ge5EvnCY^SWcDzNdw%jjf+hZJ^SH*&r~!8nf3=>_;X5a$N4xf`Z6Upr5m zz_d+0en)4<4X(iqg>(jd=7bMGeIl6I;(Ozt2K_(lJqn7rn0F7vP@kcl0qYe$d(L}q zQQ2?-&DvqV!!;E+_SJF&E2#~6COqs%rt9-;ARv6vR+X?8zkBrZd5#6U}*mZW~wPz;SHLRK(@QudAU zVg`C>J~ob?_@@@>f*_(}Ky!5lvdMmcat1HO<>b-H`A+EA8YX=hDnw-qqaX-~{*(x)A zdxc2s#fxl~^^-QBy%k@|iiI#V&r2!lW3a<~AL5mx4?o8*RfNk1PhIU+N{jtn@-G9+ z!-Q|>hRU^-xz>1(L~5)gpVaUV&oNs^#88m9IpZnn{`Z;1T#9GCx95S~`_T2`X|}o) z|FlKCJ>*5&HG?)fd|u{q+t}q2Uhki1q*hl4?*# zqDid6WlMU$sL&ye)bB%kuccm9lIdIBB2WdP%+``vdPbt?bCTB+vbE6|H{L2)0=vbX zPqhfL7IJL-yghlwwwXICPcoPylwEa@;1j`01+Tne-g@Q27m_)dV{*v6LchXTjjmd^ z6=pTeVq3?}5#n%15}x(;t;IK5B#iNi2CMWi!pVRaX-UOj2|A=12{D~NxOO0hi(f<% z0<+>QHQe+H~$vU-8Qkck0$OH{mkn4EEDCCNSYZ z@k`D4?$BqVR7^fAA+I^gcEHV=)Ds>X?Uca0%aSZ71p!9LWXotTqPgE%bMg)ekhG=e zn*<$c!jf=9#*=F{um)@)ok-Y|FUI*AA~(fz$AZEg zNdyNrcZ>P!{pjLHmmVsis^!Mg2!63f@J!n4g#yVvp>&JzbnV^x zp5-|aZe7n@y`*K>TUjaTIyK?s2B&=;nG!hQd#XnrcRKVwt+m}yK6;%q_QS|#1~cX- zi?O0ZW7kc+8sol_!~$<7Ytqj%yyrI3j{Ue239>bGj!v^KbgoGka zY28#g4fdf|9zV8??3#Q-yXyGBSQ6pWsYZG{w}$x&BUhZ-NG3~1M^6hnfDrls614zi z=$_`3LrsqxM5ph*Seo8|4Stg8Qw7f0 zLw4o2qDzArP`C)hm_j$SeN$ikODz!DM9G9##MF~kX=bot+Tf_0vkWqFaq8~3>OmsNJhKGIx7|#8+>vT_b039ybgFMXpDlm*(jIrX8etkFKiQCT zUJQbqZ6hb|YU|D+6~0X~xPE)8G|y5A&w2iz(f2mEu7)O3`A9ZZU&HgKsV?9<2D77J zy%*ZPA}h>PfHawkbakcd{NL5t|CTd)JxO2Z-Bac5O+F{-=r`D3!tX+Q64ei6_*c8W z`m=2d5vTk{aL5NgSTmNXFAP9RK+-ma}p zZOoO=o=X7>$WI)13VJJ?&{z;bq*!Q3%*mencLp_LVU$cEIt3)>0dU#HVyFwEjuvK2 zmEbHsa^qh=)%yMCbXSe`BzN34&K*mF42SG`!v#VKfeqPtVKY{%HTK(>P_dKnJ znL}u0HsZ4R$dOWxMkJ8JMk=q192xevZ9tB_x}YPnG;)t`X1prpjZcta!-_)f1jxl8 zV~+?r+63 zM4f1k6?f$I`|mqp?~HZ^fz37uEF0xlZ0q+Ky8&=6iXopGhxn<`XaT^v;P&xMZCxYr z;1BEWOpT3j0GvI+XGf}hOkmL5^7ildw12TuED=k4Jn`HN_FV(RG}~rocb#!>s?CMAT!FISxugG?1tt*L-XMb| zLrt9klZp$}R#QGnzVm%fe$fz#JO!kSVCL`_X( zbM>vxHDG|+L|&Yna{u^o8q`{!F{c(JoEh}w++K)SL>WDp`Pg+6NCdx_mGbjjwf-{| zT+jacednhNvdjy;5>Iz9a6FEZtMgxxqx{eOWX@H}pK+2UqO1k4&8m0*MDj4U<8*9w~YjyIr+ zszEhrISbqvIuDtwPF%l*?0N-MsmD{|>$+hT;2AlapbGfGi{KyX&jeT}0#KUvj7GfH z1U1TeAj~%5jspO@AE^ZHt4nULMI($6ImY0Ynhdvy!c{OReK6-~jztx?QmSlNq*Hs3 zn>YJMNt0o3b9Vx`kaHssovNGu)aNM_mPEJ!emsD}m24z3OeH>_{xn;NU8rn=&jCMS zs>&60!ZMk#tzJ{73TXnahKgbW|2&Xofr|hH>c7Vc{q2f?GEwrTph4WwtHqeA#X=h3 z7#O%m`nTTkvKY#oGM#D0Dz-M`XL9JAvV}9>alTRfOFst9fs+9ynE#UX>cWpj>wa-1 zW*74>RF1REIcM?>FXms`_>TN-4gNfE=_k8YlrX#~U~pNWsn$DUS&OcDQ?v|&1?Xn_ zU1F}rO`ju9?^s~C=PVD6bBQW$cz2Jx-7F8y3-1_aTK}d_>scA@0PpO7O4zlr^U$JS z+=JdG&c>E@fYXlOYjZ$%6X(f|e}PKB_7VD?qk^GRJwwQEe9f*oib$2CG z^ebv9>DT}R18{=@vs0*eg#h5X`tRqtYa1C3jr0Y}N7!eHAF&B$qEME&?PZ4pCBa(A zrUy^JZKU!Rkkw($moKA&N_`3!eMHuHC-hc!vu|*7#|rjW-=I#X@WFTR@r%eqT|i$= zq)}mK&+3Epk1Z;D__9EVbU|2DxjCDBMD6$7R@$S@G&kqyHt;n!mT`R*VLrvl1a6aI za5ean(|{fV^N%c~!Vmb=z)ieW&2c#Ok!Ohc4&Kak}+6U)neD%L%^~uSqtiG1PA3h*3u3<%SXlp=< z^oe}H0eAFP?Nc#Hxn$@j$jTFpb$BS@WH<~(+^^nddKYZ2_ng@JRU5+WvZn`th`4R+ z{Ow7-ZOcpu6HLgE^uj zW+3E2Alda1^PwMkaa5Yd6%)&yAZ5;oQ19P(f%qrjf55M2AAk4XTbUAsom9mb-d9)E zrvxP3IDEKq+@Cw^{_QypupfU|`S5G5Tcp9&+^FX`cJbw~Im1M66 zPw4yDX8*B?`)@zw=eLtvTP7YSTgw!ExZnGZ!vxkVo}j#0d$Pp;pp#MipsH(eysIPX zeK%s`+5JH0;Y3r$-(+wLK+}o6qVY0`S2my1$|f4U9qwyPa3m?Eq~~IVRPqyotx4Bx zT{PL_IcXUH^Ab)UBj%_iP&PvEd(gVvb7AU9a+*vLk6_OQ{lo(-bgeO7X)f!#e^vIS zY-m`vE!@nE8YwSL!$PGa!hyF8s@~I6@%&4e*vY2QnR%)P&{(&Ll>XST+jcxFnGhV~ z6PUBobC@R9|M}YI@p@0pCwoKnAE=sDq3Flo)-Z>JC+gEy!*r?2FQxb-f(ht2RoHJJ z*kvW$pcBsuj2tHuygjadMvHc*$sR|U!60-Xj${qZYWHoJ73&?wqQBf zS{p04yA<&Rcs=9!TXlW|78;3;Hk!fv229_pYhk%1-^RP34P95m=Mz2!n{WKe`hynO z=`KJ|?nHZ0>-%0?%fqU^+KFbSzxCk%3F=K5MiKYKhcLpZlH1??s+D*ZPOM(-`Fl?R^d`@~;OtTpH}?YzvUUIk{c1t=tPeZuZUY5&GS>Uzd#6DtbOvhp z9c1$-A9hdQ1!#iX+(jSkQ%BxDplo+W$6`M0bp8$E)t7x7$_)o(Qc0aysY2?SJz-@Y z^HbV>Y0y^5T=YFxW+5B6^}2iQ7r8$Tu%%c@-9&ewo#+-<>1(^p@OF zaGlWSUoADLVP2d%%3w`h5%o~ lQu}dsjW+P|unn(1^T>AGwZL-(;9s@vU+vzKzv=M#{{qUY4=(@! literal 0 HcmV?d00001 diff --git a/docs/deploy.md b/docs/deploy.md index dc89860a2..280a4485d 100644 --- a/docs/deploy.md +++ b/docs/deploy.md @@ -21,7 +21,7 @@ Docker ^^^ - [Guide](deploy/docker) -- [Dockerhub](https://hub.docker.com/u/rocm/#!) +- [Dockerhub](https://hub.docker.com/u/rocm/) :::: diff --git a/docs/deploy/build_source.md b/docs/deploy/build_source.md deleted file mode 100644 index 43dc7a747..000000000 --- a/docs/deploy/build_source.md +++ /dev/null @@ -1 +0,0 @@ -# Build from Source diff --git a/docs/deploy/spack.md b/docs/deploy/spack.md deleted file mode 100644 index 483ec4f9b..000000000 --- a/docs/deploy/spack.md +++ /dev/null @@ -1 +0,0 @@ -# Spack diff --git a/docs/how_to/docker_gpu_isolation.md b/docs/how_to/docker_gpu_isolation.md deleted file mode 100644 index 1f861651d..000000000 --- a/docs/how_to/docker_gpu_isolation.md +++ /dev/null @@ -1,5 +0,0 @@ -# Docker GPU Isolation Techniques - -## GPU Passthrough - -## Environment Variable diff --git a/docs/how_to/pytorch_install/pytorch_install.md b/docs/how_to/pytorch_install/pytorch_install.md index c3124725b..a08cd5d78 100644 --- a/docs/how_to/pytorch_install/pytorch_install.md +++ b/docs/how_to/pytorch_install/pytorch_install.md @@ -63,7 +63,7 @@ and choose the "ROCm" compute platform. {numref}`Installation-Matrix-from-Pytorc --- align: center --- -Installation Matrix from Pytorch.org +Installation Matrix from Pytorch ``` To install PyTorch using the wheels package, follow these installation steps: diff --git a/docs/how_to/system_debugging.md b/docs/how_to/system_debugging.md index c45f343e6..c1db17e43 100644 --- a/docs/how_to/system_debugging.md +++ b/docs/how_to/system_debugging.md @@ -1,3 +1,68 @@ # System Debugging Guide -Pull from +## ROCm Language and System Level Debug, Flags, and Environment Variables + +Kernel options to avoid: the Ethernet port getting renamed every time you change graphics cards, `net.ifnames=0 biosdevname=0` + +## ROCr Error Code + +- 2 Invalid Dimension + +- 4 Invalid Group Memory + +- 8 Invalid (or Null) Code + +- 32 Invalid Format + +- 64 Group is too large + +- 128 Out of VGPRs + +- 0x80000000 Debug Options + +## Command to Dump Firmware Version and Get Linux Kernel Version + +`sudo cat /sys/kernel/debug/dri/1/amdgpu_firmware_info` + +`uname -a` + +## Debug Flags + +Debug messages when developing/debugging base ROCm driver. You could enable the printing from `libhsakmt.so` by setting an environment variable, `HSAKMT_DEBUG_LEVEL`. Available debug levels are 3-7. The higher level you set, the more messages will print. + +- `export HSAKMT_DEBUG_LEVEL=3` : Only pr_err() prints. + +- `export HSAKMT_DEBUG_LEVEL=4` : pr_err() and pr_warn() print. + +- `export HSAKMT_DEBUG_LEVEL=5` : We currently do not implement “notice”. Setting to 5 is same as setting to 4. + +- `export HSAKMT_DEBUG_LEVEL=6` : pr_err(), pr_warn(), and pr_info print. + +- `export HSAKMT_DEBUG_LEVEL=7` : Everything including pr_debug prints. + +## ROCr Level Environment Variables for Debug + +`HSA_ENABLE_SDMA=0` + +`HSA_ENABLE_INTERRUPT=0` + +`HSA_SVM_GUARD_PAGES=0` + +`HSA_DISABLE_CACHE=1` + +## Turn Off Page Retry on GFX9/Vega Devices + +`sudo –s` + +`echo 1 > /sys/module/amdkfd/parameters/noretry` + +## HIP Environment Variables 3.x + +### OpenCL Debug Flags + +`AMD_OCL_WAIT_COMMAND=1 (0 = OFF, 1 = On)` + +## PCIe-Debug + +Refer to ROCm PCIe Debug, https://rocmdocs.amd.com/en/latest/Other_Solutions/PCIe-Debug.html#pcie-debug. +For information on how to debug and profile HIP applications, see https://rocmdocs.amd.com/projects/HIP/en/latest/how_to_guides/debugging.html diff --git a/docs/reference/all.md b/docs/reference/all.md index 5fd77c129..9a981509e 100644 --- a/docs/reference/all.md +++ b/docs/reference/all.md @@ -8,7 +8,7 @@ :::{grid-item-card} [HIP](./hip) HIP is both AMD's GPU programming language extension and the GPU runtime. -- [HIP Runtime API Manual](https://rocmdocs.amd.com/projects/hipBLAS/en/rtd/) +- [HIP Runtime API Manual](https://rocmdocs.amd.com/projects/hipBLAS/en/latest/) - [Examples](https://github.com/amd/rocm-examples/tree/develop/HIP-Basic) ::: @@ -50,8 +50,8 @@ Libraries related to AI. :::{grid-item-card} [Computer Vision](./computer_vision) Computer vision related projects. -- [MIVisionX](https://rocmdocs.amd.com/projects/MIVisionX/en/develop) -- [rocAL](https://rocmdocs.amd.com/projects/rocAL/en/develop) +- [MIVisionX](https://rocmdocs.amd.com/projects/MIVisionX/en/latest) +- [rocAL](https://rocmdocs.amd.com/projects/rocAL/en/latest) ::: diff --git a/docs/reference/framework_compatibility/framework_compatibility.md b/docs/reference/framework_compatibility/framework_compatibility.md index 9bced739f..240298bd3 100644 --- a/docs/reference/framework_compatibility/framework_compatibility.md +++ b/docs/reference/framework_compatibility/framework_compatibility.md @@ -1,8 +1,37 @@ # Framework Compatibility -Pull content from -. -Only the frameworks content. Link to kernel/user space guide. +The ROCm release supports the most recent and two prior releases of PyTorch and TensorFlow. -Also pull content from - +Legends: + +Blue: Shows compatibility tested versions + +Gray: Not tested + +![With PyTorch](../../data/framework_compatibility/with_pytorch.png) + +![With TensorFlow](../../data/framework_compatibility/with_tensorflow.png) + +## Supported Frameworks + +This section contains the latest release notes for each framework compatible with ROCm™ and Deep Learning (DL) applications. + +The ROCm 5.4 platform supports the following frameworks: + +• PyTorch v1.12.1 + +• MAGMA v2.5.4 + +• TensorFlow v2.10.0 + +### PyTorch + +For the latest release of PyTorch, refer to https://github.com/pytorch/pytorch/releases/ + +### MAGMA + +For the latest release of MAGMA, refer to https://icl.utk.edu/magma/index.html + +### TensorFlow + +For the latest release of TensorFlow, refer to https://github.com/tensorflow/tensorflow/releases diff --git a/docs/reference/gpu_libraries/fft.md b/docs/reference/gpu_libraries/fft.md index 300b6d4c9..10d70ac5a 100644 --- a/docs/reference/gpu_libraries/fft.md +++ b/docs/reference/gpu_libraries/fft.md @@ -5,21 +5,20 @@ ROCm libraries for FFT are as follows: :::::{grid} 1 1 2 2 :gutter: 1 -:::{grid-item-card} [rocFFT](https://rocmdocs.amd.com/projects/rocFFT/en/rtd/) +:::{grid-item-card} [rocFFT](https://rocmdocs.amd.com/projects/rocFFT/en/latest/) rocFFT is an AMD GPU optimized library for FFT. -- [Documentation](https://rocmdocs.amd.com/projects/rocFFT/en/rtd/) +- [Documentation](https://rocmdocs.amd.com/projects/rocFFT/en/latest/) - [Changelog](https://github.com/ROCmSoftwarePlatform/rocFFT/blob/develop/CHANGELOG.md) -- [Examples](https://github.com/amd/rocm-examples/tree/develop/Libraries/rocFFT) ::: -:::{grid-item-card} [hipFFT](https://rocmdocs.amd.com/projects/hipFFT/en/rtd/) +:::{grid-item-card} [hipFFT](https://rocmdocs.amd.com/projects/hipFFT/en/latest/) hipFFT is a compatibility layer for GPU accelerated FFT optimized for AMD GPUs using rocFFT. hipFFT allows for a common interface for other non AMD GPU FFT libraries. -- [Documentation](https://rocmdocs.amd.com/projects/hipFFT/en/rtd/) +- [Documentation](https://rocmdocs.amd.com/projects/hipFFT/en/latest/) - [Changelog](https://github.com/ROCmSoftwarePlatform/hipFFT/blob/develop/CHANGELOG.md) ::: diff --git a/docs/reference/gpu_libraries/rand.md b/docs/reference/gpu_libraries/rand.md index 52c5f935b..d8c7152b5 100644 --- a/docs/reference/gpu_libraries/rand.md +++ b/docs/reference/gpu_libraries/rand.md @@ -3,21 +3,21 @@ :::::{grid} 1 1 2 2 :gutter: 1 -:::{grid-item-card} [rocRAND](https://rocmdocs.amd.com/projects/rocRAND/en/rtd/) +:::{grid-item-card} [rocRAND](https://rocmdocs.amd.com/projects/rocRAND/en/latest/) rocRAND is an AMD GPU optimized library for pseudo-random number generators (PRNG). -- [Documentation](https://rocmdocs.amd.com/projects/rocRAND/en/rtd/) +- [Documentation](https://rocmdocs.amd.com/projects/rocRAND/en/latest/) - [Changelog](https://github.com/ROCmSoftwarePlatform/rocRAND/blob/develop/CHANGELOG.md) - [Examples](https://github.com/amd/rocm-examples/tree/develop/Libraries/rocRAND) ::: -:::{grid-item-card} [hipRAND](https://rocmdocs.amd.com/projects/hipRAND/en/rtd/) +:::{grid-item-card} [hipRAND](https://rocmdocs.amd.com/projects/hipRAND/en/latest/) hipRAND is a compatibility layer for GPU accelerated FFT optimized for AMD GPUs using rocFFT. hipFFT allows for a common interface for other non AMD GPU FFT libraries. -- [Documentation](https://rocmdocs.amd.com/projects/hipRAND/en/rtd/) +- [Documentation](https://rocmdocs.amd.com/projects/hipRAND/en/latest/) - [Changelog](https://github.com/ROCmSoftwarePlatform/hipRAND/blob/develop/CHANGELOG.md) ::: diff --git a/docs/reference/kernel_userspace_compatibility/kernel_userspace_comp.md b/docs/reference/kernel_userspace_compatibility/kernel_userspace_comp.md deleted file mode 100644 index f706b7a34..000000000 --- a/docs/reference/kernel_userspace_compatibility/kernel_userspace_comp.md +++ /dev/null @@ -1 +0,0 @@ -# Kernel User Space Compatibility Reference diff --git a/docs/reference/management_tools.md b/docs/reference/management_tools.md index 38e9872bf..848a683d8 100644 --- a/docs/reference/management_tools.md +++ b/docs/reference/management_tools.md @@ -4,11 +4,11 @@ :gutter: 1 :::{grid-item-card} [AMD SMI](https://rocmdocs.amd.com/projects/amdsmi/en/latest/) -GO AMD SMI provides GO binding for [E-SMI In-Band C library](https://github.com/amd/esmi_ib_library.git), -[ROCm SMI Library](https://github.com/RadeonOpenCompute/rocm_smi_lib.git), and any +GO AMD SMI provides GO binding for [E-SMI In-Band C library](https://github.com/amd/esmi_ib_library), +[ROCm SMI Library](https://github.com/RadeonOpenCompute/rocm_smi_lib), and any GO language application that needs to link with these libraries and call the APIs from the GO application. The GO binding are imported in the -[AMD SMI Exporter](https://github.com/amd/amd_smi_exporter.git) to export information +[AMD SMI Exporter](https://github.com/amd/amd_smi_exporter) to export information provided by the AMD E-SMI inband library and the ROCm SMI GPU library to the Prometheus server. - [Documentation](https://rocmdocs.amd.com/projects/amdsmi/en/latest/) diff --git a/docs/reference/rocmcc/rocmcc.md b/docs/reference/rocmcc/rocmcc.md index 1f5db3c9a..3085bb54c 100644 --- a/docs/reference/rocmcc/rocmcc.md +++ b/docs/reference/rocmcc/rocmcc.md @@ -121,7 +121,7 @@ the same compiler entry point, provided AMD provides high-performance compiler optimizations for Zen-based processors in AOCC. For more information, refer to -[https://developer.amd.com/amd-aocc/](https://developer.amd.com/amd-aocc/). +[https://www.amd.com/en/developer/aocc.html](https://www.amd.com/en/developer/aocc.html). #### `-famd-opt` diff --git a/docs/release.md b/docs/release.md deleted file mode 100644 index 38bf0d779..000000000 --- a/docs/release.md +++ /dev/null @@ -1 +0,0 @@ -# Release Notes diff --git a/docs/release/compatibility.md b/docs/release/compatibility.md index 9ccd656b3..f08d72fac 100644 --- a/docs/release/compatibility.md +++ b/docs/release/compatibility.md @@ -1 +1,5 @@ # Compatibility + +[Frameworks Support Matrix](docker_support_matrix.md) + +[Framework Compatibility](../reference/framework_compatibility/framework_compatibility) diff --git a/docs/release/docker_support_matrix.md b/docs/release/docker_support_matrix.md index ba67ee31c..5f5def35e 100644 --- a/docs/release/docker_support_matrix.md +++ b/docs/release/docker_support_matrix.md @@ -8,7 +8,7 @@ The software support matrices for ROCm container releases is listed. #### `Ubuntu+ rocm5.6_internal_testing +169530b` -* [ROCm5.6](http://repo.radeon.com/rocm/apt/latest/) +* [ROCm5.6](https://repo.radeon.com/rocm/apt/latest/) * [Python 3.8](https://www.python.org/downloads/release/python-380/) * [Torch 2.0.0](https://github.com/ROCmSoftwarePlatform/pytorch/tree/rocm5.6_internal_testing) * [Apex 0.1](https://github.com/ROCmSoftwarePlatform/apex/tree/v0.1) @@ -17,11 +17,11 @@ The software support matrices for ROCm container releases is listed. * [MAGMA](https://bitbucket.org/icl/magma/src/master/) * [UCX 1.10.0](https://github.com/openucx/ucx/tree/v1.10.0) * [OMPI 4.0.3](https://github.com/open-mpi/ompi/tree/v4.0.3) -* [OFED 5.4.3](http://content.mellanox.com/ofed/MLNX_OFED-5.3-1.0.5.0/MLNX_OFED_LINUX-5.3-1.0.5.0-ubuntu20.04-x86_64.tgz) +* [OFED 5.4.3](https://content.mellanox.com/ofed/MLNX_OFED-5.3-1.0.5.0/MLNX_OFED_LINUX-5.3-1.0.5.0-ubuntu20.04-x86_64.tgz) #### `CentOS7+ rocm5.6_internal_testing +169530b` -* [ROCm5.6](http://repo.radeon.com/rocm/apt/latest/) +* [ROCm5.6](https://repo.radeon.com/rocm/apt/latest/) * [Python 3.8](https://www.python.org/downloads/release/python-380/) * [Torch 2.0.0](https://github.com/ROCmSoftwarePlatform/pytorch/tree/rocm5.6_internal_testing) * [Apex 0.1](https://github.com/ROCmSoftwarePlatform/apex/tree/v0.1) @@ -31,7 +31,7 @@ The software support matrices for ROCm container releases is listed. #### `1.13 +bfeb431` -* [ROCm5.6](http://repo.radeon.com/rocm/apt/latest/) +* [ROCm5.6](https://repo.radeon.com/rocm/apt/latest/) * [Python 3.8](https://www.python.org/downloads/release/python-380/) * [Torch 1.13.1](https://github.com/ROCmSoftwarePlatform/pytorch/tree/release/1.13) * [Apex 0.1](https://github.com/ROCmSoftwarePlatform/apex/tree/v0.1) @@ -40,11 +40,11 @@ The software support matrices for ROCm container releases is listed. * [MAGMA](https://bitbucket.org/icl/magma/src/master/) * [UCX 1.10.0](https://github.com/openucx/ucx/tree/v1.10.0) * [OMPI 4.0.3](https://github.com/open-mpi/ompi/tree/v4.0.3) -* [OFED 5.4.3](http://content.mellanox.com/ofed/MLNX_OFED-5.3-1.0.5.0/MLNX_OFED_LINUX-5.3-1.0.5.0-ubuntu20.04-x86_64.tgz) +* [OFED 5.4.3](https://content.mellanox.com/ofed/MLNX_OFED-5.3-1.0.5.0/MLNX_OFED_LINUX-5.3-1.0.5.0-ubuntu20.04-x86_64.tgz) #### `1.12 +05d5d04` -* [ROCm5.6](http://repo.radeon.com/rocm/apt/latest/) +* [ROCm5.6](https://repo.radeon.com/rocm/apt/latest/) * [Python 3.8](https://www.python.org/downloads/release/python-380/) * [Torch 1.12.1](https://github.com/ROCmSoftwarePlatform/pytorch/tree/release/1.12) * [Apex 0.1](https://github.com/ROCmSoftwarePlatform/apex/tree/v0.1) @@ -53,36 +53,36 @@ The software support matrices for ROCm container releases is listed. * [MAGMA](https://bitbucket.org/icl/magma/src/master/) * [UCX 1.10.0](https://github.com/openucx/ucx/tree/v1.10.0) * [OMPI 4.0.3](https://github.com/open-mpi/ompi/tree/v4.0.3) -* [OFED 5.4.3](http://content.mellanox.com/ofed/MLNX_OFED-5.3-1.0.5.0/MLNX_OFED_LINUX-5.3-1.0.5.0-ubuntu20.04-x86_64.tgz) +* [OFED 5.4.3](https://content.mellanox.com/ofed/MLNX_OFED-5.3-1.0.5.0/MLNX_OFED_LINUX-5.3-1.0.5.0-ubuntu20.04-x86_64.tgz) ### TensorFlow #### `tensorflow_develop-upstream-QA-rocm56 +c88a9f4` -* [ROCm5.6](http://repo.radeon.com/rocm/apt/latest/) +* [ROCm5.6](https://repo.radeon.com/rocm/apt/latest/) * [Python 3.9](https://www.python.org/downloads/release/python-390/) -* `tensorflow-rocm` 2.13.0 -* [OFED 5.3](http://content.mellanox.com/ofed/MLNX_OFED-5.3-1.0.5.0/MLNX_OFED_LINUX-5.3-1.0.5.0-ubuntu20.04-x86_64.tgz) +* [tensorflow-rocm 2.13.0]() +* [OFED 5.3](https://content.mellanox.com/ofed/MLNX_OFED-5.3-1.0.5.0/MLNX_OFED_LINUX-5.3-1.0.5.0-ubuntu20.04-x86_64.tgz) * [OMPI 4.0.7](https://github.com/open-mpi/ompi/tree/v4.0.7) * [Horovod 0.27.0](https://github.com/horovod/horovod/tree/v0.27.0) * [Tensorboard 2.12.0](https://github.com/tensorflow/tensorboard/tree/2.12.0) #### `r2.11-rocm-enhanced +5be4141` -* [ROCm5.6](http://repo.radeon.com/rocm/apt/latest/) +* [ROCm5.6](https://repo.radeon.com/rocm/apt/latest/) * [Python 3.9](https://www.python.org/downloads/release/python-390/) -* `tensorflow-rocm` 2.11.0 -* [OFED 5.3](http://content.mellanox.com/ofed/MLNX_OFED-5.3-1.0.5.0/MLNX_OFED_LINUX-5.3-1.0.5.0-ubuntu20.04-x86_64.tgz) +* [tensorflow-rocm 2.11.0](https://pypi.org/project/tensorflow-rocm/2.11.0.540/) +* [OFED 5.3](https://content.mellanox.com/ofed/MLNX_OFED-5.3-1.0.5.0/MLNX_OFED_LINUX-5.3-1.0.5.0-ubuntu20.04-x86_64.tgz) * [OMPI 4.0.7](https://github.com/open-mpi/ompi/tree/v4.0.7) * [Horovod 0.27.0](https://github.com/horovod/horovod/tree/v0.27.0) * [Tensorboard 2.11.2](https://github.com/tensorflow/tensorboard/tree/2.11.2) #### `r2.10-rocm-enhanced +72789a3` -* [ROCm5.6](http://repo.radeon.com/rocm/apt/latest/) +* [ROCm5.6](https://repo.radeon.com/rocm/apt/latest/) * [Python 3.9](https://www.python.org/downloads/release/python-390/) -* `tensorflow-rocm` 2.10.1 -* [OFED 5.3](http://content.mellanox.com/ofed/MLNX_OFED-5.3-1.0.5.0/MLNX_OFED_LINUX-5.3-1.0.5.0-ubuntu20.04-x86_64.tgz) +* [tensorflow-rocm 2.10.1](https://pypi.org/project/tensorflow-rocm/2.10.1.540/) +* [OFED 5.3](https://content.mellanox.com/ofed/MLNX_OFED-5.3-1.0.5.0/MLNX_OFED_LINUX-5.3-1.0.5.0-ubuntu20.04-x86_64.tgz) * [OMPI 4.0.7](https://github.com/open-mpi/ompi/tree/v4.0.7) * [Horovod 0.27.0](https://github.com/horovod/horovod/tree/v0.27.0) * [Tensorboard 2.10.1](https://github.com/tensorflow/tensorboard/tree/2.10.1) diff --git a/docs/release/licensing.md b/docs/release/licensing.md index eefa7a8c3..100d03ef3 100644 --- a/docs/release/licensing.md +++ b/docs/release/licensing.md @@ -25,9 +25,9 @@ The table is ordered to follow ROCm's manifest file. | [hipamd](https://github.com/ROCm-Developer-Tools/hipamd/) | [MIT](https://github.com/ROCm-Developer-Tools/hipamd/blob/develop/LICENSE.txt) | | [ROCclr](https://github.com/ROCm-Developer-Tools/ROCclr/) | [MIT](https://github.com/ROCm-Developer-Tools/ROCclr/blob/develop/LICENSE.txt) | | [HIPIFY](https://github.com/ROCm-Developer-Tools/HIPIFY/) | [MIT](https://github.com/ROCm-Developer-Tools/HIPIFY/blob/amd-staging/LICENSE.txt) | -| [HIPCC](https://github.com/ROCm-Developer-Tools/HIPCC/blob/) | [MIT](https://github.com/ROCm-Developer-Tools/HIPCC/blob/develop/LICENSE.txt) | +| [HIPCC](https://github.com/ROCm-Developer-Tools/HIPCC/blob/develop/LICENSE.txt) | [MIT](https://github.com/ROCm-Developer-Tools/HIPCC/blob/develop/LICENSE.txt) | | [llvm-project](https://github.com/ROCm-Developer-Tools/llvm-project/) | [Apache](https://github.com/ROCm-Developer-Tools/llvm-project/blob/main/LICENSE.TXT) | -| rocm-llvm-alt | [AMD Proprietary License](https://www.amd.com/en/support/gpu-pro-eula) +| rocm-llvm-alt | [AMD Proprietary License]() | [ROCm-Device-Libs](https://github.com/RadeonOpenCompute/ROCm-Device-Libs/) | [The University of Illinois/NCSA](https://github.com/RadeonOpenCompute/ROCm-Device-Libs/blob/amd-stg-open/LICENSE.TXT) | | [atmi](https://github.com/RadeonOpenCompute/atmi/) | [MIT](https://github.com/RadeonOpenCompute/atmi/blob/master/LICENSE.txt) | | [ROCm-CompilerSupport](https://github.com/RadeonOpenCompute/ROCm-CompilerSupport/) | [The University of Illinois/NCSA](https://github.com/RadeonOpenCompute/ROCm-CompilerSupport/blob/amd-stg-open/LICENSE.txt) | @@ -65,8 +65,8 @@ The table is ordered to follow ROCm's manifest file. | [flang](https://github.com/ROCm-Developer-Tools/flang/) | [Apache 2.0](https://github.com/ROCm-Developer-Tools/flang/blob/master/LICENSE.txt) | Open sourced ROCm components are released via public GitHub -repositories, packages on repo.radeon.com and other distribution channels. -Proprietary products are only available on repo.radeon.com. Currently, only +repositories, packages on https://repo.radeon.com and other distribution channels. +Proprietary products are only available on https://repo.radeon.com. Currently, only one component of ROCm, rocm-llvm-alt is governed by a proprietary license. Proprietary components are organized in a proprietary subdirectory in the package repositories to distinguish from open sourced packages. diff --git a/docs/under_construction.md b/docs/under_construction.md new file mode 100644 index 000000000..6131bf6ee --- /dev/null +++ b/docs/under_construction.md @@ -0,0 +1,5 @@ +# Under Construction + +ROCm beta documentation is not complete yet. + +Please check back again later. diff --git a/docs/understand/compiler_disambiguation.md b/docs/understand/compiler_disambiguation.md index 0d4d8adcf..30d60ba7d 100644 --- a/docs/understand/compiler_disambiguation.md +++ b/docs/understand/compiler_disambiguation.md @@ -1,4 +1,14 @@ # ROCm Compilers Disambiguation -Pull from - +The following table summarizes the widely used terms in this document. + +## Compiler Terms + +| Term | Description | +| - | - | +| `amdclang++` | Clang/LLVM-based compiler that is part of `rocm-llvm` package. The source code is available at https://github.com/RadeonOpenCompute/llvm-project. | +| AOCC | Closed-source clang-based compiler that includes additional CPU optimizations. Offered as part of ROCm via the `rocm-llvm-alt` package. See for details, https://developer.amd.com/amd-aocc/. | +| HIP-Clang | Informal term for the `amdclang++` compiler | +| HIPify | Tools including `hipify-clang` and `hipify-perl`, used to automatically translate CUDA source code into portable HIP C++. The source code is available at https://github.com/ROCm-Developer-Tools/HIPIFY | +| `hipcc` | HIP compiler driver. A utility that invokes `clang` or `nvcc` depending on the target and passes the appropriate include and library options for the target compiler and HIP infrastructure. The source code is available at https://github.com/ROCm-Developer-Tools/HIPCC. | +| ROCmCC | Clang/LLVM-based compiler. ROCmCC in itself is not a binary but refers to the overall compiler. | diff --git a/docs/understand/installing_linux.md b/docs/understand/installing_linux.md index a8c82969e..9bcb1071e 100644 --- a/docs/understand/installing_linux.md +++ b/docs/understand/installing_linux.md @@ -47,8 +47,6 @@ terms of this agreement, do not install, copy or use the AQL Profiler and/or the AOCC CPU Optimizations. ``` -Access the EULA agreement at: - For the rest of the ROCm packages, you can find the licensing information at the following location: `/opt/rocm/share/doc//` diff --git a/mdlrc-style.rb b/mdlrc-style.rb index 5f20119ad..0c21f9c9d 100644 --- a/mdlrc-style.rb +++ b/mdlrc-style.rb @@ -8,10 +8,14 @@ rule 'MD029', :style => :ordered # Allow in-line HTML exclude_rule 'MD033' +exclude_rule 'MD034' + exclude_rule 'MD041' + + # False positives, see: https://github.com/markdownlint/markdownlint/issues/374 exclude_rule 'MD005' # False positives, see: https://github.com/markdownlint/markdownlint/issues/313 -exclude_rule 'MD007' \ No newline at end of file +exclude_rule 'MD007'