API Reference Orchid v#0.5.6

Copy Markdown View Source

Modules

The core entry point for the Orchid workflow engine.

A container for errors that occur during Orchid execution.

Executor behavoir.

Asynchronous Executor, implementing the behaviour of Orchid.Executor.

Serial Executor, implementing the behaviour of Orchid.Executor.

Execute recipe.

The standard unit of data exchange.

Defines a processing workflow (Recipe).

Responsible for analysing the topological structure of Recipes, primarily conducting static checks.

Defines the behaviour of the data warehouse. Used to store large volumes of data unsuitable for direct transmission via Param (such as audio waveforms or model weights).

Run step.

Context for step execution.

Behaviour for runner hooks.

Scheduler is responsible for managing and scheduling the execution order of steps in the Recipe.

The state machine for workflow execution.

Defines the behavior and specification for a workflow step.

Create identifier/fingerprint via Step's input, output or mapper in option.

Encapsulates a complete Recipe as a standalone Step to implement nested operations.

Represents the context of a workflow execution, including its configuration, path, and baggage.