diff --git a/.wordlist.txt b/.wordlist.txt index 226ff9f8..807d8847 100644 --- a/.wordlist.txt +++ b/.wordlist.txt @@ -56,7 +56,6 @@ SMCi SRIOV SVM SuperMicro -Taichi tbody td thead diff --git a/docs/how-to/docker.rst b/docs/how-to/docker.rst index c69fa4a1..4f138343 100644 --- a/docs/how-to/docker.rst +++ b/docs/how-to/docker.rst @@ -19,7 +19,7 @@ Prerequisites * `Check for amdgpu-dkms `_ * If you don't have ``amdgpu-dkms``, follow the :ref:`standard install instructions` - (which comes with ``amdgpu-dkms``) or :ref:`install amdgpu-dkms only`. + (which comes with ``amdgpu-dkms``) or `install amdgpu-dkms separately `__. .. seealso:: diff --git a/docs/index.rst b/docs/index.rst index f0843e9d..1fac7bbb 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -33,7 +33,6 @@ This section describes the ROCm for Linux installation options. * :doc:`Stanford Megatron-LM ` * :doc:`DGL ` * :doc:`Megablocks ` - * :doc:`Taichi ` diff --git a/docs/install/3rd-party/dgl-install.rst b/docs/install/3rd-party/dgl-install.rst index b0e8ad04..e0dbad7d 100644 --- a/docs/install/3rd-party/dgl-install.rst +++ b/docs/install/3rd-party/dgl-install.rst @@ -208,6 +208,7 @@ Build your own Docker image --build-arg ARG_GPU_BUILD_TARGETS="gfx90a,gfx942" \ -f Dockerfile.rocm \ . + Test the DGL installation ================================================================================ diff --git a/docs/install/3rd-party/taichi-install.rst b/docs/install/3rd-party/taichi-install.rst deleted file mode 100644 index 9616883f..00000000 --- a/docs/install/3rd-party/taichi-install.rst +++ /dev/null @@ -1,202 +0,0 @@ -.. meta:: - :description: Install Taichi on ROCm - :keywords: installation, docker, Taichi, AMD, ROCm - -******************************************************************************** -Taichi on ROCm -******************************************************************************** - -`Taichi `_ is an open-source, imperative, and parallel -programming language designed for high-performance numerical computation. -Embedded in Python, it leverages just-in-time (JIT) compilation frameworks such as LLVM to accelerate -compute-intensive Python code by compiling it to native GPU or CPU instructions. - -For hardware, software, and third-party framework compatibility between ROCm and Taichi, -see the following resources: - -* :ref:`system-requirements` -* :doc:`rocm:compatibility/ml-compatibility/taichi-compatibility` - -.. note:: - - Taichi is supported on ROCm 6.3.2. - -Install Taichi -================================================================================ - -To install Taichi on ROCm, you have the following options: - -- :ref:`Use the prebuilt Docker image ` **(recommended)** -- :ref:`Use a wheels package ` -- :ref:`Build your own docker image ` - -.. _using-docker-with-taichi-pre-installed: - -Use a prebuilt Docker image with Taichi pre-installed --------------------------------------------------------------------------------- - -Docker is the recommended method to set up a Taichi environment, and it avoids potential installation issues. -The tested, prebuilt image includes Taichi, Python, ROCm, and other dependencies. - -1. Pull the Docker image - - .. code-block:: bash - - docker pull rocm/taichi:taichi-1.8.0b1_rocm6.3.2_ubuntu22.04_py3.10.12 - -2. Launch and connect to the container - - .. code-block:: bash - - docker run -it -d --network=host --device=/dev/kfd --device=/dev/dri --ipc=host --shm-size 64G \ - --group-add video --cap-add=SYS_PTRACE --security-opt seccomp=unconfined -v $(pwd):/taichi_dir \ - --name rocm_taichi rocm/taichi:taichi-1.8.0b1_rocm6.3.2_ubuntu22.04_py3.10.12 - -.. _taichi-wheels-package: - -Use a wheels package --------------------------------------------------------------------------------- - -The Taichi ``.whl`` packages are hosted on the AMD PyPI repository. -Instead of manually downloading the files, you can simply install Taichi using ``pip`` with the provided URL. -This command will automatically download and install the appropriate ``.whl`` file. - -.. code-block:: bash - - pip install amd-taichi==1.8.0b1 --extra-index-url=https://pypi.amd.com/simple - sudo apt-get update - sudo apt-get install -y lld - -.. _build-taichi-rocm-docker-image: - -Build your own Docker image --------------------------------------------------------------------------------- - -If you prefer to use the ROCm Ubuntu image, or already have a ROCm Ubuntu container, follow these steps to install Taichi in the container. - -1. Pull the ROCm Ubuntu Docker image - - .. code-block:: bash - - docker pull rocm/dev-ubuntu-22.04:6.3.2 - -2. Launch the Docker container - - .. code-block:: bash - - docker run -it -d --network=host --device=/dev/kfd --device=/dev/dri --ipc=host --shm-size 64G \ - --group-add video --cap-add=SYS_PTRACE --security-opt seccomp=unconfined -v $(pwd):/taichi_dir \ - --name rocm_taichi rocm/dev-ubuntu-22.04:6.3.2 /bin/bash - -3. Inside the running container, install build dependencies - - .. code-block:: bash - - sudo apt-get update && apt-get install -y --no-install-recommends \ - git wget vim \ - freeglut3-dev libglfw3-dev libglm-dev libglu1-mesa-dev \ - libjpeg-dev liblz4-dev libpng-dev libssl-dev \ - libwayland-dev libx11-xcb-dev libxcb-dri3-dev libxcb-ewmh-dev \ - libxcb-keysyms1-dev libxcb-randr0-dev libxcursor-dev libxi-dev \ - libxinerama-dev libxrandr-dev libzstd-dev \ - python3-pip cmake pybind11-dev ca-certificates \ - llvm-15 clang-15 lld-15 \ - && apt-get clean && rm -rf /var/lib/apt/lists/* - -4. Add LLVM 15 to PATH - - .. code-block:: bash - - export LLVM_DIR=/usr/lib/llvm-15 - export PATH=${LLVM_DIR}/bin:$PATH - -5. Clone the `https://github.com/ROCm/taichi `_ repository with the desired branch - - .. code-block:: bash - - cd - git clone --recursive https://github.com/ROCm/taichi -b amd-release/v1.8.0b1 - cd taichi - -6. Build the Taichi wheel - - .. code-block:: bash - - export GPU_TARGETS=gfx90a - export TAICHI_CMAKE_ARGS="-DTI_WITH_VULKAN=OFF -DTI_WITH_OPENGL=OFF -DTI_BUILD_TESTS=ON -DTI_BUILD_EXAMPLES=OFF -DCMAKE_PREFIX_PATH=${LLVM_DIR}/lib/cmake -DCMAKE_CXX_COMPILER=${LLVM_DIR}/bin/clang++ -DTI_WITH_AMDGPU=ON -DTI_WITH_CUDA=OFF -DTI_AMDGPU_ARCHS=${GPU_TARGETS}" - - ./build.py - -7. Install the Taichi ``.whl`` file - - .. code-block:: bash - - pip3 install /dist/taichi*.whl - - -.. _build-taichi-docker-from-source: - -Test the Taichi installation -================================================================================ - -Clone the `https://github.com/ROCm/taichi `_ repository - - .. code-block:: bash - - sudo apt-get update - sudo apt-get install -y git - git clone --recursive https://github.com/ROCm/taichi -b amd-release/v1.8.0b1 - -To test the Taichi installation, run the ``laplace`` example in the source code: - -.. code-block:: bash - - python3 taichi/python/taichi/examples/algorithm/laplace.py - - -``laplace`` example output: - -.. code-block:: bash - - [Taichi] version 1.8.0, llvm 15.0.0, commit f7911653, linux, python 3.10.12 - [Taichi] Starting on arch=amdgpu - 0.0 - 4.0 - 0.0 - 0.0 - 4.0 - 0.0 - 0.0 - 4.0 - 0.0 - 0.0 - - -Run a Taichi example -================================================================================ - -Several examples have been collected in the `https://github.com/ROCm/taichi_examples `_ repository. -This repository contains a Dockerfile for building a container and installing Taichi. It contains a ``README.md`` file that guides the building of the container using the Dockerfile and running the examples. - -1. Clone the repository: - - .. code-block:: bash - - git clone https://github.com/ROCm/taichi_examples.git - -2. If you have Taichi installed in your environment, you do not need to build an additional container. Simply install the example dependencies: - - .. code-block:: bash - - pip3 install pillow - pip3 install --no-cache-dir torch --index-url https://download.pytorch.org/whl/nightly/rocm6.3/ - -3. Run the examples scripts from the ``taichi_examples`` directory: - - .. code-block:: bash - - cd taichi_examples - ./run_demos.sh - ./run_algorithm_graph_examples.sh - -Refer to the `AMD ROCm blog `_ to search for Taichi examples and best practices to optimize your workflows on AMD GPUs. diff --git a/docs/install/rocm-offline-installer.rst b/docs/install/rocm-offline-installer.rst index 72221c1f..dbdc9b2b 100644 --- a/docs/install/rocm-offline-installer.rst +++ b/docs/install/rocm-offline-installer.rst @@ -297,7 +297,7 @@ components are integrated into the resulting installer. .. note:: To reference the meta package equivalents and descriptions for each of the legacy ROCm component use cases, - see the :doc:`ROCm runtime and developer packages list <./install-methods/includes/meta-package-table>`. + see the :doc:`ROCm runtime and developer packages list <../reference/package-manager-integration>`. .. _driver-options-label: diff --git a/docs/sphinx/_toc.yml.in b/docs/sphinx/_toc.yml.in index ae2615f8..1d5829c0 100644 --- a/docs/sphinx/_toc.yml.in +++ b/docs/sphinx/_toc.yml.in @@ -72,8 +72,6 @@ subtrees: title: DGL - file: install/3rd-party/megablocks-install title: Megablocks - - file: install/3rd-party/taichi-install - title: Taichi - caption: How to entries: