|
| 1 | +# Grid Docker Build Instructions |
| 2 | + |
| 3 | + |
| 4 | +## Inputs |
| 5 | +Possible `build-arg` for the Docker build command |
| 6 | + |
| 7 | +- ## IMAGE |
| 8 | + Default: `rocm/dev-ubuntu-22.04:5.6-complete` |
| 9 | + Docker Tags found: |
| 10 | + - [ROCm Ubuntu 22.04](https://hub.docker.com/r/rocm/dev-ubuntu-22.04) |
| 11 | + - [ROCm Ubuntu 20.04](https://hub.docker.com/r/rocm/dev-ubuntu-20.04) |
| 12 | + > ***Note:*** |
| 13 | + > The `*-complete` version has all the components required for building and installation. |
| 14 | +
|
| 15 | +- ## UCX_BRANCH |
| 16 | + Default: `v1.14.1` |
| 17 | + Branch/Tag found: [UXC repo](https://github.com/openucx/ucx) |
| 18 | + |
| 19 | +- ## OMPI_BRANCH |
| 20 | + Default: `v4.1.5` |
| 21 | + Branch/Tag found: [OpenMPI repo](https://github.com/open-mpi/ompi) |
| 22 | + |
| 23 | +- ## GRID_BRANCH |
| 24 | + Default: `develop` |
| 25 | + Branch/Tag found: [Grid repo](https://github.com/paboyle/Grid) |
| 26 | + |
| 27 | + |
| 28 | +## Building Container |
| 29 | +Download the [Dockerfile related files](/grid/docker/). |
| 30 | + |
| 31 | +To build the default configuration: |
| 32 | +``` |
| 33 | +docker build -t mycontainer/grid -f /path/to/Dockerfile . |
| 34 | +``` |
| 35 | +> Notes: |
| 36 | +>- `mycontainer` is an example container name. |
| 37 | +>- the `.` at the end of the build line is important. It tells Docker where your build context is located. |
| 38 | +>- `-f /path/to/Dockerfile` is only required if your docker file is in a different directory than your build context, if you are building in the same directory it is not required. |
| 39 | +
|
| 40 | +To run a custom configuration, include one or more customized build-arg |
| 41 | + |
| 42 | +*DISCLAIMER:* This Docker build has only been validated using the default values. Using a different base image or branch may result in build failures or poor performance. |
| 43 | + |
| 44 | +``` |
| 45 | +docker build \ |
| 46 | + -t mycontainer/grid \ |
| 47 | + -f /path/to/Dockerfile \ |
| 48 | + --build-arg IMAGE=rocm/dev-ubuntu-22.04:5.5-complete \ |
| 49 | + --build-arg UCX_BRANCH=master \ |
| 50 | + --build-arg OMPI_BRANCH=main |
| 51 | + . |
| 52 | +``` |
| 53 | + |
| 54 | +## Running a Grid Container |
| 55 | +Both Docker and Singularity can be run interactively or as a single command. |
| 56 | + |
| 57 | +To run the [Grid Benchmarks](/grid/README.md#running-grid-benchmarks), replace the `<Grid Command>` the examples in [Running Grid Benchmarks](/grid/README.md#running-grid-benchmarks) section of the Grid readme. The commands can be run directly in an interactive session as well. |
| 58 | + |
| 59 | +### Docker |
| 60 | +If you want to save files generated during the run, add `-v $(pwd):/host` before `mycontainer/grid` in the following commands. Files may then be copied or saved between the container /host directory and the users working directory. |
| 61 | + |
| 62 | +#### Docker Interactive |
| 63 | +``` |
| 64 | +docker run --rm -it --device=/dev/kfd --device=/dev/dri --security-opt seccomp=unconfined \ |
| 65 | + mycontainer/grid /bin/bash |
| 66 | +``` |
| 67 | +#### Docker Non-Interactive |
| 68 | +``` |
| 69 | +docker run --rm -it --device=/dev/kfd --device=/dev/dri --security-opt seccomp=unconfined \ |
| 70 | + mycontainer/grid <Grid Command> |
| 71 | +``` |
| 72 | + |
| 73 | +### Singularity |
| 74 | +If you want to save files generated during the run, add `--binf $(pwd):/host` before `mycontainer/grid` in the following commands. Files may then be copied or saved between the container /host directory and the users working directory. |
| 75 | +#### Build Singularity image from Docker |
| 76 | +To build a Singularity image from the locally created docker file do the following: |
| 77 | +``` |
| 78 | +singularity build grid.sif docker-daemon://mycontainer/grid:latest |
| 79 | +``` |
| 80 | + |
| 81 | +#### Singularity Interactive |
| 82 | +To launch a Singularity image build locally. |
| 83 | +``` |
| 84 | +singularity shell --no-home --writable-tmpfs --pwd /benchmark grid.sif |
| 85 | +``` |
| 86 | + |
| 87 | +#### Singularity Non-Interactive |
| 88 | +To launch a Singularity image build locally. |
| 89 | +``` |
| 90 | +singularity run --no-home --writable-tmpfs -pwd /benchmark grid.sif <Grid Command> |
| 91 | +``` |
| 92 | + |
| 93 | +## Licensing Information |
| 94 | +Your access and use of this application is subject to the terms of the applicable component-level license identified below. To the extent any subcomponent in this container requires an offer for corresponding source code, AMD hereby makes such an offer for corresponding source code form, which will be made available upon request. By accessing and using this application, you are agreeing to fully comply with the terms of this license. If you do not agree to the terms of this license, do not access or use this application. |
| 95 | + |
| 96 | +The application is provided in a container image format that includes the following separate and independent components: |
| 97 | +|Package | License | URL| |
| 98 | +|---|---|---| |
| 99 | +|Ubuntu| Creative Commons CC-BY-SA Version 3.0 UK License |[Ubuntu Legal](https://ubuntu.com/legal)| |
| 100 | +|CMAKE|OSI-approved BSD-3 clause|[CMake License](https://cmake.org/licensing/)| |
| 101 | +|OpenMPI|BSD 3-Clause|[OpenMPI License](https://www-lb.open-mpi.org/community/license.php)<br /> [OpenMPI Dependencies Licenses](https://docs.open-mpi.org/en/v5.0.x/license/index.html)| |
| 102 | +|OpenUCX|BSD 3-Clause|[OpenUCX License](https://openucx.org/license/)| |
| 103 | +|ROCm|Custom/MIT/Apache V2.0/UIUC OSL|[ROCm Licensing Terms](https://rocm.docs.amd.com/en/latest/release/licensing.html)| |
| 104 | +|Grid|GPL V2|[Grid](https://github.com/paboyle/Grid)<br >[Grid License](https://github.com/paboyle/Grid/blob/develop/LICENSE)| |
| 105 | + |
| 106 | +Additional third-party content in this container may be subject to additional licenses and restrictions. The components are licensed to you directly by the party that owns the content pursuant to the license terms included with such content and is not licensed to you by AMD. ALL THIRD-PARTY CONTENT IS MADE AVAILABLE BY AMD “AS IS” WITHOUT A WARRANTY OF ANY KIND. USE OF SUCH THIRD-PARTY CONTENT IS DONE AT YOUR SOLE DISCRETION AND UNDER NO CIRCUMSTANCES WILL AMD BE LIABLE TO YOU FOR ANY THIRD-PARTY CONTENT. YOU ASSUME ALL RISK AND ARE SOLELY RESPONSIBLE FOR ANY DAMAGES THAT MAY ARISE FROM YOUR USE OF THIRD-PARTY CONTENT. |
| 107 | + |
| 108 | +## Disclaimer |
| 109 | +The information contained herein is for informational purposes only, and is subject to change without notice. In addition, any stated support is planned and is also subject to change. While every precaution has been taken in the preparation of this document, it may contain technical inaccuracies, omissions and typographical errors, and AMD is under no obligation to update or otherwise correct this information. Advanced Micro Devices, Inc. makes no representations or warranties with respect to the accuracy or completeness of the contents of this document, and assumes no liability of any kind, including the implied warranties of noninfringement, merchantability or fitness for particular purposes, with respect to the operation or use of AMD hardware, software or other products described herein. No license, including implied or arising by estoppel, to any intellectual property rights is granted by this document. Terms and limitations applicable to the purchase or use of AMD’s products are as set forth in a signed agreement between the parties or in AMD's Standard Terms and Conditions of Sale. |
| 110 | + |
| 111 | +## Notices and Attribution |
| 112 | +© 2022-2023 Advanced Micro Devices, Inc. All rights reserved. AMD, the AMD Arrow logo, Instinct, Radeon Instinct, ROCm, and combinations thereof are trademarks of Advanced Micro Devices, Inc. |
| 113 | + |
| 114 | +Docker and the Docker logo are trademarks or registered trademarks of Docker, Inc. in the United States and/or other countries. Docker, Inc. and other parties may also have trademark rights in other terms used herein. Linux® is the registered trademark of Linus Torvalds in the U.S. and other countries. |
| 115 | + |
| 116 | +All other trademarks and copyrights are property of their respective owners and are only mentioned for informative purposes. |
0 commit comments