Skip to content
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 46 additions & 2 deletions RELEASES.md
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.
Comment thread
marbre marked this conversation as resolved.
Outdated

## Current state

Expand All @@ -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.
Comment thread
marbre marked this conversation as resolved.
Outdated

```bash
echo "Unpacking artifacts"
Expand Down Expand Up @@ -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.
Comment thread
marbre marked this conversation as resolved.
Outdated

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The 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.

  • Rather than frame this as "using our python packages", how about "Installing TheRock using pip"? That way, we lead with "installing TheRock" or "installing ROCm" and pip/Python is a detail.
  • We can clarify that the packages do not come with Python APIs, just distributed prebuilt native tools, after explaining the primary function.
  • With that new framing, the tip about installing into a virtual environment has more meaning. Virtual environments can be swapped between and activated/deactivated at will. You can also have multiple virtual environments present on a system at a time.
  • Similarly, the warning about --break-system-packages and /usr/local/bin/ could be flipped to a "if you want a system-wide install, do this instead".


> [!TIP]
> We highly recommend to create an virtual environment
Comment thread
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.
Comment thread
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]
```
Comment thread
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]
```
Loading