knp::framework::ModelExecutor Class Reference

The ModelExecutor class is a definition of an executor that runs the uploaded model on the specified backend. More...

#include <knp/framework/model_executor.h>

Collaboration diagram for knp::framework::ModelExecutor:

Public Member Functions
	ModelExecutor (knp::framework::Model &model, std::shared_ptr< core::Backend > backend, ModelLoader::InputChannelMap i_map)
	ModelExecutor constructor.
void	start ()
	Start model execution.
void	start (core::Backend::RunPredicate run_predicate)
	Start model execution.
void	stop ()
	Stop model execution.
template<class Message >
void	add_observer (monitoring::MessageProcessor< Message > &&message_processor, const std::vector< core::UID > &senders)
	Add observer to executor.
void	start_learning ()
	Unlock synapse weights.
void	stop_learning ()
	Lock synapse weights.
std::shared_ptr< core::Backend >	get_backend ()
	Get pointer to backend object.
auto &	get_loader ()
	Get model loader object.

Detailed Description

The ModelExecutor class is a definition of an executor that runs the uploaded model on the specified backend.

Definition at line 47 of file model_executor.h.

Constructor & Destructor Documentation

ModelExecutor()

knp::framework::ModelExecutor::ModelExecutor ( knp::framework::Model & model, std::shared_ptr< core::Backend > backend, ModelLoader::InputChannelMap i_map )

inline

ModelExecutor constructor.

Parameters

model	model to run.
backend	pointer to backend on which you want to run the model.
i_map	input channel map.

Definition at line 56 of file model_executor.h.

Member Function Documentation

add_observer()

template<class Message >

void knp::framework::ModelExecutor::add_observer ( monitoring::MessageProcessor< Message > && message_processor, const std::vector< core::UID > & senders )

inline

Add observer to executor.

Template Parameters

Message

type of messages to observe.

Parameters

message_processor	functor to process received messages.
senders	list of observed entities.

Definition at line 88 of file model_executor.h.

get_backend()

std::shared_ptr< core::Backend > knp::framework::ModelExecutor::get_backend ( )

inline

Get pointer to backend object.

Returns

shared pointer to Backend object.

Definition at line 110 of file model_executor.h.

get_loader()

auto & knp::framework::ModelExecutor::get_loader ( )

inline

Get model loader object.

Returns

reference to ModelLoader object.

Definition at line 116 of file model_executor.h.

start()

void knp::framework::ModelExecutor::start

(

core::Backend::RunPredicate

run_predicate

)

Start model execution.

Parameters

run_predicate

predicate that stops running if the false value is returned.

start_learning()

void knp::framework::ModelExecutor::start_learning ( )

inline

Unlock synapse weights.

Definition at line 99 of file model_executor.h.

stop_learning()

void knp::framework::ModelExecutor::stop_learning ( )

inline

Lock synapse weights.

Definition at line 104 of file model_executor.h.

---

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

• base-framework/include/knp/framework/model_executor.h