SchedulerOptions

class pyedb.workflows.job_manager.backend.job_submission.SchedulerOptions(/, **data: Any)

Bases: pydantic.BaseModel

Resource requirements and scheduler-specific directives.

All attributes are validated by validate(), which is automatically called after instantiation.

Parameters:

queuestr, optional

Partition or queue name. Defaults to "default".

timestr, optional

Wall-time limit in HH:MM:SS or D.HH:MM:SS. Defaults to "24:00:00".

nodesint, optional

Number of compute nodes. Defaults to 1.

tasks_per_nodeint, optional

Processes per node. Defaults to 1.

memorystr, optional

Memory per node, e.g. "4GB". Defaults to "4GB".

accountstr, optional

Account / project to charge.

reservationstr, optional

Advance reservation name.

qosstr, optional

Quality-of-service level.

constraintsstr, optional

Node features, e.g. "gpu".

exclusivebool, optional

Request whole nodes. Defaults to False.

gpusint, optional

Number of GPUs. Defaults to 0.

gpu_typestr, optional

GPU model, e.g. "a100".

prioritystr, optional

Job priority: Low, BelowNormal, Normal, AboveNormal, High. Defaults to "Normal".

email_notificationstr, optional

Address for status mails.

run_as_administratorbool, optional

Elevated privileges (Windows HPC only). Defaults to False.

Raises:

ValueError

On any validation failure.

Overview

Methods

validate_fields

Validate all scheduler options for correctness and consistency.

Attributes

queue
time
nodes
tasks_per_node
cores_per_node
memory
account
reservation
qos
constraints
exclusive
gpus
gpu_type
priority
email_notification
run_as_administrator

Import detail

from pyedb.workflows.job_manager.backend.job_submission import SchedulerOptions

Attribute detail

SchedulerOptions.queue: str = 'default'

SchedulerOptions.time: str = '24:00:00'

SchedulerOptions.nodes: int = 1

SchedulerOptions.tasks_per_node: int = 1

SchedulerOptions.cores_per_node: int = 0

SchedulerOptions.memory: str = '4GB'

SchedulerOptions.account: str | None = None

SchedulerOptions.reservation: str | None = None

SchedulerOptions.qos: str | None = None

SchedulerOptions.constraints: str | None = None

SchedulerOptions.exclusive: bool = False

SchedulerOptions.gpus: int = 0

SchedulerOptions.gpu_type: str | None = None

SchedulerOptions.priority: str = 'Normal'

SchedulerOptions.email_notification: str | None = None

SchedulerOptions.run_as_administrator: bool = False

Method detail

SchedulerOptions.validate_fields() → None

Validate all scheduler options for correctness and consistency.

Raises:

ValueError

If any parameter is invalid or out of range.