From 3083f87838deb832739fbc9b8b8e6a537d55f04b Mon Sep 17 00:00:00 2001 From: spolifroni-amd Date: Wed, 20 Nov 2024 20:07:24 -0500 Subject: [PATCH] removed unused files and reorganized the index and toc. (#3638) --- docs/index.rst | 8 +-- docs/install/build_and_install_with_cmake.rst | 62 ------------------- .../install/build_and_install_with_docker.rst | 52 ---------------- .../install/build_and_install_with_rbuild.rst | 32 ---------- docs/sphinx/_toc.yml.in | 2 +- 5 files changed, 5 insertions(+), 151 deletions(-) delete mode 100644 docs/install/build_and_install_with_cmake.rst delete mode 100644 docs/install/build_and_install_with_docker.rst delete mode 100644 docs/install/build_and_install_with_rbuild.rst diff --git a/docs/index.rst b/docs/index.rst index 8ec6956816a..55403e64ba7 100755 --- a/docs/index.rst +++ b/docs/index.rst @@ -25,9 +25,10 @@ The MIGraphX public repository is located at `https://github.com/ROCm/AMDMIGraph .. grid-item-card:: Install - * :doc:`Installing MIGraphX <./install/installing_with_package>` + * :doc:`Installing MIGraphX with the package installer <./install/installing_with_package>` + * :doc:`Building and installing MIGraphX from source code <./install/building_migraphx>` - .. grid-item-card:: Using the MIGraphX API + .. grid-item-card:: Reference * :ref:`cpp-api-reference` * :ref:`python-api-reference` @@ -35,11 +36,10 @@ The MIGraphX public repository is located at `https://github.com/ROCm/AMDMIGraph .. grid-item-card:: Contributing to the MIGraphX code base - * :doc:`Building MIGraphX <./install/building_migraphx>` * :doc:`Developing for MIGraphX <./dev/contributing-to-migraphx>` To contribute to the documentation refer to -`Contribute to ROCm documentation `_. +`Contributing to ROCm `_. Licensing information can be found on the `Licensing `_ page. diff --git a/docs/install/build_and_install_with_cmake.rst b/docs/install/build_and_install_with_cmake.rst deleted file mode 100644 index 0c34f31f642..00000000000 --- a/docs/install/build_and_install_with_cmake.rst +++ /dev/null @@ -1,62 +0,0 @@ -.. meta:: - :description: Build and install MIGraphX using CMake - :keywords: build, install, MIGraphX, AMD, ROCm, CMake - -******************************************************************** -Build and install MIGraphX using CMake -******************************************************************** - -ROCm must be installed before installing MIGraphX. See `ROCm installation for Linux `_ for information on how to install ROCm on Linux. - -.. note:: - - This method for building MIGraphX requires using ``sudo``. - - -1. Install the dependencies: - - .. code:: shell - - sudo rbuild build -d depend -B build -DGPU_TARGETS=$(/opt/rocm/bin/rocminfo | grep -o -m1 'gfx.*') - - .. note:: - - If ``rbuild`` is not installed on your system, install it with: - - .. code:: shell - - pip3 install --prefix /usr/local https://github.com/RadeonOpenCompute/rbuild/archive/master.tar.gz - -2. Create a build directory and change directory to it: - - .. code:: shell - - mkdir build - cd build - -3. Configure CMake: - - .. code:: shell - - CXX=/opt/rocm/llvm/bin/clang++ cmake .. -DGPU_TARGETS=$(/opt/rocm/bin/rocminfo | grep -o -m1 'gfx.*') - -4. Build MIGraphX source code: - - .. code:: shell - - make -j$(nproc) - - - You can verify this using: - - .. code:: shell - - make -j$(nproc) check - - -5. Install MIGraphX libraries: - - .. code:: shell - - make install - \ No newline at end of file diff --git a/docs/install/build_and_install_with_docker.rst b/docs/install/build_and_install_with_docker.rst deleted file mode 100644 index 95057d3dfe0..00000000000 --- a/docs/install/build_and_install_with_docker.rst +++ /dev/null @@ -1,52 +0,0 @@ -.. meta:: - :description: Installing MIGraphX using Docker - :keywords: install, MIGraphX, AMD, ROCm, Docker - -******************************************************************** -Installing MIGraphX using Docker -******************************************************************** - -ROCm must be installed before installing MIGraphX. See `ROCm installation for Linux `_ for information on how to install ROCm on Linux. - -.. note:: - - Docker commands are run using ``sudo``. - -1. Build the Docker image. This command will install all the prerequisites required to install MIGraphX. Ensure that you are running this in the same directory as ``Dockerfile``. - - .. code:: shell - - sudo docker build -t migraphx . - - -2. Create and run the container. Once this command is run, you will be in the ``/code/AMDMIGraphX`` directory of a pseudo-tty. - - .. code:: shell - - sudo docker run --device='/dev/kfd' --device='/dev/dri' -v=`pwd`:/code/AMDMIGraphX -w /code/AMDMIGraphX --group-add video -it migraphx - -3. In the ``/code/AMDMIGraphX``, create a ``build`` directory, then change directory to ``/code/AMDMIGraphX/build``: - - .. code:: shell - - mkdir build - cd build - - -4. Configure CMake: - - .. code:: shell - - CXX=/opt/rocm/llvm/bin/clang++ cmake .. -DGPU_TARGETS=$(/opt/rocm/bin/rocminfo | grep -o -m1 'gfx.*') - -4. Build the MIGraphX libraries: - - .. code:: shell - - make -j$(nproc) - -5. Install the libraries: - - .. code:: shell - - make install \ No newline at end of file diff --git a/docs/install/build_and_install_with_rbuild.rst b/docs/install/build_and_install_with_rbuild.rst deleted file mode 100644 index 3e962244940..00000000000 --- a/docs/install/build_and_install_with_rbuild.rst +++ /dev/null @@ -1,32 +0,0 @@ -.. meta:: - :description: Build and install MIGraphX using rbuild - :keywords: build, install, MIGraphX, AMD, ROCm, rbuild - -******************************************************************** -Build and install MIGraphX using rbuild -******************************************************************** - -ROCm must be installed before installing MIGraphX. See `ROCm installation for Linux `_ for information on how to install ROCm on Linux. - -.. note:: - - This method for building MIGraphX requires using ``sudo``. - -1. Install `rocm-cmake`, `pip3`, `rocblas`, and `miopen-hip`: - - .. code:: shell - - sudo apt install -y rocm-cmake python3-pip rocblas miopen-hip - -2. Install `rbuild `_: - - .. code:: shell - - pip3 install --prefix /usr/local https://github.com/RadeonOpenCompute/rbuild/archive/master.tar.gz - - -3. Build MIGraphX source code: - - .. code:: shell - - sudo rbuild build -d depend -B build -DGPU_TARGETS=$(/opt/rocm/bin/rocminfo | grep -o -m1 'gfx.*') diff --git a/docs/sphinx/_toc.yml.in b/docs/sphinx/_toc.yml.in index 88b1383424f..bab661618f7 100644 --- a/docs/sphinx/_toc.yml.in +++ b/docs/sphinx/_toc.yml.in @@ -6,6 +6,7 @@ subtrees: - caption: Installation entries: - file: install/installing_with_package + - file: install/building_migraphx - caption: Reference entries: @@ -18,7 +19,6 @@ subtrees: - caption: Developing for MIGraphX entries: - - file: install/building_migraphx - file: dev/contributing-to-migraphx subtrees: - entries: