Skip to main content

ClikaRT::graph::CaptureOptions

struct

Header: ClikaRT/graph/compile.h

How ClikaRT::compile captures. The zero-options default runs the standard graph-optimization pipeline and finalizes packed weights, with shape specialization gated behind specialize (the shape guard and the re-capture loop keep an unspecialized capture honest across shapes).

Scope: transform selection is not part of this surface; individual pass names are not public vocabulary; the capture runs the standard pipeline as one unit. A field value the captured road cannot honor is refused at compile() with a readable error, never ignored.

Data members​

optimize​

bool optimize = true

Run the graph-optimization pipeline and finalize the operators' packed weight forms on capture. false captures TRACE-ONLY: no transform pipeline, no weight baking (TraceOptions{run_transforms=false, bake=false}): the graph replays exactly the operations the function recorded, resolved per run, the raw-topology posture for graph-level tooling and diagnosis.

Declared in ClikaRT/graph/compile.h, line 106

specialize​

bool specialize = false

Additionally collapse always-constant subgraphs and fix signature-static dims into the captured graph. Requires optimize (specialization is a transform). Composes with the dynamic-dim hints: specialization fixes ONLY dims not declared dynamic; a hinted axis stays symbolic while everything else fixes, and a call that drifts on a fixed dim re-captures and re-fixes at the widened signature.

Declared in ClikaRT/graph/compile.h, line 113

weights​

io::LoadPolicy weights

Weight residency for the captured graph. device anchors the EXECUTION lane the capture homes the graph onto; its packed weights build there and every replay runs there. Unset: the graph stays where the capture built it. The graph relocates its OWN copies; the function's live tensors are never moved behind the caller's back. sticky is checkpoint-spill vocabulary with no captured-road meaning and is refused at compile().

Declared in ClikaRT/graph/compile.h, line 121

dynamic_dims​

std::vector<std::string> dynamic_dims

Dimension NAMES declared dynamic: every signature axis carrying one of these names (spec::TensorSpec::dim_names) captures as a dynamic axis. A name matching no declared axis fails the capture (it would silently do nothing); the function then serves eagerly.

Declared in ClikaRT/graph/compile.h, line 126

dynamic_axes​

std::vector<DynamicAxis> dynamic_axes

Axes declared dynamic by coordinate, the road when the signature is derived from the first call (derived specs carry no dim names).

Declared in ClikaRT/graph/compile.h, line 129

output_names​

std::vector<std::string> output_names

Names for the captured graph's outputs, positionally over the function's RETURNED outputs (empty = the "output_0", "output_1", … defaults; an empty entry keeps its positional default). State outputs the capture surfaces beyond the function's returns keep the names the capture assigns. A count that does not match the function's returns surfaces at the first capture, warned once, and the function keeps serving eagerly.

Declared in ClikaRT/graph/compile.h, line 137

graph_name​

std::string graph_name = "compiled_model"

The captured graph's name (profiling, diagnostics).

Declared in ClikaRT/graph/compile.h, line 139