You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+11-9
Original file line number
Diff line number
Diff line change
@@ -31,24 +31,27 @@ Install ROCm in the default directory under `/opt` following the [ROCm documenta
31
31
## Versioning Scheme
32
32
33
33
The crates in this repository follow the versioning conventions outlined below:
34
-
- The default supported ROCm version of the crates is used as the base version.
35
-
- The patch version of the ROCm release is multiplied by 1000, allowing multiple revisions of a crate that defaults to the same ROCm version.
34
+
- The latest supported ROCm version of the crates is used as the base version.
35
+
- The patch version of the ROCm release is multiplied by 1000, allowing multiple revisions of a crate for the same ROCm version.
36
36
37
37
### Example:
38
38
39
-
The `cubecl-hip-sys` version `6.2.4000` represents the first release with ROCm `6.2.4` as the default.
40
-
If a fix is required and the default ROCm version remains `6.2.4`, the `cubecl-hip-sys` version is incremented to `6.2.4001`.
39
+
The `cubecl-hip-sys` version `6.2.4000` represents the first release with ROCm `6.2.4`.
40
+
If a fix is required and the ROCm version remains `6.2.4`, the `cubecl-hip-sys` version is incremented to `6.2.4001`.
41
41
42
42
## Usage
43
43
44
-
Add the crate [cubecl-hip-sys][2] to the `Cargo.toml` of your project and enable the feature
44
+
Add the crate [cubecl-hip-sys][2] to the `Cargo.toml`file of your project and enable the feature
45
45
corresponding to the version of ROCm you have installed.
46
46
47
+
If no feature is provided then the build script will attempt to find the default ROCm version installed on your system.
48
+
Read the `warning` messages in the build output to learn about the script behavior.
49
+
47
50
```toml
48
51
cubecl-hip-sys = { version = "6.3.1000", features = ["rocm__6_3_1"] }
49
52
```
50
53
51
-
If no feature corresponds to your ROCm installation then read the next section to learn
54
+
If you installed a newer ROCm version that is not yet supported by this crate then read the next section to learn
52
55
how to generate and submit new bindings for your version.
53
56
54
57
Next you need to point out where you installed ROCm so that `rustc` can link to your ROCM libraries. To do so set the variable `ROCM_PATH`, or `HIP_PATH` or the more specific `CUBECL_ROCM_PATH` to its
@@ -75,11 +78,10 @@ Here is a table of the libraries covered by each crate:
75
78
To run tests you need to first meet the expectations for both `Prerequisites` and `Usage`
76
79
sections.
77
80
78
-
Then execute the following xtask command. If you want to test against a different version of
79
-
ROCm than the default one, use the `-v <version>`, for instance `-v 6.2.2`:
81
+
Then execute the following xtask command by providing the version of ROCm to test, for instance `-v 6.2.2`:
80
82
81
83
```sh
82
-
# test default ROCm bindings
84
+
# test ROCm bindings againt the system default ROCm installation if found
0 commit comments