NCCL API

The following sections describe the NCCL methods and operations.

• Communicator Creation and Management Functions
  • ncclGetLastError
  • ncclGetErrorString
  • ncclGetVersion
  • ncclGetUniqueId
  • ncclCommInitRank
  • ncclCommInitAll
  • ncclCommInitRankConfig
  • ncclCommInitRankScalable
  • ncclCommSplit
  • ncclCommFinalize
  • ncclCommDestroy
  • ncclCommAbort
  • ncclCommGetAsyncError
  • ncclCommCount
  • ncclCommCuDevice
  • ncclCommUserRank
  • ncclCommRegister
  • ncclCommDeregister
  • ncclMemAlloc
  • ncclMemFree
• Collective Communication Functions
  • ncclAllReduce
  • ncclBroadcast
  • ncclReduce
  • ncclAllGather
  • ncclReduceScatter
• Group Calls
  • ncclGroupStart
  • ncclGroupEnd
  • ncclGroupSimulateEnd
• Point To Point Communication Functions
  • ncclSend
  • ncclRecv
• Types
  • ncclComm_t
  • ncclResult_t
  • ncclDataType_t
  • ncclRedOp_t
  • ncclScalarResidence_t
  • ncclConfig_t
  • ncclSimInfo_t
• User Defined Reduction Operators
  • ncclRedOpCreatePreMulSum
  • ncclRedOpDestroy