:py:mod:`cars.orchestrator.cluster.abstract_cluster`
====================================================

.. py:module:: cars.orchestrator.cluster.abstract_cluster

.. autoapi-nested-parse::

   Contains abstract function for Abstract Cluster



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

Classes
~~~~~~~

.. autoapisummary::

   cars.orchestrator.cluster.abstract_cluster.AbstractCluster




.. py:class:: AbstractCluster(conf_cluster, out_dir, launch_worker=True, data_to_propagate=None)


   AbstractCluster

   .. py:attribute:: available_modes
      :type: Dict

      

   .. py:attribute:: profiling
      :type: cars.conf.input_parameters.ConfigType

      

   .. py:attribute:: out_dir
      :type: str

      

   .. py:method:: register_subclass(*short_names: str)
      :classmethod:

      Allows to register the subclass with its short name
      :param short_names: the subclasses to be registered
      :type short_names: string


   .. py:method:: get_delayed_type()
      :abstractmethod:

      Get delayed type


   .. py:method:: cleanup(**kwargs)
      :abstractmethod:

      Cleanup cluster


   .. py:method:: check_conf(conf)
      :abstractmethod:

      Check configuration

      :param conf: configuration to check
      :type conf: dict

      :return: overloaded configuration
      :rtype: dict



   .. py:method:: get_conf()

      Get overriden configuration


      :return: overriden configuration


   .. py:method:: create_task(func, nout=1)

      Create task

      :param func: function
      :param nout: number of outputs


   .. py:method:: create_task_wrapped(func, nout=1)
      :abstractmethod:

      Create task

      :param func: function
      :param nout: number of outputs


   .. py:method:: start_tasks(task_list)
      :abstractmethod:

      Start all tasks

      :param task_list: task list


   .. py:method:: scatter(data, broadcast=True)
      :abstractmethod:

      Distribute data through workers

      :param data: task data


   .. py:method:: future_iterator(future_list, timeout=None)
      :abstractmethod:

      Iterator, iterating on computed futures

      :param future_list: future_list list
      :param timeout: time to wait for next job