Skip to navigation

Systems

View as Markdown

This chapter lists all the systems supported by CloudAI. The attributes shown for each system can be set in TOML configuration files.

SystemScheduler Value
Slurmslurm
Kuberneteskubernetes
RunAIrunai
LSFlsf
Standalonestandalone

Slurm

SlurmSystem

Represents a Slurm system.

FieldTypeDefaultDescription
namestrRequired
schedulerstr'slurm'
install_pathpathlib.PathRequired
output_pathpathlib.PathRequired
hf_home_pathpathlib.PathFactory: System.<lambda>
global_env_varsdict[str, typing.Any]Factory: dict
monitor_intervalfloat60.0
soldict[str, list[cloudai.metrics.SOLTarget]]Factory: dict
default_partitionstrRequired
partitionsList[cloudai.systems.slurm.slurm_system.SlurmPartition]Required
accountstr | NoneNone
distributionstr | NoneNone
mpistr'pmix'
gpus_per_nodeint | NoneNone
ntasks_per_nodeint | NoneNone
cache_docker_images_locallyboolFalse
docker_image_import_extra_sbatch_argslist[str]Factory: list
extra_srun_argsstr | NoneNone
extra_sbatch_argslist[str]Factory: list
extra_transient_status_errorslist[str]Factory: list
status_retry_pause_secondsint10Constraints: Ge(ge=0).
container_mount_homeboolFalse
slurm_apicloudai.systems.slurm.slurm_rest_client.SlurmAPIConfig | NoneNone
data_repositorycloudai.systems.slurm.slurm_system.DataRepositoryConfig | NoneNone
reportsdict[str, cloudai.models.scenario.ReportConfig] | NoneNone

SlurmPartition

Represents a partition within a Slurm system.

FieldTypeDefaultDescription
namestrRequired
groupsList[cloudai.systems.slurm.slurm_system.SlurmGroup][]

SlurmGroup

Represents a group of nodes within a partition.

FieldTypeDefaultDescription
namestrRequired
nodesList[str]Required

DataRepositoryConfig

Configuration for a data repository.

FieldTypeDefaultDescription
endpointstrRequired
verify_certsboolTrue

Kubernetes

KubernetesSystem

Represents a Kubernetes system.

FieldTypeDefaultDescription
namestrRequired
schedulerstr'kubernetes'
install_pathpathlib.PathRequired
output_pathpathlib.PathRequired
hf_home_pathpathlib.PathFactory: System.<lambda>
global_env_varsdict[str, typing.Any]Factory: dict
monitor_intervalfloat1.0
soldict[str, list[cloudai.metrics.SOLTarget]]Factory: dict
kube_config_pathpathlib.PathRequired
default_namespacestrRequired
gpus_per_nodeint1
use_host_networkbool | NoneNone

RunAI

RunAISystem

RunAISystem integrates with the RunAI platform to manage and monitor jobs and nodes.

FieldTypeDefaultDescription
namestrRequired
schedulerstr'runai'
install_pathpathlib.PathRequired
output_pathpathlib.PathRequired
hf_home_pathpathlib.PathFactory: System.<lambda>
global_env_varsdict[str, typing.Any]Factory: dict
monitor_intervalfloat60.0
soldict[str, list[cloudai.metrics.SOLTarget]]Factory: dict
base_urlstrRequired
verify_certsboolTrue
user_emailstrRequired
app_idstrRequired
app_secretstrRequired
project_idstrRequired
cluster_idstrRequired

RunAINode

Represent a node in the RunAI cluster.

FieldTypeDefaultDescription
statuscloudai.systems.runai.runai_node.NodeStatus<NodeStatus.UNKNOWN: 'Unknown'>Alias: status.
conditionsList[Dict[str, Any]]Factory: listAlias: conditions.
taintsList[Dict[str, Any]]Factory: listAlias: taints.
node_poolstr''Alias: nodePool.
created_atstr''Alias: createdAt.
gpu_typestr | NoneNoneAlias: gpuType.
gpu_countint | NoneNoneAlias: gpuCount.
nvlink_domain_uidstr | NoneNoneAlias: nvLinkDomainUid.
nvlink_clique_idstr | NoneNoneAlias: nvLinkCliqueId.
namestr''Alias: name.
idstr''Alias: id.
cluster_uuidstr''Alias: clusterUuid.
updated_atstr''Alias: updatedAt.

LSF

LSFSystem

Represents an LSF system.

FieldTypeDefaultDescription
namestrRequired
schedulerstr'lsf'
install_pathpathlib.PathRequired
output_pathpathlib.PathRequired
hf_home_pathpathlib.PathFactory: System.<lambda>
global_env_varsdict[str, typing.Any]Factory: dict
monitor_intervalfloat60.0
soldict[str, list[cloudai.metrics.SOLTarget]]Factory: dict
queuesList[cloudai.systems.lsf.lsf_system.LSFQueue]Factory: listA list of queues in the LSF system, filled in automatically
accountstr | NoneNone
project_namestr | NoneNone
default_queuestr | NoneNone
appstr | NoneNone
os_versionstr | NoneNone

LSFQueue

Represents a queue within the LSF system.

FieldTypeDefaultDescription
namestrRequired
groupsList[cloudai.systems.lsf.lsf_system.LSFGroup][]

LSFGroup

Represents a group of nodes within a queue.

FieldTypeDefaultDescription
namestrRequired
nodesList[str]Required

Standalone

StandaloneSystem

Class representing a Standalone system.

This class is used for systems that execute commands directly without a job scheduler.

FieldTypeDefaultDescription
namestrRequired
schedulerstr'standalone'
install_pathpathlib.PathRequired
output_pathpathlib.PathRequired
hf_home_pathpathlib.PathFactory: System.<lambda>
global_env_varsdict[str, typing.Any]Factory: dict
monitor_intervalfloat1.0
soldict[str, list[cloudai.metrics.SOLTarget]]Factory: dict