Commit 662596cb authored by randyh62's avatar randyh62 Committed by Sam Wu
Browse files

doc reorg and edits (#1112)



* doc reorg and edits

* Update wrapper.rst with changes from PR #1098

* Update docs/dockerhub.rst
Co-authored-by: default avatarBartlomiej Wroblewski <bwroblewski10@gmail.com>

* Update docs/index.rst
Co-authored-by: default avatarBartlomiej Wroblewski <bwroblewski10@gmail.com>

* Update docs/what-is-ck.rst
Co-authored-by: default avatarBartlomiej Wroblewski <bwroblewski10@gmail.com>

* Update docs/what-is-ck.rst

Restored to 4 bullets, with additional text for wrapper.
Co-authored-by: default avatarBartlomiej Wroblewski <bwroblewski10@gmail.com>

* Update docs/Contributors_Guide.rst
Co-authored-by: default avatarLisa <lisajdelaney@gmail.com>

* Update API_Reference_Guide.rst

using sentence case for title

* updated index structure per Lisa

* separate docker hub and tutorial

---------
Co-authored-by: default avatarBartlomiej Wroblewski <bwroblewski10@gmail.com>
Co-authored-by: default avatarLisa <lisajdelaney@gmail.com>
Co-authored-by: default avatarIllia Silin <98187287+illsilin@users.noreply.github.com>
parent 33c8706a
...@@ -85,11 +85,9 @@ Where: ...@@ -85,11 +85,9 @@ Where:
To start a container from the image, use the ``docker start`` command:: To start a container from the image, use the ``docker start`` command::
Let's take a look at the image naming, for example ``ck_ub20.04_rocm6.0``. The image specs are: docker start <container_name>
* ``ck`` - made for running Composable Kernel; Then use the docker exec command as shown above to start the bash shell.
* ``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:: Use the ``docker stop`` command to stop the container and restore the image to its initial state::
......
...@@ -58,28 +58,9 @@ This tutorial is based on the use of docker images as explained in :ref:`docker- ...@@ -58,28 +58,9 @@ This tutorial is based on the use of docker images as explained in :ref:`docker-
.. note:: .. note::
To make our lives easier we prepared You can also `install ROCm <https://rocm.docs.amd.com/projects/install-on-linux/en/latest/>`_ on your system, clone the `Composable Kernel repository <https://github.com/ROCmSoftwarePlatform/composable_kernel.git>`_ on GitHub, and use that to build and run the examples using the commands described below.
`docker images <https://hub.docker.com/r/rocm/composable_kernel>`_ with all the necessary
dependencies. Pick the right image and create a container. In this tutorial we use Both the docker container and GitHub repository include the Composable Kernel library. Navigate to the library::
``rocm/composable_kernel:ck_ub20.04_rocm6.0`` image, it is based on Ubuntu 20.04 and
ROCm v6.0.
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/ cd composable_kernel/
......
...@@ -18,7 +18,8 @@ Description ...@@ -18,7 +18,8 @@ Description
The CK library provides a lightweight wrapper for more complex operations implemented in The CK library provides a lightweight wrapper for more complex operations implemented in
the library. the library. It allows indexing of nested layouts using a simple interface
(avoiding complex descriptor transformations) and memory access (using Tensor).
Example: Example:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment