Skip to content

Commit 25f61a1

Browse files
committed
SWDEV-447465 - Update HIP documents for the repos link change
Change-Id: Ib191c96b57458c7abc9c490329d582c28d4632a7
1 parent 62dd171 commit 25f61a1

10 files changed

+41
-35
lines changed

README.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Key features include:
77
* HIP is very thin and has little or no performance impact over coding directly in CUDA mode.
88
* HIP allows coding in a single-source C++ programming language including features such as templates, C++11 lambdas, classes, namespaces, and more.
99
* HIP allows developers to use the "best" development environment and tools on each target platform.
10-
* The [HIPIFY](https://github.com/ROCm-Developer-Tools/HIPIFY/blob/amd-staging/README.md) tools automatically convert source from CUDA to HIP.
10+
* The [HIPIFY](https://github.com/ROCm/HIPIFY/blob/amd-staging/README.md) tools automatically convert source from CUDA to HIP.
1111
* Developers can specialize for the platform (CUDA or AMD) to tune for performance or handle tricky cases.
1212

1313
New projects can be developed directly in the portable HIP C++ language and can run on either NVIDIA or AMD platforms. Additionally, HIP provides porting tools which make it easy to port existing CUDA codes to the HIP layer, with no loss of performance as compared to the original CUDA application. HIP is not intended to be a drop-in replacement for CUDA, and developers should expect to do some manual coding and performance tuning work to complete the port.
@@ -45,17 +45,17 @@ HIP releases are typically naming convention for each ROCM release to help diffe
4545
- [HIP Debugging ](docs/how_to_guides/debugging.md)
4646
- [HIP RTC](docs/user_guide/hip_rtc.md)
4747
- [HIP Terminology](docs/reference/terms.md) (including Rosetta Stone of GPU computing terms across CUDA/HIP/OpenCL)
48-
- [HIPIFY](https://github.com/ROCm-Developer-Tools/HIPIFY/blob/amd-staging/README.md)
48+
- [HIPIFY](https://github.com/ROCm/HIPIFY/blob/amd-staging/README.md)
4949
- Supported CUDA APIs:
50-
* [Runtime API](https://github.com/ROCm-Developer-Tools/HIPIFY/blob/master/doc/markdown/CUDA_Runtime_API_functions_supported_by_HIP.md)
51-
* [Driver API](https://github.com/ROCm-Developer-Tools/HIPIFY/blob/master/doc/markdown/CUDA_Driver_API_functions_supported_by_HIP.md)
52-
* [cuComplex API](https://github.com/ROCm-Developer-Tools/HIPIFY/blob/master/doc/markdown/cuComplex_API_supported_by_HIP.md)
53-
* [Device API](https://github.com/ROCm-Developer-Tools/HIPIFY/blob/master/doc/markdown/CUDA_Device_API_supported_by_HIP.md)
54-
* [cuBLAS](https://github.com/ROCm-Developer-Tools/HIPIFY/blob/master/doc/markdown/CUBLAS_API_supported_by_HIP.md)
55-
* [cuRAND](https://github.com/ROCm-Developer-Tools/HIPIFY/blob/master/doc/markdown/CURAND_API_supported_by_HIP.md)
56-
* [cuDNN](https://github.com/ROCm-Developer-Tools/HIPIFY/blob/master/doc/markdown/CUDNN_API_supported_by_HIP.md)
57-
* [cuFFT](https://github.com/ROCm-Developer-Tools/HIPIFY/blob/master/doc/markdown/CUFFT_API_supported_by_HIP.md)
58-
* [cuSPARSE](https://github.com/ROCm-Developer-Tools/HIPIFY/blob/master/doc/markdown/CUSPARSE_API_supported_by_HIP.md)
50+
* [Runtime API](https://github.com/ROCm/HIPIFY/blob/amd-staging/docs/tables/CUDA_Runtime_API_functions_supported_by_HIP.md)
51+
* [Driver API](https://github.com/ROCm/HIPIFY/blob/amd-staging/docs/tables/CUDA_Driver_API_functions_supported_by_HIP.md)
52+
* [cuComplex API](https://github.com/ROCm/HIPIFY/blob/amd-staging/docs/tables/cuComplex_API_supported_by_HIP.md)
53+
* [Device API](https://github.com/ROCm/HIPIFY/blob/amd-staging/docs/tables/CUDA_Device_API_supported_by_HIP.md)
54+
* [cuBLAS](https://github.com/ROCm/HIPIFY/blob/amd-staging/docs/tables/CUBLAS_API_supported_by_ROC.md)
55+
* [cuRAND](https://github.com/ROCm/HIPIFY/blob/amd-staging/docs/tables/CURAND_API_supported_by_HIP.md)
56+
* [cuDNN](https://github.com/ROCm/HIPIFY/blob/amd-staging/docs/tables/CUDNN_API_supported_by_HIP.md)
57+
* [cuFFT](https://github.com/ROCm/HIPIFY/blob/amd-staging/docs/tables/CUFFT_API_supported_by_HIP.md)
58+
* [cuSPARSE](https://github.com/ROCm/HIPIFY/blob/amd-staging/docs/tables/CUSPARSE_API_supported_by_HIP.md)
5959
- [Developer/CONTRIBUTING Info](docs/developer_guide/contributing.md)
6060
- [Release Notes](RELEASE.md)
6161

@@ -115,15 +115,15 @@ HIP C++ code can be compiled with either,
115115
profiler and debugger.
116116
- On the AMD ROCm platform, HIP provides a header and runtime library built on top of HIP-Clang compiler. The HIP runtime implements HIP streams, events, and memory APIs,
117117
and is a object library that is linked with the application. The source code for all headers and the library implementation is available on GitHub.
118-
HIP developers on ROCm can use AMD's ROCgdb (https://github.com/ROCm-Developer-Tools/ROCgdb) for debugging and profiling.
118+
HIP developers on ROCm can use AMD's ROCgdb (https://github.com/ROCm/ROCgdb) for debugging and profiling.
119119
120120
Thus HIP source code can be compiled to run on either platform. Platform-specific features can be isolated to a specific platform using conditional compilation. Thus HIP
121121
provides source portability to either platform. HIP provides the _hipcc_ compiler driver which will call the appropriate toolchain depending on the desired platform.
122122
123123
124124
## Examples and Getting Started:
125125
126-
* A sample and [blog](https://github.com/ROCm-Developer-Tools/hip-tests/tree/develop/samples/0_Intro/square) that uses any of [HIPIFY](https://github.com/ROCm-Developer-Tools/HIPIFY/blob/amd-staging/README.md) tools to convert a simple app from CUDA to HIP:
126+
* A sample and [blog](https://github.com/ROCm/hip-tests/tree/develop/samples/0_Intro/square) that uses any of [HIPIFY](https://github.com/ROCm/HIPIFY/blob/amd-staging/README.md) tools to convert a simple app from CUDA to HIP:
127127
128128
129129
```shell
@@ -135,8 +135,8 @@ cd samples/01_Intro/square
135135

136136

137137
## More Examples
138-
The GitHub repository [HIP-Examples](https://github.com/ROCm-Developer-Tools/HIP-Examples) contains a hipified version of benchmark suite.
139-
Besides, there are more samples in Github [HIP samples](https://github.com/ROCm-Developer-Tools/hip-tests/tree/develop/samples), showing how to program with different features, build and run.
138+
The GitHub repository [HIP-Examples](https://github.com/ROCm/HIP-Examples) contains a hipified version of benchmark suite.
139+
Besides, there are more samples in Github [HIP samples](https://github.com/ROCm/hip-tests/tree/develop/samples), showing how to program with different features, build and run.
140140

141141
## Tour of the HIP Directories
142142
* **include**:
@@ -151,6 +151,6 @@ Besides, there are more samples in Github [HIP samples](https://github.com/ROCm-
151151
* **docs**: Documentation - markdown and doxygen info.
152152

153153
## Reporting an issue
154-
Use the [GitHub issue tracker](https://github.com/ROCm-Developer-Tools/HIP/issues).
154+
Use the [GitHub issue tracker](https://github.com/ROCm/HIP/issues).
155155
If reporting a bug, include the output of "hipconfig --full" and samples/1_hipInfo/hipInfo (if possible).
156156

RELEASE.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Release notes
22

3-
We have attempted to document known bugs and limitations - in particular the [HIP Kernel Language](docs/markdown/hip_kernel_language.md) document uses the phrase "Under Development", and the [HIP Runtime API bug list](http://rocm-developer-tools.github.io/HIP/bug.html) lists known bugs.
3+
We have attempted to document known bugs and limitations - in particular the [HIP Kernel Language](docs/markdown/hip_kernel_language.md) document uses the phrase "Under Development", and the [HIP Runtime API issue list](https://github.com/ROCm/HIP/issues) lists known bugs.
44

55

66
===================================================================================================
@@ -155,7 +155,7 @@ Date: 2016.06.06
155155
- Add cross-linking support between G++ and HCC, in particular for interfaces that use
156156
standard C++ libraries (ie std::vectors, std::strings). HIPCC now uses libstdc++ by default on the HCC
157157
compilation path.
158-
- More samples including gpu-burn, SHOC, nbody, rtm. See [HIP-Examples](https://github.com/ROCm-Developer-Tools/HIP-Examples)
158+
- More samples including gpu-burn, SHOC, nbody, rtm. See [HIP-Examples](https://github.com/ROCm/HIP-Examples)
159159

160160

161161
===================================================================================================

docs/developer_guide/build.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ HIP catch tests, with the newly architectured Catch2, are officially separated f
134134
##### Get HIP tests source code
135135

136136
```shell
137-
git clone -b "$ROCM_BRANCH" https://github.com/ROCm-Developer-Tools/hip-tests.git
137+
git clone -b "$ROCM_BRANCH" https://github.com/ROCm/hip-tests.git
138138
```
139139
##### Build HIP tests from source
140140

docs/developer_guide/contributing.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Selected multilib: .;@m64
5959

6060
## Unit Testing Environment
6161

62-
Tests for HIP are hosted at [ROCm-Developer-Tools/hip-tests](https://github.com/ROCm-Developer-Tools/hip-tests).
62+
Tests for HIP are hosted at [ROCm/hip-tests](https://github.com/ROCm/hip-tests).
6363

6464
To run `hip-tests` please go to the repo and follow the steps.
6565

@@ -124,7 +124,7 @@ Differences or limitations of HIP APIs as compared to CUDA APIs should be clearl
124124

125125

126126
### Presubmit Testing:
127-
Before checking in or submitting a pull request, run all hip-tests (see [ROCm-Developer-Tools/hip-tests](https://github.com/ROCm-Developer-Tools/hip-tests)).
127+
Before checking in or submitting a pull request, run all hip-tests (see [ROCm/hip-tests](https://github.com/ROCm/hip-tests)).
128128

129129

130130
### Checkin messages

docs/how_to_guides/debugging.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ PASSED!
7979
### Using ROCgdb
8080
HIP developers on ROCm can use AMD's ROCgdb for debugging and profiling.
8181
ROCgdb is the ROCm source-level debugger for Linux, based on GDB, the GNU source-level debugger, equivalent of cuda-gdb, can be used with debugger frontends, such as eclipse, vscode, or gdb-dashboard.
82-
For details, see (https://github.com/ROCm-Developer-Tools/ROCgdb).
82+
For details, see (https://github.com/ROCm/ROCgdb).
8383

8484
Below is a sample how to use ROCgdb run and debug HIP application, rocgdb is installed with ROCM package in the folder /opt/rocm/bin.
8585

@@ -91,7 +91,7 @@ Copyright (C) 2020 Free Software Foundation, Inc.
9191
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
9292
...
9393
For bug reporting instructions, please see:
94-
<https://github.com/ROCm-Developer-Tools/ROCgdb/issues>.
94+
<https://github.com/ROCm/ROCgdb/issues>.
9595
Find the GDB manual and other documentation resources online at:
9696
<http://www.gnu.org/software/gdb/documentation/>.
9797

docs/reference/deprecated_api_list.md

+2
Original file line numberDiff line numberDiff line change
@@ -86,3 +86,5 @@ Should use roctracer/rocTX instead
8686
### hipTexRefSetMipmapLevelClamp
8787
### hipTexRefSetMipmappedArray
8888
### hipBindTextureToMipmappedArray
89+
### hipTexRefGetBorderColor
90+
### hipTexRefGetArray

docs/reference/glossary.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,13 @@ The default device can be set with hipSetDevice.
1010

1111
- HIP-Clang - Heterogeneous AMDGPU Compiler, with its capability to compile HIP programs on AMD platform (https://github.com/RadeonOpenCompute/llvm-project).
1212

13-
- ROCclr - a virtual device interface that compute runtimes interact with different backends such as ROCr on Linux or PAL on Windows.
14-
The ROCclr (https://github.com/ROCm-Developer-Tools/ROCclr) is an abstraction layer allowing runtimes to work on both OSes without much effort.
13+
- clr - a repository for AMD Common Language Runtime, contains source codes for AMD's compute languages runtimes: HIP and OpenCL™.
14+
clr (https://github.com/ROCm/clr) contains the following three parts,
15+
hipamd: contains implementation of HIP language on AMD platform.
16+
rocclr: contains common runtime used in HIP and OpenCL™, which provides virtual device interfaces that compute runtimes interact with different backends such as ROCr on Linux or PAL on Windows.
17+
opencl: contains implementation of OpenCL™ on AMD platform.
1518

16-
- hipify tools - tools to convert CUDA code to portable C++ code (https://github.com/ROCm-Developer-Tools/HIPIFY).
19+
- hipify tools - tools to convert CUDA code to portable C++ code (https://github.com/ROCm/HIPIFY).
1720

1821
- hipconfig - tool to report various configuration properties of the target platform.
1922

docs/user_guide/hip_porting_driver_api.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ The CUDA Runtime API unifies the Context API with the Device API. This simplifie
4040
HIP provides a context API to facilitate easy porting from existing Driver codes.
4141
In HIP, the Ctx functions largely provide an alternate syntax for changing the active device.
4242

43-
Most new applications will prefer to use `hipSetDevice` or the stream APIs , therefore HIP has marked hipCtx APIs as **deprecated**. Support for these APIs may not be available in future releases. For more details on deprecated APIs please refer [HIP deprecated APIs](https://github.com/ROCm-Developer-Tools/HIP/tree/master/docs/markdown/hip_deprecated_api_list.md).
43+
Most new applications will prefer to use `hipSetDevice` or the stream APIs , therefore HIP has marked hipCtx APIs as **deprecated**. Support for these APIs may not be available in future releases. For more details on deprecated APIs please refer [HIP deprecated APIs](https://github.com/ROCm/HIP/blob/develop/docs/reference/deprecated_api_list.md).
4444

4545
## HIP Module and Ctx APIs
4646

docs/user_guide/hip_porting_guide.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ and provides practical suggestions on how to port CUDA code and work through com
99
- Starting the port on a CUDA machine is often the easiest approach, since you can incrementally port pieces of the code to HIP while leaving the rest in CUDA. (Recall that on CUDA machines HIP is just a thin layer over CUDA, so the two code types can interoperate on nvcc platforms.) Also, the HIP port can be compared with the original CUDA code for function and performance.
1010
- Once the CUDA code is ported to HIP and is running on the CUDA machine, compile the HIP code using the HIP compiler on an AMD machine.
1111
- HIP ports can replace CUDA versions: HIP can deliver the same performance as a native CUDA implementation, with the benefit of portability to both Nvidia and AMD architectures as well as a path to future C++ standard support. You can handle platform-specific features through conditional compilation or by adding them to the open-source HIP infrastructure.
12-
- Use **[hipconvertinplace-perl.sh](https://github.com/ROCm-Developer-Tools/HIPIFY/blob/master/bin/hipconvertinplace-perl.sh)** to hipify all code files in the CUDA source directory.
12+
- Use **[hipconvertinplace-perl.sh](https://github.com/ROCm/HIPIFY/blob/amd-staging/bin/hipconvertinplace-perl.sh)** to hipify all code files in the CUDA source directory.
1313

1414
### Scanning existing CUDA code to scope the porting effort
15-
The **[hipexamine-perl.sh](https://github.com/ROCm-Developer-Tools/HIPIFY/blob/master/bin/hipexamine-perl.sh)** tool will scan a source directory to determine which files contain CUDA code and how much of that code can be automatically hipified.
15+
The **[hipexamine-perl.sh](https://github.com/ROCm/HIPIFY/blob/amd-staging/bin/hipexamine-perl.sh)** tool will scan a source directory to determine which files contain CUDA code and how much of that code can be automatically hipified.
1616
```
1717
> cd examples/rodinia_3.0/cuda/kmeans
1818
> $HIP_DIR/bin/hipexamine-perl.sh.
@@ -66,7 +66,7 @@ For each input file FILE, this script will:
6666
This is useful for testing improvements to the hipify toolset.
6767

6868

69-
The [hipconvertinplace-perl.sh](https://github.com/ROCm-Developer-Tools/HIPIFY/blob/master/bin/hipconvertinplace-perl.sh) script will perform inplace conversion for all code files in the specified directory.
69+
The [hipconvertinplace-perl.sh](https://github.com/ROCm/HIPIFY/blob/amd-staging/bin/hipconvertinplace-perl.sh) script will perform inplace conversion for all code files in the specified directory.
7070
This can be quite handy when dealing with an existing CUDA code base since the script preserves the existing directory structure
7171
and filenames - and includes work. After converting in-place, you can review the code to add additional parameters to
7272
directory names.
@@ -461,7 +461,7 @@ In this case, memory type translation for hipPointerGetAttributes needs to be ha
461461

462462
So in any HIP applications which use HIP APIs involving memory types, developers should use #ifdef in order to assign the correct enum values depending on Nvidia or AMD platform.
463463

464-
As an example, please see the code from the [link](https://github.com/ROCm-Developer-Tools/hip-tests/tree/develop/catch/unit/memory/hipMemcpyParam2D.cc).
464+
As an example, please see the code from the [link](https://github.com/ROCm/hip-tests/tree/develop/catch/unit/memory/hipMemcpyParam2D.cc).
465465

466466
With the #ifdef condition, HIP APIs work as expected on both AMD and NVIDIA platforms.
467467

docs/user_guide/programming_manual.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -127,8 +127,9 @@ HIP now supports runtime compilation (HIPRTC), the usage of which will provide t
127127

128128
HIPRTC APIs accept HIP source files in character string format as input parameters and create handles of programs by compiling the HIP source files without spawning separate processes.
129129

130-
For more details on HIPRTC APIs, refer to HIP-API.pdf in GitHub (https://docs.amd.com/category/api_documentation).
131-
For Linux developers, the link here(https://github.com/ROCm-Developer-Tools/hip-tests/blob/develop/samples/2_Cookbook/23_cmake_hiprtc/saxpy.cpp) shows an example how to program HIP application using runtime compilation mechanism, and detail HIPRTC programming guide is also available in Github (https://github.com/ROCm-Developer-Tools/HIP/blob/develop/docs/user_guide/hip_rtc.md).
130+
For more details on HIPRTC APIs, refer to [HIP Runtime API Reference](https://rocm.docs.amd.com/projects/HIP/en/latest/doxygen/html/index.html).
131+
132+
For Linux developers, the link here (https://github.com/ROCm/hip-tests/blob/develop/samples/2_Cookbook/23_cmake_hiprtc/saxpy.cpp) shows an example how to program HIP application using runtime compilation mechanism, and detail HIPRTC programming guide is also available in Github (https://github.com/ROCm/HIP/blob/develop/docs/user_guide/hip_rtc.md).
132133

133134
## HIP Graph
134135
HIP graph is supported. For more details, refer to the HIP API Guide.
@@ -145,7 +146,7 @@ The per-thread default stream is a blocking stream and will synchronize with the
145146
The per-thread default stream can be enabled via adding a compilation option,
146147
"-fgpu-default-stream=per-thread".
147148

148-
And users can explicitly use "hipStreamPerThread" as per-thread default stream handle as input in API commands. There are test codes as examples in the link (https://github.com/ROCm-Developer-Tools/hip-tests/tree/develop/catch/unit/streamperthread).
149+
And users can explicitly use "hipStreamPerThread" as per-thread default stream handle as input in API commands. There are test codes as examples in the link (https://github.com/ROCm/hip-tests/tree/develop/catch/unit/streamperthread).
149150

150151
## Use of Long Double Type
151152

@@ -190,4 +191,4 @@ Here is an example to create and use static libraries:
190191
hipcc libHipDevice.a test.cpp -fgpu-rdc -o test.out
191192
```
192193
193-
For more information, please see [HIP samples](https://github.com/ROCm-Developer-Tools/hip-tests/tree/rocm-5.5.x/samples/2_Cookbook/15_static_library/host_functions) and [samples](https://github.com/ROCm-Developer-Tools/hip-tests/tree/rocm-5.5.x/samples/2_Cookbook/15_static_library/device_functions).
194+
For more information, please see [HIP samples](https://github.com/ROCm/hip-tests/tree/develop/samples/2_Cookbook/15_static_library/host_functions) and [samples](https://github.com/ROCm/hip-tests/tree/rocm-5.5.x/samples/2_Cookbook/15_static_library/device_functions).

0 commit comments

Comments
 (0)