Package ai.djl.serving.workflow.function

Class WorkflowFunction

java.lang.Object

ai.djl.serving.workflow.function.WorkflowFunction

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

AdapterWorkflowFunction, EnsembleMerge, FunctionsApply, IdentityWF, WlmWorkflowFunction

public abstract class WorkflowFunction
extends Object
implements AutoCloseable

A lambda function that can be run within a Workflow.

See Also:

• run(Workflow.WorkflowExecutor, List)

Constructor Summary

Constructors

Constructor	Description
WorkflowFunction()

Method Summary

Modifier and Type	Method	Description
void	close()
protected CompletableFuture<List<WorkflowExpression.Item>>	evaluateArgs(List<Workflow.WorkflowArgument> args)	A helper to evaluate all function arguments.
void	prepare(ai.djl.serving.wlm.WorkLoadManager wlm, Map<String,Map<String,Object>> configs)	Prepares this WorkflowFunction.
abstract CompletableFuture<WorkflowExpression.Item>	run(Workflow.WorkflowExecutor executor, List<Workflow.WorkflowArgument> args)	The lambda function that is run.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WorkflowFunction

public WorkflowFunction()

Method Details

run

public abstract CompletableFuture<WorkflowExpression.Item> run(Workflow.WorkflowExecutor executor,
 List<Workflow.WorkflowArgument> args)

The lambda function that is run.

Parameters:

executor - an executor that can be used to run expressions or models

args - the list of function arguments

Returns:

a future containing the input

evaluateArgs

protected CompletableFuture<List<WorkflowExpression.Item>> evaluateArgs(List<Workflow.WorkflowArgument> args)

A helper to evaluate all function arguments.

Parameters:

args - the arguments to evaluate

Returns:

a future with the list of evaluated arguments

prepare

public void prepare(ai.djl.serving.wlm.WorkLoadManager wlm,
 Map<String,Map<String,Object>> configs)

Prepares this WorkflowFunction.

Parameters:

wlm - the wlm

configs - the workflow configs

close

public void close()

Specified by:

close in interface AutoCloseable