GuidesAPI reference
DiscordDashboard
DiscordDashboard

pipeline.pipeline_model

pipeline_model - class decorator

Source on GitHub

pipeline.objects.decorators.pipeline_model(
	model_class: Any = None
)

Description

The pipeline_model decorator is used on classes to allow the Pipeline context manager to treat them as model objects. A model can contain pipeline_function decorated functions and allows for persistent logic to be present inside of the wrapped class (for caching etc).

Parameters

  • model_class (Any, optional) - The model class to be wrapped, this is implicitly passed in you do not manually pass this.

Examples

from pipeline import Pipeline, pipeline_model

...

@pipeline_model
class MyModel:
	def __init__(self, ...):
  	...
 
...


with Pipeline("example-model") as builder:
	...
  
  my_model = MyModel()
  
  ...