-
Notifications
You must be signed in to change notification settings - Fork 271
Re-fresh releases docs #653
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.
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
Merged
Merged
Changes from 2 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
50c82e9
Replace outdated link
marbre 0bdf48e
Add section on Python packages
marbre 37d8934
Formatting
marbre d5af89b
Update RELEASES.md
marbre 79f5f79
Update RELEASES.md
marbre f42027b
Update RELEASES.md
marbre dba50ae
Update RELEASES.md
marbre 954daf1
Update RELEASES.md
marbre b5277b2
Revise section on Python packages
marbre File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| # Releases | ||
|
|
||
| This is a quick overview of how to consume our current build and release [artifacts](docs/development/artifacts.md). | ||
| This is a quick overview of how to consume our current build, release [artifacts](docs/development/artifacts.md) and Python packages. | ||
|
|
||
| ## Current state | ||
|
|
||
|
|
@@ -24,7 +24,7 @@ popd | |
|
|
||
| ### From per-commit CI builds | ||
|
|
||
| Our CI builds artifacts need to be flattened to be used. Leverage the `build_tools/fileset_tool.py artifact-flatten` command. You will need to have a [checkout](README.md#Checkout-Sources) in ${SOURCE_DIR} to leverage this tool and a Python environment. | ||
| Our CI builds artifacts need to be flattened to be used. Leverage the `build_tools/fileset_tool.py artifact-flatten` command. You will need to have a checkout (see for example [Clone and fetch sources](https://github.com/ROCm/TheRock/blob/main/docs/development/windows_support.md#clone-and-fetch-sources)) in ${SOURCE_DIR} to leverage this tool and a Python environment. | ||
|
marbre marked this conversation as resolved.
Outdated
|
||
|
|
||
| ```bash | ||
| echo "Unpacking artifacts" | ||
|
|
@@ -80,3 +80,47 @@ popd | |
| - [Packages](https://github.com/orgs/ROCm/packages?repo_name=TheRock): We currently publish docker images for LLVM targets we support (as well as a container for our build machines) | ||
|
|
||
| - [Per-commit CI builds](https://github.com/ROCm/TheRock/actions/workflows/ci.yml?query=branch%3Amain+is%3Asuccess): Each of our latest passing CI builds has its own artifacts you can leverage. This is the latest and greatest! We will eventually support a nightly release that is at a higher quality bar than CI. Note a quick recipe for getting all of these from the s3 bucket is to use this quick command `aws s3 cp s3://therock-artifacts . --recursive --exclude "*" --include "${RUN_ID}-${OPERATING_SYSTEM}/*.tar.xz" --no-sign-request` where ${RUN_ID} is the runner id you selected (see the URL). Check the [AWS docs](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) to get the aws cli. | ||
|
|
||
| ## Using our Python packages | ||
|
|
||
| The Python packages contain pre-build libraries and tools but do not provide Python APIs for import or usage. Rather, pip is leveraged as a convient way to install the pre-build libraries and tools. For now, Python packages are only supported on Linux. | ||
|
marbre marked this conversation as resolved.
Outdated
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What you have now for python package information is a good start, but I think we can get the message across more clearly with some renaming and restructuring.
|
||
|
|
||
| > [!TIP] | ||
| > We highly recommend to create an virtual environment | ||
|
marbre marked this conversation as resolved.
Outdated
|
||
| > ```bash | ||
| > python -m venv .venv | ||
| > source .venv/bin/activate | ||
| > ``` | ||
|
|
||
| > [!WARNING] | ||
| > If installing the Python packages by passing `--break-system-packages` to `pip`, commandline interface shims for executables get installed to `/usr/local/bin` which normally has precende over `/usr/bin` and might therefore conflict with a previous installation of ROCm. | ||
|
marbre marked this conversation as resolved.
Outdated
|
||
|
|
||
| In dependence of the respective GPU architecture the URL to the appropirate index file must be passed to install the respective packages. | ||
| On of the following commands can be used to install `rocm-sdk[libraries,devel]`. | ||
|
|
||
| ### gfx942-dcgpu | ||
|
|
||
| ```bash | ||
| python -m pip install --find-links https://therock-nightly-python.s3.us-east-2.amazonaws.com/gfx94X-dcgpu/index.html \ | ||
| rocm-sdk[libraries,devel] | ||
| ``` | ||
|
marbre marked this conversation as resolved.
Outdated
|
||
|
|
||
| ### gfx110X-dcgpu | ||
|
|
||
| ```bash | ||
| python -m pip install --find-links https://therock-nightly-python.s3.us-east-2.amazonaws.com/gfx110X-dcgpu/index.html \ | ||
| rocm-sdk[libraries,devel] | ||
| ``` | ||
|
|
||
| ### gfx110X-dcgpu | ||
|
|
||
| ```bash | ||
| python -m pip install --find-links https://therock-nightly-python.s3.us-east-2.amazonaws.com/gfx1151/index.html \ | ||
| rocm-sdk[libraries,devel] | ||
| ``` | ||
| ### gfx110X-dcgpu | ||
|
|
||
| ```bash | ||
| python -m pip install --find-links https://therock-nightly-python.s3.us-east-2.amazonaws.com/gfx120X-all/index.html \ | ||
| rocm-sdk[libraries,devel] | ||
| ``` | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.