client.commands.resources
=========================

.. py:module:: client.commands.resources

.. autoapi-nested-parse::

   Resource usage commands.

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



Attributes
----------

.. autoapisummary::

   client.commands.resources.logger


Functions
---------

.. autoapisummary::

   client.commands.resources.task_template_resources
   client.commands.resources.create_resource_yaml


Module Contents
---------------

.. py:data:: logger

.. py:function:: task_template_resources(task_template_version: int, workflows: Optional[list] = None, node_args: Optional[Dict] = None, ci: Optional[float] = None, requester: Optional[jobmon.core.requester.Requester] = None) -> Optional[Dict]

   Get aggregate resource usage data for a given TaskTemplateVersion.

   :param task_template_version: The task template version ID the user wants to find the
                                 resource usage of.
   :param workflows: list of workflows a user wants query by.
   :param node_args: dictionary of node arguments a user wants to query by.
   :param ci: confidence interval. Not calculate if None.
   :param requester: object to communicate with the flask services

   :returns: Dataframe of TaskTemplate resource usage


.. py:function:: create_resource_yaml(wfid: Optional[int], tid: Optional[int], v_mem: str, v_core: str, v_runtime: str, clusters: List, requester: Optional[jobmon.core.requester.Requester] = None) -> str

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

   :param wfid: Workflow ID to query (or None if using task ID)
   :param tid: Task ID to query (or None if using workflow ID)
   :param v_mem: Memory aggregation strategy ('avg', 'min', 'max')
   :param v_core: Core aggregation strategy ('avg', 'min', 'max')
   :param v_runtime: Runtime aggregation strategy ('avg', 'min', 'max')
   :param clusters: List of cluster names to include in the YAML
   :param requester: object to communicate with the flask services

   :returns: YAML formatted string containing resource configurations