PyCS/pycs/pipeline/Pipeline.py

from pycs.pipeline import Result
from pycs.pipeline.Job import Job


class Pipeline:
    def __init__(self, root_folder, distribution):
        """
        prepare everything needed to run jobs later

        :param root_folder: relative path to model folder
        :param distribution: object parsed from distribution.json
        """
        raise NotImplementedError

    def close(self):
        """
        is called everytime a pipeline is not needed anymore and should be used
        to free native resources

        :return:
        """
        raise NotImplementedError

    def execute(self, job: Job) -> Result:
        """
        receive a job, execute it and return the predicted result

        :param job: that should be executed
        :return:
        """
        raise NotImplementedError

    # TODO documentation
    def fit(self, data):
        raise NotImplementedError