xplogger.experiment_manager.slurm package

Submodules

xplogger.experiment_manager.slurm.ds module

Datastructures to interact with the SLURM system.

class xplogger.experiment_manager.slurm.ds.SlurmInfo(priority: int, job_id: str, partition: str, job_step_name: str, user: str, state: str, start_time: str, time: str, time_limit: str, num_nodes: int, tres_per_node: str, min_cpus: int, min_memory_size: str, nodelist: str, mongo_id: str = '', project: str = '', git_issue_id: str = '', script_id: str = '')[source]

Bases: object

classmethod from_dict(data: dict[str, str]) → SlurmInfo[source]

Map a dict to SlurmInfo instance.

git_issue_id: str = ''
job_id: str
job_step_name: str
min_cpus: int
min_memory_size: str
mongo_id: str = ''
nodelist: str
num_nodes: int
partition: str
priority: int
project: str = ''
script_id: str = ''
start_time: str
state: str
time: str
time_limit: str
tres_per_node: str
user: str
class xplogger.experiment_manager.slurm.ds.SlurmInfoDict(slurminfo_sequence_dict: dict[Any, SlurmInfoList])[source]

Bases: collections.UserDict

class xplogger.experiment_manager.slurm.ds.SlurmInfoList(slurm_info_list: list[SlurmInfo])[source]

Bases: collections.UserList

populate_additional_fields(mongo_stores: list[MongoStore]) → None[source]

Populate additional fields like collection, git_issue_id and script_id.

to_slurminfo_dict(key_fn=<function SlurmInfoList.<lambda>>) → xplogger.experiment_manager.slurm.ds.SlurmInfoDict[source]

Map SlurmInfo instance to a dict.

xplogger.experiment_manager.slurm.job module

Functions to interact with the SLURM system.

xplogger.experiment_manager.slurm.job.get_running_jobs_as_df(user: str = '$USER', mongo_stores: Optional[list[MongoStore]] = None) → pd.DataFrame[source]

Get a dataframe of running jobs.

Returns

Return type

pd.DataFrame

xplogger.experiment_manager.slurm.job.get_running_jobs_as_list(user: str = '$USER', mongo_stores: Optional[list[MongoStore]] = None) → SlurmInfoList[source]

Get a list of SlurmInfo objects corresponding to running jobs.

Returns

[running jobs]

Return type

list[SlurmInfo]

xplogger.experiment_manager.slurm.utils module

Functions to interact with the SLURM system.

xplogger.experiment_manager.slurm.utils.get_info_from_slurm(job_id: str) → dict[str, Any][source]

Get info about a specific job from slurm.

Parameters

job_id (str) –

Returns

job info.

Return type

dict[str, Any]

xplogger.experiment_manager.slurm.utils.map_jobid_to_raw_job_id(job_id: str) → str[source]

Map job_id to raw job_id.

Module contents