client.swarm.swarm_array
========================

.. py:module:: client.swarm.swarm_array

.. autoapi-nested-parse::

   Array object used by swarm to create task instance batches.



Attributes
----------

.. autoapisummary::

   client.swarm.swarm_array.logger


Classes
-------

.. autoapisummary::

   client.swarm.swarm_array.SwarmArray


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

.. py:data:: logger

.. py:class:: SwarmArray(array_id: int, max_concurrently_running: int, array_name: Optional[str] = None)

   .. py:attribute:: array_id


   .. py:attribute:: array_name
      :value: 'array_Uninferable'



   .. py:attribute:: tasks
      :type:  Set[jobmon.client.swarm.swarm_task.SwarmTask]


   .. py:attribute:: max_concurrently_running


   .. py:method:: add_task(task: jobmon.client.swarm.swarm_task.SwarmTask) -> None


   .. py:method:: __hash__() -> int

      Returns the array ID.



   .. py:method:: __eq__(other: object) -> bool

      Check if the hashes of two arrays are equivalent.



   .. py:method:: __lt__(other: SwarmArray) -> bool

      Check if one hash is less than the has of another DistributorArray.