SWDEV-446296 - Update README for the repos link change

Change-Id: I13f73e3c9a066c5e92f630bcd06f777790087e5e
This commit is contained in:
jujiang
2024-02-15 19:12:04 -05:00
committed by Julia Jiang
orang tua 1f6d416684
melakukan 4c28f4aefd
2 mengubah file dengan 16 tambahan dan 20 penghapusan
+11 -9
Melihat File
@@ -1,24 +1,24 @@
# AMD CLR - Compute Language Runtimes
AMD Common Language Runtime contains source code for AMD's compute languages runtimes: `HIP` and `OpenCL™`.
AMD Common Language Runtime contains source codes for AMD's compute languages runtimes: `HIP` and `OpenCL™`.
## Project Organisation
- `hipamd` - contains implementation of `HIP` language on AMD platform. Previously this was hosted at [ROCm-Developer-Tools/hipamd](https://github.com/ROCm-Developer-Tools/hipamd)
- `opencl` - contains implementation of [OpenCL™](https://www.khronos.org/opencl/) on AMD platform. Previously this was hosted at [RadeonOpenCompute/ROCm-OpenCL-Runtime](https://github.com/RadeonOpenCompute/ROCm-OpenCL-Runtime)
- `rocclr` - contains common runtime used in `HIP` and `OpenCL™`. Previously this was hosted at [ROCm-Developer-Tools/ROCclr](https://github.com/ROCm-Developer-Tools/ROCclr)
- `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 common runtime used in `HIP` and `OpenCL™`. This is hosted at [ROCm/clr/rocclr](https://github.com/ROCm/clr/tree/develop/rocclr)
## How to build/install
### Prerequisites
Please refer to Quick Start Guide in [ROCm Docs](https://rocm.docs.amd.com/en/latest/deploy/linux/quick_start.html).
Please refer to Quick Start Guide in [ROCm Docs](https://rocm.docs.amd.com/projects/install-on-linux/en/latest/tutorial/quick-start.html).
Building clr requires `rocm-hip-libraries` meta package, which provides the pre-requisites for clr.
### Linux
- Clone this repo
- Clone this repository
- `cd clr && mkdir build && cd build`
- For HIP : `cmake .. -DCLR_BUILD_HIP=ON -DHIP_COMMON_DIR=$HIP_COMMON_DIR`
- `HIP_COMMON_DIR` points to [HIP](https://github.com/ROCm/HIP)
@@ -29,13 +29,15 @@ Building clr requires `rocm-hip-libraries` meta package, which provides the pre-
Users can also build `OCL` and `HIP` at the same time by passing `-DCLR_BUILD_HIP=ON -DCLR_BUILD_OCL=ON` to configure command.
For detail instructions, please refer to [how to build HIP](https://github.com/ROCm/HIP/blob/develop/docs/developer_guide/build.md)
## Tests
`hip-tests` is a separate repo hosted at [hip-tests](https://github.com/ROCm/hip-tests).
`hip-tests` is a separate repository hosted at [hip-tests](https://github.com/ROCm/hip-tests).
To run `hip-tests` please go to the repo and follow the steps.
To run `hip-tests` please go to the repository and follow the steps.
There used to be directed tests in [ROCm/HIP](https://github.com/ROCm/HIP) which are now removed in favor of `hip-tests` repo.
There used to be directed tests in [ROCm/HIP](https://github.com/ROCm/HIP) which are now removed in favor of `hip-tests` repository.
## Disclaimer
+5 -11
Melihat File
@@ -13,16 +13,16 @@ The information presented in this document is for informational purposes only an
Download the git projects using the following commands:
```bash
git clone -b main https://github.com/RadeonOpenCompute/ROCm-OpenCL-Runtime.git
git clone -b develop https://github.com/ROCm/clr.git
export CLR_DIR="$(readlink -f clr)"
```
## Repository branches
The repository maintains several branches. The branches that are of importance are:
- Main branch: This is the stable branch. It is up to date with the latest release branch, for example, if the latest ROCM release is rocm-4.1, main branch will be the repository based on this release.
- Develop branch: This is the default branch, on which the new features are still under development and visible. While this maybe of interest to many, it should be noted that this branch and the features under development might not be stable.
- Release branches: These are branches corresponding to each ROCM release, listed with release tags, such as rocm-4.0, rocm-4.1, etc.
- Release branches: These are branches corresponding to each ROCM release, listed with release tags, such as rocm-6.0.x, rocm-5.7.x, etc.
## Setup OpenCL
Copy the amdocl64.icd file to /etc/OpenCL/vendors
@@ -32,19 +32,13 @@ sudo cp api/opencl/config/amdocl64.icd /etc/OpenCL/vendors/
```
## Building
Follow these steps:
- Build ROCclr first. Follow the steps in the following link to build ROCclr
[ROCclr Readme](https://github.com/ROCm-Developer-Tools/ROCclr)
In this step, $OPENCL_DIR and $ROCclr_DIR are defined.
- Building OpenCL
Run these commands:
```bash
cd "$OPENCL_DIR"
cd "$CLR_DIR"
mkdir -p build; cd build
cmake -DUSE_COMGR_LIBRARY=ON -DCMAKE_PREFIX_PATH="$ROCclr_DIR/build;/opt/rocm/" ..
cmake -DUSE_COMGR_LIBRARY=ON -DCMAKE_PREFIX_PATH="/opt/rocm/" -DCLR_BUILD_HIP=OFF -DCLR_BUILD_OCL=ON ..
make -j$(nproc)
```