docs / rig / api
library module about rig Rig Devices such as GPUs, and the order of the work they run. rig.amd Rig_amd The driver of AMD GPUs. rig.amd.abi Rig_amd_abi The bytes an AMD GPU shares with its driver and with compiled code, as values. rig.amd.amdgpu Rig_amd_amdgpu The path that opens AMD GPUs through Linux's amdgpu kernel driver. rig.amd.pci Rig_amd_pci The path that drives AMD GPUs over PCI, with no kernel driver. rig.bnxt Rig_bnxt Broadcom NetXtreme RoCE NICs, driven over PCI with no kernel driver. rig.cuda Rig_cuda NVIDIA GPUs, driven through the CUDA library. rig.cuda.abi Rig_cuda_abi What compiled code needs from a CUDA device. rig.disk Rig_disk Files as an io device. rig.edge Rig_edge The contract between rig and the drivers that run its devices. rig.edge Rig_edge_primitives The OCaml primitives of rig_edge.h: the host's clock, rig's array of timeline words, the count of the locks a thread holds and its signal mask, which rig, its drivers and their C share. rig.elf Rig_elf ELF objects laid out in one image. rig.gpus Rig_gpus The GPUs of this machine. rig.metal Rig_metal The Mac's GPU, driven through Apple's Metal framework. rig.metal.abi Rig_metal_abi What compiled code needs from a Metal device. rig.mlx5 Rig_mlx5 ConnectX NICs of this machine, opened through Linux's RDMA subsystem. rig.mlx5.abi Rig_mlx5_abi ConnectX NICs' formats, as values. rig.nv Rig_nv The driver of NVIDIA GPUs. rig.nv.abi Rig_nv_abi NVIDIA GPUs' formats, as values. rig.nv.nvidia Rig_nv_nvidia NVIDIA GPUs of this machine, opened through NVIDIA's kernel driver. rig.nv.pci Rig_nv_pci NVIDIA GPUs driven over PCI, with no kernel driver. rig.pci Rig_pci GPUs driven through their PCI function. rig.pool Rig_pool rig.program Rig_program Programs of steps on one machine's devices, as data that loads once and runs many times. rig.remote Rig_remote Jobs, in which one process uses the devices of other machines through an agent on each. rig.remote.abi Rig_remote_abi What compiled code needs from another machine's devices. rig.remote.proxy Rig_remote_proxy Proxies: devices of another machine, driven through its agent.