nnstreamer_plugin_api_trainer.h

Go to the documentation of this file.

/* SPDX-License-Identifier: LGPL-2.1-only */
#ifndef __NNS_PLUGIN_API_TRAINER_H__
#define __NNS_PLUGIN_API_TRAINER_H__
 
#include "tensor_typedef.h"
 
#define GST_TENSOR_TRAINER_FRAMEWORK_BASE (0xDEAFDEAD00000000ULL)
#define GST_TENSOR_TRAINER_FRAMEWORK_V1 (GST_TENSOR_TRAINER_FRAMEWORK_BASE | 0x10000ULL)
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct _GstTensorTrainerProperties
{
  GstTensorsInfo input_meta;    
  const char *model_config;    
  const char *model_save_path;    
  const char *model_load_path;    
  unsigned int num_inputs;    
  unsigned int num_labels;    
  unsigned int num_training_samples;    
  unsigned int num_validation_samples;    
  unsigned int num_epochs;    
  unsigned int epoch_count;    
  double training_loss;    
  double training_accuracy;    
  double validation_loss;    
  double validation_accuracy;    
} GstTensorTrainerProperties;
 
typedef struct _GstTensorTrainerFrameworkInfo
{
  const char *name;    
} GstTensorTrainerFrameworkInfo;
 
typedef struct _GstTensorTrainerFramework GstTensorTrainerFramework;
 
typedef enum
{
  TRAINER_EVENT_EPOCH_COMPLETION,    
  TRAINER_EVENT_TRAINING_COMPLETION,    
  TRAINER_EVENT_UNKNOWN,    
} GstTensorTrainerEventType;
 
typedef struct _GstTensorTrainerEventNotifier
{
  uint64_t version;
  void *notifier;
} GstTensorTrainerEventNotifier;
 
struct _GstTensorTrainerFramework
{
  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);
};
 
/* extern functions for subplugin management, exist in tensor_trainer.c */
extern int
nnstreamer_trainer_probe (GstTensorTrainerFramework * ttsp);
 
extern int
nnstreamer_trainer_exit (GstTensorTrainerFramework * ttsp);
 
extern void
nnstreamer_trainer_notify_event (GstTensorTrainerEventNotifier * notifier,
    GstTensorTrainerEventType type, void *data);
 
#ifdef __cplusplus
}
#endif
 
#endif /* __NNS_PLUGIN_API_TRAINER_H__ */