General Types¶

Note

Many of these types are simply aliases for a corresponding gRPC protobuf type.

You can find all of those type definitions on the Beaker docs site and access them directly from Python through the beaker.beaker_pb2 module. For example:

>>> import beaker.beaker_pb2 as pb2
>>> image = pb2.Image(id=beaker_image_id)

BeakerJob¶: A type alias for the auto-generated protobuf Job type.

BeakerJobLog¶: A type alias for the auto-generated protobuf JobLog type.

BeakerSummarizedJobEvent¶: A type alias for the auto-generated protobuf SummarizedJobEvent type.

BeakerWorkload¶: A type alias for the auto-generated protobuf Workload type.

BeakerExperiment¶: A type alias for the auto-generated protobuf Experiment type.

BeakerTask¶: A type alias for the auto-generated protobuf Task type.

BeakerImage¶: A type alias for the auto-generated protobuf Image type.

BeakerCluster¶: A type alias for the auto-generated protobuf Cluster type.

BeakerNode¶: A type alias for the auto-generated protobuf Node type.

BeakerDataset¶: A type alias for the auto-generated protobuf Dataset type.

BeakerDatasetFile¶: A type alias for the auto-generated protobuf DatasetFile type.

BeakerGroup¶: A type alias for the auto-generated protobuf Group type.

BeakerSecret¶: A type alias for the auto-generated protobuf Secret type.

BeakerOrganization¶: A type alias for the auto-generated protobuf Organization type.

BeakerUser¶: A type alias for the auto-generated protobuf User type.

BeakerEnvironment¶: A type alias for the auto-generated protobuf Environment type.

BeakerWorkspace¶: A type alias for the auto-generated protobuf Workspace type.

BeakerQueue¶: A type alias for the auto-generated protobuf Queue type.

BeakerQueueWorker¶: A type alias for the auto-generated protobuf QueueWorker type.

BeakerQueueEntry¶: A type alias for the auto-generated protobuf QueueEntry type.

class BeakerSortOrder(value)[source]¶

Defines the sort order for list operations.

descending = 1¶

ascending = 2¶

class BeakerAuthRole(value)[source]¶

An enumeration of the corresponding auto-generated protobuf AuthRole values.

deactivated = 1¶

scientist = 2¶

system = 3¶

admin = 4¶

class BeakerJobPriority(value)[source]¶

An enumeration of the corresponding auto-generated protobuf JobPriority values.

low = 1¶

normal = 2¶

high = 3¶

urgent = 4¶

class BeakerWorkloadType(value)[source]¶

An enumeration of the corresponding auto-generated protobuf WorkloadType values.

experiment = 1¶

environment = 2¶

class BeakerWorkloadStatus(value)[source]¶

An enumeration of the corresponding auto-generated protobuf WorkloadStatus values.

submitted = 1¶

queued = 2¶

initializing = 3¶

running = 4¶

stopping = 5¶

uploading_results = 6¶

canceled = 7¶

succeeded = 8¶

failed = 9¶

ready_to_start = 10¶

class BeakerDatasetFileAlgorithmType(value)[source]¶

An enumeration of the corresponding auto-generated protobuf DatasetFile algorithm type values.

SHA256 = 1¶

CRC32C = 2¶

hasher()[source]¶: Get a hasher object for the given algorithm.

class BeakerCancelationCode(value)[source]¶

An enumeration of the corresponding auto-generated protobuf CancelationCode values.

system_preemption = 1¶

user_preemption = 2¶

idle = 3¶

manual = 4¶

timeout = 5¶

node_unavailable = 6¶

impossible_to_schedule = 7¶

sibling_task_failed = 8¶

sibling_task_preemption = 9¶

healthcheck_failed = 10¶

sibling_task_retry = 11¶

class BeakerGpuType(value)[source]¶

An enumeration of the corresponding auto-generated protobuf GpuType values.

NVIDIA_H100 = 1¶

NVIDIA_A100_80GB = 2¶

NVIDIA_A100_40GB = 3¶

NVIDIA_L4 = 4¶

NVIDIA_RTX_A5000 = 5¶

NVIDIA_RTX_A6000 = 6¶

NVIDIA_RTX_8000 = 7¶

NVIDIA_T4 = 8¶

NVIDIA_P100 = 10¶

NVIDIA_P4 = 11¶

NVIDIA_V100 = 12¶

NVIDIA_L40 = 13¶

NVIDIA_L40S = 14¶

NVIDIA_B200 = 15¶

class BeakerQueueEntryState(value)[source]¶

An enumeration of the corresponding auto-generated protobuf QueueEntryState values.

pending = 1¶

claimed = 2¶

canceled = 3¶

completed = 4¶

rejected = 5¶

failed = 6¶