Initial ROCm-docs (#92)
* Initial ROCm-docs commit Co-authored-by: Aurélien Bouteiller <bouteill@icl.utk.edu> Co-authored-by: Alex Xu <alex.xu@amd.com> Co-authored-by: yugang-amd <yugang.wang@amd.com>
Bu işleme şunda yer alıyor:
@@ -0,0 +1,90 @@
|
||||
.. meta::
|
||||
:description: rocSHMEM intra-kernel networking runtime for AMD dGPUs on the ROCm platform.
|
||||
:keywords: rocSHMEM, API, ROCm, documentation, HIP, Networking, Communication
|
||||
|
||||
.. _rocshmem-api-teams:
|
||||
|
||||
-------------------------
|
||||
Team Management Routines
|
||||
-------------------------
|
||||
|
||||
ROCSHMEM_TEAM_MY_PE
|
||||
-------------------
|
||||
|
||||
.. cpp:function:: __host__ int rocshmem_team_my_pe(rocshmem_team_t team)
|
||||
|
||||
:param team: The team to query
|
||||
:returns: PE ID of the caller in the provided team
|
||||
|
||||
**Description:**
|
||||
Query the PE ID of the caller in a team.
|
||||
|
||||
ROCSHMEM_TEAM_N_PES
|
||||
-------------------
|
||||
|
||||
.. cpp:function:: __host__ int rocshmem_team_n_pes(rocshmem_team_t team)
|
||||
|
||||
:param team: The team to query
|
||||
:returns: Number of PEs in the provided team
|
||||
|
||||
**Description:**
|
||||
Query the number of PEs in a team.
|
||||
|
||||
ROCSHMEM_TEAM_TRANSLATE_PE
|
||||
--------------------------
|
||||
|
||||
.. cpp:function:: __host__ int rocshmem_team_translate_pe(rocshmem_team_t src_team, int src_pe, rocshmem_team_t dest_team)
|
||||
|
||||
:param src_team: Handle of the team from which to translate
|
||||
:param src_pe: PE-of-interest's index in src_team
|
||||
:param dest_team: Handle of the team to which to translate
|
||||
:returns: PE of src_pe in dest_team;
|
||||
If any input is invalid or if src_pe is
|
||||
not in both source and destination teams, a value of -1 is returned
|
||||
|
||||
**Description:**
|
||||
Translate the PE in src_team to that in dest_team.
|
||||
|
||||
ROCSHMEM_TEAM_SPLIT_STRIDED
|
||||
---------------------------
|
||||
|
||||
.. cpp:function:: __host__ int rocshmem_team_split_strided(rocshmem_team_t parent_team, int start, int stride, int size, const rocshmem_team_config_t *config, long config_mask, rocshmem_team_t *new_team)
|
||||
|
||||
:param parent_team: The team to split from
|
||||
:param start: The lowest PE number of the subset of the PEs
|
||||
from the parent team that will form the new
|
||||
team
|
||||
:param stride: The stride between team PE members in the
|
||||
parent team that comprise the subset of PEs
|
||||
that will form the new team
|
||||
:param size: The number of PEs in the new team
|
||||
:param config: Pointer to the config parameters for the new team
|
||||
:param config_mask: Bitwise mask representing parameters to use from config
|
||||
:param new_team: Pointer to the newly created team;
|
||||
If an error occurs during team creation, or if the PE in
|
||||
the parent team is not in the new team, the value will be
|
||||
ROCSHMEM_TEAM_INVALID
|
||||
|
||||
:returns: Zero upon successful team creation; non-zero if erroneous
|
||||
|
||||
**Description:**
|
||||
Create a new a team of PEs. Must be called by all PEs in the parent team.
|
||||
|
||||
ROCSHMEM_TEAM_DESTROY
|
||||
---------------------
|
||||
|
||||
.. cpp:function:: __host__ void rocshmem_team_destroy(rocshmem_team_t team)
|
||||
|
||||
:param team: The team to destroy; The behavior is undefined if
|
||||
the input team is ROCSHMEM_TEAM_WORLD or any other
|
||||
invalid team; If the input is ROCSHMEM_TEAM_INVALID,
|
||||
this function will not perform any operation
|
||||
|
||||
:returns: None
|
||||
|
||||
**Description:**
|
||||
Destroy a team. Must be called by all PEs in the team.
|
||||
The user must destroy all private contexts created in the
|
||||
team before destroying this team. Otherwise, the behavior
|
||||
is undefined. This call will destroy only the shareable contexts
|
||||
created from the referenced team.
|
||||
Yeni konuda referans
Bir kullanıcı engelle