\hypertarget{struct__GstTensorTrainerFramework}{}\doxysection{\+\_\+\+Gst\+Tensor\+Trainer\+Framework Struct Reference}
\label{struct__GstTensorTrainerFramework}\index{\_GstTensorTrainerFramework@{\_GstTensorTrainerFramework}}


tensor\+\_\+trainer subplugin definition  




{\ttfamily \#include $<$nnstreamer\+\_\+plugin\+\_\+api\+\_\+trainer.\+h$>$}

\doxysubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item 
uint64\+\_\+t \mbox{\hyperlink{struct__GstTensorTrainerFramework_a14a7c78631118d42b91b2d196f337830}{version}}
\item 
int($\ast$ \mbox{\hyperlink{struct__GstTensorTrainerFramework_a72c696e02932c3f0b070c169191f3b29}{create}} )(const \mbox{\hyperlink{nnstreamer__plugin__api__trainer_8h_ac349cd79cfa1849ccec1b439cf4178d4}{Gst\+Tensor\+Trainer\+Framework}} $\ast$self, const \mbox{\hyperlink{nnstreamer__plugin__api__trainer_8h_a2608a46bb1180136135ced9a29eb822d}{Gst\+Tensor\+Trainer\+Properties}} $\ast$\mbox{\hyperlink{gsttensor__srciio_8c_ad143acf0919ab4b62947be3f2f168a91}{prop}}, void $\ast$$\ast$private\+\_\+data)
\item 
int($\ast$ \mbox{\hyperlink{struct__GstTensorTrainerFramework_a761464044184192692caaee5142a946c}{destroy}} )(const \mbox{\hyperlink{nnstreamer__plugin__api__trainer_8h_ac349cd79cfa1849ccec1b439cf4178d4}{Gst\+Tensor\+Trainer\+Framework}} $\ast$self, const \mbox{\hyperlink{nnstreamer__plugin__api__trainer_8h_a2608a46bb1180136135ced9a29eb822d}{Gst\+Tensor\+Trainer\+Properties}} $\ast$\mbox{\hyperlink{gsttensor__srciio_8c_ad143acf0919ab4b62947be3f2f168a91}{prop}}, void $\ast$$\ast$private\+\_\+data)
\item 
int($\ast$ \mbox{\hyperlink{struct__GstTensorTrainerFramework_a830afaf34954bdcfc954c52572a59360}{start}} )(const \mbox{\hyperlink{nnstreamer__plugin__api__trainer_8h_ac349cd79cfa1849ccec1b439cf4178d4}{Gst\+Tensor\+Trainer\+Framework}} $\ast$self, const \mbox{\hyperlink{nnstreamer__plugin__api__trainer_8h_a2608a46bb1180136135ced9a29eb822d}{Gst\+Tensor\+Trainer\+Properties}} $\ast$\mbox{\hyperlink{gsttensor__srciio_8c_ad143acf0919ab4b62947be3f2f168a91}{prop}}, \mbox{\hyperlink{nnstreamer__plugin__api__trainer_8h_a7fb58afa4d009e4e4fd4fd96919e79cf}{Gst\+Tensor\+Trainer\+Event\+Notifier}} $\ast$notifier, void $\ast$private\+\_\+data)
\item 
int($\ast$ \mbox{\hyperlink{struct__GstTensorTrainerFramework_afe615fa6c9e9932707835e42629142de}{stop}} )(const \mbox{\hyperlink{nnstreamer__plugin__api__trainer_8h_ac349cd79cfa1849ccec1b439cf4178d4}{Gst\+Tensor\+Trainer\+Framework}} $\ast$self, const \mbox{\hyperlink{nnstreamer__plugin__api__trainer_8h_a2608a46bb1180136135ced9a29eb822d}{Gst\+Tensor\+Trainer\+Properties}} $\ast$\mbox{\hyperlink{gsttensor__srciio_8c_ad143acf0919ab4b62947be3f2f168a91}{prop}}, void $\ast$$\ast$private\+\_\+data)
\item 
int($\ast$ \mbox{\hyperlink{struct__GstTensorTrainerFramework_a41231fbdeec5e126d701828ada4db69b}{push\+\_\+data}} )(const \mbox{\hyperlink{nnstreamer__plugin__api__trainer_8h_ac349cd79cfa1849ccec1b439cf4178d4}{Gst\+Tensor\+Trainer\+Framework}} $\ast$self, const \mbox{\hyperlink{nnstreamer__plugin__api__trainer_8h_a2608a46bb1180136135ced9a29eb822d}{Gst\+Tensor\+Trainer\+Properties}} $\ast$\mbox{\hyperlink{gsttensor__srciio_8c_ad143acf0919ab4b62947be3f2f168a91}{prop}}, void $\ast$private\+\_\+data, const \mbox{\hyperlink{structGstTensorMemory}{Gst\+Tensor\+Memory}} $\ast$input)
\item 
int($\ast$ \mbox{\hyperlink{struct__GstTensorTrainerFramework_a94a9fc5c440ac860f30d8c4abeb65c92}{get\+Status}} )(const \mbox{\hyperlink{nnstreamer__plugin__api__trainer_8h_ac349cd79cfa1849ccec1b439cf4178d4}{Gst\+Tensor\+Trainer\+Framework}} $\ast$self, \mbox{\hyperlink{nnstreamer__plugin__api__trainer_8h_a2608a46bb1180136135ced9a29eb822d}{Gst\+Tensor\+Trainer\+Properties}} $\ast$\mbox{\hyperlink{gsttensor__srciio_8c_ad143acf0919ab4b62947be3f2f168a91}{prop}}, void $\ast$private\+\_\+data)
\item 
int($\ast$ \mbox{\hyperlink{struct__GstTensorTrainerFramework_acb684622320d25b35d6ee14b975ad382}{get\+Framework\+Info}} )(const \mbox{\hyperlink{nnstreamer__plugin__api__trainer_8h_ac349cd79cfa1849ccec1b439cf4178d4}{Gst\+Tensor\+Trainer\+Framework}} $\ast$self, const \mbox{\hyperlink{nnstreamer__plugin__api__trainer_8h_a2608a46bb1180136135ced9a29eb822d}{Gst\+Tensor\+Trainer\+Properties}} $\ast$\mbox{\hyperlink{gsttensor__srciio_8c_ad143acf0919ab4b62947be3f2f168a91}{prop}}, void $\ast$private\+\_\+data, \mbox{\hyperlink{nnstreamer__plugin__api__trainer_8h_a121d1de3b7c8eb3a30176afff0bf3dec}{Gst\+Tensor\+Trainer\+Framework\+Info}} $\ast$fw\+\_\+info)
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
tensor\+\_\+trainer subplugin definition 

Common callback parameters\+: prop Trainer properties. Read Only. private\+\_\+data Subplugin\textquotesingle{}s private data. Set this ($\ast$private\+\_\+data = X\+XX) if you want to change trainer-\/$>$private\+\_\+data. 

Definition at line 95 of file nnstreamer\+\_\+plugin\+\_\+api\+\_\+trainer.\+h.



\doxysubsection{Member Data Documentation}
\mbox{\Hypertarget{struct__GstTensorTrainerFramework_a72c696e02932c3f0b070c169191f3b29}\label{struct__GstTensorTrainerFramework_a72c696e02932c3f0b070c169191f3b29}} 
\index{\_GstTensorTrainerFramework@{\_GstTensorTrainerFramework}!create@{create}}
\index{create@{create}!\_GstTensorTrainerFramework@{\_GstTensorTrainerFramework}}
\doxysubsubsection{\texorpdfstring{create}{create}}
{\footnotesize\ttfamily int($\ast$ \+\_\+\+Gst\+Tensor\+Trainer\+Framework\+::create) (const \mbox{\hyperlink{nnstreamer__plugin__api__trainer_8h_ac349cd79cfa1849ccec1b439cf4178d4}{Gst\+Tensor\+Trainer\+Framework}} $\ast$self, const \mbox{\hyperlink{nnstreamer__plugin__api__trainer_8h_a2608a46bb1180136135ced9a29eb822d}{Gst\+Tensor\+Trainer\+Properties}} $\ast$\mbox{\hyperlink{gsttensor__srciio_8c_ad143acf0919ab4b62947be3f2f168a91}{prop}}, void $\ast$$\ast$private\+\_\+data)}

tensor\+\_\+trainer call this to create the model 
\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em prop} & read-\/only property values \\
\hline
 & {\em \mbox{[}in/out\mbox{]}} & private\+\_\+data, a subplugin may save its internal private data here. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
0 if ok. $<$ 0 if error. 
\end{DoxyReturn}


Definition at line 102 of file nnstreamer\+\_\+plugin\+\_\+api\+\_\+trainer.\+h.

\mbox{\Hypertarget{struct__GstTensorTrainerFramework_a761464044184192692caaee5142a946c}\label{struct__GstTensorTrainerFramework_a761464044184192692caaee5142a946c}} 
\index{\_GstTensorTrainerFramework@{\_GstTensorTrainerFramework}!destroy@{destroy}}
\index{destroy@{destroy}!\_GstTensorTrainerFramework@{\_GstTensorTrainerFramework}}
\doxysubsubsection{\texorpdfstring{destroy}{destroy}}
{\footnotesize\ttfamily int($\ast$ \+\_\+\+Gst\+Tensor\+Trainer\+Framework\+::destroy) (const \mbox{\hyperlink{nnstreamer__plugin__api__trainer_8h_ac349cd79cfa1849ccec1b439cf4178d4}{Gst\+Tensor\+Trainer\+Framework}} $\ast$self, const \mbox{\hyperlink{nnstreamer__plugin__api__trainer_8h_a2608a46bb1180136135ced9a29eb822d}{Gst\+Tensor\+Trainer\+Properties}} $\ast$\mbox{\hyperlink{gsttensor__srciio_8c_ad143acf0919ab4b62947be3f2f168a91}{prop}}, void $\ast$$\ast$private\+\_\+data)}

tensor\+\_\+trainer call this to destroy the model, Set N\+U\+LL after that. 
\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em prop} & read-\/only property values \\
\hline
 & {\em \mbox{[}in/out\mbox{]}} & private\+\_\+data, a subplugin may save its internal private data here. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
0 if ok. $<$ 0 if error. 
\end{DoxyReturn}


Definition at line 110 of file nnstreamer\+\_\+plugin\+\_\+api\+\_\+trainer.\+h.

\mbox{\Hypertarget{struct__GstTensorTrainerFramework_acb684622320d25b35d6ee14b975ad382}\label{struct__GstTensorTrainerFramework_acb684622320d25b35d6ee14b975ad382}} 
\index{\_GstTensorTrainerFramework@{\_GstTensorTrainerFramework}!getFrameworkInfo@{getFrameworkInfo}}
\index{getFrameworkInfo@{getFrameworkInfo}!\_GstTensorTrainerFramework@{\_GstTensorTrainerFramework}}
\doxysubsubsection{\texorpdfstring{getFrameworkInfo}{getFrameworkInfo}}
{\footnotesize\ttfamily int($\ast$ \+\_\+\+Gst\+Tensor\+Trainer\+Framework\+::get\+Framework\+Info) (const \mbox{\hyperlink{nnstreamer__plugin__api__trainer_8h_ac349cd79cfa1849ccec1b439cf4178d4}{Gst\+Tensor\+Trainer\+Framework}} $\ast$self, const \mbox{\hyperlink{nnstreamer__plugin__api__trainer_8h_a2608a46bb1180136135ced9a29eb822d}{Gst\+Tensor\+Trainer\+Properties}} $\ast$\mbox{\hyperlink{gsttensor__srciio_8c_ad143acf0919ab4b62947be3f2f168a91}{prop}}, void $\ast$private\+\_\+data, \mbox{\hyperlink{nnstreamer__plugin__api__trainer_8h_a121d1de3b7c8eb3a30176afff0bf3dec}{Gst\+Tensor\+Trainer\+Framework\+Info}} $\ast$fw\+\_\+info)}

Mandatory callback. Get the frameworks statically determined info. 
\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em prop} & read-\/only property values \\
\hline
\mbox{\texttt{ in}}  & {\em private\+\_\+data} & A subplugin may save its internal private data here. \\
\hline
\mbox{\texttt{ out}}  & {\em fw\+\_\+info} & struct to hold frameworks info. Must be allocated by the caller (return value). \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
0 if OK. $<$ 0 if error.
\end{DoxyReturn}
\begin{DoxyNote}{Note}
C\+A\+U\+T\+I\+ON\+: private\+\_\+data can be N\+U\+LL if the framework is not yet opened by the caller. 
\end{DoxyNote}


Definition at line 154 of file nnstreamer\+\_\+plugin\+\_\+api\+\_\+trainer.\+h.

\mbox{\Hypertarget{struct__GstTensorTrainerFramework_a94a9fc5c440ac860f30d8c4abeb65c92}\label{struct__GstTensorTrainerFramework_a94a9fc5c440ac860f30d8c4abeb65c92}} 
\index{\_GstTensorTrainerFramework@{\_GstTensorTrainerFramework}!getStatus@{getStatus}}
\index{getStatus@{getStatus}!\_GstTensorTrainerFramework@{\_GstTensorTrainerFramework}}
\doxysubsubsection{\texorpdfstring{getStatus}{getStatus}}
{\footnotesize\ttfamily int($\ast$ \+\_\+\+Gst\+Tensor\+Trainer\+Framework\+::get\+Status) (const \mbox{\hyperlink{nnstreamer__plugin__api__trainer_8h_ac349cd79cfa1849ccec1b439cf4178d4}{Gst\+Tensor\+Trainer\+Framework}} $\ast$self, \mbox{\hyperlink{nnstreamer__plugin__api__trainer_8h_a2608a46bb1180136135ced9a29eb822d}{Gst\+Tensor\+Trainer\+Properties}} $\ast$\mbox{\hyperlink{gsttensor__srciio_8c_ad143acf0919ab4b62947be3f2f168a91}{prop}}, void $\ast$private\+\_\+data)}

tensor\+\_\+trainer call this to get status of subplugin 
\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em prop} & property values \\
\hline
\mbox{\texttt{ in}}  & {\em private\+\_\+data,a} & subplugin may save its internal private data here. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
0 if ok. $<$ 0 if error. 
\end{DoxyReturn}


Definition at line 146 of file nnstreamer\+\_\+plugin\+\_\+api\+\_\+trainer.\+h.

\mbox{\Hypertarget{struct__GstTensorTrainerFramework_a41231fbdeec5e126d701828ada4db69b}\label{struct__GstTensorTrainerFramework_a41231fbdeec5e126d701828ada4db69b}} 
\index{\_GstTensorTrainerFramework@{\_GstTensorTrainerFramework}!push\_data@{push\_data}}
\index{push\_data@{push\_data}!\_GstTensorTrainerFramework@{\_GstTensorTrainerFramework}}
\doxysubsubsection{\texorpdfstring{push\_data}{push\_data}}
{\footnotesize\ttfamily int($\ast$ \+\_\+\+Gst\+Tensor\+Trainer\+Framework\+::push\+\_\+data) (const \mbox{\hyperlink{nnstreamer__plugin__api__trainer_8h_ac349cd79cfa1849ccec1b439cf4178d4}{Gst\+Tensor\+Trainer\+Framework}} $\ast$self, const \mbox{\hyperlink{nnstreamer__plugin__api__trainer_8h_a2608a46bb1180136135ced9a29eb822d}{Gst\+Tensor\+Trainer\+Properties}} $\ast$\mbox{\hyperlink{gsttensor__srciio_8c_ad143acf0919ab4b62947be3f2f168a91}{prop}}, void $\ast$private\+\_\+data, const \mbox{\hyperlink{structGstTensorMemory}{Gst\+Tensor\+Memory}} $\ast$input)}

tensor\+\_\+trainer call this to push tensor data to subplugin, subplugin constructs a data set using input. 
\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em prop} & read-\/only property values \\
\hline
\mbox{\texttt{ in}}  & {\em private\+\_\+data,a} & subplugin may save its internal private data here. \\
\hline
\mbox{\texttt{ in}}  & {\em input} & The array of input tensors. Allocated and filled by tensor\+\_\+trainer \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
0 if ok. $<$ 0 if error. 
\end{DoxyReturn}


Definition at line 136 of file nnstreamer\+\_\+plugin\+\_\+api\+\_\+trainer.\+h.

\mbox{\Hypertarget{struct__GstTensorTrainerFramework_a830afaf34954bdcfc954c52572a59360}\label{struct__GstTensorTrainerFramework_a830afaf34954bdcfc954c52572a59360}} 
\index{\_GstTensorTrainerFramework@{\_GstTensorTrainerFramework}!start@{start}}
\index{start@{start}!\_GstTensorTrainerFramework@{\_GstTensorTrainerFramework}}
\doxysubsubsection{\texorpdfstring{start}{start}}
{\footnotesize\ttfamily int($\ast$ \+\_\+\+Gst\+Tensor\+Trainer\+Framework\+::start) (const \mbox{\hyperlink{nnstreamer__plugin__api__trainer_8h_ac349cd79cfa1849ccec1b439cf4178d4}{Gst\+Tensor\+Trainer\+Framework}} $\ast$self, const \mbox{\hyperlink{nnstreamer__plugin__api__trainer_8h_a2608a46bb1180136135ced9a29eb822d}{Gst\+Tensor\+Trainer\+Properties}} $\ast$\mbox{\hyperlink{gsttensor__srciio_8c_ad143acf0919ab4b62947be3f2f168a91}{prop}}, \mbox{\hyperlink{nnstreamer__plugin__api__trainer_8h_a7fb58afa4d009e4e4fd4fd96919e79cf}{Gst\+Tensor\+Trainer\+Event\+Notifier}} $\ast$notifier, void $\ast$private\+\_\+data)}

tensor\+\_\+trainer call this to start training the model 
\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em prop} & read-\/only property values \\
\hline
\mbox{\texttt{ in}}  & {\em notify,a} & handle of event notify \\
\hline
\mbox{\texttt{ in}}  & {\em private\+\_\+data,a} & subplugin may save its internal private data here. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
0 if ok. $<$ 0 if error. 
\end{DoxyReturn}


Definition at line 118 of file nnstreamer\+\_\+plugin\+\_\+api\+\_\+trainer.\+h.

\mbox{\Hypertarget{struct__GstTensorTrainerFramework_afe615fa6c9e9932707835e42629142de}\label{struct__GstTensorTrainerFramework_afe615fa6c9e9932707835e42629142de}} 
\index{\_GstTensorTrainerFramework@{\_GstTensorTrainerFramework}!stop@{stop}}
\index{stop@{stop}!\_GstTensorTrainerFramework@{\_GstTensorTrainerFramework}}
\doxysubsubsection{\texorpdfstring{stop}{stop}}
{\footnotesize\ttfamily int($\ast$ \+\_\+\+Gst\+Tensor\+Trainer\+Framework\+::stop) (const \mbox{\hyperlink{nnstreamer__plugin__api__trainer_8h_ac349cd79cfa1849ccec1b439cf4178d4}{Gst\+Tensor\+Trainer\+Framework}} $\ast$self, const \mbox{\hyperlink{nnstreamer__plugin__api__trainer_8h_a2608a46bb1180136135ced9a29eb822d}{Gst\+Tensor\+Trainer\+Properties}} $\ast$\mbox{\hyperlink{gsttensor__srciio_8c_ad143acf0919ab4b62947be3f2f168a91}{prop}}, void $\ast$$\ast$private\+\_\+data)}

tensor\+\_\+trainer call this to stop training the model 
\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em prop} & read-\/only property values \\
\hline
 & {\em \mbox{[}in/out\mbox{]}} & private\+\_\+data, a subplugin may save its internal private data here. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
0 if ok. $<$ 0 if error. 
\end{DoxyReturn}


Definition at line 128 of file nnstreamer\+\_\+plugin\+\_\+api\+\_\+trainer.\+h.

\mbox{\Hypertarget{struct__GstTensorTrainerFramework_a14a7c78631118d42b91b2d196f337830}\label{struct__GstTensorTrainerFramework_a14a7c78631118d42b91b2d196f337830}} 
\index{\_GstTensorTrainerFramework@{\_GstTensorTrainerFramework}!version@{version}}
\index{version@{version}!\_GstTensorTrainerFramework@{\_GstTensorTrainerFramework}}
\doxysubsubsection{\texorpdfstring{version}{version}}
{\footnotesize\ttfamily uint64\+\_\+t \+\_\+\+Gst\+Tensor\+Trainer\+Framework\+::version}

Version of the struct $\vert$ 32bit (validity check) $\vert$ 16bit (A\+PI version) $\vert$ 16bit (Subplugin\textquotesingle{}s internal version) $\vert$ 

Definition at line 97 of file nnstreamer\+\_\+plugin\+\_\+api\+\_\+trainer.\+h.



The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
nnstreamer/include/\mbox{\hyperlink{nnstreamer__plugin__api__trainer_8h}{nnstreamer\+\_\+plugin\+\_\+api\+\_\+trainer.\+h}}\end{DoxyCompactItemize}
