Updated ROCm-docs to match the current status of the repository (#117)
* Updated docs to match the current status of the repository Co-authored-by: yugang-amd <yugang.wang@amd.com>
This commit is contained in:
@@ -53,6 +53,45 @@ This routine finalizes device-side rocSHMEM resources.
|
||||
It must be called before work-group completion if the work-group also called ``rocshmem_wg_init``.
|
||||
It must be called collectively by all threads in the work-group.
|
||||
|
||||
ROCSHMEM_INIT_ATTR
|
||||
------------------
|
||||
.. cpp:function:: __host__ int rocshmem_init_attr(unsigned int flags, rocshmem_init_attr_t *attr)
|
||||
|
||||
:param flags: The initialization method to be used.
|
||||
:param attr: Attribute structure specifying input characteristics.
|
||||
|
||||
:returns int: Returns ``0`` on success; otherwise, returns a nonzero value.
|
||||
|
||||
**Description:**
|
||||
This routine initializes the rocSHMEM runtime and underlying transport layer using
|
||||
the provided mode and attributes.
|
||||
The parameter ``flags`` can be either
|
||||
``ROCSHMEM_INIT_WITH_UNIQUEID`` or ``ROCSHMEM_INIT_WITH_MPI_COMM``.
|
||||
|
||||
ROCSHMEM_GET_UNIQUEID
|
||||
---------------------
|
||||
.. cpp:function:: __host__ int rocshmem_get_uniqueid(rocshmem_uniqueid_t *uid)
|
||||
|
||||
:param uid: Pointer to a unique ID handle.
|
||||
:returns: Returns ``0`` on success; otherwise, returns a nonzero value.
|
||||
|
||||
**Description:**
|
||||
This routine returns a unique ID.
|
||||
|
||||
ROCSHMEM_SET_ATTR_UNIQUEID_ARGS
|
||||
-------------------------------
|
||||
.. cpp:function:: __host__ int rocshmem_set_attr_uniqueid_args(int rank, int nranks, rocshmem_uniqueid_t *uid, rocshmem_init_attr_t *attr)
|
||||
|
||||
:param rank: Rank of the calling process.
|
||||
:param nranks: Number of PEs.
|
||||
:param uid: Unique ID used to identify the group processes.
|
||||
:param attr: Attribute structure to be passed to ``rocshmem_init_attr_t``.
|
||||
|
||||
:returns: Returns ``0`` on success; otherwise, returns a nonzero value.
|
||||
|
||||
**Description:**
|
||||
This routine initializes the ``rocshmem_init_attr_t`` struct.
|
||||
|
||||
ROCSHMEM_N_PES
|
||||
--------------
|
||||
|
||||
|
||||
Reference in New Issue
Block a user