API Enumerations

API Enumerations#

Rocprofiler SDK Developer API: API Enumerations
Rocprofiler SDK Developer API 0.5.0
ROCm Profiling API and tools
API Enumerations

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

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 428 of file rccl.h.

429{
430 ncclInt8 = 0,
431 ncclChar = 0,
432 ncclUint8 = 1,
433 ncclInt32 = 2,
434 ncclInt = 2,
435 ncclUint32 = 3,
436 ncclInt64 = 4,
437 ncclUint64 = 5,
438 ncclFloat16 = 6,
439 ncclHalf = 6,
440 ncclFloat32 = 7,
441 ncclFloat = 7,
442 ncclFloat64 = 8,
443 ncclDouble = 8,
444 ncclBfloat16 = 9,
445#if defined(RCCL_FLOAT8)
446 ncclFp8E4M3 = 10,
447 ncclFp8E5M2 = 11,
448 ncclNumTypes = 12
ncclDataType_t
Data types.
Definition rccl.h:429
@ ncclFloat64
Definition rccl.h:442
@ ncclHalf
Definition rccl.h:439
@ ncclInt32
Definition rccl.h:433
@ ncclFp8E5M2
Definition rccl.h:447
@ ncclFp8E4M3
Definition rccl.h:446
@ ncclNumTypes
Definition rccl.h:448
@ ncclUint32
Definition rccl.h:435
@ ncclInt8
Definition rccl.h:430
@ ncclDouble
Definition rccl.h:443
@ ncclFloat32
Definition rccl.h:440
@ ncclBfloat16
Definition rccl.h:444
@ ncclFloat
Definition rccl.h:441
@ ncclChar
Definition rccl.h:431
@ ncclInt
Definition rccl.h:434
@ ncclUint64
Definition rccl.h:437
@ ncclUint8
Definition rccl.h:432
@ ncclInt64
Definition rccl.h:436
@ ncclFloat16
Definition rccl.h:438

◆ ncclRedOp_dummy_t

Dummy reduction enumeration.

Dummy reduction enumeration used to determine value for ncclMaxRedOp

Enumerator
ncclNumOps_dummy 

Definition at line 399 of file rccl.h.

400{
ncclRedOp_dummy_t
Dummy reduction enumeration.
Definition rccl.h:400
@ ncclNumOps_dummy
Definition rccl.h:401

◆ 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 414 of file rccl.h.

415{
416 ncclSum = 0, /*!< Sum */
417 ncclProd = 1, /*!< Product */
418 ncclMax = 2, /*!< Max */
419 ncclMin = 3, /*!< Min */
420 ncclAvg = 4, /*!< Average */
421 ncclNumOps = 5, /*!< Number of built-in reduction ops */
423 0x7fffffff >> (32 - 8 * sizeof(ncclRedOp_dummy_t)) /*!< Largest value for ncclRedOp_t */
ncclRedOp_t
Reduction operation selector.
Definition rccl.h:415
@ ncclMin
Definition rccl.h:419
@ ncclNumOps
Definition rccl.h:421
@ ncclSum
Definition rccl.h:416
@ ncclMaxRedOp
Definition rccl.h:422
@ ncclProd
Definition rccl.h:417
@ ncclMax
Definition rccl.h:418
@ ncclAvg
Definition rccl.h:420