Doxygen Book
_GstTensorTrainerFramework Struct Reference

tensor_trainer subplugin definition More...

#include <nnstreamer_plugin_api_trainer.h>

Public Attributes

uint64_t version
 
int(* create )(const GstTensorTrainerFramework *self, const GstTensorTrainerProperties *prop, void **private_data)
 
int(* destroy )(const GstTensorTrainerFramework *self, const GstTensorTrainerProperties *prop, void **private_data)
 
int(* start )(const GstTensorTrainerFramework *self, const GstTensorTrainerProperties *prop, GstTensorTrainerEventNotifier *notifier, void *private_data)
 
int(* stop )(const GstTensorTrainerFramework *self, const GstTensorTrainerProperties *prop, void **private_data)
 
int(* push_data )(const GstTensorTrainerFramework *self, const GstTensorTrainerProperties *prop, void *private_data, const GstTensorMemory *input)
 
int(* getStatus )(const GstTensorTrainerFramework *self, GstTensorTrainerProperties *prop, void *private_data)
 
int(* getFrameworkInfo )(const GstTensorTrainerFramework *self, const GstTensorTrainerProperties *prop, void *private_data, GstTensorTrainerFrameworkInfo *fw_info)
 

Detailed Description

tensor_trainer subplugin definition

Common callback parameters: prop Trainer properties. Read Only. private_data Subplugin's private data. Set this (*private_data = XXX) if you want to change trainer->private_data.

Definition at line 95 of file nnstreamer_plugin_api_trainer.h.

Member Data Documentation

◆ create

int(* _GstTensorTrainerFramework::create) (const GstTensorTrainerFramework *self, const GstTensorTrainerProperties *prop, void **private_data)

tensor_trainer call this to create the model

Parameters
[in]propread-only property values
[in/out]private_data, a subplugin may save its internal private data here.
Returns
0 if ok. < 0 if error.

Definition at line 102 of file nnstreamer_plugin_api_trainer.h.

◆ destroy

int(* _GstTensorTrainerFramework::destroy) (const GstTensorTrainerFramework *self, const GstTensorTrainerProperties *prop, void **private_data)

tensor_trainer call this to destroy the model, Set NULL after that.

Parameters
[in]propread-only property values
[in/out]private_data, a subplugin may save its internal private data here.
Returns
0 if ok. < 0 if error.

Definition at line 110 of file nnstreamer_plugin_api_trainer.h.

◆ getFrameworkInfo

int(* _GstTensorTrainerFramework::getFrameworkInfo) (const GstTensorTrainerFramework *self, const GstTensorTrainerProperties *prop, void *private_data, GstTensorTrainerFrameworkInfo *fw_info)

Mandatory callback. Get the frameworks statically determined info.

Parameters
[in]propread-only property values
[in]private_dataA subplugin may save its internal private data here.
[out]fw_infostruct to hold frameworks info. Must be allocated by the caller (return value).
Returns
0 if OK. < 0 if error.
Note
CAUTION: private_data can be NULL if the framework is not yet opened by the caller.

Definition at line 154 of file nnstreamer_plugin_api_trainer.h.

◆ getStatus

int(* _GstTensorTrainerFramework::getStatus) (const GstTensorTrainerFramework *self, GstTensorTrainerProperties *prop, void *private_data)

tensor_trainer call this to get status of subplugin

Parameters
[in]propproperty values
[in]private_data,asubplugin may save its internal private data here.
Returns
0 if ok. < 0 if error.

Definition at line 146 of file nnstreamer_plugin_api_trainer.h.

◆ push_data

int(* _GstTensorTrainerFramework::push_data) (const GstTensorTrainerFramework *self, const GstTensorTrainerProperties *prop, void *private_data, const GstTensorMemory *input)

tensor_trainer call this to push tensor data to subplugin, subplugin constructs a data set using input.

Parameters
[in]propread-only property values
[in]private_data,asubplugin may save its internal private data here.
[in]inputThe array of input tensors. Allocated and filled by tensor_trainer
Returns
0 if ok. < 0 if error.

Definition at line 136 of file nnstreamer_plugin_api_trainer.h.

◆ start

int(* _GstTensorTrainerFramework::start) (const GstTensorTrainerFramework *self, const GstTensorTrainerProperties *prop, GstTensorTrainerEventNotifier *notifier, void *private_data)

tensor_trainer call this to start training the model

Parameters
[in]propread-only property values
[in]notify,ahandle of event notify
[in]private_data,asubplugin may save its internal private data here.
Returns
0 if ok. < 0 if error.

Definition at line 118 of file nnstreamer_plugin_api_trainer.h.

◆ stop

int(* _GstTensorTrainerFramework::stop) (const GstTensorTrainerFramework *self, const GstTensorTrainerProperties *prop, void **private_data)

tensor_trainer call this to stop training the model

Parameters
[in]propread-only property values
[in/out]private_data, a subplugin may save its internal private data here.
Returns
0 if ok. < 0 if error.

Definition at line 128 of file nnstreamer_plugin_api_trainer.h.

◆ version

uint64_t _GstTensorTrainerFramework::version

Version of the struct | 32bit (validity check) | 16bit (API version) | 16bit (Subplugin's internal version) |

Definition at line 97 of file nnstreamer_plugin_api_trainer.h.


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