PyCS/pycs/pipeline/Pipeline.py

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


class Pipeline:
    def load(self, root: str, distribution: dict):
        """
        load and store properties needed for prediction and fitting

        :param root: path to model root directory containing distribution.json
        :param distribution: pipeline dict from distribution.json containing pipeline specific configuration
        :return:
        """
        pass

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

        :return:
        """
        pass

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

        :param job: that should be executed
        :return:
        """
        pass