RunExport.h File

Export a built NEAT Run's graph topology and runtime metrics as JSON. More...

Included Headers

#include "pipeline/Run.h" #include <string> #include <utility> #include <vector>

Namespaces Index

namespace	simaai
namespace	neat

Classes Index

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

Description

Export a built NEAT Run's graph topology and runtime metrics as JSON.

File Listing

The file content with the documentation metadata removed is:

1

6#pragma once

7

8#include "pipeline/Run.h"

9

10#include <string>

11#include <utility>

12#include <vector>

13

14namespace simaai::neat {

15

23struct RunExportOptions {

25 std::string label;

27 bool include_metrics = true;

29 bool include_power = true;

31 int indent = 2;

33 std::vector<std::pair<std::string, std::string>> metadata;

34};

35

37using GraphRunExportOptions = RunExportOptions;

38

40std::string run_to_json(const Run& run, const RunExportOptions& opt = {},

41 std::string* err = nullptr);

42

44bool save_run_json(const Run& run, const std::string& path, const RunExportOptions& opt = {},

45 std::string* err = nullptr);

46

48inline std::string graph_run_to_json(const Run& run, const GraphRunExportOptions& opt = {},

49 std::string* err = nullptr) {

50 return run_to_json(run, opt, err);

51}

52

54inline bool save_graph_run_json(const Run& run, const std::string& path,

55 const GraphRunExportOptions& opt = {}, std::string* err = nullptr) {

56 return save_run_json(run, path, opt, err);

57}

58

59} // namespace simaai::neat

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.