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

pydantic model cloudai.systems.slurm.slurm_system.SlurmSystem

Represents a Slurm system.

field default_partition: str [Required]**

field partitions: List[SlurmPartition] [Required]**

field account: str | None = None**

field distribution: str | None = None**

field mpi: str = ‘pmix’**

field gpus_per_node: int | None = None**

field ntasks_per_node: int | None = None**

field cache_docker_images_locally: bool = False**

field scheduler: str = ‘slurm’**

field monitor_interval: float = 60.0**

field extra_srun_args: str | None = None**

field extra_sbatch_args: list[str] [Optional]**

field extra_transient_status_errors: list[str] [Optional]**

field status_retry_pause_seconds: int = 10**

Constraints:

  • ge = 0

field container_mount_home: bool = False**

field slurm_api: SlurmAPIConfig | None = None**

field data_repository: DataRepositoryConfig | None = None**

field reports: dict[str, ReportConfig] | None = None**

field name: str [Required]**

field install_path: Path [Required]**

field output_path: Path [Required]**

field hf_home_path: Path [Optional]**

field global_env_vars: dict[str, Any] [Optional]**

field sol: cloudai.metrics.MetricSOLConfig [Optional]**

pydantic model cloudai.systems.slurm.slurm_system.SlurmPartition

Represents a partition within a Slurm system.

field name: str [Required]**

field groups: List[SlurmGroup] = []**

pydantic model cloudai.systems.slurm.slurm_system.SlurmGroup

Represents a group of nodes within a partition.

field name: str [Required]**

field nodes: List[str] [Required]**

pydantic model cloudai.systems.slurm.slurm_system.DataRepositoryConfig

Configuration for a data repository.

field endpoint: str [Required]**

field verify_certs: bool = True**

Kubernetes

pydantic model cloudai.systems.kubernetes.kubernetes_system.KubernetesSystem

Represents a Kubernetes system.

field kube_config_path: Path [Required]**

field default_namespace: str [Required]**

field scheduler: str = ‘kubernetes’**

field monitor_interval: float = 1.0**

field gpus_per_node: int = 1**

field use_host_network: bool | None = None**

field name: str [Required]**

field install_path: Path [Required]**

field output_path: Path [Required]**

field hf_home_path: Path [Optional]**

field global_env_vars: dict[str, Any] [Optional]**

field sol: cloudai.metrics.MetricSOLConfig [Optional]**

RunAI

pydantic model cloudai.systems.runai.runai_system.RunAISystem

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

field scheduler: str = ‘runai’**

field monitor_interval: float = 60.0**

field base_url: str [Required]**

field user_email: str [Required]**

field app_id: str [Required]**

field app_secret: str [Required]**

field project_id: str [Required]**

field cluster_id: str [Required]**

field name: str [Required]**

field install_path: Path [Required]**

field output_path: Path [Required]**

field hf_home_path: Path [Optional]**

field global_env_vars: dict[str, Any] [Optional]**

field sol: cloudai.metrics.MetricSOLConfig [Optional]**

pydantic model cloudai.systems.runai.runai_node.RunAINode

Represent a node in the RunAI cluster.

field status: NodeStatus = NodeStatus.UNKNOWN**

field conditions: List[Dict[str, Any]] [Optional]**

field taints: List[Dict[str, Any]] [Optional]**

field node_pool: str = ” (alias ‘nodePool’)**

field created_at: str = ” (alias ‘createdAt’)**

field gpu_type: str | None = None (alias ‘gpuType’)**

field gpu_count: int | None = None (alias ‘gpuCount’)**

field nvlink_domain_uid: str | None = None (alias ‘nvLinkDomainUid’)**

field nvlink_clique_id: str | None = None (alias ‘nvLinkCliqueId’)**

field name: str = ”**

field id: str = ”**

field cluster_uuid: str = ” (alias ‘clusterUuid’)**

field updated_at: str = ” (alias ‘updatedAt’)**

LSF

pydantic model cloudai.systems.lsf.lsf_system.LSFSystem

Represents an LSF system.

field queues: List[LSFQueue] [Optional]**

A list of queues in the LSF system, filled in automatically

field account: str | None = None**

field scheduler: str = ‘lsf’**

field project_name: str | None = None**

field default_queue: str | None = None**

field monitor_interval: float = 60.0**

field app: str | None = None**

field os_version: str | None = None**

field name: str [Required]**

field install_path: Path [Required]**

field output_path: Path [Required]**

field hf_home_path: Path [Optional]**

field global_env_vars: dict[str, Any] [Optional]**

field sol: cloudai.metrics.MetricSOLConfig [Optional]**

pydantic model cloudai.systems.lsf.lsf_system.LSFQueue

Represents a queue within the LSF system.

field name: str [Required]**

field groups: List[LSFGroup] = []**

pydantic model cloudai.systems.lsf.lsf_system.LSFGroup

Represents a group of nodes within a queue.

field name: str [Required]**

field nodes: List[str] [Required]**

Standalone

pydantic model cloudai.systems.standalone.standalone_system.StandaloneSystem

Class representing a Standalone system.

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

field scheduler: str = ‘standalone’**

field monitor_interval: float = 1.0**

field name: str [Required]**

field install_path: Path [Required]**

field output_path: Path [Required]**

field hf_home_path: Path [Optional]**

field global_env_vars: dict[str, Any] [Optional]**

field sol: cloudai.metrics.MetricSOLConfig [Optional]**