client.tool_version
===================

.. py:module:: client.tool_version

.. autoapi-nested-parse::

   A logical instance of a project or model that will be run many times over.



Attributes
----------

.. autoapisummary::

   client.tool_version.logger


Classes
-------

.. autoapisummary::

   client.tool_version.ToolVersion


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

.. py:data:: logger

.. py:class:: ToolVersion(tool_version_id: int, requester: Optional[jobmon.core.requester.Requester] = None)

   Represents a logical instance of a project or model that will be run many times over.

   Instantiate a tool version.

   :param tool_version_id: an integer id associated with a Tool
   :param requester: communicate with the FastApi services.


   .. py:attribute:: id


   .. py:attribute:: task_templates
      :type:  Dict[str, jobmon.client.task_template.TaskTemplate]


   .. py:attribute:: default_compute_resources_set
      :type:  Dict[str, Dict[str, Any]]


   .. py:attribute:: default_resource_scales_set
      :type:  Dict[str, Dict[str, float]]


   .. py:attribute:: default_cluster_name
      :type:  str
      :value: ''



   .. py:attribute:: default_max_attempt
      :type:  Optional[int]
      :value: None



   .. py:attribute:: requester
      :value: None



   .. py:method:: get_tool_version(tool: jobmon.client.tool.Tool) -> ToolVersion
      :classmethod:


      Get a new instance of a ToolVersion from the database.

      :param tool: a Tool to get a version from.
      :param tool_version_id: tool_version_id to get from the database.



   .. py:method:: from_wire(wire_tuple: Tuple, tool: jobmon.client.tool.Tool) -> ToolVersion
      :classmethod:


      Convert from the wire format of ToolVersion to an instance.

      :param wire_tuple: Wire format for ToolVersion defined in jobmon.serializers.
      :param tool: The Tool object to verify the right tool_version based on tool_id.



   .. py:property:: tool
      :type: jobmon.client.tool.Tool


      The Tool this ToolVersion is associated with.


   .. py:method:: load_task_templates() -> None

      Get all task_templates associated with this tool version from the database.



   .. py:method:: get_task_template(template_name: str) -> jobmon.client.task_template.TaskTemplate

      Get a single task_template associated with this tool version from the database.



   .. py:method:: update_default_compute_resources(cluster_name: str, **kwargs: Any) -> None

      Update default compute resources in place only overridding specified keys.

      If no default cluster is specified when this method is called, cluster_name will
      become the default cluster.

      :param cluster_name: name of cluster to modify default values for.
      :param \*\*kwargs: any key/value pair you want to update specified as an argument.



   .. py:method:: update_default_resource_scales(cluster_name: str, **kwargs: Any) -> None

      Update default resource scales in place only overridding specified keys.

      If no default cluster is specified when this method is called, cluster_name will
      become the default cluster.

      :param cluster_name: name of cluster to modify default values for.
      :param \*\*kwargs: any key/value pair you want to update specified as an argument.



   .. py:method:: set_default_compute_resources_from_dict(cluster_name: str, compute_resources: Dict[str, Any]) -> None

      Set default compute resources for a given cluster_name.

      If no default cluster is specified when this method is called, cluster_name will
      become the default cluster.

      :param cluster_name: name of cluster to set default values for.
      :param compute_resources: dictionary of default compute resources to run tasks
                                with. Can be overridden at task template or task level.
                                dict of {resource_name: resource_value}



   .. py:method:: set_default_resource_scales_from_dict(cluster_name: str, resource_scales: Dict[str, float]) -> None

      Set default resource scales for a given cluster_name.

      If no default cluster is specified when this method is called, cluster_name will
      become the default cluster.

      :param cluster_name: name of cluster to set default values for.
      :param resource_scales: dictionary of default resource scales to adjust task
                              resources with. Can be overridden at task template or task level.
                              dict of {resource_name: scale_value}



   .. py:method:: set_default_max_attempts(value: int) -> None

      Set default max attempts at tool leve.

      :param value: the default max attempts value.