image

Documentation

Index

• type CUDA
  • func NewCUDAImageFromEnv(env []string) (CUDA, error)
  • func NewCUDAImageFromSpec(spec *specs.Spec) (CUDA, error)
  • func (i CUDA) DevicesFromEnvvars(envVars ...string) VisibleDevices
  • func (i CUDA) GetDriverCapabilities() DriverCapabilities
  • func (i CUDA) GetRequirements() ([]string, error)
  • func (i CUDA) HasDisableRequire() bool
  • func (i CUDA) IsLegacy() bool
• type DriverCapabilities
  • func (c DriverCapabilities) Any(capabilities ...DriverCapability) bool
  • func (c DriverCapabilities) Has(capability DriverCapability) bool
• type DriverCapability
• type VisibleDevices
  • func NewVisibleDevices(envvars ...string) VisibleDevices

Types

type CUDA

type CUDA map[string]string

CUDA represents a CUDA image that can be used for GPU computing. This wraps a map of environment variable to values that can be used to perform lookups such as requirements.

func NewCUDAImageFromEnv

func NewCUDAImageFromEnv(env []string) (CUDA, error)

NewCUDAImageFromEnv creates a CUDA image from the input environment. The environment is a list of strings of the form ENVAR=VALUE.

func NewCUDAImageFromSpec

func NewCUDAImageFromSpec(spec *specs.Spec) (CUDA, error)

NewCUDAImageFromSpec creates a CUDA image from the input OCI runtime spec. The process environment is read (if present) to construc the CUDA Image.

func (CUDA) DevicesFromEnvvars

func (i CUDA) DevicesFromEnvvars(envVars ...string) VisibleDevices

DevicesFromEnvvars returns the devices requested by the image through environment variables

func (CUDA) GetDriverCapabilities

func (i CUDA) GetDriverCapabilities() DriverCapabilities

GetDriverCapabilities returns the requested driver capabilities.

func (CUDA) GetRequirements

func (i CUDA) GetRequirements() ([]string, error)

GetRequirements returns the requirements from all NVIDIA_REQUIRE_ environment variables.

func (CUDA) HasDisableRequire

func (i CUDA) HasDisableRequire() bool

HasDisableRequire checks for the value of the NVIDIA_DISABLE_REQUIRE. If set to a valid (true) boolean value this can be used to disable the requirement checks

func (CUDA) IsLegacy

func (i CUDA) IsLegacy() bool

IsLegacy returns whether the associated CUDA image is a "legacy" image. An image is considered legacy if it has a CUDA_VERSION environment variable defined and no NVIDIA_REQUIRE_CUDA environment variable defined.

type DriverCapabilities

type DriverCapabilities map[DriverCapability]bool

DriverCapabilities represents the NVIDIA_DRIVER_CAPABILITIES set for the specified image.

func (DriverCapabilities) Any

func (c DriverCapabilities) Any(capabilities ...DriverCapability) bool

Any checks whether any of the specified capabilites are set

func (DriverCapabilities) Has

func (c DriverCapabilities) Has(capability DriverCapability) bool

Has check whether the specified capability is selected.

type DriverCapability

type DriverCapability string

DriverCapability represents the possible values of NVIDIA_DRIVER_CAPABILITIES

const (
	DriverCapabilityAll      DriverCapability = "all"
	DriverCapabilityCompat32 DriverCapability = "compat32"
	DriverCapabilityCompute  DriverCapability = "compute"
	DriverCapabilityDisplay  DriverCapability = "display"
	DriverCapabilityGraphics DriverCapability = "graphics"
	DriverCapabilityNgx      DriverCapability = "ngx"
	DriverCapabilityUtility  DriverCapability = "utility"
	DriverCapabilityVideo    DriverCapability = "video"
)

Constants for the supported driver capabilities

type VisibleDevices

type VisibleDevices interface {
	List() []string
	Has(string) bool
}

VisibleDevices represents the devices selected in a container image through the NVIDIA_VISIBLE_DEVICES or other environment variables

func NewVisibleDevices

func NewVisibleDevices(envvars ...string) VisibleDevices

NewVisibleDevices creates a VisibleDevices based on the value of the specified envvar.