cars.pipelines.pipeline
=======================

.. py:module:: cars.pipelines.pipeline

.. autoapi-nested-parse::

   This module contains class pipeline factory.



Classes
-------

.. autoapisummary::

   cars.pipelines.pipeline.Pipeline


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

.. py:class:: Pipeline

   Pipeline factory:
   A class designed for registered all available Cars Pipeline and
   instantiate when needed.



   .. py:attribute:: available_pipeline


   .. py:method:: create_pipeline(name: str, cfg: Dict[str, Union[str, int]], config_dir)
      :classmethod:


      Factory command to create the pipeline
      Return the instance of pipeline associated with the pipeline
      name given as parameter

      :param pipeline_name: name of the pipeline.
      :type pipeline_name: str
      :param cfg: cars input configuration
      :type cfg: dictionary
      :param config_dir: path to dir containing json
      :type config_dir: str



   .. py:method:: print_available_pipelines()
      :classmethod:


      Print all registered pipelines



   .. py:method:: register(*pipeline_names: str)
      :classmethod:


      Allows to register the pipeline with its name
      :param pipeline_name: the pipelines to be registered
      :type pipeline_name: string