API Reference oi v#0.6.4
Copy MarkdownModules
Oi provides a simple API for Orchid and ready-to-use functions for bind OrchidSymbiont, OrchidStratum and OrchidIntervention.
Ready-to-use orchid adapters.
Container for a compiled Orchid recipe and its associated metadata.
Execution plan built from compiled Bundles.
Ordered sequence of stages.
A single execution barrier.
Static compilation product: bundles + execution plan.
Dispatch layer: takes a compiled pipeline and runs it with concrete data.
Immutable dispatch configuration.
Temporary result store for a single dispatch pass.
Holds computed outputs keyed by Orchid io_key (e.g. "pred_step|result"),
which is already globally unique. Workers read dependencies from here;
the dispatcher merges per-stage deltas back after each barrier.
Orchestrates barrier-synchronized execution of plan stages.
Executes a single Bundle in isolation.
Pluggable task execution strategy for stage fan-out.
Serial executor — runs all tasks in the calling process.
Task.Supervisor-backed executor — concurrent fan-out with crash isolation.
A higher API for building graph.
Execution result: the final drafting memory.
Local process storage for Oi sessions.
Session separates the whole application into several spaces where contains different steps, independent symbionts and storages.
Instance Supervisor.
Lightweight declarative syntax layer on top of Orchid.Step /
OrchidSymbiont.Step. Provides a simple API and exposes
__node_spec__/0 for topology integration.
Cluster dependencies based on user selections and dependency relationships at the front end to achieve parallel control.
The pure mathematical representation of the DAG.
A directed edge representing data flow between two node ports.
A pure data representation of a computation step in the DAG.
A container based on the node/port representation, used to dynamically generate Orchid keys.