client.commands.resources

Resource usage commands.

Commands for querying resource usage and generating resource YAML files: - Task template resource usage queries - Resource YAML generation

Attributes

logger

Functions

task_template_resources(→ Optional[Dict])

Get aggregate resource usage data for a given TaskTemplateVersion.

create_resource_yaml(→ str)

Create a resource YAML file from workflow or task resource usage.

Module Contents

client.commands.resources.logger
client.commands.resources.task_template_resources(task_template_version: int, workflows: list | None = None, node_args: Dict | None = None, ci: float | None = None, requester: jobmon.core.requester.Requester | None = None) → Dict | None

Get aggregate resource usage data for a given TaskTemplateVersion.

Parameters:

  • task_template_version – The task template version ID the user wants to find the resource usage of.

  • workflows – list of workflows a user wants query by.

  • node_args – dictionary of node arguments a user wants to query by.

  • ci – confidence interval. Not calculate if None.

  • requester – object to communicate with the flask services

Returns:

Dataframe of TaskTemplate resource usage

client.commands.resources.create_resource_yaml(wfid: int | None, tid: int | None, v_mem: str, v_core: str, v_runtime: str, clusters: List, requester: jobmon.core.requester.Requester | None = None) → str

Create a resource YAML file from workflow or task resource usage.

Parameters:

  • wfid – Workflow ID to query (or None if using task ID)

  • tid – Task ID to query (or None if using workflow ID)

  • v_mem – Memory aggregation strategy (‘avg’, ‘min’, ‘max’)

  • v_core – Core aggregation strategy (‘avg’, ‘min’, ‘max’)

  • v_runtime – Runtime aggregation strategy (‘avg’, ‘min’, ‘max’)

  • clusters – List of cluster names to include in the YAML

  • requester – object to communicate with the flask services

Returns:

YAML formatted string containing resource configurations