API Enumerations

API Enumerations#

Rocprofiler SDK Developer API: API Enumerations

Rocprofiler SDK Developer API 0.5.0

ROCm Profiling API and tools

Enumerations used by collective communication calls. More...

Enumerations
enum	ncclRedOp_dummy_t { ncclNumOps_dummy = 5 }
	Dummy reduction enumeration. More...

enum	ncclRedOp_t { ncclSum = 0 , ncclProd = 1 , ncclMax = 2 , ncclMin = 3 , ncclAvg = 4 , ncclNumOps = 5 , ncclMaxRedOp }
	Reduction operation selector. More...

enum	ncclDataType_t { ncclInt8 = 0 , ncclChar = 0 , ncclUint8 = 1 , ncclInt32 = 2 , ncclInt = 2 , ncclUint32 = 3 , ncclInt64 = 4 , ncclUint64 = 5 , ncclFloat16 = 6 , ncclHalf = 6 , ncclFloat32 = 7 , ncclFloat = 7 , ncclFloat64 = 8 , ncclDouble = 8 , ncclBfloat16 = 9 , ncclFp8E4M3 = 10 , ncclFp8E5M2 = 11 , ncclNumTypes = 12 }
	Data types. More...

Detailed Description

Enumerations used by collective communication calls.

Enumeration Type Documentation

◆ ncclDataType_t

enum ncclDataType_t

Data types.

Enumeration of the various supported datatype

Enumerator
ncclInt8
ncclChar
ncclUint8
ncclInt32
ncclInt
ncclUint32
ncclInt64
ncclUint64
ncclFloat16
ncclHalf
ncclFloat32
ncclFloat
ncclFloat64
ncclDouble
ncclBfloat16
ncclFp8E4M3
ncclFp8E5M2
ncclNumTypes

Definition at line 430 of file rccl.h.

{
    ncclInt8     = 0,
    ncclChar     = 0,
    ncclUint8    = 1,
    ncclInt32    = 2,
    ncclInt      = 2,
    ncclUint32   = 3,
    ncclInt64    = 4,
    ncclUint64   = 5,
    ncclFloat16  = 6,
    ncclHalf     = 6,
    ncclFloat32  = 7,
    ncclFloat    = 7,
    ncclFloat64  = 8,
    ncclDouble   = 8,
    ncclBfloat16 = 9,
#if defined(RCCL_FLOAT8)
    ncclFp8E4M3  = 10,
    ncclFp8E5M2  = 11,
    ncclNumTypes = 12
} ncclDataType_t;

◆ ncclRedOp_dummy_t

enum ncclRedOp_dummy_t

Dummy reduction enumeration.

Dummy reduction enumeration used to determine value for ncclMaxRedOp

Enumerator
ncclNumOps_dummy

Definition at line 401 of file rccl.h.

{
    ncclNumOps_dummy = 5
} ncclRedOp_dummy_t;

◆ ncclRedOp_t

enum ncclRedOp_t

Reduction operation selector.

Enumeration used to specify the various reduction operations ncclNumOps is the number of built-in ncclRedOp_t values and serves as the least possible value for dynamic ncclRedOp_t values constructed by ncclRedOpCreate functions.

ncclMaxRedOp is the largest valid value for ncclRedOp_t and is defined to be the largest signed value (since compilers are permitted to use signed enums) that won't grow sizeof(ncclRedOp_t) when compared to previous RCCL versions to maintain ABI compatibility.

Enumerator
ncclSum	Sum
ncclProd	Product
ncclMax	Max
ncclMin	Min
ncclAvg	Average
ncclNumOps	Number of built-in reduction ops
ncclMaxRedOp	Largest value for ncclRedOp_t

Definition at line 416 of file rccl.h.

{
    ncclSum    = 0, /*!< Sum */
    ncclProd   = 1, /*!< Product */
    ncclMax    = 2, /*!< Max */
    ncclMin    = 3, /*!< Min */
    ncclAvg    = 4, /*!< Average */
    ncclNumOps = 5, /*!< Number of built-in reduction ops */
    ncclMaxRedOp =
        0x7fffffff >> (32 - 8 * sizeof(ncclRedOp_dummy_t)) /*!< Largest value for ncclRedOp_t */
} ncclRedOp_t;