Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reformat HIP RTC #3671

Draft
wants to merge 35 commits into
base: docs/develop
Choose a base branch
from
Draft

Reformat HIP RTC #3671

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
2edf074
Update deprecated API list
neon60 Oct 23, 2024
24037e6
Correct Porting Guide Macros
harkgill-amd Oct 9, 2024
4146568
Add what is HIP
neon60 Oct 24, 2024
d2bcee1
Update FAQ
MKKnorr Oct 30, 2024
e1a5079
Docs: Fix broken refs
MKKnorr Oct 30, 2024
b4da1e5
Add HIP environment variables
neon60 Nov 5, 2024
de7195e
Fixing the what-is-hip links
neon60 Nov 10, 2024
3d97f2b
Fix deprecated API list
neon60 Nov 13, 2024
e721c1a
Add ROCm 6.3 deprecation
neon60 Nov 13, 2024
36a531a
Reorganize HIP runtime API how-to
neon60 Nov 18, 2024
12f4e57
PR feedback.
neon60 Nov 18, 2024
64f6cac
Add initialization and error handling
neon60 Nov 18, 2024
6f6b7d3
Documentation: Add hardware capabilities page
parbenc Aug 14, 2024
c8f51e3
Rebase of docs/develop fix
neon60 Nov 19, 2024
445f438
Fix doc links and fix spelling
neon60 Nov 18, 2024
11f7554
Fix opengl interop page renaming
neon60 Nov 19, 2024
1c36922
Fix links
neon60 Nov 19, 2024
9eda86a
Add call stack management
neon60 Nov 20, 2024
257b817
Add external interop page
neon60 Nov 20, 2024
68c13d2
Add multi device management
neon60 Nov 22, 2024
5c3bb4b
Landing page update
neon60 Nov 22, 2024
a7a635e
Add NVCC inability to compile .hip files notice and workaround
Nov 20, 2024
b7c7fa2
Move warning to "hipcc detected my platform incorrectly" section
Nov 21, 2024
927b718
Fix programming guide TOC
neon60 Nov 23, 2024
0a0939e
Minor fix
neon60 Nov 24, 2024
a36db31
Update HIP runtime API in programming guide
neon60 Nov 25, 2024
c8fe177
Docs: Update unified memory documentation
MKKnorr Nov 26, 2024
6ed4f91
Add OpenGL interop
neon60 Nov 28, 2024
641bd43
Bump rocm-docs-core[api_reference] from 1.7.2 to 1.10.0 in /docs/sphinx
dependabot[bot] Dec 2, 2024
80c4c73
[Docs] Revert the deprecation of hipHostMalloc/hipHostFree
neon60 Dec 4, 2024
49bcfac
Fix typo in FAQ
neon60 Dec 3, 2024
f5989be
Fix code highlighting
matyas-streamhpc Dec 2, 2024
c569504
Fix the multi device link
neon60 Dec 3, 2024
f59066d
Resolve merge conflict
neon60 Dec 5, 2024
397fee4
Reformat HIP RTC
matyas-streamhpc Nov 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 24 additions & 2 deletions .wordlist.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ APU
APUs
AQL
AXPY
asm
Asynchrony
backtrace
Bitcode
Expand All @@ -15,6 +16,7 @@ builtins
Builtins
CAS
clr
compilable
coroutines
Ctx
cuBLASLt
Expand Down Expand Up @@ -42,12 +44,14 @@ extern
fatbin
fatbinary
foundationally
framebuffer
frontends
fnuz
FNUZ
fp
gedit
GPGPU
GROMACS
GWS
hardcoded
HC
Expand All @@ -58,23 +62,28 @@ hipcc
hipCtx
hipexamine
hipified
HIPify
hipModule
hipModuleLaunchKernel
hipother
HIPRTC
icc
IILE
iGPU
inlined
inplace
Interoperation
interop
interoperation
interoperate
interoperation
Interprocess
interprocess
Intrinsics
intrinsics
IPC
IPs
isa
iteratively
Lapack
latencies
libc
Expand All @@ -87,6 +96,8 @@ ltrace
makefile
Malloc
malloc
MALU
MiB
memset
multicore
multigrid
Expand All @@ -101,23 +112,28 @@ NOP
Numa
Nsight
ocp
omnitrace
overindex
overindexing
oversubscription
overutilized
parallelizable
pixelated
pragmas
preallocated
preconditioners
predefining
prefetched
preprocessor
profilers
PTX
PyHIP
queryable
prefetching
quad
representable
RMW
rocgdb
ROCm's
rocTX
roundtrip
Expand All @@ -129,6 +145,7 @@ scalarizing
sceneries
shaders
SIMT
sinewave
SOMA
SPMV
structs
Expand All @@ -139,11 +156,16 @@ texels
tradeoffs
templated
toolkits
transfering
typedefs
unintuitive
UMM
unmap
unmapped
unmapping
unregister
upscaled
variadic
vulkan
WinGDB
zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz
zc
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ HIP releases are typically naming convention for each ROCM release to help diffe
## More Info

* [Installation](docs/install/install.rst)
* [HIP FAQ](docs/how-to/faq.md)
* [HIP FAQ](docs/faq.rst)
* [HIP C++ Language Extensions](docs/reference/cpp_language_extensions.rst)
* [HIP Porting Guide](docs/how-to/hip_porting_guide.md)
* [HIP Porting Driver Guide](docs/how-to/hip_porting_driver_api.md)
Expand Down
4 changes: 2 additions & 2 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@

numfig = False


exclude_patterns = [
"doxygen/mainpage.md",
"understand/glossary.md"
"understand/glossary.md",
'how-to/debugging_env.rst'
]
0 ...roups/thread_hierarchy_coop_bottom.drawio → ...roups/thread_hierarchy_coop_bottom.drawio
View file
Open in desktop
File renamed without changes.
0 ...e_groups/thread_hierarchy_coop_bottom.svg → ...e_groups/thread_hierarchy_coop_bottom.svg
View file
Open in desktop
File renamed without changes
0 ...e_groups/thread_hierarchy_coop_top.drawio → ...e_groups/thread_hierarchy_coop_top.drawio
View file
Open in desktop
File renamed without changes.
0 ...tive_groups/thread_hierarchy_coop_top.svg → ...tive_groups/thread_hierarchy_coop_top.svg
View file
Open in desktop
File renamed without changes
0 docs/data/how-to/hipgraph/hip_graph.drawio → ...hip_runtime_api/hipgraph/hip_graph.drawio
View file
Open in desktop
File renamed without changes.
0 docs/data/how-to/hipgraph/hip_graph.svg → ...to/hip_runtime_api/hipgraph/hip_graph.svg
View file
Open in desktop
File renamed without changes
0 .../how-to/hipgraph/hip_graph_speedup.drawio → ...ime_api/hipgraph/hip_graph_speedup.drawio
View file
Open in desktop
File renamed without changes.
0 ...ata/how-to/hipgraph/hip_graph_speedup.svg → ...untime_api/hipgraph/hip_graph_speedup.svg
View file
Open in desktop
File renamed without changes
106 changes: 106 additions & 0 deletions docs/data/how-to/hip_runtime_api/memory_management/pageable_pinned.drawio
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
<mxfile host="65bd71144e">
<diagram id="zBbb_w2fufU70cdOGtND" name="1 oldal">
<mxGraphModel dx="1547" dy="1302" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="0" pageScale="1" pageWidth="660" pageHeight="610" background="none" math="0" shadow="0">
<root>
<mxCell id="0"/>
<mxCell id="1" parent="0"/>
<mxCell id="5927" value="" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#5E5B61;fontColor=#FFFFFF;strokeColor=none;spacing=0;" parent="1" vertex="1">
<mxGeometry y="-10" width="740" height="290" as="geometry"/>
</mxCell>
<mxCell id="5928" value="Pageable data transfer" style="text;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;rounded=0;fontFamily=Helvetica;fontSize=17;fontColor=#FFFFFF;" parent="1" vertex="1">
<mxGeometry x="20" width="340" height="30" as="geometry"/>
</mxCell>
<mxCell id="UvHuP5o6jSuoLTm0AUZA-5955" value="" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#4F1623;fontColor=#FFFFFF;strokeColor=none;" parent="1" vertex="1">
<mxGeometry x="20" y="160" width="340" height="100" as="geometry"/>
</mxCell>
<mxCell id="UvHuP5o6jSuoLTm0AUZA-5959" value="" style="group" parent="1" vertex="1" connectable="0">
<mxGeometry x="230" y="170" width="120" height="80" as="geometry"/>
</mxCell>
<mxCell id="UvHuP5o6jSuoLTm0AUZA-5960" value="" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#C23555;fontColor=#FFFFFF;strokeColor=none;" parent="UvHuP5o6jSuoLTm0AUZA-5959" vertex="1">
<mxGeometry width="120" height="80" as="geometry"/>
</mxCell>
<mxCell id="UvHuP5o6jSuoLTm0AUZA-5961" value="&lt;div&gt;Pinned memory&lt;/div&gt;" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontSize=17;fontColor=#FFFFFF;" parent="UvHuP5o6jSuoLTm0AUZA-5959" vertex="1">
<mxGeometry width="120" height="80" as="geometry"/>
</mxCell>
<mxCell id="LV0FwBpydXXZrUbya0PG-5946" value="Pinned data transfer" style="text;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;rounded=0;fontFamily=Helvetica;fontSize=17;fontColor=#FFFFFF;" parent="1" vertex="1">
<mxGeometry x="380" width="340" height="30" as="geometry"/>
</mxCell>
<mxCell id="UvHuP5o6jSuoLTm0AUZA-5952" value="" style="group;fillColor=#9C2A44;" parent="1" vertex="1" connectable="0">
<mxGeometry x="70" y="170" width="120" height="80" as="geometry"/>
</mxCell>
<mxCell id="UvHuP5o6jSuoLTm0AUZA-5950" value="" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#9C2A44;fontColor=#FFFFFF;strokeColor=none;" parent="UvHuP5o6jSuoLTm0AUZA-5952" vertex="1">
<mxGeometry width="120" height="80" as="geometry"/>
</mxCell>
<mxCell id="UvHuP5o6jSuoLTm0AUZA-5951" value="Pageable memory" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontSize=17;fontColor=#FFFFFF;" parent="UvHuP5o6jSuoLTm0AUZA-5952" vertex="1">
<mxGeometry width="120" height="80" as="geometry"/>
</mxCell>
<mxCell id="LV0FwBpydXXZrUbya0PG-5974" value="" style="endArrow=classic;startArrow=classic;html=1;rounded=0;entryX=1;entryY=0.5;entryDx=0;entryDy=0;strokeWidth=2;exitX=0;exitY=0.5;exitDx=0;exitDy=0;" parent="1" target="UvHuP5o6jSuoLTm0AUZA-5950" edge="1" source="UvHuP5o6jSuoLTm0AUZA-5961">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="220" y="250" as="sourcePoint"/>
<mxPoint x="109.5" y="201" as="targetPoint"/>
</mxGeometry>
</mxCell>
<mxCell id="5929" value="" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#4F1623;fontColor=#FFFFFF;strokeColor=none;" vertex="1" parent="1">
<mxGeometry x="20" y="40" width="340" height="100" as="geometry"/>
</mxCell>
<mxCell id="5930" value="" style="group" vertex="1" connectable="0" parent="1">
<mxGeometry x="230" y="50" width="120" height="80" as="geometry"/>
</mxCell>
<mxCell id="5931" value="" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#C23555;fontColor=#FFFFFF;strokeColor=none;" vertex="1" parent="5930">
<mxGeometry width="120" height="80" as="geometry"/>
</mxCell>
<mxCell id="5932" value="&lt;div&gt;Device memory&lt;/div&gt;" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontSize=17;fontColor=#FFFFFF;" vertex="1" parent="5930">
<mxGeometry width="120" height="80" as="geometry"/>
</mxCell>
<mxCell id="LV0FwBpydXXZrUbya0PG-5968" value="" style="endArrow=classic;startArrow=classic;html=1;rounded=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;strokeWidth=2;strokeColor=#ffffff;exitX=0.5;exitY=1;exitDx=0;exitDy=0;" parent="1" source="5932" target="UvHuP5o6jSuoLTm0AUZA-5960" edge="1">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="290" y="120" as="sourcePoint"/>
<mxPoint x="289.5" y="160" as="targetPoint"/>
</mxGeometry>
</mxCell>
<mxCell id="5944" value="" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#4F1623;fontColor=#FFFFFF;strokeColor=none;" vertex="1" parent="1">
<mxGeometry x="380" y="160" width="340" height="100" as="geometry"/>
</mxCell>
<mxCell id="5945" value="" style="group" vertex="1" connectable="0" parent="1">
<mxGeometry x="590" y="170" width="120" height="80" as="geometry"/>
</mxCell>
<mxCell id="5946" value="" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#C23555;fontColor=#FFFFFF;strokeColor=none;" vertex="1" parent="5945">
<mxGeometry width="120" height="80" as="geometry"/>
</mxCell>
<mxCell id="5947" value="&lt;div&gt;Pinned memory&lt;/div&gt;" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontSize=17;fontColor=#FFFFFF;" vertex="1" parent="5945">
<mxGeometry width="120" height="80" as="geometry"/>
</mxCell>
<mxCell id="5948" value="" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#4F1623;fontColor=#FFFFFF;strokeColor=none;" vertex="1" parent="1">
<mxGeometry x="380" y="40" width="340" height="100" as="geometry"/>
</mxCell>
<mxCell id="5949" value="" style="group" vertex="1" connectable="0" parent="1">
<mxGeometry x="590" y="50" width="120" height="80" as="geometry"/>
</mxCell>
<mxCell id="5950" value="" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#C23555;fontColor=#FFFFFF;strokeColor=none;" vertex="1" parent="5949">
<mxGeometry width="120" height="80" as="geometry"/>
</mxCell>
<mxCell id="5951" value="&lt;div&gt;Device memory&lt;/div&gt;" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontSize=17;fontColor=#FFFFFF;" vertex="1" parent="5949">
<mxGeometry width="120" height="80" as="geometry"/>
</mxCell>
<mxCell id="5952" style="edgeStyle=none;html=1;exitX=0.5;exitY=0;exitDx=0;exitDy=0;entryX=0.5;entryY=1;entryDx=0;entryDy=0;startArrow=classic;startFill=1;strokeWidth=2;strokeColor=#FFFFFF;" edge="1" parent="1" source="5947" target="5951">
<mxGeometry relative="1" as="geometry"/>
</mxCell>
<mxCell id="5958" value="&lt;div&gt;Host&lt;/div&gt;" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontSize=17;fontColor=#FFFFFF;direction=west;" vertex="1" parent="1">
<mxGeometry x="20" y="195" width="50" height="30" as="geometry"/>
</mxCell>
<mxCell id="5960" value="&lt;div&gt;Device&lt;/div&gt;" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontSize=17;fontColor=#FFFFFF;" vertex="1" parent="1">
<mxGeometry x="20" y="75" width="70" height="30" as="geometry"/>
</mxCell>
<mxCell id="5961" value="&lt;div&gt;Device&lt;/div&gt;" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontSize=17;fontColor=#FFFFFF;" vertex="1" parent="1">
<mxGeometry x="380" y="75" width="70" height="30" as="geometry"/>
</mxCell>
<mxCell id="5962" value="&lt;div&gt;Host&lt;/div&gt;" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontSize=17;fontColor=#FFFFFF;" vertex="1" parent="1">
<mxGeometry x="380" y="195" width="60" height="30" as="geometry"/>
</mxCell>
<mxCell id="5964" value="" style="edgeStyle=none;html=1;strokeWidth=2;startArrow=classic;startFill=1;strokeColor=#FFFFFF;" edge="1" parent="1" source="UvHuP5o6jSuoLTm0AUZA-5951" target="UvHuP5o6jSuoLTm0AUZA-5961">
<mxGeometry relative="1" as="geometry"/>
</mxCell>
</root>
</mxGraphModel>
</diagram>
</mxfile>
Loading
Loading