ppline 0.1.3

Pipeline framework.

ppline

1. About

ppline can trigger your python modules in any specified order, making it look like a pipeline!

1.1. Installation

pip install ppline

1.2. How it works

Ppline takes configuration of your pipeline from .yml file, so you have to create it in your root directory in the following form:

steps:
    [step name]:
        exec: [relative path to a file]:[class to execute]
    [step name]:
        exec: [relative path to a file]:[class to execute]
    [step name]:
        exec: [relative path to a file]:[class to execute]

Here is the example:

steps:
    preProcessing:
        exec: src/calculation.py:Calculate
    kMeans:
        exec: src/models.py:Kmeans
    hyperTuning:
        exec: src/tuning.py:GridSearch

Any executable class should have a method __call__. For example:

class Calculate(object):
	def sum(self):
		a=2
		b=4
		self.c=a+b

	def divide(self):
		f=4
		self.d = self.c/f

        def show_result(self):
                print(self.d)

	def __call__(self):
		self.sum()
		self.divide()
                self.show_result()
    

1.3. How to use

Create a .yml file in your root directory, with pipeline config. Then, use the following command to trigger the pipeline

python -m ppline.cli --pipeline_config file.yml

1.4. To do

• dependency map between steps
• independent steps in parallel
• make png export of visualized pipeline w/ names