Model.h File

Model — the simplified entry point for loading and running a compiled model archive on Modalix. More...

Included Headers

#include "model/PreprocessPlan.h" #include "nodes/io/Input.h" #include "pipeline/BoxDecodeType.h" #include "pipeline/Run.h" #include "pipeline/TensorSpec.h" #include <cstddef> #include <array> #include <cstdint> #include <memory> #include <optional> #include <string> #include <unordered_map> #include <utility> #include <vector>

Namespaces Index

namespace	simaai
namespace	neat
namespace	internal

Classes Index

struct	BenchmarkReport
	Headline result returned by Model::benchmark(). More...
class	Model
	Loaded form of a compiled model archive; the simplified entry point to run inference on Modalix. More...
struct	ModelInfo
	Diagnostic snapshot of how the route planner resolved the model. More...
struct	RouteNeeds
	What the model fundamentally needs in its pre/post chain (derived from manifest dtypes). More...
struct	RouteCapabilities
	What pre/post adapters the MPK contract provides (read from manifest stages). More...
struct	RouteSelection
	What the planner actually included in the materialized route. More...
struct	OutputTopology
	Output topology: how many tensors the model emits, and whether they're physically packed. More...
struct	InferenceTerminalPolicy
	Where the inference pipeline should terminate. More...
struct	PreprocessRequirements
	Concrete preprocess parameters resolved by the planner from the MPK contract. More...
struct	Options
	User-provided options at Model construction time. More...
struct	RouteOptions
	Options for Model::graph() — controls how the model assembles into a Graph. More...
class	Runner
	Long-lived execution handle returned by Model::build(...). More...

Description

Model — the simplified entry point for loading and running a compiled model archive on Modalix.

Model is the user-facing wrapper around a compiled model archive (.tar.gz). It loads the file, extracts and validates the manifest, runs the route planner, and exposes ready-to-use Graph fragments (preprocess, inference, postprocess) plus convenience run() and build() methods that drive a one-shot inference. Internally a Model is a Graph wrapper: the same composition, validation, and runtime machinery the Graph API exposes powers Model underneath. New users start with Model::run(input); advanced users compose their own Graph from model.graph() plus extra Nodes.

See Also

"Models" in the design deep dive (§0.7 — The main concepts)

See Also

"Graphs: the assembly contract" (§0.12) for what Model wraps

See Also

"MPK contract" (§0.16) for the inference contract embedded in Model archives

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.