RunExportOptions Struct

Options for exporting a built Run as graph JSON. More...

Declaration

struct simaai::neat::RunExportOptions { ... }

Included Headers

#include <RunExport.h>

Public Member Attributes Index

std::string	label
	Human-readable graph/run label in the JSON. Empty means "run". More...
bool	include_metrics = true
	Include runtime counters, latency, power, and per-segment pipeline strings. More...
bool	include_power = true
	Include board power summary when enabled on the Run. More...
bool	include_node_metrics = true
	Include node-level latency metrics. More...
bool	include_plugin_metrics = true
	Include per-plugin/kernel latency metrics when a MeasureReport is supplied. More...
bool	include_empty_node_metrics = true
	Include node metric rows that carry attribution metadata but no samples yet. More...
int	indent = 2
	Pretty-print indentation. 0 emits compact JSON. More...
std::vector< std::pair< std::string, std::string > >	metadata
	Free-form string metadata copied to the top-level "metadata" object. More...

Description

Options for exporting a built Run as graph JSON.

The export is intentionally a snapshot: it does not stop or mutate the Run. Export after the workload has drained but before run.close(); close() releases the underlying Run core. If you need to stop the live pipeline before exporting, call run.stop() instead so the Run handle remains exportable.

Definition at line 24 of file RunExport.h.

Public Member Attributes

include_empty_node_metrics

bool simaai::neat::RunExportOptions::include_empty_node_metrics = true

Include node metric rows that carry attribution metadata but no samples yet.

Definition at line 36 of file RunExport.h.

include_metrics

bool simaai::neat::RunExportOptions::include_metrics = true

Include runtime counters, latency, power, and per-segment pipeline strings.

Definition at line 28 of file RunExport.h.

include_node_metrics

bool simaai::neat::RunExportOptions::include_node_metrics = true

Include node-level latency metrics.

Definition at line 32 of file RunExport.h.

include_plugin_metrics

bool simaai::neat::RunExportOptions::include_plugin_metrics = true

Include per-plugin/kernel latency metrics when a MeasureReport is supplied.

Definition at line 34 of file RunExport.h.

include_power

bool simaai::neat::RunExportOptions::include_power = true

Include board power summary when enabled on the Run.

Definition at line 30 of file RunExport.h.

indent

int simaai::neat::RunExportOptions::indent = 2

Pretty-print indentation. 0 emits compact JSON.

Definition at line 38 of file RunExport.h.

label

std::string simaai::neat::RunExportOptions::label

Human-readable graph/run label in the JSON. Empty means "run".

Definition at line 26 of file RunExport.h.

metadata

std::vector<std::pair<std::string, std::string> > simaai::neat::RunExportOptions::metadata

Free-form string metadata copied to the top-level "metadata" object.

Definition at line 40 of file RunExport.h.

---

The documentation for this struct was generated from the following file:

• RunExport.h

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.