derek.holloway
7502bf64a4
CodeQL / Analyze (actions) (push) Canceled after 0s
CodeQL / Analyze (python) (push) Canceled after 0s
pre-commit / pre-commit (push) Canceled after 0s
Multi-Arch CI / setup (push) Canceled after 0s
Publish build_manylinux_x86_64 images / publish_build_manylinux_x86_64 (push) Canceled after 0s
Setup (Multi-Arch) / setup (push) Canceled after 0s
Multi-Arch CI / Linux::${{ fromJSON(needs.setup.outputs.linux_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubi10 image / publish_no_rocm_image_ubi10 (push) Canceled after 0s
Multi-Arch CI / Windows::${{ fromJSON(needs.setup.outputs.windows_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Multi-Arch CI / Manifest Diff (push) Canceled after 0s
TheRock Manifest Diff Report / Generate Manifest Diff Report (push) Canceled after 0s
Multi-Arch CI / CI Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_ocl_rt images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_rocgdb images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Unit Tests / Unit Tests :: ubuntu-24.04 (push) Canceled after 0s
Unit Tests / Unit Tests :: windows-2022 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_media (push) Canceled after 0s
Unit Tests / Unit Tests Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_openmpi (push) Canceled after 0s
52 lines
2.1 KiB
ReStructuredText
52 lines
2.1 KiB
ReStructuredText
.. meta::
|
|
:description: rocSHMEM is a runtime that provides GPU-centric networking through an OpenSHMEM-like interface.
|
|
:keywords: rocSHMEM, ROCm, OpenSHMEM, library, API, IPC, RO
|
|
|
|
****************************
|
|
rocSHMEM documentation
|
|
****************************
|
|
|
|
The ROCm OpenSHMEM (rocSHMEM) is an intra-kernel networking library that provides GPU-centric networking through an OpenSHMEM-like interface. It simplifies application code complexity and enables finer communication and computation overlap than traditional host-driven networking. rocSHMEM uses a single symmetric heap allocated to GPU memories. For more information, see :doc:`introduction`.
|
|
|
|
The rocSHMEM public repository is located within the ROCm Systems Super Repo at `<https://github.com/ROCm/rocm-systems/tree/develop/projects/rocshmem>`_.
|
|
|
|
.. grid:: 2
|
|
:gutter: 3
|
|
|
|
.. grid-item-card:: Install
|
|
|
|
* :doc:`Install rocSHMEM <./install>`
|
|
* :doc:`Build from source <./build>`
|
|
|
|
.. grid-item-card:: How to
|
|
|
|
* :doc:`Compile and run applications <./compile_and_run>`
|
|
* :doc:`Using the Docker container <./docker>`
|
|
|
|
.. grid-item-card:: Library constants
|
|
|
|
* :doc:`Library constants <./library_constants>`
|
|
|
|
.. grid-item-card:: Environment variables
|
|
|
|
* :doc:`Environment variables <./env_variables>`
|
|
|
|
.. grid-item-card:: API reference
|
|
|
|
* :doc:`Library setup, exit, and query routines <./api/init>`
|
|
* :doc:`Memory management routines <./api/memory_management>`
|
|
* :doc:`Team management routines <./api/teams>`
|
|
* :doc:`Context management routines <./api/ctx>`
|
|
* :doc:`Remote memory access routines <./api/rma>`
|
|
* :doc:`Atomic memory operations <./api/amo>`
|
|
* :doc:`Signaling operations <./api/sigops>`
|
|
* :doc:`Collective routines <./api/coll>`
|
|
* :doc:`Point-to-point synchronization routines <./api/pt2pt_sync>`
|
|
* :doc:`Memory ordering routines <./api/memory_ordering>`
|
|
|
|
To contribute to the documentation, refer to
|
|
`Contributing to ROCm <https://rocm.docs.amd.com/en/latest/contribute/contributing.html>`_.
|
|
|
|
You can find licensing information on the
|
|
`Licensing <https://rocm.docs.amd.com/en/latest/about/license.html>`_ page.
|