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

Hip metadata #3720

Merged
merged 6 commits into from
Jan 15, 2025
+30 −7
Merged

Hip metadata #3720

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1050cef
SWDEV-507699 - Update HIP license date
jujiang-del Jan 6, 2025
8082749
SWDEV-507714 - Update description for hip API hipDriverGetVersion
jujiang-del Jan 7, 2025
f06f532
Update terms.md
randyh62 Jan 15, 2025
e9abfe4
Update hip_porting_guide.md
randyh62 Jan 15, 2025
91941af
Update debugging_env.rst
randyh62 Jan 15, 2025
db5960e
Update hip_rtc.md
randyh62 Jan 15, 2025
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
3 changes: 1 addition & 2 deletions LICENSE.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2008 - 2024 Advanced Micro Devices, Inc.
Copyright (c) 2008 - 2025 Advanced Micro Devices, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand All @@ -17,4 +17,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

4 changes: 4 additions & 0 deletions docs/how-to/debugging_env.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
.. meta::
:description: Debug environment variables for HIP.
:keywords: AMD, ROCm, HIP, debugging, Environment variables, ROCgdb

.. list-table::
:header-rows: 1
:widths: 35,14,51
Expand Down
6 changes: 6 additions & 0 deletions docs/how-to/hip_porting_guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
<head>
<meta charset="UTF-8">
<meta name="description" content="HIP porting guide describing how to port CUDA code to HIP.">
<meta name="keywords" content="HIP, Heterogeneous-computing Interface for Portability, HIP porting guide">
</head>

# HIP porting guide

In addition to providing a portable C++ programming environment for GPUs, HIP is designed to ease
Expand Down
6 changes: 6 additions & 0 deletions docs/how-to/hip_rtc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
<head>
<meta charset="UTF-8">
<meta name="description" content="HIP Runtime Compiler API.">
<meta name="keywords" content="HIP, Heterogeneous-computing Interface for Portability, HIP runtime compiler">
</head>

# Programming for HIP runtime compiler (RTC)

HIP lets you compile kernels at runtime with the `hiprtc*` APIs.
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/terms.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
<head>
<meta charset="UTF-8">
<meta name="description" content="Table comparing syntax for HIP, CUDA, and OpenCL APIs">
<meta name="keywords" content="HIP, Heterogeneous-computing Interface for Portability, HIP terms">
</head>

# Table comparing syntax for different compute APIs

|Term|CUDA|HIP|OpenCL|
Expand Down
12 changes: 7 additions & 5 deletions include/hip/hip_runtime_api.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1836,13 +1836,15 @@ hipError_t hipInit(unsigned int flags);
*
* @param [out] driverVersion driver version
*
* HIP driver version shows up in the format:
* HIP_VERSION_MAJOR * 10000000 + HIP_VERSION_MINOR * 100000 + HIP_VERSION_PATCH.
*
* @returns #hipSuccess, #hipErrorInvalidValue
*
* @warning The HIP feature set does not correspond to an exact CUDA SDK driver revision.
* This function always set *driverVersion to 4 as an approximation though HIP supports
* some features which were introduced in later CUDA SDK revisions.
* HIP apps code should not rely on the driver revision number here and should
* use arch feature flags to test device capabilities or conditional compilation.
* @warning The HIP driver version does not correspond to an exact CUDA driver revision.
* On AMD platform, the API returns the HIP driver version, while on NVIDIA platform, it calls
* the corresponding CUDA runtime API and returns the CUDA driver version.
* There is no mapping/correlation between HIP driver version and CUDA driver version.
*
* @see hipRuntimeGetVersion
*/
Expand Down
Loading