Doc updates updating internal links from deprecated repos to rocm-systems project locations (#2294)
* Update README documentation links for clarity and consistency across projects - Changed links in the README files for `clr`, `hipother`, and `hip-tests` to use relative paths instead of absolute URLs, improving navigation within the repository. * Update CONTRIBUTING documentation to use relative links for improved navigation - Changed absolute URLs to relative paths in the CONTRIBUTING.md files for the hip and hipother projects, enhancing consistency and ease of access within the repository.
This commit is contained in:
@@ -4,9 +4,9 @@ AMD CLR (Compute Language Runtime) contains source codes for AMD's compute langu
|
||||
|
||||
## Project Organisation
|
||||
|
||||
- `hipamd` - contains implementation of `HIP` language on AMD platform. It is hosted at [ROCm/clr/hipamd](https://github.com/ROCm/clr/tree/develop/hipamd)
|
||||
- `opencl` - contains implementation of [OpenCL™](https://www.khronos.org/opencl/) on AMD platform. Now it is hosted at [ROCm/clr/opencl](https://github.com/ROCm/clr/tree/develop/opencl)
|
||||
- `rocclr` - contains compute runtime used in `HIP` and `OpenCL™`. This is hosted at [ROCm/clr/rocclr](https://github.com/ROCm/clr/tree/develop/rocclr)
|
||||
- `hipamd` - contains implementation of `HIP` language on AMD platform. It is hosted at [hipamd](./hipamd)
|
||||
- `opencl` - contains implementation of [OpenCL™](https://www.khronos.org/opencl/) on AMD platform. Now it is hosted at [opencl](./opencl)
|
||||
- `rocclr` - contains compute runtime used in `HIP` and `OpenCL™`. This is hosted at [rocclr](./rocclr)
|
||||
|
||||
## How to build/install
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
## What is this repository for? ###
|
||||
|
||||
This repository provides unit tests for [HIP](https://github.com/ROCm/HIP) implementation.
|
||||
This repository provides unit tests for [HIP](../hip) implementation.
|
||||
|
||||
## DISCLAIMER
|
||||
|
||||
|
||||
@@ -31,14 +31,14 @@ Some guidelines are outlined below:
|
||||
|
||||
* Add a translation to the hipify-clang tool ; many examples abound.
|
||||
* For stat tracking purposes, place the API into an appropriate stat category ("dev", "mem", "stream", etc).
|
||||
* Add a inlined NVIDIA implementation for the function in /hipnv/include/hip/nvidia_detail/nvidia_hip_runtime_api.h in the repository [hipother](https://github.com/ROCm/hipother).
|
||||
* Add a inlined NVIDIA implementation for the function in /hipnv/include/hip/nvidia_detail/nvidia_hip_runtime_api.h in the repository [hipother](../hipother).
|
||||
* These are typically headers
|
||||
* Add an HIP definition and Doxygen comments for the function in /include/hip/hip_runtime_api.h, in the repository [hip](https://github.com/ROCm/hip).
|
||||
* Source implementation typically go in clr/hipamd/src/hip_*.cpp in the reposotory [clr](https://github.com/ROCm/clr). The implementation involves calls to HIP runtime (ie for hipStream_t).
|
||||
* Add an HIP definition and Doxygen comments for the function in /include/hip/hip_runtime_api.h, in the hip repository.
|
||||
* Source implementation typically go in clr/hipamd/src/hip_*.cpp in the repository [clr](../clr). The implementation involves calls to HIP runtime (ie for hipStream_t).
|
||||
|
||||
### Run Unit Tests ###
|
||||
|
||||
For new features or bug fixes, it's mandatory to run associate [hip-tests](https://github.com/ROCm/hip-tests).
|
||||
For new features or bug fixes, it's mandatory to run associate [hip-tests](../hip-tests).
|
||||
Please go to the repo and follow the steps.
|
||||
|
||||
For applications and benchmarks outside the hip-tests environment, developments should use a two-step development flow:
|
||||
|
||||
@@ -31,14 +31,14 @@ Some guidelines are outlined below:
|
||||
|
||||
- Add a translation to the hipify-clang tool ; many examples abound.
|
||||
- For stat tracking purposes, place the API into an appropriate stat category ("dev", "mem", "stream", etc).
|
||||
- Add a inlined NVIDIA implementation for the function in /hipnv/include/hip/nvidia_detail/nvidia_hip_runtime_api.h in the repository [hipother](https://github.com/ROCm/hipother).
|
||||
- Add a inlined NVIDIA implementation for the function in /hipnv/include/hip/nvidia_detail/nvidia_hip_runtime_api.h in the hipother repository.
|
||||
- These are typically headers
|
||||
- Add an HIP definition and Doxygen comments for the function in /include/hip/hip_runtime_api.h, in the repository [hip](https://github.com/ROCm/hip).
|
||||
- Source implementation typically go in clr/hipamd/src/hip_*.cpp in the reposotory [clr](https://github.com/ROCm/clr). The implementation involves calls to HIP runtime (ie for hipStream_t).
|
||||
- Add an HIP definition and Doxygen comments for the function in /include/hip/hip_runtime_api.h, in the repository [hip](../hip).
|
||||
- Source implementation typically go in clr/hipamd/src/hip_*.cpp in the repository [clr](../clr). The implementation involves calls to HIP runtime (ie for hipStream_t).
|
||||
|
||||
### Run Unit Tests ###
|
||||
|
||||
For new features or bug fixes, it's mandatory to run associate [hip-tests](https://github.com/ROCm/hip-tests) on both AMD and NVIDIA platforms.
|
||||
For new features or bug fixes, it's mandatory to run associate [hip-tests](../hip-tests) on both AMD and NVIDIA platforms.
|
||||
Please go to the repo and follow the steps.
|
||||
|
||||
For applications and benchmarks outside the hip-tests environment, developments should use a two-step development flow:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
## What is this repository for? ###
|
||||
|
||||
This repository provides files required to support non-AMD specific back-end implementation for [HIP](https://github.com/ROCm/HIP).
|
||||
This repository provides files required to support non-AMD specific back-end implementation for [HIP](../hip).
|
||||
|
||||
## DISCLAIMER
|
||||
|
||||
|
||||
Fai riferimento in un nuovo problema
Block a user