NVIDIA Collective Communication Library (NCCL) Documentation
NVIDIA Collective Communication Library (NCCL) 文档 ¶

Contents:  内容：

• Overview of NCCL  NCCL 概述
• Setup
• Using NCCL  使用 NCCL
  • Creating a Communicator
    创建 Communicator
    • Creating a communicator with options
      创建带有选项的通信器
    • Creating a communicator using multiple ncclUniqueIds
      使用多个 ncclUniqueId 创建通信器
    • Creating more communicators
      创建更多通信器
    • Using multiple NCCL communicators concurrently
      使用多个 NCCL 通信器并发
    • Finalizing a communicator
      完成通信器
    • Destroying a communicator
      销毁一个通信器
  • Error handling and communicator abort
    错误处理和通信器中止
    • Asynchronous errors and error handling
      异步错误和错误处理
  • Fault Tolerance  容错
  • Collective Operations
    • AllReduce
    • Broadcast  广播
    • Reduce
    • AllGather
    • ReduceScatter
  • Data Pointers
  • CUDA Stream Semantics
    CUDA 流语义
    • Mixing Multiple Streams within the same ncclGroupStart/End() group
      在同一 ncclGroupStart/End()组内混合多个流
  • Group Calls  群组通话
    • Management Of Multiple GPUs From One Thread
      从单个线程管理多个 GPU
    • Aggregated Operations (2.2 and later)
      聚合操作（2.2 及更高版本）
    • Nonblocking Group Operation
      非阻塞组操作
  • Point-to-point communication
    点对点通信
    • Sendrecv
    • One-to-all (scatter)  一对多（散射）
    • All-to-one (gather)  All-to-one（聚集）
    • All-to-all
    • Neighbor exchange  邻居交换
  • Thread Safety  线程安全
  • In-place Operations
  • Using NCCL with CUDA Graphs
    使用 NCCL 与 CUDA Graphs
  • User Buffer Registration
    用户缓冲区注册
    • NVLink Sharp Buffer Registration
      NVLink Sharp 缓冲区注册
    • IB Sharp Buffer Registration
    • General Buffer Registration
      通用缓冲区注册
    • Memory Allocator  内存分配器
• NCCL API
  • Communicator Creation and Management Functions
    Communicator 创建和管理函数
    • 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
• Migrating from NCCL 1 to NCCL 2
  从 NCCL 1 迁移到 NCCL 2
  • Initialization  初始化
  • Communication
  • Counts  计数
  • In-place usage for AllGather and ReduceScatter
    AllGather 和 ReduceScatter 的就地使用
  • AllGather arguments order
    AllGather 参数顺序
  • Datatypes
  • Error codes  错误代码
• Examples
  • Communicator Creation and Destruction Examples
    Communicator 创建和销毁示例
    • Example 1: Single Process, Single Thread, Multiple Devices
      示例 1：单进程、单线程、多设备
    • Example 2: One Device per Process or Thread
      示例 2：每个进程或线程一个设备
    • Example 3: Multiple Devices per Thread
      示例 3：每个线程多个设备
    • Example 4: Multiple communicators per device
      示例 4：每个设备的多个通信器
  • Communication Examples  通信示例
    • Example 1: One Device per Process or Thread
      示例 1：每个进程或线程一个设备
    • Example 2: Multiple Devices per Thread
      示例 2：每个线程多个设备
• NCCL and MPI
  NCCL 和 MPI
  • API
    • Using multiple devices per process
      每个进程使用多个设备
    • ReduceScatter operation  ReduceScatter 操作
    • Send and Receive counts
      发送和接收计数
    • Other collectives and point-to-point operations
      其他集合和点对点操作
    • In-place operations  就地操作
  • Using NCCL within an MPI Program
    在 MPI 程序中使用 NCCL
    • MPI Progress  MPI 进度
    • Inter-GPU Communication with CUDA-aware MPI
• Environment Variables  环境变量
  • System configuration  系统配置
    • NCCL_SOCKET_IFNAME
      • Values accepted  接受的值
    • NCCL_SOCKET_FAMILY
      • Values accepted  接受的值
    • NCCL_SOCKET_RETRY_CNT
      • Values accepted
    • NCCL_SOCKET_RETRY_SLEEP_MSEC
      • Values accepted
    • NCCL_SOCKET_NTHREADS
      • Values accepted
    • NCCL_NSOCKS_PERTHREAD
      • Values accepted  接受的值
    • NCCL_CROSS_NIC
      • Values accepted
    • NCCL_IB_HCA
      • Values accepted  接受的值
    • NCCL_IB_TIMEOUT
      • Values accepted
    • NCCL_IB_RETRY_CNT
      • Values accepted
    • NCCL_IB_GID_INDEX
      • Values accepted
    • NCCL_IB_ADDR_FAMILY
      • Values accepted
    • NCCL_IB_ADDR_RANGE
      • Values accepted  接受的值
    • NCCL_IB_ROCE_VERSION_NUM
      • Values accepted  接受的值
    • NCCL_IB_SL
      • Values accepted  接受的值
    • NCCL_IB_TC
      • Values accepted  接受的值
    • NCCL_IB_FIFO_TC
      • Values accepted  接受的值
    • NCCL_IB_RETURN_ASYNC_EVENTS
      • Values accepted  接受的值
    • NCCL_OOB_NET_ENABLE
      • Values accepted  接受的值
    • NCCL_OOB_NET_IFNAME
      • Values accepted  接受的值
    • NCCL_UID_STAGGER_THRESHOLD
      • Values accepted  接受的值
    • NCCL_UID_STAGGER_RATE
      • Values accepted  接受的值
    • NCCL_NET
      • Values accepted  接受的值
    • NCCL_NET_PLUGIN
      • Values accepted
    • NCCL_TUNER_PLUGIN
      • Values accepted  接受的值
    • NCCL_PROFILER_PLUGIN
      • Values accepted  接受的值
    • NCCL_IGNORE_CPU_AFFINITY
      • Values accepted  接受的值
    • NCCL_CONF_FILE
      • Values accepted
    • NCCL_DEBUG
      • Values accepted  接受的值
    • NCCL_DEBUG_FILE
      • Values accepted  接受的值
    • NCCL_DEBUG_SUBSYS
      • Values accepted  接受的值
    • NCCL_COLLNET_ENABLE
      • Value accepted
    • NCCL_COLLNET_NODE_THRESHOLD
      • Value accepted  值已接受
    • NCCL_TOPO_FILE
      • Value accepted  值已接受
    • NCCL_TOPO_DUMP_FILE
      • Value accepted  值已接受
    • NCCL_SET_THREAD_NAME
      • Value accepted
  • Debugging  调试
    • NCCL_P2P_DISABLE
      • Values accepted  接受的值
    • NCCL_P2P_LEVEL
      • Values accepted
      • Integer Values (Legacy)  整数值（旧版）
    • NCCL_P2P_DIRECT_DISABLE
      • Values accepted  接受的值
    • NCCL_SHM_DISABLE
      • Values accepted  接受的值
    • NCCL_BUFFSIZE
      • Values accepted
    • NCCL_NTHREADS
      • Values accepted  接受的值
    • NCCL_MAX_NCHANNELS
      • Values accepted  接受的值
    • NCCL_MIN_NCHANNELS
      • Values accepted
    • NCCL_CHECKS_DISABLE
      • Values accepted  接受的值
    • NCCL_CHECK_POINTERS
      • Values accepted  接受的值
    • NCCL_LAUNCH_MODE
      • Values accepted  接受的值
    • NCCL_IB_DISABLE
      • Values accepted  接受的值
    • NCCL_IB_AR_THRESHOLD
      • Values accepted  接受的值
    • NCCL_IB_QPS_PER_CONNECTION
      • Values accepted  接受的值
    • NCCL_IB_SPLIT_DATA_ON_QPS
      • Values accepted  接受的值
    • NCCL_IB_CUDA_SUPPORT
      • Values accepted  接受的值
    • NCCL_IB_PCI_RELAXED_ORDERING
      • Values accepted  接受的值
    • NCCL_IB_ADAPTIVE_ROUTING
      • Values accepted  接受的值
    • NCCL_IB_ECE_ENABLE
      • Values accepted  接受的值
    • NCCL_MEM_SYNC_DOMAIN
      • Values accepted  接受的值
    • NCCL_CUMEM_ENABLE
      • Values accepted
    • NCCL_CUMEM_HOST_ENABLE
      • Values accepted
    • NCCL_NET_GDR_LEVEL (formerly NCCL_IB_GDR_LEVEL)
      NCCL_NET_GDR_LEVEL（原为 NCCL_IB_GDR_LEVEL）
      • Values accepted
      • Integer Values (Legacy)  整数值（旧版）
    • NCCL_NET_GDR_READ
      • Values accepted
    • NCCL_NET_SHARED_BUFFERS
      • Value accepted  值已接受
    • NCCL_NET_SHARED_COMMS
      • Value accepted
    • NCCL_SINGLE_RING_THRESHOLD
      • Values accepted
    • NCCL_LL_THRESHOLD
      • Values accepted
    • NCCL_TREE_THRESHOLD
      • Values accepted
    • NCCL_ALGO
      • Values accepted
    • NCCL_PROTO
      • Values accepted
    • NCCL_NVB_DISABLE
      • Value accepted
    • NCCL_PXN_DISABLE
      • Value accepted
    • NCCL_P2P_PXN_LEVEL
      • Value accepted
    • NCCL_RUNTIME_CONNECT
      • Value accepted
    • NCCL_GRAPH_REGISTER
      • Value accepted
    • NCCL_LOCAL_REGISTER
      • Value accepted
    • NCCL_LEGACY_CUDA_REGISTER
      • Value accepted
    • NCCL_SET_STACK_SIZE
      • Value accepted
    • NCCL_GRAPH_MIXING_SUPPORT
      • Value accepted
    • NCCL_DMABUF_ENABLE
      • Value accepted
    • NCCL_P2P_NET_CHUNKSIZE
      • Values accepted  接受的值
    • NCCL_P2P_LL_THRESHOLD
      • Values accepted  接受的值
    • NCCL_ALLOC_P2P_NET_LL_BUFFERS
      • Values accepted  接受的值
    • NCCL_COMM_BLOCKING
      • Values accepted  接受的值
    • NCCL_CGA_CLUSTER_SIZE
      • Values accepted  接受的值
    • NCCL_MAX_CTAS
      • Values accepted  接受的值
    • NCCL_MIN_CTAS
      • Values accepted  接受的值
    • NCCL_NVLS_ENABLE
      • Values accepted  接受的值
    • NCCL_IB_MERGE_NICS
      • Values accepted  接受的值
    • NCCL_MNNVL_ENABLE
      • Values accepted  接受的值
    • NCCL_RAS_ENABLE
      • Values accepted  接受的值
    • NCCL_RAS_ADDR
      • Values accepted  接受的值
    • NCCL_RAS_TIMEOUT_FACTOR
      • Values accepted  接受的值
• Troubleshooting  故障排除
  • Errors  错误
  • RAS
    • RAS
      • Principle of Operation  操作原理
      • RAS Queries  RAS 查询
      • Sample Output
  • GPU Direct
    • GPU-to-GPU communication
      GPU-to-GPU 通信
    • GPU-to-NIC communication
      GPU-to-NIC 通信
    • PCI Access Control Services (ACS)
      PCI 访问控制服务（ACS）
  • Topology detection  拓扑检测
  • Shared memory  共享内存
    • Docker
    • Systemd
  • Networking issues  网络问题
    • IP Network Interfaces  IP 网络接口
    • IP Ports  IP 端口
    • InfiniBand
    • RDMA over Converged Ethernet (RoCE)

Indices and tables  索引和表格 ¶

• Index
• Module Index  模块索引
• Search Page  搜索页面