From 33c8706aecbf41ae3d3b79d265daf513461395fc Mon Sep 17 00:00:00 2001 From: Bartlomiej Wroblewski Date: Fri, 5 Jan 2024 18:36:02 +0100 Subject: [PATCH] Update the recommended version of ROCm in docs (#1110) --- docs/dockerhub.rst | 6 ++++-- docs/tutorial_hello_world.rst | 23 +++++++++++++++++++++-- 2 files changed, 25 insertions(+), 4 deletions(-) diff --git a/docs/dockerhub.rst b/docs/dockerhub.rst index fb89bef72b..49fea868a7 100644 --- a/docs/dockerhub.rst +++ b/docs/dockerhub.rst @@ -85,9 +85,11 @@ Where: To start a container from the image, use the ``docker start`` command:: - docker start +Let's take a look at the image naming, for example ``ck_ub20.04_rocm6.0``. The image specs are: -Then use the docker exec command as shown above to start the bash shell. +* ``ck`` - made for running Composable Kernel; +* ``ub20.04`` - based on Ubuntu 20.04; +* ``rocm6.0`` - ROCm platform version 6.0. Use the ``docker stop`` command to stop the container and restore the image to its initial state:: diff --git a/docs/tutorial_hello_world.rst b/docs/tutorial_hello_world.rst index d89331e579..8a16c80052 100644 --- a/docs/tutorial_hello_world.rst +++ b/docs/tutorial_hello_world.rst @@ -58,9 +58,28 @@ This tutorial is based on the use of docker images as explained in :ref:`docker- .. note:: - You can also `install ROCm `_ on your system, clone the `Composable Kernel repository `_ on GitHub, and use that to build and run the examples using the commands described below. +To make our lives easier we prepared +`docker images `_ with all the necessary +dependencies. Pick the right image and create a container. In this tutorial we use +``rocm/composable_kernel:ck_ub20.04_rocm6.0`` image, it is based on Ubuntu 20.04 and +ROCm v6.0. -Both the docker container and GitHub repository include the Composable Kernel library. Navigate to the library:: +If your current folder is ``${HOME}``, start the docker container with:: + + docker run \ + -it \ + --privileged \ + --group-add sudo \ + -w /root/workspace \ + -v ${HOME}:/root/workspace \ + rocm/composable_kernel:ck_ub20.04_rocm6.0 \ + /bin/bash + +If your current folder is different from ``${HOME}``, adjust the line ``-v ${HOME}:/root/workspace`` +to fit your folder structure. + +Inside the docker container current folder is ``~/workspace``, library path is +``~/workspace/composable_kernel``, navigate to the library:: cd composable_kernel/