github ↗
docs menu

API reference

  • rigRigDevices such as GPUs, and the order of the work they run.
  • rig.amdRig_amdThe driver of AMD GPUs.
  • rig.amd.abiRig_amd_abiThe bytes an AMD GPU shares with its driver and with compiled code, as values.
  • rig.amd.amdgpuRig_amd_amdgpuThe path that opens AMD GPUs through Linux's amdgpu kernel driver.
  • rig.amd.pciRig_amd_pciThe path that drives AMD GPUs over PCI, with no kernel driver.
  • rig.bnxtRig_bnxtBroadcom NetXtreme RoCE NICs, driven over PCI with no kernel driver.
  • rig.cudaRig_cudaNVIDIA GPUs, driven through the CUDA library.
  • rig.cuda.abiRig_cuda_abiWhat compiled code needs from a CUDA device.
  • rig.diskRig_diskFiles as an io device.
  • rig.edgeRig_edgeThe contract between rig and the drivers that run its devices.
  • rig.edgeRig_edge_primitivesThe 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.elfRig_elfELF objects laid out in one image.
  • rig.gpusRig_gpusThe GPUs of this machine.
  • rig.metalRig_metalThe Mac's GPU, driven through Apple's Metal framework.
  • rig.metal.abiRig_metal_abiWhat compiled code needs from a Metal device.
  • rig.mlx5Rig_mlx5ConnectX NICs of this machine, opened through Linux's RDMA subsystem.
  • rig.mlx5.abiRig_mlx5_abiConnectX NICs' formats, as values.
  • rig.nvRig_nvThe driver of NVIDIA GPUs.
  • rig.nv.abiRig_nv_abiNVIDIA GPUs' formats, as values.
  • rig.nv.nvidiaRig_nv_nvidiaNVIDIA GPUs of this machine, opened through NVIDIA's kernel driver.
  • rig.nv.pciRig_nv_pciNVIDIA GPUs driven over PCI, with no kernel driver.
  • rig.pciRig_pciGPUs driven through their PCI function.
  • rig.poolRig_pool
  • rig.programRig_programPrograms of steps on one machine's devices, as data that loads once and runs many times.
  • rig.remoteRig_remoteJobs, in which one process uses the devices of other machines through an agent on each.
  • rig.remote.abiRig_remote_abiWhat compiled code needs from another machine's devices.
  • rig.remote.proxyRig_remote_proxyProxies: devices of another machine, driven through its agent.