learn_sampset_boxT_learn_sampset_boxLearnSampsetBoxLearnSampsetBoxlearn_sampset_box (Operator)
Name
learn_sampset_boxT_learn_sampset_boxLearnSampsetBoxLearnSampsetBoxlearn_sampset_box — Train the classifier with one data set.
Warning
learn_sampset_boxlearn_sampset_boxLearnSampsetBoxLearnSampsetBoxLearnSampsetBoxlearn_sampset_box is obsolete and is only provided for
reasons of backward compatibility. New applications should use the
MLP, SVM, KNN or GMM operators instead.
Signature
void LearnSampsetBox(const HTuple& ClassifHandle, const HTuple& SampKey, const HTuple& Outfile, const HTuple& NSamples, const HTuple& StopError, const HTuple& ErrorN)
void HFeatureSet::LearnSampsetBox(const HClassBox& ClassifHandle, const HString& Outfile, Hlong NSamples, double StopError, Hlong ErrorN) const
void HFeatureSet::LearnSampsetBox(const HClassBox& ClassifHandle, const char* Outfile, Hlong NSamples, double StopError, Hlong ErrorN) const
void HFeatureSet::LearnSampsetBox(const HClassBox& ClassifHandle, const wchar_t* Outfile, Hlong NSamples, double StopError, Hlong ErrorN) const
(Windows only)
void HClassBox::LearnSampsetBox(const HFeatureSet& SampKey, const HString& Outfile, Hlong NSamples, double StopError, Hlong ErrorN) const
void HClassBox::LearnSampsetBox(const HFeatureSet& SampKey, const char* Outfile, Hlong NSamples, double StopError, Hlong ErrorN) const
void HClassBox::LearnSampsetBox(const HFeatureSet& SampKey, const wchar_t* Outfile, Hlong NSamples, double StopError, Hlong ErrorN) const
(Windows only)
static void HOperatorSet.LearnSampsetBox(HTuple classifHandle, HTuple sampKey, HTuple outfile, HTuple NSamples, HTuple stopError, HTuple errorN)
void HFeatureSet.LearnSampsetBox(HClassBox classifHandle, string outfile, int NSamples, double stopError, int errorN)
void HClassBox.LearnSampsetBox(HFeatureSet sampKey, string outfile, int NSamples, double stopError, int errorN)
Description
learn_sampset_boxlearn_sampset_boxLearnSampsetBoxLearnSampsetBoxLearnSampsetBoxlearn_sampset_box trains the classifier with data for the
key SampKeySampKeySampKeySampKeysampKeysamp_key (see read_sampsetread_sampsetReadSampsetReadSampsetReadSampsetread_sampset). The training sequence
is terminated at least after NSamplesNSamplesNSamplesNSamplesNSamplesnsamples examples.
If NSamplesNSamplesNSamplesNSamplesNSamplesnsamples is bigger than the number of examples in
SampKeySampKeySampKeySampKeysampKeysamp_key, then a cyclic start at the beginning occurs.
If the error underpasses the value StopErrorStopErrorStopErrorStopErrorstopErrorstop_error, then the training
sequence is prematurely terminated. StopErrorStopErrorStopErrorStopErrorstopErrorstop_error is calculated with
N / ErrorN. Whereby N means the number of examples which were wrong
classified during the last ErrorNErrorNErrorNErrorNerrorNerror_n training examples.
Typically ErrorNErrorNErrorNErrorNerrorNerror_n is the number of examples in SampKeySampKeySampKeySampKeysampKeysamp_key
and NSamplesNSamplesNSamplesNSamplesNSamplesnsamples is a multiple of it.
If you want a data set with 100 examples to run 5 times at most and if you
want it to terminate with an error lower than 5%, then the corresponding
values are NSamplesNSamplesNSamplesNSamplesNSamplesnsamples = 500, ErrorNErrorNErrorNErrorNerrorNerror_n = 100 and
StopErrorStopErrorStopErrorStopErrorstopErrorstop_error = 0.05.
A protocol of the training activity is going to be written in file
OutfileOutfileOutfileOutfileoutfileoutfile.
Execution Information
- Multithreading type: reentrant (runs in parallel with non-exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without parallelization.
This operator modifies the state of the following input parameter:
During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.
Parameters
ClassifHandleClassifHandleClassifHandleClassifHandleclassifHandleclassif_handle (input_control, state is modified) class_box → HClassBox, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handle of the classifier.
SampKeySampKeySampKeySampKeysampKeysamp_key (input_control) feature_set → HFeatureSet, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Number of the data set to train.
OutfileOutfileOutfileOutfileoutfileoutfile (input_control) filename.write → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
Name of the protocol file.
Default value:
'training_prot'
"training_prot"
"training_prot"
"training_prot"
"training_prot"
"training_prot"
NSamplesNSamplesNSamplesNSamplesNSamplesnsamples (input_control) integer → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Number of arrays of attributes to learn.
Default value: 500
StopErrorStopErrorStopErrorStopErrorstopErrorstop_error (input_control) real → HTuplefloatHTupleHtuple (real) (double) (double) (double)
Classification error for termination.
Default value: 0.05
ErrorNErrorNErrorNErrorNerrorNerror_n (input_control) integer → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Error during the assignment.
Default value: 100
Result
learn_sampset_boxlearn_sampset_boxLearnSampsetBoxLearnSampsetBoxLearnSampsetBoxlearn_sampset_box returns 2 (H_MSG_TRUE).
An exception is raised if key SampKeySampKeySampKeySampKeysampKeysamp_key does not exist
or there are problems while opening the file.
Possible Predecessors
create_class_boxcreate_class_boxCreateClassBoxCreateClassBoxCreateClassBoxcreate_class_box
Possible Successors
test_sampset_boxtest_sampset_boxTestSampsetBoxTestSampsetBoxTestSampsetBoxtest_sampset_box,
enquire_class_boxenquire_class_boxEnquireClassBoxEnquireClassBoxEnquireClassBoxenquire_class_box,
write_class_boxwrite_class_boxWriteClassBoxWriteClassBoxWriteClassBoxwrite_class_box,
close_class_boxclose_class_boxCloseClassBoxCloseClassBoxCloseClassBoxclose_class_box,
clear_sampsetclear_sampsetClearSampsetClearSampsetClearSampsetclear_sampset
See also
test_sampset_boxtest_sampset_boxTestSampsetBoxTestSampsetBoxTestSampsetBoxtest_sampset_box,
enquire_class_boxenquire_class_boxEnquireClassBoxEnquireClassBoxEnquireClassBoxenquire_class_box,
learn_class_boxlearn_class_boxLearnClassBoxLearnClassBoxLearnClassBoxlearn_class_box,
read_sampsetread_sampsetReadSampsetReadSampsetReadSampsetread_sampset
Module
Foundation