This reference describes unreleased code on main; no release documents it yet.

rlmesh::Recorder

classExperimental#include <rlmesh.hpp>[source]

Class in rlmesh.hpp.

class Recorder

Recorder

constructor[source]
explicit Recorder(const RecorderOptions& options = {})

Recorder

constructor[source]
Recorder(Recorder&&) = default

add

method[source]
WorkloadRecord add(
    const RunResult& result,
    std::string_view model,
    std::string_view env,
    const RecorderAddOptions& options = {}
)

capture

method[source]
std::unique_ptr<RunHooks> capture(
    std::string_view model,
    std::string_view env,
    const RecorderCaptureOptions& options = {}
)

to_dict

method[source]
Metadata to_dict(const RecorderToDictOptions& options = {}) const

export_

method[source]
std::filesystem::path export_(
    const std::filesystem::path& path,
    const RecorderExportOptions& options = {}
) const

result_set_id

method[source]
std::string result_set_id() const

workloads

method[source]
std::vector<WorkloadRecord> workloads() const

close

method[source]
void close()